Spring Security 6 配置方法，废弃 WebSecurityConfigurerAdapter

一、背景

最近阿里云的项目迁回本地运行，数据库从阿里云的RDS（即Mysql5.6）换成了本地8.0，Redis也从古董级别的2.x换成了现在6，忍不住，手痒，把jdk升级到了17，用zgc垃圾回收器，源代码重新编译重新发布，结果碰到了古董的SpringBoot不支持jdk17，所以有了这篇日志。记录一下SpringBoot2+SpringSecurity+JWT升级成SpringBoot3+SpringSecurity+JWT，就像文章标题所说的，SpringSecurity已经废弃了继承WebSecurityConfigurerAdapter的配置方式，那就的从头来咯。

在Spring Security 5.7.0-M2中，Spring就废弃了WebSecurityConfigurerAdapter，因为Spring官方鼓励用户转向基于组件的安全配置。本文整理了一下新的配置方法。 

在下面的例子中，我们使用Spring Security lambda DSL和HttpSecurity#authorizeHttpRequests方法来定义我们的授权规则，从而遵循最佳实践。

二、配置成功后根据配置的情况整理的类图

​​​​​​​

 

三、配置详情

3.1. 启用WebSecurity配置 

 
  1. @Configuration
  2. @EnableWebSecurity
  3. public class SecurityConfig {
  4.  
  5. }
 

 以下的配置在SecurityConfig内完成。

3.1.1. 注册SecurityFilterChain Bean，并完成HttpSecurity配置

在HttpSecurity中注意使用了lambda写法，使用这种写法之后，每个设置都直接返回HttpSecurity对象，避免了多余的and()操作符。每一步具体的含义，请参考代码上的注释。

 
  1. @Bean
  2. public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
  3. http
  4. // 禁用basic明文验证
  5. .httpBasic().disable()
  6. // 前后端分离架构不需要csrf保护
  7. .csrf().disable()
  8. // 禁用默认登录页
  9. .formLogin().disable()
  10. // 禁用默认登出页
  11. .logout().disable()
  12. // 设置异常的EntryPoint，如果不设置，默认使用Http403ForbiddenEntryPoint
  13. .exceptionHandling(exceptions -> exceptions.authenticationEntryPoint(invalidAuthenticationEntryPoint))
  14. // 前后端分离是无状态的，不需要session了，直接禁用。
  15. .sessionManagement(session -> session.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
  16. .authorizeHttpRequests(authorizeHttpRequests -> authorizeHttpRequests
  17. // 允许所有OPTIONS请求
  18. .requestMatchers(HttpMethod.OPTIONS, "/**").permitAll()
  19. // 允许直接访问授权登录接口
  20. .requestMatchers(HttpMethod.POST, "/web/authenticate").permitAll()
  21. // 允许 SpringMVC 的默认错误地址匿名访问
  22. .requestMatchers("/error").permitAll()
  23. // 其他所有接口必须有Authority信息，Authority在登录成功后的UserDetailsImpl对象中默认设置“ROLE_USER”
  24. //.requestMatchers("/**").hasAnyAuthority("ROLE_USER")
  25. // 允许任意请求被已登录用户访问，不检查Authority
  26. .anyRequest().authenticated())
  27. .authenticationProvider(authenticationProvider())
  28. // 加我们自定义的过滤器，替代UsernamePasswordAuthenticationFilter
  29. .addFilterBefore(authenticationJwtTokenFilter(), UsernamePasswordAuthenticationFilter.class);
  30.  
  31. return http.build();
  32. }
 

3.1.2. 注册自定义用户登录信息查询Bean

 
  1. @Autowired
  2. private UserDetailsService userDetailsService;
  3.  
  4. @Bean
  5. public UserDetailsService userDetailsService() {
  6. // 调用 JwtUserDetailService实例执行实际校验
  7. return username -> userDetailsService.loadUserByUsername(username);
  8. }
 

 这里关联到一个自定义的子类UserDetailsService，代码逻辑如下，注意需要根据实际情况改造数据库查询逻辑：

 
  1. @Component
  2. public class SecurityUserDetailsService implements UserDetailsService {
  3.  
  4. @Autowired
  5. private SqlSession sqlSession;
  6.  
  7. @Override
  8. public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
  9. try {
  10. // 查询数据库用户表，获得用户信息
  11. sqlSession.xxx
  12. // 使用获得的信息创建SecurityUserDetails
  13. SecurityUserDetails user = new SecurityUserDetails(username,
  14. password,
  15. // 以及其他org.springframework.security.core.userdetails.UserDetails接口要求的信息
  16. );
  17.  
  18. logger.info("用户信息：{}", user);
  19. return user;
  20. } catch (Exception e) {
  21. String msg = "Username: " + username + " not found";
  22. logger.error(msg, e);
  23. throw new UsernameNotFoundException(msg);
  24. }
  25. }
  26. }
 

