Spring Boot + Spring Security + Thymeleaf 简单教程

时间  2019-11-17
标签 spring boot security thymeleaf 简单 教程 栏目 Spring 繁體版
原文   原文链接

由于有一个项目需采用MVC构架，因此学习了Spring Security并记录下来，但愿你们一块儿学习提供意见php

GitHub地址：github.com/Smith-Cruis…。html

原文地址：www.inlighting.org/2019/spring…。前端

若是有疑问，请在 GitHub 中发布 issue，我有空会为你们解答的java

本项目基于Spring Boot 2 + Spring Security 5 + Thymeleaf 2 + JDK11（你也能够用8，应该区别不大）git

实现了如下功能：github

  • 基于注解的权限控制
  • 在Thymeleaf中使用Spring Security的标签
  • 自定义权限注解
  • 记住密码功能

若是须要先后端分离的安全框架搭建教程能够参考：Spring Boot 2 + Spring Security 5 + JWT 的单页应用Restful解决方案web

项目演示

若是想要直接体验，直接 clone 项目，运行 mvn spring-boot:run 命令便可进行访问，网址规则自行看教程后面算法

首页spring

首页

登入数据库

登入

登出

登出

Home页面

登出

Admin页面

登出

403无权限页面

登出

Spring Security 基本原理

Spring Security 过滤器链

Spring Security实现了一系列的过滤器链，就按照下面顺序一个一个执行下去。

  1. ....class 一些自定义过滤器（在配置的时候你能够本身选择插到哪一个过滤器以前），由于这个需求因人而异，本文不探讨，你们能够本身研究
  2. UsernamePasswordAithenticationFilter.class Spring Security 自带的表单登入验证过滤器，也是本文主要使用的过滤器
  3. BasicAuthenticationFilter.class
  4. ExceptionTranslation.class 异常解释器
  5. FilterSecurityInterceptor.class 拦截器最终决定请求可否经过
  6. Controller 咱们最后本身编写的控制器

相关类说明

  • User.class ：注意这个类不是咱们本身写的，而是Spring Security官方提供的，他提供了一些基础的功能，咱们能够经过继承这个类来扩充方法。详见代码中的 CustomUser.java
  • UserDetailsService.class： Spring Security官方提供的一个接口，里面只有一个方法loadUserByUsername() ，Spring Security会调用这个方法来获取数据库中存在的数据，而后和用户POST过来的用户名密码进行比对，从而判断用户的用户名密码是否正确。因此咱们须要本身实现loadUserByUsername() 这个方法。详见代码中的 CustomUserDetailsService.java。

项目逻辑

为了体现权限区别，咱们经过HashMap构造了一个数据库，里面包含了4个用户

ID 用户名 密码 权限
1 jack jack123 user
2 danny danny123 editor
3 alice alice123 reviewer
4 smith smith123 admin

说明下权限

user：最基础的权限，只要是登入用户就有 user 权限

editor：在 user 权限上面增长了 editor 的权限

reviewer：与上同理，editor 和 reviewer 属于同一级的权限

admin：包含全部权限

为了检验权限，咱们提供若干个页面

网址 说明 可访问权限
/ 首页 全部人都可访问（anonymous）
/login 登入页面 全部人都可访问（anonymous）
/logout 退出页面 全部人都可访问（anonymous）
/user/home 用户中心 user
/user/editor editor, admin
/user/reviewer reviewer, admin
/user/admin admin
/403 403错误页面，美化过，你们能够直接用 全部人都可访问（anonymous）
/404 404错误页面，美化过，你们能够直接用 全部人都可访问（anonymous）
/500 500错误页面，美化过，你们能够直接用 全部人都可访问（anonymous）

代码配置

Maven 配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>org.inlighting</groupId>
    <artifactId>security-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>security-demo</name>
    <description>Demo project for Spring Boot &amp; Spring Security</description>

    <!--指定JDK版本，你们能够改为本身的-->
    <properties>
        <java.version>11</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--对Thymeleaf添加Spring Security标签支持-->
        <dependency>
            <groupId>org.thymeleaf.extras</groupId>
            <artifactId>thymeleaf-extras-springsecurity5</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--开发的热加载配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
复制代码

application.properties配置

为了使热加载（这样修改模板后无需重启 Tomcat ）生效，咱们须要在Spring Boot的配置文件上面加上一段话

spring.thymeleaf.cache=false
复制代码

若是须要详细了解热加载，请看官方文档：docs.spring.io/spring-boot…

Spring Security 配置

首先咱们开启方法注解支持：只须要在类上添加 @EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = true) 注解，咱们设置 prePostEnabled = true 是为了支持 hasRole() 这类表达式。若是想进一步了解方法注解能够看 Introduction to Spring Method Security 这篇文章。

SecurityConfig.java

