【知识总结】thymeleaf-extras-springsecurity5

# 1.添加依赖

在项目的 pom.xml 文件中添加 thymeleaf-extras-springsecurity5 的依赖：

```xml
<dependency>
    <groupId>org.thymeleaf.extras</groupId>
    <artifactId>thymeleaf-extras-springsecurity5</artifactId>
    <version>3.0.4.RELEASE</version>
</dependency>
```

# 2.配置 Spring Security

为了使用 thymeleaf-extras-springsecurity5，需要先配置 Spring Security，包括用户认证、授权等相关配置。可以参考 Spring Security 的官方文档进行配置。

我们应为使用了thymeleaf-extras-springsecurity5，需要添加SpringSecurityDialect放入Spring容器中。

```java
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
 
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        // ...其他配置
    }
 
    @Bean
    public SpringSecurityDialect securityDialect() {
        return new SpringSecurityDialect();
    }
}
```

# 3.配置 Thymeleaf 模板引擎

在 Spring Boot 应用中，可以通过在 application.properties 或 application.yml 配置文件中配置 Thymeleaf 模板引擎，指定模板文件的位置等。例如：

```yaml
spring:
  thymeleaf:
    prefix: classpath:/templates/
    suffix: .html
```

其中，`spring.thymeleaf.prefix` 表示模板文件所在的路径，`spring.thymeleaf.suffix` 表示模板文件的后缀名。在上述示例中，模板文件的路径为 classpath:/templates/，后缀名为 .html。

另外，如果需要开启 Thymeleaf 模板引擎的缓存功能，可以在配置文件中添加如下配置：

```yaml
spring:
  thymeleaf:
    cache: true
```

以上配置表示开启 Thymeleaf 模板引擎的缓存功能，可以提高模板渲染的效率。如果需要关闭缓存功能，可以将 `cache` 属性的值设置为 false。

# 4.添加 Thymeleaf 模板标签

在需要使用 Spring Security 的 Thymeleaf 模板文件中添加 thymeleaf-extras-springsecurity5 的标签。例如：

```html
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:th="http://www.thymeleaf.org"
      xmlns:sec="http://www.thymeleaf.org/extras/spring-security">
<head>
    <title>使用 Thymeleaf-extras-springsecurity5</title>
</head>
<body>
    <div sec:authorize="hasRole('ROLE_ADMIN')">
        只有 ADMIN 【角色】才能看到这段内容。
    </div>

<sec:authorize access="hasAuthority('EDIT_USER')">
        <div>
            只有拥有编辑用户【权限】的用户才能看到这个内容。
        </div>
    </sec:authorize>

</body>
</html>
```

在上述示例中，`sec:authorize` 是授权标签，表示只有具有 ADMIN 角色的用户才能看到包含在 `div` 标签中的内容。

# 5.运行应用

完成上述步骤后，运行应用并访问相关页面，即可看到使用 thymeleaf-extras-springsecurity5 的效果。

需要注意的是，在使用 thymeleaf-extras-springsecurity5 的标签时，需要在标签前添加 `sec:` 前缀。例如，`sec:authorize` 表示授权标签，`sec:authentication` 表示认证标签。

# 6.注意事项

使用 Thymeleaf-extras-springsecurity5 前需要添加 org.thymeleaf 的 maven 依赖，因为 Thymeleaf-extras-springsecurity5 是 Thymeleaf 的扩展库，需要依赖于 Thymeleaf。可以在项目的 pom.xml 文件中添加如下依赖：

```xml
<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf-spring5</artifactId>
    <version>3.0.12.RELEASE</version>
</dependency>
```

其中，版本号可以根据实际情况进行修改。

最后修改：2023 年 03 月 20 日