3.1.3. 注册密码加密Bean

 
  1. @Bean
  2. public PasswordEncoder passwordEncoder() {
  3. return new BCryptPasswordEncoder();
  4. }
 

3.1.4. 注册用户授权检查执行Bean 

这里设定使用DaoAuthenticationProvider执行具体的校验检查，并且将自定义的用户登录查询服务Bean，和密码生成器都注入到该对象中

 
  1. /**
  2. * 调用loadUserByUsername获得UserDetail信息，在AbstractUserDetailsAuthenticationProvider里执行用户状态检查
  3. *
  4. * @return
  5. */
  6. @Bean
  7. public AuthenticationProvider authenticationProvider() {
  8. DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
  9. // DaoAuthenticationProvider 从自定义的 userDetailsService.loadUserByUsername 方法获取UserDetails
  10. authProvider.setUserDetailsService(userDetailsService());
  11. // 设置密码编辑器
  12. authProvider.setPasswordEncoder(passwordEncoder());
  13. return authProvider;
  14. }
 

3.1.5. 注册授权检查管理Bean 

 
  1. /**
  2. * 登录时需要调用AuthenticationManager.authenticate执行一次校验
  3. *
  4. * @param config
  5. * @return
  6. * @throws Exception
  7. */
  8. @Bean
  9. public AuthenticationManager authenticationManager(AuthenticationConfiguration config) throws Exception {
  10. return config.getAuthenticationManager();
  11. }
 

3.1.6. 注册每次请求的jwt检查拦截器

在拦截器中检查jwt是否能够通过签名验证，是否还在有效期内。如果通过验证，使用jwt中的信息生成一个不含密码信息的SecurityUserDetails对象，并设置到SecurityContext中，确保后续的过滤器检查能够知晓本次请求是被授权过的。具体代码逻辑看3.2. jwt请求过滤器。

 
  1. @Bean
  2. public JwtTokenOncePerRequestFilter authenticationJwtTokenFilter() {
  3. return new JwtTokenOncePerRequestFilter();
  4. }
 

3.1.7.  SecurityConfig 对象完整内容

 
  1. @Configuration
  2. @EnableWebSecurity
  3. public class SecurityConfig {
  4.  
  5. @Autowired
  6. private UserDetailsService userDetailsService;
  7.  
  8. @Autowired
  9. private InvalidAuthenticationEntryPoint invalidAuthenticationEntryPoint;
  10.  
  11. @Bean
  12. public PasswordEncoder passwordEncoder() {
  13. return new BCryptPasswordEncoder();
  14. }
  15.  
  16. @Bean
  17. public JwtTokenOncePerRequestFilter authenticationJwtTokenFilter() {
  18. return new JwtTokenOncePerRequestFilter();
  19. }
  20.  
  21. @Bean
  22. public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
  23. http
  24. // 禁用basic明文验证
  25. .httpBasic().disable()
  26. // 前后端分离架构不需要csrf保护
  27. .csrf().disable()
  28. // 禁用默认登录页
  29. .formLogin().disable()
  30. // 禁用默认登出页
  31. .logout().disable()
  32. // 设置异常的EntryPoint，如果不设置，默认使用Http403ForbiddenEntryPoint
  33. .exceptionHandling(exceptions -> exceptions.authenticationEntryPoint(invalidAuthenticationEntryPoint))
  34. // 前后端分离是无状态的，不需要session了，直接禁用。
  35. .sessionManagement(session -> session.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
  36. .authorizeHttpRequests(authorizeHttpRequests -> authorizeHttpRequests
  37. // 允许所有OPTIONS请求
  38. .requestMatchers(HttpMethod.OPTIONS, "/**").permitAll()
  39. // 允许直接访问授权登录接口
  40. .requestMatchers(HttpMethod.POST, "/web/authenticate").permitAll()
  41. // 允许 SpringMVC 的默认错误地址匿名访问
  42. .requestMatchers("/error").permitAll()
  43. // 其他所有接口必须有Authority信息，Authority在登录成功后的UserDetailsImpl对象中默认设置“ROLE_USER”
  44. //.requestMatchers("/**").hasAnyAuthority("ROLE_USER")
  45. // 允许任意请求被已登录用户访问，不检查Authority
  46. .anyRequest().authenticated())
  47. .authenticationProvider(authenticationProvider())
  48. // 加我们自定义的过滤器，替代UsernamePasswordAuthenticationFilter
  49. .addFilterBefore(authenticationJwtTokenFilter(), UsernamePasswordAuthenticationFilter.class);
  50.  
  51. return http.build();
  52. }
  53.  
  54. @Bean
  55. public UserDetailsService userDetailsService() {
  56. // 调用 JwtUserDetailService实例执行实际校验
  57. return username -> userDetailsService.loadUserByUsername(username);
  58. }
  59.  
  60. /**
  61. * 调用loadUserByUsername获得UserDetail信息，在AbstractUserDetailsAuthenticationProvider里执行用户状态检查
  62. *
  63. * @return
  64. */
  65. @Bean
  66. public AuthenticationProvider authenticationProvider() {
  67. DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
  68. // DaoAuthenticationProvider 从自定义的 userDetailsService.loadUserByUsername 方法获取UserDetails
  69. authProvider.setUserDetailsService(userDetailsService());
  70. // 设置密码编辑器
  71. authProvider.setPasswordEncoder(passwordEncoder());
  72. return authProvider;
  73. }
  74.  
  75. /**
  76. * 登录时需要调用AuthenticationManager.authenticate执行一次校验
  77. *
  78. * @param config
  79. * @return
  80. * @throws Exception
  81. */
  82. @Bean
  83. public AuthenticationManager authenticationManager(AuthenticationConfiguration config) throws Exception {
  84. return config.getAuthenticationManager();
  85. }
  86. }
 