/** * 开启方法注解支持，咱们设置prePostEnabled = true是为了后面可以使用hasRole()这类表达式 * 进一步了解可看教程：https://www.baeldung.com/spring-security-method-security */
@EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = true)
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    /** * TokenBasedRememberMeServices的生成密钥， * 算法实现详见文档：https://docs.spring.io/spring-security/site/docs/5.1.3.RELEASE/reference/htmlsingle/#remember-me-hash-token */
    private final String SECRET_KEY = "123456";

    @Autowired
    private CustomUserDetailsService customUserDetailsService;

    /** * 必须有此方法，Spring Security官方规定必需要有一个密码加密方式。 * 注意：例如这里用了BCryptPasswordEncoder()的加密方法，那么在保存用户密码的时候也必须使用这种方法，确保先后一致。 * 详情参见项目中Database.java中保存用户的逻辑 */
    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }

    /** * 配置Spring Security，下面说明几点注意事项。 * 1. Spring Security 默认是开启了CSRF的，此时咱们提交的POST表单必须有隐藏的字段来传递CSRF， * 并且在logout中，咱们必须经过POST到 /logout 的方法来退出用户，详见咱们的login.html和logout.html. * 2. 开启了rememberMe()功能后，咱们必须提供rememberMeServices，例以下面的getRememberMeServices()方法， * 并且咱们只能在TokenBasedRememberMeServices中设置cookie名称、过时时间等相关配置,若是在别的地方同时配置，会报错。 * 错误示例：xxxx.and().rememberMe().rememberMeServices(getRememberMeServices()).rememberMeCookieName("cookie-name") */
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.formLogin()
                .loginPage("/login") // 自定义用户登入页面
                .failureUrl("/login?error") // 自定义登入失败页面，前端能够经过url中是否有error来提供友好的用户登入提示
                .and()
                .logout()
                .logoutUrl("/logout")// 自定义用户登出页面
                .logoutSuccessUrl("/")
                .and()
                .rememberMe() // 开启记住密码功能
                .rememberMeServices(getRememberMeServices()) // 必须提供
                .key(SECRET_KEY) // 此SECRET须要和生成TokenBasedRememberMeServices的密钥相同
                .and()
                /* * 默认容许全部路径全部人均可以访问，确保静态资源的正常访问。 * 后面再经过方法注解的方式来控制权限。 */
                .authorizeRequests().anyRequest().permitAll()
                .and()
                .exceptionHandling().accessDeniedPage("/403"); // 权限不足自动跳转403
    }

    /** * 若是要设置cookie过时时间或其余相关配置，请在下方自行配置 */
    private TokenBasedRememberMeServices getRememberMeServices() {
        TokenBasedRememberMeServices services = new TokenBasedRememberMeServices(SECRET_KEY, customUserDetailsService);
        services.setCookieName("remember-cookie");
        services.setTokenValiditySeconds(100); // 默认14天
        return services;
    }
}
复制代码

UserService.java

本身模拟数据库操做的Service，用于向本身经过HashMap模拟的数据源获取数据。

@Service
public class UserService {

    private Database database = new Database();

    public CustomUser getUserByUsername(String username) {
        CustomUser originUser = database.getDatabase().get(username);
        if (originUser == null) {
            return null;
        }

        /* * 此处有坑，之因此这么作是由于Spring Security得到到User后，会把User中的password字段置空，以确保安全。 * 由于Java类是引用传递，为防止Spring Security修改了咱们的源头数据，因此咱们复制一个对象提供给Spring Security。 * 若是经过真实数据库的方式获取，则没有这种问题须要担忧。 */
        return new CustomUser(originUser.getId(), originUser.getUsername(), originUser.getPassword(), originUser.getAuthorities());
    }
}
复制代码

CustomUserDetailsService.java

/** * 实现官方提供的UserDetailsService接口便可 */
@Service
public class CustomUserDetailsService implements UserDetailsService {

    private Logger LOGGER = LoggerFactory.getLogger(getClass());

    @Autowired
    private UserService userService;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        CustomUser user = userService.getUserByUsername(username);
        if (user == null) {
            throw new  UsernameNotFoundException("该用户不存在");
        }
        LOGGER.info("用户名："+username+" 角色："+user.getAuthorities().toString());
        return user;
    }
}
复制代码

自定义权限注解

咱们在开发网站的过程当中，好比 GET /user/editor 这个请求角色为 EDITOR 和 ADMIN 确定均可以，若是咱们在每个须要判断权限的方法上面写一长串的权限表达式，必定很复杂。可是经过自定义权限注解，咱们能够经过 @IsEditor 这样的方法来判断，这样一来就简单了不少。进一步了解能够看：Introduction to Spring Method Security

IsUser.java

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasAnyAuthority('ROLE_USER', 'ROLE_EDITOR', 'ROLE_REVIEWER', 'ROLE_ADMIN')")
public @interface IsUser {
}
复制代码

IsEditor.java

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasAnyRole('ROLE_USER', 'ROLE_EDITOR', 'ROLE_ADMIN')")
public @interface IsEditor {
}
复制代码

IsReviewer.java

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasAnyRole('ROLE_USER', 'ROLE_REVIEWER', 'ROLE_ADMIN')")
public @interface IsReviewer {
}
复制代码