3.2. JWT请求过滤检查

 
  1. /**
  2. * 每次请求的 Security 过滤类。执行jwt有效性检查，如果失败，不会设置 SecurityContextHolder 信息，会进入 AuthenticationEntryPoint
  3. */
  4. public class JwtTokenOncePerRequestFilter extends OncePerRequestFilter {
  5.  
  6. @Autowired
  7. private JwtTokenProvider jwtTokenProvider;
  8.  
  9. @Override
  10. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
  11. throws ServletException, IOException {
  12. try {
  13. String token = jwtTokenProvider.resolveToken(request);
  14. if (token != null && jwtTokenProvider.validateToken(token)) {
  15. Authentication auth = jwtTokenProvider.getAuthentication(token);
  16.  
  17. if (auth != null) {
  18. SecurityContextHolder.getContext().setAuthentication(auth);
  19. }
  20. }
  21. } catch (Exception e) {
  22. logger.error("Cannot set user authentication!", e);
  23. }
  24.  
  25. filterChain.doFilter(request, response);
  26. }
  27.  
  28. }
 

3.3. 登录校验

 考虑到jwt签名验签的可靠性，以及jwt的有效载荷并未被加密，所以jwt中放置了UserDetails接口除密码字段外其他所有字段以及项目所需的业务字段。两个目的，1. 浏览器端可以解码jwt的有效载荷部分的内容用于业务处理，由于不涉及到敏感信息，不担心泄密；2.服务端可以通过jwt的信息重新生成UserDetails对象，并设置到SecurityContext中，用于请求拦截的授权校验。

代码如下：

 
  1. @RestController
  2. @RequestMapping("/web")
  3. public class AuthController {
  4.  
  5. @PostMapping(value="/authenticate")
  6. public ResponseEntity<?> authenticate(@RequestBody Map<String, String> param) {
  7. logger.debug("登录请求参数：{}", param);
  8.  
  9. try {
  10. String username = param.get("username");
  11. String password = param.get("password");
  12. String reqType = param.get("type");
  13.  
  14. // 传递用户密码给到SpringSecurity执行校验，如果校验失败，会进入BadCredentialsException
  15. Authentication authentication = authenticationManager.authenticate(new UsernamePasswordAuthenticationToken(username, password));
  16. // 验证通过，设置授权信息至SecurityContextHolder
  17. SecurityContextHolder.getContext().setAuthentication(authentication);
  18.  
  19. // 如果验证通过了，从返回的authentication里获得完整的UserDetails信息
  20. SecurityUserDetails userDetails = (SecurityUserDetails) authentication.getPrincipal();
  21.  
  22. // 将用户的ID、名称等信息保存在jwt的token中
  23. String token = jwtTokenProvider.createToken(userDetails.getUsername(), userDetails.getCustname(), new ArrayList<>());
  24.  
  25. // 设置cookie，本项目中非必需，因以要求必须传head的Authorization: Bearer 参数
  26. ResponseCookie jwtCookie = jwtTokenProvider.generateJwtCookie(token);
  27. Map<String, Object> model = new HashMap<>();
  28. model.put("username", username);
  29. model.put("token", token);
  30. return ok().body(RespBody.build().ok("登录成功", model));
  31. } catch (BadCredentialsException e) {
  32. return ok(RespBody.build().fail("账号或密码错误！"));
  33. }
  34. }
  35. }
 

4. 总结 

经过以上步骤，对SpringSecurity6结合jwt机制进行校验的过程就全部完成了，jwt的工具类可以按照项目自己的情况进行编码。这里（GitHub - markvivv/springboot-security-jwt-example: Spring Boot + Spring Security + JSON Web Token(JWT) + Mybatis完整示例，包含SpringBoot2和Spring Boot3两种方式。）有完整的SpringBoot3+SpringSecurity6+jwt的示例工程。目前有一个SpringBoot2的老版本在这里。jwt的工具类也可以参考老版本的这个。

Spring Security 6 配置方法，废弃 WebSecurityConfigurerAdapter_websecurityconfigureradapter作废-CSDN博客

posted @ 2025-01-24 10:28  CharyGao  阅读(662)  评论(0)    收藏  举报