IsAdmin.java

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@PreAuthorize("hasAnyRole('ROLE_ADMIN')")
public @interface IsAdmin { 
}
复制代码

Spring Security自带表达式

  • hasRole()，是否拥有某一个权限

  • hasAnyRole()，多个权限中有一个便可，如 hasAnyRole("ADMIN","USER")

  • hasAuthority()，Authority 和 Role 很像，惟一的区别就是 Authority 前缀多了 ROLE_ ，如 hasAuthority("ROLE_ADMIN") 等价于 hasRole("ADMIN") ，能够参考上面 IsUser.java 的写法

  • hasAnyAuthority()，同上，多个权限中有一个便可

  • permitAll(), denyAll(),isAnonymous(), isRememberMe()，经过字面意思能够理解

  • isAuthenticated(), isFullyAuthenticated()，这两个区别就是isFullyAuthenticated()对认证的安全要求更高。例如用户经过记住密码功能登入到系统进行敏感操做，isFullyAuthenticated()会返回false，此时咱们可让用户再输入一次密码以确保安全，而 isAuthenticated() 只要是登入用户均返回true。

  • principal(), authentication()，例如咱们想获取登入用户的id，能够经过principal() 返回的 Object 获取，实际上 principal() 返回的 Object 基本上能够等同咱们本身编写的 CustomUser 。而 authentication() 返回的 Authentication 是 Principal 的父类，相关操做可看 Authentication 的源码。进一步了解能够看后面Controller编写中获取用户数据的四种方法

  • hasPermission()，参考字面意思便可

若是想进一步了解，能够参考 Intro to Spring Security Expressions。

添加Thymeleaf支持

咱们经过 thymeleaf-extras-springsecurity 来添加Thymeleaf对Spring Security的支持。

Maven配置

上面的Maven配置已经加过了

<dependency>
    <groupId>org.thymeleaf.extras</groupId>
    <artifactId>thymeleaf-extras-springsecurity5</artifactId>
</dependency>
复制代码

使用例子

注意咱们要在html中添加 xmlns:sec 的支持

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/extras/spring-security">
<head>
    <meta charset="UTF-8">
    <title>Admin</title>
</head>
<body>
<p>This is a home page.</p>
<p>Id: <th:block sec:authentication="principal.id"></th:block></p>
<p>Username: <th:block sec:authentication="principal.username"></th:block></p>
<p>Role: <th:block sec:authentication="principal.authorities"></th:block></p>
</body>
</html>
复制代码

若是想进一步了解请看文档 thymeleaf-extras-springsecurity。

Controller编写

IndexController.java

本控制器没有任何的权限规定

@Controller
public class IndexController {

    @GetMapping("/")
    public String index() {
        return "index/index";
    }

    @GetMapping("/login")
    public String login() {
        return "index/login";
    }

    @GetMapping("/logout")
    public String logout() {
        return "index/logout";
    }
}
复制代码

UserController.java

在这个控制器中，我综合展现了自定义注解的使用和4种获取用户信息的方式

@IsUser // 代表该控制器下全部请求都须要登入后才能访问
@Controller
@RequestMapping("/user")
public class UserController {

    @GetMapping("/home")
    public String home(Model model) {
        // 方法一：经过SecurityContextHolder获取
        CustomUser user = (CustomUser)SecurityContextHolder.getContext().getAuthentication().getPrincipal();
        model.addAttribute("user", user);
        return "user/home";
    }

    @GetMapping("/editor")
    @IsEditor
    public String editor(Authentication authentication, Model model) {
        // 方法二：经过方法注入的形式获取Authentication
        CustomUser user = (CustomUser)authentication.getPrincipal();
        model.addAttribute("user", user);
        return "user/editor";
    }

    @GetMapping("/reviewer")
    @IsReviewer
    public String reviewer(Principal principal, Model model) {
        // 方法三：一样经过方法注入的方法，注意要转型，此方法很二，不推荐
        CustomUser user = (CustomUser) ((Authentication)principal).getPrincipal();
        model.addAttribute("user", user);
        return "user/reviewer";
    }

    @GetMapping("/admin")
    @IsAdmin
    public String admin() {
        // 方法四：经过Thymeleaf的Security标签进行，详情见admin.html
        return "user/admin";
    }
}
复制代码

注意

  • 若是有安全控制的方法 A 被同一个类中别的方法调用，那么方法 A 的权限控制会被忽略，私有方法一样会受到影响
  • Spring 的 SecurityContext 是线程绑定的，若是咱们在当前的线程中新建了别的线程，那么他们的 SecurityContext 是不共享的，进一步了解请看 Spring Security Context Propagation with @Async

Html的编写

在编写html的时候，基本上就是大同小异了，就是注意一点，**若是开启了CSRF，在编写表单POST请求的时候添加上隐藏字段，如 **<input type="hidden" th:name="${_csrf.parameterName}" th:value="${_csrf.token}"/> ，不过你们其实不用加也没事，由于Thymeleaf自动会加上去的😀。

总结

教程粗糙，欢迎指正！

如需深刻了解，若是想系统的学习能够看看 Security with Spring。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程