当前位置:   article > 正文

Spring Security_2024 最新springsecurity 搭建

2024 最新springsecurity 搭建

0.简介
        

1. 介绍
springsecurity是安全框架,准确来说是安全管理框架。相比与另外一个安全框架Shiro,springsecurity提供了更丰富的功能,社区资源也比Shiro丰富
springsecurity框架用于Web应用的需要进行认证和授权
认证:验证当前访问系统的是不是本系统的用户,并且要确认具体是哪个用户
授权:经过认证后判断当前用户是否有权限进行某个操作。认证和授权也是SpringSecurity作为安全框架的核心功能
认证和授权也是SpringSecurity作为安全框架的核心功能

该笔记对标的视频是 BV1mm4y1X7Hc,拿着这个BV号在b站搜,就能搜到课程视频
 

1.快速入门


        第一步 修改pom.xml文件为如下

  1. <parent>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-parent</artifactId>
  4. <version>2.5.0</version>
  5. </parent>
  6. <dependencies>
  7. <dependency>
  8. <groupId>org.springframework.boot</groupId>
  9. <artifactId>spring-boot-starter-web</artifactId>
  10. </dependency>
  11. <dependency>
  12. <groupId>org.projectlombok</groupId>
  13. <artifactId>lombok</artifactId>
  14. <optional>true</optional>
  15. </dependency>
  16. </dependencies>

第二步: 在idea修改maven的相关设置,然后刷新maven
        

第三步: 在 src/main/java 目录新建 com.huanf.SpringsecurityDome01Application类,作为项目的引导类,也叫启动类。在SpringsecurityDome01Application类写入如下

  1. package com.huanf;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication
  5. public class SpringsecurityDome01Application {
  6. public static void main(String[] args) {
  7. SpringApplication.run(SpringsecurityDome01Application.class, args);
  8. }
  9. }

第四步: 在 src/main/java/com.huanf 目录新建controller.HelloController类,写入如下

  1. package com.huanf.controller;
  2. import org.springframework.stereotype.Controller;
  3. import org.springframework.web.bind.annotation.RequestMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  5. /**
  6. * @Author:豆浆
  7. * @name :HelloController
  8. * @Date:2024/4/16 11:15
  9. */
  10. @RestController
  11. public class HelloController {
  12. @RequestMapping("/hello")
  13. public String hello(){
  14. return "hello";
  15. }
  16. }

第五步: 运行SpringsecurityDome01Application引导类,然后浏览器访问如下,测试SpringBoot工程有没有搭建成功

http://localhost:8080/hello

2. Boot整合Security


第一步: 在pom.xml添加如下

  1. <!--SpringSecurity启动器-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-security</artifactId>
  5. </dependency>


引入依赖后我们在尝试去访问之前的接口就会自动跳转到一个SpringSecurity的默认登录页面,默认用户名是user,密码会输出在控制台。必须登录之后才能对接口进行访问
第二步: 重新运行SpringsecurityDome01Application引导类,浏览器访问如下


访问时会自动被下面的链接拦截
第三步: 在idea控制台查看登录的密码,用户名是user


登录之后,就会自动跳到并访问下面的地址
第四步: 默认的退出登录接口如下


3.认证


springsecurity的权限管理,是先授权后认证,所以我们先学习认证这一部分
流程图如下,注意下图的jwt指的是 json web token,jwt是登录校验的时候用的技术,可以根据指定的算法进行信息的加密和解密


1. spring security原理


Spring Security的原理其实就是一个过滤器链,内部包含了提供各种功能的过滤器。例如快速入门案例里面使用到的三种过滤器,如下图
监听器 -> 过滤器链 -> dispatcherservlet(前置拦截器 -> mapperHandle -> 后置拦截器 -> 最终拦截器)


一、UsernamePasswordAuthenticationFilter: 负责处理我们在登陆页面填写了用户名密码后的登陆请求。入门案例的认证工作主要有它负责
二、ExceptionTranslationFilter:处理过滤器链中抛出的任何AccessDeniedException和AuthenticationException
三、FilterSecurityInterceptor:负责权限校验的过滤器


注意上图,橙色部分表示认证,黄色部分表示异常处理,红色部分表示授权
如何查看security提供的过滤器有哪几个,或者叫哪几种,如下


2. 认证流程


我们来详细学一下上面 '1. springsecurity原理' 的橙色部分,也就是认证那部分的知识
一、Authentication接口: 它的实现类,表示当前访问系统的用户,封装了用户相关信息
二、AuthenticationManager接口:定义了认证Authentication的方法
三、UserDetailsService接口:加载用户特定数据的核心接口。里面定义了一个根据用户名查询用户信息的方法
四、UserDetails接口:提供核心用户信息。通过UserDetailsService根据用户名获取处理的用户信息要封装成UserDetails对象返回。然后将这些信息封装到Authentication对象中

 


3. 自定义security的思路


        在 '快速入门' 中,我们在Boot项目里面引入了Security依赖,实现了当我们访问某个业务接口时,会被Security的login接口拦截,但是如果我们不想使用Security默认的登录页面,那么怎么办呢,还有,springsecurity的校验,我们希望是根据数据库来做校验,那么怎么实现呢。我们需要实现如下
【登录-未实现】
①、自定义登录接口。用于调用ProviderManager的方法进行认证 如果认证通过生成jwt,然后把用户信息存入redis中
②、自定义UserDetailsService接口的实现类。在这个实现类中去查询数据库
【校验-未实现】
①、定义Jwt认证过滤器。用于获取token,然后解析token获取其中的userid,还需要从redis中获取用户信息,然后存入SecurityContextHolder


4. 自定义security的搭建


注意: 这次搭建的项目,会在下面所有的笔记中都学习,不管是 '认证' 还是 '授权',反正下面谈到什么目录、什么类,说的都是这个项目
第四步: 打开idea,新建maven项目


第五步: 修改pom.xml文件为如下

  1. <parent>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-parent</artifactId>
  4. <version>2.5.0</version>
  5. </parent>
  6. <dependencies>
  7. <!--还要引入这个,不然后面javax.servlet依赖找不到-->
  8. <dependency>
  9. <groupId>org.springframework.boot</groupId>
  10. <artifactId>spring-boot-starter-web</artifactId>
  11. </dependency>
  12. <!--springboot整合springsecurity-->
  13. <dependency>
  14. <groupId>org.springframework.boot</groupId>
  15. <artifactId>spring-boot-starter-security</artifactId>
  16. </dependency>
  17. <!--redis依赖-->
  18. <dependency>
  19. <groupId>org.springframework.boot</groupId>
  20. <artifactId>spring-boot-starter-data-redis</artifactId>
  21. </dependency>
  22. <!--fastjson依赖-->
  23. <dependency>
  24. <groupId>com.alibaba</groupId>
  25. <artifactId>fastjson</artifactId>
  26. <version>1.2.33</version>
  27. </dependency>
  28. <!--jwt依赖-->
  29. <dependency>
  30. <groupId>io.jsonwebtoken</groupId>
  31. <artifactId>jjwt</artifactId>
  32. <version>0.9.0</version>
  33. </dependency>
  34. <!--引入Lombok依赖,方便实体类开发-->
  35. <dependency>
  36. <groupId>org.projectlombok</groupId>
  37. <artifactId>lombok</artifactId>
  38. </dependency>
  39. </dependencies>


第七步: 在 src/main/java 目录新建 com.huanf.TokenApplication 类,写入如下

  1. package com.sangeng;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. /**
  5. * @Author:豆浆
  6. * @name :TokenApplication
  7. * @Date:2024/4/16 12:12
  8. */
  9. @SpringBootApplication
  10. public class TokenApplication {
  11. public static void main(String[] args) {
  12. SpringApplication.run(TokenApplication.class,args);
  13. }
  14. }


第八步: 在 src/main/java/com.huanf 目录新建 controller.HelloController 类,写入如下

  1. package com.sangeng.controller;
  2. import org.springframework.web.bind.annotation.RequestMapping;
  3. import org.springframework.web.bind.annotation.RestController;
  4. /**
  5. * @Author:豆浆
  6. * @name :HelloController
  7. * @Date:2024/4/16 12:13
  8. */
  9. @RestController
  10. public class HelloController {
  11. @RequestMapping("/hello")
  12. public String hello(){
  13. return "hello";
  14. }
  15. }


5. 自定义security的代码


第一步: 在 src/main/java/com.huanf 目录新建 utils.FastJsonRedisSerializer 类,写入如下

  1. package com.huanf.utils;
  2. import com.alibaba.fastjson.JSON;
  3. import com.alibaba.fastjson.serializer.SerializerFeature;
  4. import com.fasterxml.jackson.databind.JavaType;
  5. import com.fasterxml.jackson.databind.ObjectMapper;
  6. import com.fasterxml.jackson.databind.type.TypeFactory;
  7. import org.springframework.data.redis.serializer.RedisSerializer;
  8. import org.springframework.data.redis.serializer.SerializationException;
  9. import com.alibaba.fastjson.parser.ParserConfig;
  10. import org.springframework.util.Assert;
  11. import java.nio.charset.Charset;
  12. //Redis使用FastJson序列化
  13. public class FastJsonRedisSerializer<T> implements RedisSerializer<T> {
  14. public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
  15. private Class<T> clazz;
  16. static
  17. {
  18. ParserConfig.getGlobalInstance().setAutoTypeSupport(true);
  19. }
  20. public FastJsonRedisSerializer(Class<T> clazz)
  21. {
  22. super();
  23. this.clazz = clazz;
  24. }
  25. @Override
  26. public byte[] serialize(T t) throws SerializationException
  27. {
  28. if (t == null)
  29. {
  30. return new byte[0];
  31. }
  32. return JSON.toJSONString(t, SerializerFeature.WriteClassName).getBytes(DEFAULT_CHARSET);
  33. }
  34. @Override
  35. public T deserialize(byte[] bytes) throws SerializationException
  36. {
  37. if (bytes == null || bytes.length <= 0)
  38. {
  39. return null;
  40. }
  41. String str = new String(bytes, DEFAULT_CHARSET);
  42. return JSON.parseObject(str, clazz);
  43. }
  44. protected JavaType getJavaType(Class<?> clazz)
  45. {
  46. return TypeFactory.defaultInstance().constructType(clazz);
  47. }
  48. }


第二步: 在 src/main/java/com.huanf 目录新建 config.RedisConfig 类,写入如下

  1. package com.sangeng.config;
  2. import com.sangeng.utils.FastJsonRedisSerializer;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.data.redis.connection.RedisConnectionFactory;
  6. import org.springframework.data.redis.core.RedisTemplate;
  7. import org.springframework.data.redis.serializer.StringRedisSerializer;
  8. @Configuration
  9. public class RedisConfig {
  10. @Bean
  11. @SuppressWarnings(value = { "unchecked", "rawtypes" })
  12. public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
  13. RedisTemplate<Object, Object> template = new RedisTemplate<>();
  14. template.setConnectionFactory(connectionFactory);
  15. FastJsonRedisSerializer serializer = new FastJsonRedisSerializer(Object.class);
  16. // 使用StringRedisSerializer来序列化和反序列化redis的key
  17. template.setKeySerializer(new StringRedisSerializer());
  18. template.setValueSerializer(serializer);
  19. // Hash的key也采用StringRedisSerializer的序列化方式
  20. template.setHashKeySerializer(new StringRedisSerializer());
  21. template.setHashValueSerializer(serializer);
  22. template.afterPropertiesSet();
  23. return template;
  24. }
  25. }


第三步: 在 src/main/java/com.huanf 目录新建 domain.ResponseResult 类,写入如下

  1. package com.sangeng.domain;
  2. import com.fasterxml.jackson.annotation.JsonInclude;
  3. //响应类
  4. @JsonInclude(JsonInclude.Include.NON_NULL)
  5. public class ResponseResult<T> {
  6. /**
  7. * 状态码
  8. */
  9. private Integer code;
  10. /**
  11. * 提示信息,如果有错误时,前端可以获取该字段进行提示
  12. */
  13. private String msg;
  14. /**
  15. * 查询到的结果数据,
  16. */
  17. private T data;
  18. public ResponseResult(Integer code, String msg) {
  19. this.code = code;
  20. this.msg = msg;
  21. }
  22. public ResponseResult(Integer code, T data) {
  23. this.code = code;
  24. this.data = data;
  25. }
  26. public Integer getCode() {
  27. return code;
  28. }
  29. public void setCode(Integer code) {
  30. this.code = code;
  31. }
  32. public String getMsg() {
  33. return msg;
  34. }
  35. public void setMsg(String msg) {
  36. this.msg = msg;
  37. }
  38. public T getData() {
  39. return data;
  40. }
  41. public void setData(T data) {
  42. this.data = data;
  43. }
  44. public ResponseResult(Integer code, String msg, T data) {
  45. this.code = code;
  46. this.msg = msg;
  47. this.data = data;
  48. }
  49. }


第四步: 在 utile 目录新建 JwtUtil 类,写入如下

  1. package com.sangeng.utils;
  2. import io.jsonwebtoken.Claims;
  3. import io.jsonwebtoken.JwtBuilder;
  4. import io.jsonwebtoken.Jwts;
  5. import io.jsonwebtoken.SignatureAlgorithm;
  6. import javax.crypto.SecretKey;
  7. import javax.crypto.spec.SecretKeySpec;
  8. import java.util.Base64;
  9. import java.util.Date;
  10. import java.util.UUID;
  11. //JWT工具类
  12. public class JwtUtil {
  13. //有效期为
  14. public static final Long JWT_TTL = 60 * 60 *1000L;// 60 * 60 *1000 一个小时
  15. //设置秘钥明文, 注意长度必须大于等于6
  16. public static final String JWT_KEY = "huanfqc";
  17. public static String getUUID(){
  18. String token = UUID.randomUUID().toString().replaceAll("-", "");
  19. return token;
  20. }
  21. /**
  22. * 生成jtw
  23. * @param subject token中要存放的数据(json格式)
  24. * @return
  25. */
  26. public static String createJWT(String subject) {
  27. JwtBuilder builder = getJwtBuilder(subject, null, getUUID());// 设置过期时间
  28. return builder.compact();
  29. }
  30. /**
  31. * 生成jtw
  32. * @param subject token中要存放的数据(json格式)
  33. * @param ttlMillis token超时时间
  34. * @return
  35. */
  36. public static String createJWT(String subject, Long ttlMillis) {
  37. JwtBuilder builder = getJwtBuilder(subject, ttlMillis, getUUID());// 设置过期时间
  38. return builder.compact();
  39. }
  40. private static JwtBuilder getJwtBuilder(String subject, Long ttlMillis, String uuid) {
  41. SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
  42. SecretKey secretKey = generalKey();
  43. long nowMillis = System.currentTimeMillis();
  44. Date now = new Date(nowMillis);
  45. if(ttlMillis==null){
  46. ttlMillis=JwtUtil.JWT_TTL;
  47. }
  48. long expMillis = nowMillis + ttlMillis;
  49. Date expDate = new Date(expMillis);
  50. return Jwts.builder()
  51. .setId(uuid) //唯一的ID
  52. .setSubject(subject) // 主题 可以是JSON数据
  53. .setIssuer("huanf") // 签发者
  54. .setIssuedAt(now) // 签发时间
  55. .signWith(signatureAlgorithm, secretKey) //使用HS256对称加密算法签名, 第二个参数为秘钥
  56. .setExpiration(expDate);
  57. }
  58. /**
  59. * 创建token
  60. * @param id
  61. * @param subject
  62. * @param ttlMillis
  63. * @return
  64. */
  65. public static String createJWT(String id, String subject, Long ttlMillis) {
  66. JwtBuilder builder = getJwtBuilder(subject, ttlMillis, id);// 设置过期时间
  67. return builder.compact();
  68. }
  69. public static void main(String[] args) throws Exception {
  70. String token = "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJjYWM2ZDVhZi1mNjVlLTQ0MDAtYjcxMi0zYWEwOGIyOTIwYjQiLCJzdWIiOiJzZyIsImlzcyI6InNnIiwiaWF0IjoxNjM4MTA2NzEyLCJleHAiOjE2MzgxMTAzMTJ9.JVsSbkP94wuczb4QryQbAke3ysBDIL5ou8fWsbt_ebg";
  71. Claims claims = parseJWT(token);
  72. System.out.println(claims);
  73. }
  74. /**
  75. * 生成加密后的秘钥 secretKey
  76. * @return
  77. */
  78. public static SecretKey generalKey() {
  79. byte[] encodedKey = Base64.getDecoder().decode(JwtUtil.JWT_KEY);
  80. SecretKey key = new SecretKeySpec(encodedKey, 0, encodedKey.length, "AES");
  81. return key;
  82. }
  83. /**
  84. * 解析
  85. *
  86. * @param jwt
  87. * @return
  88. * @throws Exception
  89. */
  90. public static Claims parseJWT(String jwt) throws Exception {
  91. SecretKey secretKey = generalKey();
  92. return Jwts.parser()
  93. .setSigningKey(secretKey)
  94. .parseClaimsJws(jwt)
  95. .getBody();
  96. }
  97. }


第五步: 在 utile 目录新建 RedisCache 类,写入如下

  1. package com.sangeng.utils;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.data.redis.core.BoundSetOperations;
  4. import org.springframework.data.redis.core.HashOperations;
  5. import org.springframework.data.redis.core.RedisTemplate;
  6. import org.springframework.data.redis.core.ValueOperations;
  7. import org.springframework.stereotype.Component;
  8. import java.util.*;
  9. import java.util.concurrent.TimeUnit;
  10. @SuppressWarnings(value = { "unchecked", "rawtypes" })
  11. @Component
  12. //redis工具类
  13. public class RedisCache {
  14. @Autowired
  15. public RedisTemplate redisTemplate;
  16. /**
  17. * 缓存基本的对象,Integer、String、实体类等
  18. *
  19. * @param key 缓存的键值
  20. * @param value 缓存的值
  21. */
  22. public <T> void setCacheObject(final String key, final T value)
  23. {
  24. redisTemplate.opsForValue().set(key, value);
  25. }
  26. /**
  27. * 缓存基本的对象,Integer、String、实体类等
  28. *
  29. * @param key 缓存的键值
  30. * @param value 缓存的值
  31. * @param timeout 时间
  32. * @param timeUnit 时间颗粒度
  33. */
  34. public <T> void setCacheObject(final String key, final T value, final Integer timeout, final TimeUnit timeUnit)
  35. {
  36. redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
  37. }
  38. /**
  39. * 设置有效时间
  40. *
  41. * @param key Redis键
  42. * @param timeout 超时时间
  43. * @return true=设置成功;false=设置失败
  44. */
  45. public boolean expire(final String key, final long timeout)
  46. {
  47. return expire(key, timeout, TimeUnit.SECONDS);
  48. }
  49. /**
  50. * 设置有效时间
  51. *
  52. * @param key Redis键
  53. * @param timeout 超时时间
  54. * @param unit 时间单位
  55. * @return true=设置成功;false=设置失败
  56. */
  57. public boolean expire(final String key, final long timeout, final TimeUnit unit)
  58. {
  59. return redisTemplate.expire(key, timeout, unit);
  60. }
  61. /**
  62. * 获得缓存的基本对象。
  63. *
  64. * @param key 缓存键值
  65. * @return 缓存键值对应的数据
  66. */
  67. public <T> T getCacheObject(final String key)
  68. {
  69. ValueOperations<String, T> operation = redisTemplate.opsForValue();
  70. return operation.get(key);
  71. }
  72. /**
  73. * 删除单个对象
  74. *
  75. * @param key
  76. */
  77. public boolean deleteObject(final String key)
  78. {
  79. return redisTemplate.delete(key);
  80. }
  81. /**
  82. * 删除集合对象
  83. *
  84. * @param collection 多个对象
  85. * @return
  86. */
  87. public long deleteObject(final Collection collection)
  88. {
  89. return redisTemplate.delete(collection);
  90. }
  91. /**
  92. * 缓存List数据
  93. *
  94. * @param key 缓存的键值
  95. * @param dataList 待缓存的List数据
  96. * @return 缓存的对象
  97. */
  98. public <T> long setCacheList(final String key, final List<T> dataList)
  99. {
  100. Long count = redisTemplate.opsForList().rightPushAll(key, dataList);
  101. return count == null ? 0 : count;
  102. }
  103. /**
  104. * 获得缓存的list对象
  105. *
  106. * @param key 缓存的键值
  107. * @return 缓存键值对应的数据
  108. */
  109. public <T> List<T> getCacheList(final String key)
  110. {
  111. return redisTemplate.opsForList().range(key, 0, -1);
  112. }
  113. /**
  114. * 缓存Set
  115. *
  116. * @param key 缓存键值
  117. * @param dataSet 缓存的数据
  118. * @return 缓存数据的对象
  119. */
  120. public <T> BoundSetOperations<String, T> setCacheSet(final String key, final Set<T> dataSet)
  121. {
  122. BoundSetOperations<String, T> setOperation = redisTemplate.boundSetOps(key);
  123. Iterator<T> it = dataSet.iterator();
  124. while (it.hasNext())
  125. {
  126. setOperation.add(it.next());
  127. }
  128. return setOperation;
  129. }
  130. /**
  131. * 获得缓存的set
  132. *
  133. * @param key
  134. * @return
  135. */
  136. public <T> Set<T> getCacheSet(final String key)
  137. {
  138. return redisTemplate.opsForSet().members(key);
  139. }
  140. /**
  141. * 缓存Map
  142. *
  143. * @param key
  144. * @param dataMap
  145. */
  146. public <T> void setCacheMap(final String key, final Map<String, T> dataMap)
  147. {
  148. if (dataMap != null) {
  149. redisTemplate.opsForHash().putAll(key, dataMap);
  150. }
  151. }
  152. /**
  153. * 获得缓存的Map
  154. *
  155. * @param key
  156. * @return
  157. */
  158. public <T> Map<String, T> getCacheMap(final String key)
  159. {
  160. return redisTemplate.opsForHash().entries(key);
  161. }
  162. /**
  163. * 往Hash中存入数据
  164. *
  165. * @param key Redis键
  166. * @param hKey Hash键
  167. * @param value 值
  168. */
  169. public <T> void setCacheMapValue(final String key, final String hKey, final T value)
  170. {
  171. redisTemplate.opsForHash().put(key, hKey, value);
  172. }
  173. /**
  174. * 获取Hash中的数据
  175. *
  176. * @param key Redis键
  177. * @param hKey Hash键
  178. * @return Hash中的对象
  179. */
  180. public <T> T getCacheMapValue(final String key, final String hKey)
  181. {
  182. HashOperations<String, String, T> opsForHash = redisTemplate.opsForHash();
  183. return opsForHash.get(key, hKey);
  184. }
  185. /**
  186. * 删除Hash中的数据
  187. *
  188. * @param key
  189. * @param hkey
  190. */
  191. public void delCacheMapValue(final String key, final String hkey)
  192. {
  193. HashOperations hashOperations = redisTemplate.opsForHash();
  194. hashOperations.delete(key, hkey);
  195. }
  196. /**
  197. * 获取多个Hash中的数据
  198. *
  199. * @param key Redis键
  200. * @param hKeys Hash键集合
  201. * @return Hash对象集合
  202. */
  203. public <T> List<T> getMultiCacheMapValue(final String key, final Collection<Object> hKeys)
  204. {
  205. return redisTemplate.opsForHash().multiGet(key, hKeys);
  206. }
  207. /**
  208. * 获得缓存的基本对象列表
  209. *
  210. * @param pattern 字符串前缀
  211. * @return 对象列表
  212. */
  213. public Collection<String> keys(final String pattern)
  214. {
  215. return redisTemplate.keys(pattern);
  216. }
  217. }


第六步: 在 utile 目录新建 WebUtils 类,写入如下

  1. package com.sangeng.utils;
  2. import javax.servlet.http.HttpServletResponse;
  3. import java.io.IOException;
  4. public class WebUtils {
  5. /**
  6. * 将字符串渲染到客户端
  7. *
  8. * @param response 渲染对象
  9. * @param string 待渲染的字符串
  10. * @return null
  11. */
  12. public static String renderString(HttpServletResponse response, String string) {
  13. try
  14. {
  15. response.setStatus(200);
  16. response.setContentType("application/json");
  17. response.setCharacterEncoding("utf-8");
  18. response.getWriter().print(string);
  19. }
  20. catch (IOException e)
  21. {
  22. e.printStackTrace();
  23. }
  24. return null;
  25. }
  26. }


第七步: 在 domain目录新建 User类,写入如下

  1. package com.sangeng.domain;
  2. import com.baomidou.mybatisplus.annotation.TableId;
  3. import com.baomidou.mybatisplus.annotation.TableName;
  4. import lombok.AllArgsConstructor;
  5. import lombok.Data;
  6. import lombok.NoArgsConstructor;
  7. import java.io.Serializable;
  8. import java.util.Date;
  9. //用户表(User)实体类
  10. @Data
  11. @AllArgsConstructor
  12. @NoArgsConstructor
  13. @TableName("sys_user")
  14. public class User implements Serializable {
  15. private static final long serialVersionUID = -40356785423868312L;
  16. /**
  17. * 主键
  18. */
  19. @TableId
  20. private Long id;
  21. /**
  22. * 用户名
  23. */
  24. private String userName;
  25. /**
  26. * 昵称
  27. */
  28. private String nickName;
  29. /**
  30. * 密码
  31. */
  32. private String password;
  33. /**
  34. * 账号状态(0正常 1停用)
  35. */
  36. private String status;
  37. /**
  38. * 邮箱
  39. */
  40. private String email;
  41. /**
  42. * 手机号
  43. */
  44. private String phonenumber;
  45. /**
  46. * 用户性别(0男,1女,2未知)
  47. */
  48. private String sex;
  49. /**
  50. * 头像
  51. */
  52. private String avatar;
  53. /**
  54. * 用户类型(0管理员,1普通用户)
  55. */
  56. private String userType;
  57. /**
  58. * 创建人的用户id
  59. */
  60. private Long createBy;
  61. /**
  62. * 创建时间
  63. */
  64. private Date createTime;
  65. /**
  66. * 更新人
  67. */
  68. private Long updateBy;
  69. /**
  70. * 更新时间
  71. */
  72. private Date updateTime;
  73. /**
  74. * 删除标志(0代表未删除,1代表已删除)
  75. */
  76. private Integer delFlag;
  77. }

上面的代码总体如下图所示


6. 自定义security的数据库

第一步: 数据库校验用户。从之前的分析我们可以知道,我们自定义了一个UserDetailsService,让SpringSecurity使用我们的UserDetailsService。我们自己的UserDetailsService可以从数据库中查询用户名和密码。我们先创建一个用户表, 建表语句如下:
注意: 要想让用户的密码是明文存储,需要在密码前加{noop},作用是例如等下在浏览器登陆的时候就可以用huanf作为用户名,112233作为密码来登陆了

  1. create database if not exists huanf_security;
  2. use huanf_security;
  3. CREATE TABLE `sys_user` (
  4. `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  5. `user_name` VARCHAR(64) NOT NULL DEFAULT 'NULL' COMMENT '用户名',
  6. `nick_name` VARCHAR(64) NOT NULL DEFAULT 'NULL' COMMENT '昵称',
  7. `password` VARCHAR(64) NOT NULL DEFAULT 'NULL' COMMENT '密码',
  8. `status` CHAR(1) DEFAULT '0' COMMENT '账号状态(0正常 1停用)',
  9. `email` VARCHAR(64) DEFAULT NULL COMMENT '邮箱',
  10. `phonenumber` VARCHAR(32) DEFAULT NULL COMMENT '手机号',
  11. `sex` CHAR(1) DEFAULT NULL COMMENT '用户性别(0男,1女,2未知)',
  12. `avatar` VARCHAR(128) DEFAULT NULL COMMENT '头像',
  13. `user_type` CHAR(1) NOT NULL DEFAULT '1' COMMENT '用户类型(0管理员,1普通用户)',
  14. `create_by` BIGINT(20) DEFAULT NULL COMMENT '创建人的用户id',
  15. `create_time` DATETIME DEFAULT NULL COMMENT '创建时间',
  16. `update_by` BIGINT(20) DEFAULT NULL COMMENT '更新人',
  17. `update_time` DATETIME DEFAULT NULL COMMENT '更新时间',
  18. `del_flag` INT(11) DEFAULT '0' COMMENT '删除标志(0代表未删除,1代表已删除)',
  19. PRIMARY KEY (`id`)
  20. ) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COMMENT='用户表';
  21. insert into sys_user values (1,'admin','管理员','{noop}123456','0',DEFAULT,DEFAULT,DEFAULT,DEFAULT,'0',DEFAULT,DEFAULT,DEFAULT,DEFAULT,DEFAULT);
  22. insert into sys_user values (2,'huanf','豆浆','{noop}112233','0',DEFAULT,DEFAULT,DEFAULT,DEFAULT,'1',DEFAULT,DEFAULT,DEFAULT,DEFAULT,DEFAULT);


第二步: 在pom.xml添加如下

  1. <!--引入MybatisPuls依赖-->
  2. <dependency>
  3. <groupId>com.baomidou</groupId>
  4. <artifactId>mybatis-plus-boot-starter</artifactId>
  5. <version>3.4.3</version>
  6. </dependency>
  7. <!--引入mysql驱动的依赖-->
  8. <dependency>
  9. <groupId>mysql</groupId>
  10. <artifactId>mysql-connector-java</artifactId>
  11. </dependency>


第三步: 在 src/main/resources 目录新建File,文件名为application.yml,写入如下

  1. spring:
  2. datasource:
  3. url: jdbc:mysql://localhost:3306/huanf_security?characterEncoding=utf-8&serverTimezone=UTC
  4. username: root
  5. password: 228675
  6. driver-class-name: com.mysql.cj.jdbc.Driver


第四步: 在 src/main/java/com.huanf 目录新建 mapper.UserMapper 接口,写入如下

  1. package com.huanf.mapper;
  2. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  3. import com.huanf.domain.User;
  4. @Service
  5. public interface UserMapper extends BaseMapper<User> {
  6. }


第五步: 在TokenApplication引导类添加如下

@MapperScan("com.huanf.mapper")


第六步: 在pom.xml添加如下

  1. <!--引入Junit,用于测试-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-test</artifactId>
  5. </dependency>


第七步: 在 src/test/java 目录新建 com.huanf.MapperTest类,写入如下。作用是测试mybatis-plus是否正常

  1. package com.sangeng;
  2. import com.sangeng.domain.User;
  3. import com.sangeng.mapper.UserMapper;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.boot.test.context.SpringBootTest;
  7. import java.util.List;
  8. /**
  9. * @Author:豆浆
  10. * @name :MapperTest
  11. * @Date:2024/4/23 15:59
  12. */
  13. @SpringBootTest
  14. public class MapperTest {
  15. @Autowired
  16. private UserMapper userMapper;
  17. @Test
  18. public void testUserMapper(){
  19. //查询所有用户
  20. List<User> users = userMapper.selectList(null);
  21. System.out.println(users);
  22. }
  23. }

第八步: 运行MapperTest类的testUserMapper方法,看是否能查到数据库的所有用户。到此,可以确定数据库是没问题的,环境到此就准备好了


7. 自定义security的认证实现


上面我们已经把准备工作做好了,包括搭建、代码、数据库。接下来我们会实现让security在认证的时候,根据我们数据库的用户和密码进行认证,也就是被security拦截业务接口,出现登录页面之后,我们需要通过输入数据库里的用户和密码来登录,而不是使用security默认的用户和密码进行登录
思路: 只需要新建一个实现类,在这个实现类里面实现Security官方的UserDetailsService接口,然后重写里面的loadUserByUsername方法
注意: 重写好loadUserByUsername方法之后,我们需要把拿到 '数据库与用户输入的数据' 进行比对的结果,也就是user对象这个结果封装成能被 'Security官方的UserDetailsService接口' 接收的类型,例如可以封装成我们下面写的LoginUser类型。然后才能伪装好数据,给Security官方的认证机制去对比user对象与数据库的结果是否匹配。Security官方的认证机制会拿LoginUser类的方法数据(数据库拿,不再用默认的),跟我们封装过去的user对象进行匹配,要使匹配一致,就证明认证通过,也就是用户在浏览器页面输入的用户名和密码能被Security认证通过,就不再拦截该用户去访问我们的业务接口
第一步: 在domain目录新建LoginUser类,作为UserDetails接口(Security官方提供的接口)的实现类

  1. package com.huanf.domain;
  2. import lombok.AllArgsConstructor;
  3. import lombok.Data;
  4. import lombok.NoArgsConstructor;
  5. import org.springframework.security.core.GrantedAuthority;
  6. import org.springframework.security.core.userdetails.UserDetails;
  7. import java.util.Collection;
  8. @Data //get和set方法
  9. @NoArgsConstructor //无参构造
  10. @AllArgsConstructor //带参构造
  11. //实现UserDetails接口之后,要重写UserDetails接口里面的7个方法
  12. public class LoginUser implements UserDetails {
  13. private User xxuser;
  14. @Override
  15. //用于返回权限信息。现在我们正在学'认证','权限'后面才学。所以返回null即可
  16. public Collection<? extends GrantedAuthority> getAuthorities() {
  17. return null;
  18. }
  19. @Override
  20. //用于获取用户密码。由于使用的实体类是User,所以获取的是数据库的用户密码
  21. public String getPassword() {
  22. return xxuser.getPassword();
  23. }
  24. @Override
  25. //用于获取用户名。由于使用的实体类是User,所以获取的是数据库的用户名
  26. public String getUsername() {
  27. return xxuser.getUserName();
  28. }
  29. @Override
  30. //判断登录状态是否过期。把这个改成true,表示永不过期
  31. public boolean isAccountNonExpired() {
  32. return true;
  33. }
  34. @Override
  35. //判断账号是否被锁定。把这个改成true,表示未锁定,不然登录的时候,不让你登录
  36. public boolean isAccountNonLocked() {
  37. return true;
  38. }
  39. @Override
  40. //判断登录凭证是否过期。把这个改成true,表示永不过期
  41. public boolean isCredentialsNonExpired() {
  42. return true;
  43. }
  44. @Override
  45. //判断用户是否可用。把这个改成true,表示可用状态
  46. public boolean isEnabled() {
  47. return true;
  48. }
  49. }


第二步: 在 src/main/java/com.huanf 目录新建 service.impl.MyUserDetailServiceImpl 类,写入如下

  1. package com.huanf.service.impl;
  2. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  3. import com.huanf.domain.LoginUser;
  4. import com.huanf.domain.User;
  5. import com.huanf.mapper.UserMapper;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.security.core.userdetails.UserDetails;
  8. import org.springframework.security.core.userdetails.UserDetailsService;
  9. import org.springframework.security.core.userdetails.UsernameNotFoundException;
  10. import org.springframework.stereotype.Service;
  11. import java.util.Objects;
  12. @Service
  13. public class MyUserDetailServiceImpl implements UserDetailsService {
  14. @Autowired
  15. private UserMapper userMapper;
  16. @Override
  17. //UserDetails是Security官方提供的接口
  18. public UserDetails loadUserByUsername(String xxusername) throws UsernameNotFoundException {
  19. //查询用户信息。我们写的userMapper接口里面是空的,所以调用的是mybatis-plus提供的方法
  20. LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
  21. //eq方法表示等值匹配,第一个参数是数据库的用户名,第二个参数是我们传进来的用户名,这两个参数进行比较是否相等
  22. queryWrapper.eq(User::getUserName,xxusername);
  23. User user = userMapper.selectOne(queryWrapper);
  24. //如果用户传进来的用户名,但是数据库没有这个用户名,就会导致我们是查不到的情况,那么就进行下面的判断。避免程序安全问题
  25. if(Objects.isNull(user)){//判断user对象是否为空。当在数据库没有查到数据时,user就会为空,也就会进入这个判断
  26. throw new RuntimeException("用户名或者密码错误");
  27. }
  28. //把查询到的user结果,封装成UserDetails类型,然后返回。
  29. //但是由于UserDetails是个接口,所以我们先需要在domino目录新建LoginUser类,作为UserDetails的实现类,再写下面那行
  30. return new LoginUser(user);
  31. }
  32. }

第三步: 测试。运行TokenApplication引导类,浏览器输入如下,然后我们输入一下登录的用户名和密码,看是不是根据数据库来进行认证

http://localhost:8080/hello


8. 密码加密校验问题

上面我们实现了自定义Security的认证机制,让Security根据数据库的数据,来认证用户输入的数据是否正确。但是当时存在一个问题,就是我们在数据库存入用户表的时候,插入的huanf用户的密码是 {noop}112233,为什么用112233不行呢
原因: SpringSecurity默认使用的PasswordEncoder要求数据库中的密码格式为:{加密方式}密码。对应的就是{noop}112233,实际表示的是112233
但是我们在数据库直接暴露112233为密码,会造成安全问题,所以我们需要把加密后的1234的密文当作密码,此时用户在浏览器登录时输入1234,我们如何确保用户能够登录进去呢,答案是SpringSecurity默认的密码校验,替换为SpringSecurity为我们提供的BCryptPasswordEncoder
我们只需要使用把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验。我们可以定义一个SpringSecurity的配置类,SpringSecurity要求这个配置类要继承WebSecurityConfigurerAdapter。
【首先是 '加密',如何实现,如下】
第一步: 在config目录新建 SecurityConfig 类,写入如下。作用是根据原文,生成一个密文

  1. package com.sangeng.config;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  5. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  6. import org.springframework.security.crypto.password.PasswordEncoder;
  7. /**
  8. * @Author:豆浆
  9. * @name :SecurityConfig
  10. * @Date:2024/4/23 16:50
  11. */
  12. @Configuration
  13. //实现Security提供的WebSecurityConfigurerAdapter类,就可以改变密码校验的规则了
  14. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  15. @Bean
  16. //把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验
  17. //注意也可以注入PasswordEncoder,效果是一样的,因为PasswordEncoder是BCry..的父类
  18. public PasswordEncoder passwordEncoder(){
  19. return new BCryptPasswordEncoder();
  20. }
  21. }

第二步: 测试。在MapperTest类,添加如下,然后运行 xxTestBCryptPasswordEncoder 方法

  1. @Test
  2. public void xxTestBCryptPasswordEncoder(){
  3. //如果不想在下面那行new的话,那么就在该类注入PasswordEncoder,例如如下
  4. /**
  5. * @Autowired
  6. * private PasswordEncoder passwordEncoder;
  7. */
  8. BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
  9. //模拟用户输入的密码
  10. String encode1 = passwordEncoder.encode("1234");
  11. //再模拟一次用户输入的密码
  12. String encode2 = passwordEncoder.encode("1234");
  13. //虽然这两次的密码都是一样的,但是加密后是不一样的。每次运行,对同一原文都会有不同的加密结果
  14. //原因:会添加随机的盐,加密结果=+原文+加密。达到每次加密后的密文都不相同的效果
  15. System.out.println(encode1);
  16. System.out.println(encode2);
  17. }


【然后是 '校验',如何实现,如下】
第一步(已做可跳过): 在config目录新建 SecurityConfig 类,写入如下。作用是根据原文,生成一个密文

  1. package com.sangeng.config;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  5. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  6. import org.springframework.security.crypto.password.PasswordEncoder;
  7. /**
  8. * @Author:豆浆
  9. * @name :SecurityConfig
  10. * @Date:2024/4/23 16:50
  11. */
  12. @Configuration
  13. //实现Security提供的WebSecurityConfigurerAdapter类,就可以改变密码校验的规则了
  14. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  15. @Bean
  16. //把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验
  17. //注意也可以注入PasswordEncoder,效果是一样的,因为PasswordEncoder是BCry..的父类
  18. public PasswordEncoder passwordEncoder(){
  19. return new BCryptPasswordEncoder();
  20. }
  21. }

第二步: 测试。在MapperTest类,添加如下,然后运行 yyTestBCryptPasswordEncoder 方法

  1. @Test
  2. public void yyTestBCryptPasswordEncoder(){
  3. BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
  4. //模拟用户输入了1234(第一个参数),然后我们去跟数据库的密文进行比较(第二个参数)
  5. boolean result = passwordEncoder.matches("1234", "$2a$10$zOitKu6UNk.b/iPFTtIj2u80sH/dfJI9vFr57qhDGteuXj/Wl8uSy");
  6. //看一下比对结果
  7. System.out.println(result);
  8. }

9. jwt工具类实现加密校验


刚刚我们在测试类学习了密码的加密和校验,我们下面会先学如何使用jwt工具类实现密码的加密解密
首先是在pom.xml添加如下(已做可跳过)

  1. <!--jwt依赖-->
  2. <dependency>
  3. <groupId>io.jsonwebtoken</groupId>
  4. <artifactId>jjwt</artifactId>
  5. <version>0.9.0</version>
  6. </dependency>

然后我们在上面的 '认证' 的 '5. 自定义security的代码' 已经创建了大量的类,写了大量的代码,但是还没有使用到,例如jwt的工具类,我们在utils目录创建的JwtUtil类还没有使用过,下面就来使用。如下
【加密】
第一步: 把JwtUtil类的main方法修改为如下,作用是使用createJWT方法生成指定字符串的密文J

  1. public static void main(String[] args) throws Exception {
  2. //加密指定字符串,xxjwt是123456加密后的密文
  3. String xxjwt = createJWT("123456");
  4. System.out.println(xxjwt);
  5. }

第二步: 运行JwtUtil类的main方法


【校验】
第一步: 把JwtUtil类的main方法修改为如下,作用是使用createJWT方法生成指定字符串的密文

  1. public static void main(String[] args) throws Exception {
  2. Claims xxclaims = parseJWT("eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIyYWMxODhlZjJmMDE0YTU5YjU1YzM4MWNmMjMzNjA1MiIsInN1YiI6IjEyMzQ1NiIsImlzcyI6InNnIiwiaWF0IjoxNjg5MTMwMTE3LCJleHAiOjE2ODkxMzM3MTd9.RxI0dlCrDhYspi4VoIlblk7J9tvOO8Sd5p8bbFrd0mg");
  3. //把上面那行的密文解密(校验)为原文
  4. String yysubject = xxclaims.getSubject();
  5. //输出解密后的原文
  6. System.out.println(yysubject);
  7. }

第二步: 运行JwtUtil类的main方法


10. 登录接口的分析

在上面学习的 '认证' 的 '3. 自定义security的思路' 当中,我们有一个功能需求是自定义登录接口,这个功能还没有实现,我们需要实现这个功能,但是,实现这个功能需要使用到jwt,我们刚刚也学习了使用jwt来实现加密校验,那么下面就正式学习如何实现这个登录接口,首先是分析,如下

①我们需要自定义登陆接口,也就是在controller目录新建LoginController类,在controller方法里面去调用service接口,在service接口实现AuthenticationManager去进行用户的认证,注意,我们定义的controller方法要让SpringSecurity对这个接口放行(如果不放行的话,会被SpringSecurity拦截),让用户访问这个接口的时候不用登录也能访问。
②在service接口中我们通过AuthenticationManager的authenticate方法来进行用户认证,所以需要在SecurityConfig中配置把AuthenticationManager注入容器
③认证成功的话要生成一个jwt,放入响应中返回。并且为了让用户下回请求时能通过jwt识别出具体的是哪个用户,我们需要把用户信息存入redis,可以把用户id作为key。


11. redis下载安装启动


Redis是一款key-value存储结构的内存级NoSQL数据库,也就是运行在内存上的数据库
●支持多种数据存储格式
●支持持久化
●支持集群
Redis下载(windows版-Redis-x64-5.0.14.msi)

https://github.com/tporadowski/redis/releases

为方便学习,可拿我在用的redis,如下网盘有软件包

安装完成之后,打开安装目录

 


redis的服务端启动命令

redis-server.exe redis.windows.conf


redis的客户端启动命令

redis-cli.exe


具体启动步骤如下。注意: 如果你的redis启动后控制台没蜂窝图案,那么请认真按照下面第二张图的步骤,数字表示命令的先后顺序


12. 登录接口的实现


第一步: 修改数据库的huanf用户的密码,把112233明文修改为对应的密文。密文可以用jwt工具类加密112233看一下,或者直接复制我给出的

UPDATE sys_user SET password = '$2a$10$YPnG.IYUk0mMechaxSibBuKmNeTzvuHdcxkqvoxizsll6WCQG9CHG' WHERE id = 2;


第二步: 在 SecurityConfig 类添加如下

  1. @Bean
  2. @Override
  3. public AuthenticationManager authenticationManagerBean() throws Exception {
  4. return super.authenticationManagerBean();
  5. }
  6. @Override
  7. protected void configure(HttpSecurity http) throws Exception {
  8. http
  9. //由于是前后端分离项目,所以要关闭csrf
  10. .csrf().disable()
  11. //由于是前后端分离项目,所以session是失效的,我们就不通过Session获取SecurityContext
  12. .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
  13. .and()
  14. //指定让spring security放行登录接口的规则
  15. .authorizeRequests()
  16. // 对于登录接口 anonymous表示允许匿名访问
  17. .antMatchers("/user/login").anonymous()
  18. // 除上面外的所有请求全部需要鉴权认证
  19. .anyRequest().authenticated();
  20. }


第三步: 在service目录新建 LoginService 接口,写入如下

  1. package com.huanf.service;
  2. import com.huanf.domain.ResponseResult;
  3. import com.huanf.domain.User;
  4. import org.springframework.stereotype.Service;
  5. @Service
  6. public interface LoginService {
  7. ResponseResult login(User user);
  8. }


第四步: 在service目录新建 impl.LoginServiceImpl 类,写入如下

  1. package com.huanf.service.impl;
  2. import com.huanf.domain.LoginUser;
  3. import com.huanf.domain.ResponseResult;
  4. import com.huanf.domain.User;
  5. import com.huanf.service.LoginService;
  6. import com.huanf.utils.JwtUtil;
  7. import com.huanf.utils.RedisCache;
  8. import org.springframework.beans.factory.annotation.Autowired;
  9. import org.springframework.security.authentication.AuthenticationManager;
  10. import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
  11. import org.springframework.security.core.Authentication;
  12. import org.springframework.stereotype.Service;
  13. import java.util.HashMap;
  14. import java.util.Map;
  15. import java.util.Objects;
  16. @Service
  17. //写登录的核心代码
  18. public class LoginServiceImpl implements LoginService {
  19. @Autowired
  20. //先在SecurityConfig,使用@Bean注解重写官方的authenticationManagerBean类,然后这里才能注入成功
  21. private AuthenticationManager authenticationManager;
  22. @Autowired
  23. //RedisCache是我们在utils目录写好的类
  24. private RedisCache redisCache;
  25. @Override
  26. //ResponseResult和user是我们在domain目录写好的类
  27. public ResponseResult login(User user) {
  28. //用户在登录页面输入的用户名和密码
  29. UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(user.getUserName(),user.getPassword());
  30. //获取AuthenticationManager的authenticate方法来进行用户认证
  31. Authentication authenticate = authenticationManager.authenticate(authenticationToken);
  32. //判断上面那行的authenticate是否为null,如果是则认证没通过,就抛出异常
  33. if(Objects.isNull(authenticate)){
  34. throw new RuntimeException("登录失败");
  35. }
  36. //如果认证通过,就使用userid生成一个jwt,然后把jwt存入ResponseResult后返回
  37. LoginUser loginUser = (LoginUser) authenticate.getPrincipal();
  38. String userid = loginUser.getXxuser().getId().toString();
  39. String jwt = JwtUtil.createJWT(userid);
  40. //把完整的用户信息存入redis,其中userid作为key,注意存入redis的时候加了前缀 login:
  41. Map<String, String> map = new HashMap<>();
  42. map.put("token",jwt);
  43. redisCache.setCacheObject("login:"+userid,loginUser);
  44. return new ResponseResult(200,"登录成功",map);
  45. }
  46. }


第五步: 在controller目录新建 LoginController 类,写入如下

  1. package com.huanf.controller;
  2. import com.huanf.domain.ResponseResult;
  3. import com.huanf.domain.User;
  4. import com.huanf.service.LoginService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.PostMapping;
  7. import org.springframework.web.bind.annotation.RequestBody;
  8. import org.springframework.web.bind.annotation.RestController;
  9. @RestController
  10. public class LoginController {
  11. @Autowired
  12. //LoginService是我们在service目录写好的接口
  13. private LoginService loginService;
  14. @PostMapping("/user/login")
  15. //ResponseResult和user是我们在domain目录写好的类
  16. public ResponseResult xxlogin(@RequestBody User user){
  17. //登录
  18. return loginService.login(user);
  19. }
  20. }


第六步: 在application.yml添加如下,作用是添加redis的连接信息

  1. redis:
  2. host: 127.0.0.1
  3. port: 6379


第七步: 本地打开你的redis

  1. d:
  2. cd /redis
  3. redis-server.exe redis.windows.conf


第八步: 运行TokenApplication引导类
第九步: 测试。打开你的postman,发送下面的POST请求

localhost:8080/user/login


注意还要带上如下JSON类型的Body数据

  1. {
  2. "userName":"huanf",
  3. "password":"112233"
  4. }


13. 认证过滤器


在上面学习的 '认证' 的 '3. 自定义security的思路' 当中,我们有一个功能需求是定义Jwt认证过滤器,这个功能还没有实现,下面就正式学习如何实现这个功能。要实现Jwt认证过滤器,我们需要获取token,然后解析token获取其中的userid,还需要从redis中获取用户信息,然后存入SecurityContextHolder
为什么要有redis参与: 是为了防止过了很久之后,浏览器没有关闭,拿着token也能访问,这样不安全
认证过滤器的作用是什么: 上面我们实现登录接口的时,当某个用户登录之后,该用户就会有一个token值,我们可以通过认证过滤器,由于有token值,并且token值认证通过,也就是证明是这个用户的token值,那么该用户访问我们的业务接口时,就不会被Security拦截。简单理解作用就是登录过的用户可以访问我们的业务接口,拿到对应的资源


第一步: 定义过滤器。在 src/main/java/com.huanf 目录新建 filter.JwtAuthenticationTokenFilter 类,写入如下

  1. package com.huanf.filter;
  2. import com.huanf.domain.LoginUser;
  3. import com.huanf.utils.JwtUtil;
  4. import com.huanf.utils.RedisCache;
  5. import io.jsonwebtoken.Claims;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
  8. import org.springframework.security.core.context.SecurityContextHolder;
  9. import org.springframework.stereotype.Component;
  10. import org.springframework.util.StringUtils;
  11. import org.springframework.web.filter.OncePerRequestFilter;
  12. import javax.servlet.FilterChain;
  13. import javax.servlet.ServletException;
  14. import javax.servlet.http.HttpServletRequest;
  15. import javax.servlet.http.HttpServletResponse;
  16. import java.io.IOException;
  17. import java.util.Objects;
  18. @Component
  19. public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
  20. @Autowired
  21. private RedisCache redisCache;
  22. @Override
  23. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
  24. //获取token,指定你要获取的请求头叫什么
  25. String xxtoken = request.getHeader("token");
  26. //判空,不一定所有的请求都有请求头,所以上面那行的xxtoken可能为空
  27. //!StringUtils.hasText()方法用于检查给定的字符串是否为空或仅包含空格字符
  28. if (!StringUtils.hasText(xxtoken)) {
  29. //如果请求没有携带token,那么就不需要解析token,不需要获取用户信息,直接放行就可以
  30. filterChain.doFilter(request, response);
  31. //return之后,就不会走下面那些代码
  32. return;
  33. }
  34. //解析token
  35. String userid; //把userid定义在外面,才能同时用于下面的46行和52行
  36. try {
  37. Claims claims = JwtUtil.parseJWT(xxtoken);
  38. userid = claims.getSubject();
  39. } catch (Exception e) {
  40. e.printStackTrace();
  41. throw new RuntimeException("token非法");
  42. }
  43. //从redis中获取用户信息
  44. String redisKey = "login:" + userid;
  45. //LoginUser是我们在domain目录写的实体类
  46. LoginUser loginUser = redisCache.getCacheObject(redisKey);
  47. //判断获取到的用户信息是否为空,因为redis里面可能并不存在这个用户信息,例如缓存过期了
  48. if(Objects.isNull(loginUser)){
  49. //抛出一个异常
  50. throw new RuntimeException("用户未登录");
  51. }
  52. //把最终的LoginUser用户信息,通过setAuthentication方法,存入SecurityContextHolder
  53. //TODO 获取权限信息封装到Authentication中
  54. UsernamePasswordAuthenticationToken authenticationToken =
  55. //第一个参数是LoginUser用户信息,第二个参数是凭证(null),第三个参数是权限信息(null)
  56. new UsernamePasswordAuthenticationToken(loginUser,null,null);
  57. SecurityContextHolder.getContext().setAuthentication(authenticationToken);
  58. //全部做完之后,就放行
  59. filterChain.doFilter(request, response);
  60. }
  61. }


第二步: 修改SecurityConfig类为如下,其实也就是在configure方法加了一点代码、并且注入了JwtAuthenticationTokenFilter类

  1. package com.huanf.config;
  2. import com.huanf.filter.JwtAuthenticationTokenFilter;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.security.authentication.AuthenticationManager;
  7. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  8. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  9. import org.springframework.security.config.http.SessionCreationPolicy;
  10. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  11. import org.springframework.security.crypto.password.PasswordEncoder;
  12. import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
  13. @Configuration
  14. //实现Security提供的WebSecurityConfigurerAdapter类,就可以改变密码校验的规则了
  15. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  16. @Bean
  17. //把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验
  18. //注意也可以注入PasswordEncoder,效果是一样的,因为PasswordEncoder是BCry..的父类
  19. public PasswordEncoder passwordEncoder(){
  20. return new BCryptPasswordEncoder();
  21. }
  22. //---------------------------认证过滤器的实现----------------------------------
  23. @Autowired
  24. //注入我们在filter目录写好的类
  25. private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
  26. //---------------------------登录接口的实现----------------------------------
  27. @Bean
  28. @Override
  29. public AuthenticationManager authenticationManagerBean() throws Exception {
  30. return super.authenticationManagerBean();
  31. }
  32. @Override
  33. protected void configure(HttpSecurity http) throws Exception {
  34. http
  35. //由于是前后端分离项目,所以要关闭csrf
  36. .csrf().disable()
  37. //由于是前后端分离项目,所以session是失效的,我们就不通过Session获取SecurityContext
  38. .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
  39. .and()
  40. //指定让spring security放行登录接口的规则
  41. .authorizeRequests()
  42. // 对于登录接口 anonymous表示允许匿名访问
  43. .antMatchers("/user/login").anonymous()
  44. // 除上面外的所有请求全部需要鉴权认证
  45. .anyRequest().authenticated();
  46. //---------------------------认证过滤器的实现----------------------------------
  47. //把token校验过滤器添加到过滤器链中
  48. //第一个参数是上面注入的我们在filter目录写好的类,第二个参数表示你想添加到哪个过滤器之前
  49. http.addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class);
  50. }
  51. }


第三步: 本地打开你的redis

redis-server.exe redis.windows.conf


第四步: 运行TokenApplication引导类
第五步: 测试。打开你的postman,发送如下的POST请求,作用是先登录一个用户,这样就能生成这个用户对应的token值

localhost:8080/user/login


注意还要带上如下JSON类型的Body数据

  1. {
  2. "userName":"huanf",
  3. "password":"112233"
  4. }


第六步: 测试。继续在你的postman,发送如下GET请求,作用是拿着刚刚的token值,去访问我们的业务接口,看会不会被Security拦截,如果不会拦截,那么就说明认证过滤器生效了,使用场景就是简单理解就是登录过的用户可以访问我们的业务接口,拿到对应的资源


注意,由于token值我们是存在redis,所以是有默认过期时间的。注意在请求头那里,key要写token,value要写你复制的token值,然后点击发送请求。这个token值实际上就是使用jwt工具类把112233密码加密后的密文,不信你翻一下前面笔记看当时112233的密文,长得是不是跟现在的token值格式一样


14. 退出登录


上面我们既测试了登录认证,又实现了基于密文的token认证,到此就完整地实现了我们在 '认证' 的 '3. 自定义security的思路' 里面的【登录】和【校验】的功能
那么,我们怎么退出登录呢,也就是让某个用户的登录状态消失,也就是让token失效 ?
实现起来也比较简单,只需要定义一个登陆接口,然后获取SecurityContextHolder中的认证信息,删除redis中对应的数据即可
注意: 我们的token其实就是用户密码的密文,token是存在redis里面
第一步: 把LoginService接口修改为如下,注意只是稍微增加了一点代码,我用虚线隔开了,增加的代码是在虚线的下方

  1. package com.huanf.service;
  2. import com.huanf.domain.ResponseResult;
  3. import com.huanf.domain.User;
  4. import org.springframework.stereotype.Service;
  5. @Service
  6. public interface LoginService {
  7. ResponseResult login(User user);
  8. //-----------------------------------退出登录--------------------------------
  9. ResponseResult yylogout();
  10. }


第二步: 把LoginServiceImpl实现类修改为如下,注意只是稍微增加了一点代码,我用虚线隔开了,增加的代码是在虚线的下方

  1. package com.huanf.service.impl;
  2. import com.huanf.domain.LoginUser;
  3. import com.huanf.domain.ResponseResult;
  4. import com.huanf.domain.User;
  5. import com.huanf.service.LoginService;
  6. import com.huanf.utils.JwtUtil;
  7. import com.huanf.utils.RedisCache;
  8. import org.springframework.beans.factory.annotation.Autowired;
  9. import org.springframework.security.authentication.AuthenticationManager;
  10. import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
  11. import org.springframework.security.core.Authentication;
  12. import org.springframework.security.core.context.SecurityContextHolder;
  13. import org.springframework.stereotype.Service;
  14. import java.util.HashMap;
  15. import java.util.Map;
  16. import java.util.Objects;
  17. @Service
  18. //写登录的核心代码
  19. public class LoginServiceImpl implements LoginService {
  20. @Autowired
  21. //先在SecurityConfig,使用@Bean注解重写官方的authenticationManagerBean类,然后这里才能注入成功
  22. private AuthenticationManager authenticationManager;
  23. @Autowired
  24. //RedisCache是我们在utils目录写好的类
  25. private RedisCache redisCache;
  26. @Override
  27. //ResponseResult和user是我们在domain目录写好的类
  28. public ResponseResult login(User user) {
  29. //用户在登录页面输入的用户名和密码
  30. UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(user.getUserName(),user.getPassword());
  31. //获取AuthenticationManager的authenticate方法来进行用户认证
  32. Authentication authenticate = authenticationManager.authenticate(authenticationToken);
  33. //判断上面那行的authenticate是否为null,如果是则认证没通过,就抛出异常
  34. if(Objects.isNull(authenticate)){
  35. throw new RuntimeException("登录失败");
  36. }
  37. //如果认证通过,就使用userid生成一个jwt,然后把jwt存入ResponseResult后返回
  38. LoginUser loginUser = (LoginUser) authenticate.getPrincipal();
  39. String userid = loginUser.getXxuser().getId().toString();
  40. String jwt = JwtUtil.createJWT(userid);
  41. //把完整的用户信息存入redis,其中userid作为key,注意存入redis的时候加了前缀 login:
  42. Map<String, String> map = new HashMap<>();
  43. map.put("token",jwt);
  44. redisCache.setCacheObject("login:"+userid,loginUser);
  45. return new ResponseResult(200,"登录成功",map);
  46. }
  47. //-----------------------------------退出登录的具体代码--------------------------------
  48. @Override
  49. public ResponseResult yylogout() {
  50. //获取我们在JwtAuthenticationTokenFilter类写的SecurityContextHolder对象中的用户id
  51. UsernamePasswordAuthenticationToken authentication = (UsernamePasswordAuthenticationToken) SecurityContextHolder.getContext().getAuthentication();
  52. //loginUser是我们在domain目录写好的实体类
  53. LoginUser loginUser = (LoginUser) authentication.getPrincipal();
  54. //获取用户id
  55. Long userid = loginUser.getXxuser().getId();
  56. //根据用户id,删除redis中的token值,注意我们的key是被 login: 拼接过的,所以下面写完整key的时候要带上 longin:
  57. redisCache.deleteObject("login:"+userid);
  58. return new ResponseResult(200,"注销成功");
  59. }
  60. }


第三步: 把LoginController类修改为如下,注意只是稍微增加了一点代码,我用虚线隔开了,增加的代码是在虚线的下方

  1. package com.huanf.controller;
  2. import com.huanf.domain.ResponseResult;
  3. import com.huanf.domain.User;
  4. import com.huanf.service.LoginService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.PostMapping;
  7. import org.springframework.web.bind.annotation.RequestBody;
  8. import org.springframework.web.bind.annotation.RequestMapping;
  9. import org.springframework.web.bind.annotation.RestController;
  10. @RestController
  11. public class LoginController {
  12. @Autowired
  13. //LoginService是我们在service目录写好的接口
  14. private LoginService loginService;
  15. @PostMapping("/user/login")
  16. //ResponseResult和user是我们在domain目录写好的类
  17. public ResponseResult xxlogin(@RequestBody User user){
  18. //登录
  19. return loginService.login(user);
  20. }
  21. //-----------------------------------退出登录--------------------------------
  22. @RequestMapping("/user/logout")
  23. //ResponseResult是我们在domain目录写好的实体类
  24. public ResponseResult xxlogout(){
  25. return loginService.yylogout();
  26. }
  27. }


第四步: 本地打开你的redis

redis-server.exe redis.windows.conf


第五步: 运行TokenApplication引导类
第六步: 测试。打开你的postman,发送如下的POST请求,作用是先登录一个用户,这样就能生成这个用户对应的token值

localhost:8080/user/login


注意还要带上如下JSON类型的Body数据

  1. {
  2. "userName":"huanf",
  3. "password":"112233"
  4. }


第七步: 测试。继续在你的postman,发送如下GET请求,作用是拿着刚刚的token值,去访问我们的业务接口,看在有登录状态的情况下,能不能访问

http://localhost:8080/hello


注意还要带上你刚刚复制的token值,粘贴到消息头的Value输入框


第八步: 测试。继续在你的postman,发送如下GET请求,作用是退出登录,然后去访问我们的业务接口,看在没有登录状态的情况下,能不能访问

 这个用户对应的token值

localhost:8080/user/logout

注意还要带上你刚刚复制的token值,粘贴到消息头的Value输入框

授权


1. 权限系统的作用


为什么要设计权限系统 ?
        例如要设计一个图书管理系统,普通学生账号的权限不能使用书籍编辑、删除的功能,普通学生能使用的功能仅仅是浏览页面,但是,如果是图书管理员用户,那么就能使用所有权限。简单理解就是我们需要不同的用户使用不同的功能,这就是权限系统要实现的效果
        虽然前端也可以去判断用户的权限来选择是否显示某些功能的页面或组件,但是不安全,因为如果有人知道了对应功能的接口地址就可以不通过前端,直接去发送请求来实现相关功能操作,所以我们还需要在后端进行用户权限的判断,判断当前用户是否有相应的权限,必须具有所需权限才能进行相应的操作


前端防君子,后端防小人


2. 授权的基本流程


        在SpringSecurity中,会使用默认的FilterSecurityInterceptor来进行权限校验。在FilterSecurityInterceptor中会从SecurityContextHolder获取其中的Authentication,然后获取其中的权限信息。当前用户是否拥有访问当前资源所需的权限


        所以我们在项目中只需要把当前登录用户的权限信息也存入Authentication,然后设置我们的资源所需要的权限即可


3. 自定义访问路径的权限


SpringSecurity为我们提供了基于注解的权限控制方案,这也是我们项目中主要采用的方式。我们可以使用注解去指定访问对应的资源所需的权限
第一步: 在SecurityConfig配置类添加如下,作用是开启相关配置

@EnableGlobalMethodSecurity(prePostEnabled = true)


第二步: 开启了相关配置之后,就能使用@PreAuthorize等注解了。在HelloController类的hello方法,添加如下注解,其中test表示自定义权限的名字

@PreAuthorize("hasAuthority('test')")


4. 带权限访问的实现


权限信息: 有特殊含义的字符串
我们前面在登录时,会调用到MyUserDetailServiceImpl类的loadUserByUsername方法,当时我们写loadUserByUsername方法时,只写了查询用户数据信息的代码,还差查询用户权限信息的代码。在登录完之后,因为携带了token,所以需要在JwtAuthenticationTokenFilter类添加 '获取权限信息封装到Authentication中' 的代码,添加到UsernamePasswordAuthenticationToken的第三个参数里面,我们当时第三个参数传的是null。
第一步: 在上面的'3. 自定义访问路径的权限',我们给HelloController类的 /hello 路径添加了权限限制,只有用户具有叫test的权限,才能访问这个路径


第二步: 把MyUserDetailServiceImpl类修改为如下,主要是增加了查询用户权限信息的代码,我会把增加的代码用红框框起来

  1. package com.huanf.service.impl;
  2. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  3. import com.huanf.domain.LoginUser;
  4. import com.huanf.domain.User;
  5. import com.huanf.mapper.UserMapper;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.security.core.userdetails.UserDetails;
  8. import org.springframework.security.core.userdetails.UserDetailsService;
  9. import org.springframework.security.core.userdetails.UsernameNotFoundException;
  10. import org.springframework.stereotype.Service;
  11. import java.util.ArrayList;
  12. import java.util.Arrays;
  13. import java.util.List;
  14. import java.util.Objects;
  15. @Service
  16. public class MyUserDetailServiceImpl implements UserDetailsService {
  17. @Autowired
  18. private UserMapper userMapper;
  19. @Override
  20. //UserDetails是Security官方提供的接口
  21. public UserDetails loadUserByUsername(String xxusername) throws UsernameNotFoundException {
  22. //查询用户信息。我们写的userMapper接口里面是空的,所以调用的是mybatis-plus提供的方法
  23. LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
  24. //eq方法表示等值匹配,第一个参数是数据库的用户名,第二个参数是我们传进来的用户名,这两个参数进行比较是否相等
  25. queryWrapper.eq(User::getUserName,xxusername);
  26. User user = userMapper.selectOne(queryWrapper);
  27. //如果用户传进来的用户名,但是数据库没有这个用户名,就会导致我们是查不到的情况,那么就进行下面的判断。避免程序安全问题
  28. if(Objects.isNull(user)){//判断user对象是否为空。当在数据库没有查到数据时,user就会为空,也就会进入这个判断
  29. throw new RuntimeException("用户名或者密码错误");
  30. }
  31. //--------------------------------查询用户权限信息---------------------------------
  32. //由于我们自定义了3个权限,所以用List集合存储。注意权限实际就是'有特殊含义的字符串',所以下面的三个字符串就是自定义的
  33. //下面那行就是我们的权限集合,等下还要在LoginUser类做权限集合的转换
  34. List<String> list = new ArrayList<>(Arrays.asList("test","adminAuth","huanfAuth"));
  35. //------------------------------------------------------------------------------
  36. //把查询到的user结果,封装成UserDetails类型,然后返回。
  37. //但是由于UserDetails是个接口,所以我们先需要在domino目录新建LoginUser类,作为UserDetails的实现类,再写下面那行
  38. return new LoginUser(user,list); //这里传了第二个参数,表示的是权限信息
  39. }
  40. }


第三步: 封装权限信息。把LoginUser类修改为如下,主要是增加了把用户权限字符串的集合,转换封装在authorities变量里面

  1. package com.huanf.domain;
  2. import com.alibaba.fastjson.annotation.JSONField;
  3. import lombok.AllArgsConstructor;
  4. import lombok.Data;
  5. import lombok.NoArgsConstructor;
  6. import org.springframework.security.core.GrantedAuthority;
  7. import org.springframework.security.core.authority.SimpleGrantedAuthority;
  8. import org.springframework.security.core.userdetails.UserDetails;
  9. import java.util.Collection;
  10. import java.util.List;
  11. import java.util.stream.Collectors;
  12. @Data //getset方法
  13. @NoArgsConstructor //无参构造
  14. //@AllArgsConstructor //在下面封装权限信息时,由于我们自己写有参构造,所以这个注解需要注释掉
  15. //实现UserDetails接口之后,要重写UserDetails接口里面的7个方法
  16. public class LoginUser implements UserDetails {
  17. //查询用户的用户名和密码等数据信息
  18. private User xxuser;
  19. //查询用户权限信息
  20. private List<String> xxpermissions;
  21. public LoginUser(User xxuser, List<String> permissions) {
  22. this.xxuser = xxuser;
  23. this.xxpermissions = permissions;
  24. }
  25. //我们把这个List写到外面这里了,注意成员变量名一定要是authorities,不然会出现奇奇怪怪的问题
  26. @JSONField(serialize = false) //这个注解的作用是不让下面那行的成员变量序列化存入redis,避免redis不支持而报异常
  27. private List<SimpleGrantedAuthority> authorities;
  28. @Override
  29. //用于返回权限信息。现在我们正在学'认证''权限'后面才学。所以返回null即可
  30. //当要查询用户信息的时候,我们不能单纯返回null,要重写这个方法,作用是封装权限信息
  31. public Collection<? extends GrantedAuthority> getAuthorities() { //重写GrantedAuthority接口的getAuthorities方法
  32. /* 第一种权限集合的转换写法如下,传统的方式
  33. //把xxpermissions中的String类型的权限信息(也就是"test","adminAuth","huanfAuth")封装成SimpleGrantedAuthority对象
  34. //List<GrantedAuthority> authorities = new ArrayList<>(); //简化这行如下一行,我们把authorities成员变量写到外面了
  35. authorities = new ArrayList<>();
  36. for (String yypermission : xxpermissions) {
  37. SimpleGrantedAuthority yyauthority = new SimpleGrantedAuthority(yypermission);
  38. authorities.add(yyauthority);
  39. }
  40. */
  41. /* 第二种权限集合的转换写法如下,函数式编程 + stream流 的方式,双引号表示方法引用 */
  42. //当authorities集合为空,就说明是第一次,就需要转换,当不为空就说明不是第一次,就不需要转换直接返回
  43. if(authorities != null){ //严谨来说这个if判断是避免整个调用链中security本地线程变量在获取用户时的重复解析,和redis存取无关
  44. return authorities;
  45. }
  46. //为空的话就会执行下面的转换代码
  47. //List<SimpleGrantedAuthority> authorities = xxpermissions //简化这行如下一行,我们把authorities成员变量写到外面了
  48. authorities = xxpermissions
  49. .stream()
  50. .map(SimpleGrantedAuthority::new)
  51. .collect(Collectors.toList());
  52. //最终返回转换结果
  53. return authorities;
  54. }
  55. @Override
  56. //用于获取用户密码。由于使用的实体类是User,所以获取的是数据库的用户密码
  57. public String getPassword() {
  58. return xxuser.getPassword();
  59. }
  60. @Override
  61. //用于获取用户名。由于使用的实体类是User,所以获取的是数据库的用户名
  62. public String getUsername() {
  63. return xxuser.getUserName();
  64. }
  65. @Override
  66. //判断登录状态是否过期。把这个改成true,表示永不过期
  67. public boolean isAccountNonExpired() {
  68. return true;
  69. }
  70. @Override
  71. //判断账号是否被锁定。把这个改成true,表示未锁定
  72. public boolean isAccountNonLocked() {
  73. return true;
  74. }
  75. @Override
  76. //判断登录凭证是否过期。把这个改成true,表示永不过期
  77. public boolean isCredentialsNonExpired() {
  78. return true;
  79. }
  80. @Override
  81. //判断用户是否可用。把这个改成true,表示可用状态
  82. public boolean isEnabled() {
  83. return true;
  84. }
  85. }


第四步: 把JwtAuthenticationTokenFilter类修改为如下,主要是补充了前面没写的第三个参数,写成第三步封装好的权限信息

  1. package com.huanf.filter;
  2. import com.huanf.domain.LoginUser;
  3. import com.huanf.utils.JwtUtil;
  4. import com.huanf.utils.RedisCache;
  5. import io.jsonwebtoken.Claims;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
  8. import org.springframework.security.core.context.SecurityContextHolder;
  9. import org.springframework.stereotype.Component;
  10. import org.springframework.util.StringUtils;
  11. import org.springframework.web.filter.OncePerRequestFilter;
  12. import javax.servlet.FilterChain;
  13. import javax.servlet.ServletException;
  14. import javax.servlet.http.HttpServletRequest;
  15. import javax.servlet.http.HttpServletResponse;
  16. import java.io.IOException;
  17. import java.util.Objects;
  18. @Component
  19. public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
  20. @Autowired
  21. private RedisCache redisCache;
  22. @Override
  23. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
  24. //获取token,指定你要获取的请求头叫什么
  25. String xxtoken = request.getHeader("token");
  26. //判空,不一定所有的请求都有请求头,所以上面那行的xxtoken可能为空
  27. //!StringUtils.hasText()方法用于检查给定的字符串是否为空或仅包含空格字符
  28. if (!StringUtils.hasText(xxtoken)) {
  29. //如果请求没有携带token,那么就不需要解析token,不需要获取用户信息,直接放行就可以
  30. filterChain.doFilter(request, response);
  31. //return之后,就不会走下面那些代码
  32. return;
  33. }
  34. //解析token
  35. String userid; //把userid定义在外面,才能同时用于下面的46行和52行
  36. try {
  37. Claims claims = JwtUtil.parseJWT(xxtoken);
  38. userid = claims.getSubject();
  39. } catch (Exception e) {
  40. e.printStackTrace();
  41. throw new RuntimeException("token非法");
  42. }
  43. //从redis中获取用户信息
  44. String redisKey = "login:" + userid;
  45. //LoginUser是我们在domain目录写的实体类
  46. LoginUser loginUser = redisCache.getCacheObject(redisKey);
  47. //判断获取到的用户信息是否为空,因为redis里面可能并不存在这个用户信息,例如缓存过期了
  48. if(Objects.isNull(loginUser)){
  49. //抛出一个异常
  50. throw new RuntimeException("用户未登录");
  51. }
  52. //把最终的LoginUser用户信息,通过setAuthentication方法,存入SecurityContextHolder
  53. UsernamePasswordAuthenticationToken authenticationToken =
  54. //第一个参数是LoginUser用户信息,第二个参数是凭证(null),第三个参数是权限信息(null)
  55. //在学习封装权限信息时,就要把下面的第三个参数补充完整,getAuthorities是我们在loginUser写的方法
  56. new UsernamePasswordAuthenticationToken(loginUser,null,loginUser.getAuthorities());
  57. SecurityContextHolder.getContext().setAuthentication(authenticationToken);
  58. //全部做完之后,就放行
  59. filterChain.doFilter(request, response);
  60. }
  61. }


第五步: 本地打开你的redis

redis-server.exe redis.windows.conf


第六步: 运行TokenApplication引导类
第七步: 测试。打开你的postman,发送如下的POST请求,作用是先登录一个用户,这样就能生成这个用户对应的token值

localhost:8080/user/login


注意还要带上如下JSON类型的Body数据

  1. {
  2. "userName":"huanf",
  3. "password":"112233"
  4. }


第八步: 测试。继续在你的postman,发送如下GET请求,作用是拿着刚刚的token值,去访问我们的业务接口,看在有登录状态的情况下,能不能访问

http://localhost:8080/hello


注意还要带上你刚刚复制的token值,粘贴到消息头的Value输入框


第九步: 测试。修改HelloController类的@PreAuthorize注解的权限字符串,我们把test改为xxtest。然后重新运行Application引导类
第十步: 测试。把第八步的测试再做一遍,看还能访问吗

授权-RBAC权限模型


1. 介绍


刚刚我们实现了只有当用户具备某种权限,才能访问我们的某个业务接口。但是存在一个问题,我们在给用户设置权限的时候,是写死的,在真正的开发中,我们是需要从数据库查询权限信息,下面就来学习如何从数据库查询权限信息,然后封装给用户。这个功能需要先准备好数据库和java代码,所以,下面的 '授权-RBAC权限模型' 都是在围绕这个功能进行学习,直到实现这个功能


RBAC权限模型 (Role-Based Access Control) ,是权限系统用到的经典模型,基于角色的权限控制。该模型由以下五个主要组成部分构成:
一、用户: 在系统中代表具体个体的实体,可以是人员、程序或其他实体。用户需要访问系统资源
二、角色: 角色是权限的集合,用于定义一组相似权限的集合。角色可以被赋予给用户,从而授予用户相应的权限
三、权限: 权限表示系统中具体的操作或功能,例如读取、写入、执行等。每个权限定义了对系统资源的访问规则
四、用户-角色映射: 用户-角色映射用于表示用户与角色之间的关系。通过为用户分配适当的角色,用户可以获得与角色相关联的权限
五、角色-权限映射: 角色-权限映射表示角色与权限之间的关系。每个角色都被分配了一组权限,这些权限决定了角色可执行的操作
截止目前,我们数据库只有1张表,在上面 '认证' 的 '6. 自定义security的数据库' 里面创建的 sys_user 用户表,下面我们会新增4张表,分别是权限表(每条数据是单个'粒度细的权限')、角色表(每条数据是多个'粒度细的权限')、角色表与权限表的中间表、用户表与角色表的中间表。总共5张表,组成了RBAC模型,中间表的作用是维护两张表的多对多关系


2.数据库表的创建


第一步: 在你数据库的huanf_security 库,新建 sys_menu权限表、sys_role角色表、sys_role_menu中间表、sys_user_role中间表,并插入数据

  1. create database if not exists huanf_security;
  2. use huanf_security;
  3. CREATE TABLE `sys_menu` (
  4. `id` bigint(20) NOT NULL AUTO_INCREMENT,
  5. `menu_name` varchar(64) NOT NULL DEFAULT 'NULL' COMMENT '菜单名',
  6. `path` varchar(200) DEFAULT NULL COMMENT '路由地址',
  7. `component` varchar(255) DEFAULT NULL COMMENT '组件路径',
  8. `visible` char(1) DEFAULT '0' COMMENT '菜单状态(0显示 1隐藏)',
  9. `status` char(1) DEFAULT '0' COMMENT '菜单状态(0正常 1停用)',
  10. `perms` varchar(100) DEFAULT NULL COMMENT '权限标识',
  11. `icon` varchar(100) DEFAULT '#' COMMENT '菜单图标',
  12. `create_by` bigint(20) DEFAULT NULL,
  13. `create_time` datetime DEFAULT NULL,
  14. `update_by` bigint(20) DEFAULT NULL,
  15. `update_time` datetime DEFAULT NULL,
  16. `del_flag` int(11) DEFAULT '0' COMMENT '是否删除(0未删除 1已删除)',
  17. `remark` varchar(500) DEFAULT NULL COMMENT '备注',
  18. PRIMARY KEY (`id`)
  19. ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COMMENT='权限表';
  20. CREATE TABLE `sys_role` (
  21. `id` bigint(20) NOT NULL AUTO_INCREMENT,
  22. `name` varchar(128) DEFAULT NULL,
  23. `role_key` varchar(100) DEFAULT NULL COMMENT '角色权限字符串',
  24. `status` char(1) DEFAULT '0' COMMENT '角色状态(0正常 1停用)',
  25. `del_flag` int(1) DEFAULT '0' COMMENT 'del_flag',
  26. `create_by` bigint(200) DEFAULT NULL,
  27. `create_time` datetime DEFAULT NULL,
  28. `update_by` bigint(200) DEFAULT NULL,
  29. `update_time` datetime DEFAULT NULL,
  30. `remark` varchar(500) DEFAULT NULL COMMENT '备注',
  31. PRIMARY KEY (`id`)
  32. ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT='角色表';
  33. CREATE TABLE `sys_role_menu` (
  34. `role_id` bigint(200) NOT NULL AUTO_INCREMENT COMMENT '角色ID',
  35. `menu_id` bigint(200) NOT NULL DEFAULT '0' COMMENT '菜单id',
  36. PRIMARY KEY (`role_id`,`menu_id`)
  37. ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4;
  38. CREATE TABLE `sys_user_role` (
  39. `user_id` bigint(200) NOT NULL AUTO_INCREMENT COMMENT '用户id',
  40. `role_id` bigint(200) NOT NULL DEFAULT '0' COMMENT '角色id',
  41. PRIMARY KEY (`user_id`,`role_id`)
  42. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  43. insert into sys_user_role values (2,1);
  44. insert into sys_role values
  45. (1,'经理','ceo',0,0,default,default,default,default,default),
  46. (2,'程序员','coder',0,0,default,default,default,default,default);
  47. insert into sys_role_menu values (1,1),(1,2);
  48. insert into sys_menu values
  49. (1,'部门管理','dept','system/dept/index',0,0,'system:dept:list','#',default,default,default,default,default,default),
  50. (2,'测试','test','system/test/index',0,0,'system:test:list','#',default,default,default,default,default,default)

注意: 没有huanf_security数据库 和 sys_user用户表 的话,请去上面笔记的 '认证' 的 '6. 自定义security的数据库' 里面进行创建。或者我给你写出来了,如下

  1. create database if not exists huanf_security;
  2. use huanf_security;
  3. CREATE TABLE `sys_user` (
  4. `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  5. `user_name` VARCHAR(64) NOT NULL DEFAULT 'NULL' COMMENT '用户名',
  6. `nick_name` VARCHAR(64) NOT NULL DEFAULT 'NULL' COMMENT '昵称',
  7. `password` VARCHAR(64) NOT NULL DEFAULT 'NULL' COMMENT '密码',
  8. `status` CHAR(1) DEFAULT '0' COMMENT '账号状态(0正常 1停用)',
  9. `email` VARCHAR(64) DEFAULT NULL COMMENT '邮箱',
  10. `phonenumber` VARCHAR(32) DEFAULT NULL COMMENT '手机号',
  11. `sex` CHAR(1) DEFAULT NULL COMMENT '用户性别(0男,1女,2未知)',
  12. `avatar` VARCHAR(128) DEFAULT NULL COMMENT '头像',
  13. `user_type` CHAR(1) NOT NULL DEFAULT '1' COMMENT '用户类型(0管理员,1普通用户)',
  14. `create_by` BIGINT(20) DEFAULT NULL COMMENT '创建人的用户id',
  15. `create_time` DATETIME DEFAULT NULL COMMENT '创建时间',
  16. `update_by` BIGINT(20) DEFAULT NULL COMMENT '更新人',
  17. `update_time` DATETIME DEFAULT NULL COMMENT '更新时间',
  18. `del_flag` INT(11) DEFAULT '0' COMMENT '删除标志(0代表未删除,1代表已删除)',
  19. PRIMARY KEY (`id`)
  20. ) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COMMENT='用户表';
  21. insert into sys_user values (1,'admin','管理员','{noop}123456','0',DEFAULT,DEFAULT,DEFAULT,DEFAULT,'0',DEFAULT,DEFAULT,DEFAULT,DEFAULT,DEFAULT);
  22. insert into sys_user values (2,'huanf','涣沷a靑惷','$2a$10$YPnG.IYUk0mMechaxSibBuKmNeTzvuHdcxkqvoxizsll6WCQG9CHG','0',DEFAULT,DEFAULT,DEFAULT,DEFAULT,'1',DEFAULT,DEFAULT,DEFAULT,DEFAULT,DEFAULT);


第二步: 测试SQL语句,也就是确认一下你的建表、插入数据是否达到要求

  1. # 通过用户id去查询这个用户具有的权限列表。也就是根据userid查询perms,并且限制条件为role和menu都必须正常状态么也就是等于0
  2. SELECT
  3. DISTINCT m.`perms`
  4. FROM
  5. sys_user_role ur
  6. LEFT JOIN `sys_role` r ON ur.`role_id` = r.`id`
  7. LEFT JOIN `sys_role_menu` rm ON ur.`role_id` = rm.`role_id`
  8. LEFT JOIN `sys_menu` m ON m.`id` = rm.`menu_id`
  9. WHERE
  10. user_id = 2
  11. AND r.`status` = 0
  12. AND m.`status` = 0


注意: 可以查到两条数据,这两条数据就是等下数据库返回给我们的权限字符串


3. 查询数据库的权限信息


第一步: 在 domain 目录新建 Menu 实体类,写入如下

  1. package com.huanf.domain;
  2. import com.baomidou.mybatisplus.annotation.TableId;
  3. import com.baomidou.mybatisplus.annotation.TableName;
  4. import com.fasterxml.jackson.annotation.JsonInclude;
  5. import lombok.AllArgsConstructor;
  6. import lombok.Data;
  7. import lombok.NoArgsConstructor;
  8. import java.io.Serializable;
  9. import java.util.Date;
  10. //权限表(也叫菜单表)的实体类
  11. @TableName(value="sys_menu") //指定表名,避免等下mybatisplus的影响
  12. @Data
  13. @AllArgsConstructor
  14. @NoArgsConstructor
  15. @JsonInclude(JsonInclude.Include.NON_NULL)
  16. //Serializable是官方提供的,作用是将对象转化为字节序列
  17. public class Menu implements Serializable {
  18. private static final long serialVersionUID = -54979041104113736L;
  19. @TableId
  20. private Long id;
  21. /**
  22. * 菜单名
  23. */
  24. private String menuName;
  25. /**
  26. * 路由地址
  27. */
  28. private String path;
  29. /**
  30. * 组件路径
  31. */
  32. private String component;
  33. /**
  34. * 菜单状态(0显示 1隐藏)
  35. */
  36. private String visible;
  37. /**
  38. * 菜单状态(0正常 1停用)
  39. */
  40. private String status;
  41. /**
  42. * 权限标识
  43. */
  44. private String perms;
  45. /**
  46. * 菜单图标
  47. */
  48. private String icon;
  49. private Long createBy;
  50. private Date createTime;
  51. private Long updateBy;
  52. private Date updateTime;
  53. /**
  54. * 是否删除(0未删除 1已删除)
  55. */
  56. private Integer delFlag;
  57. /**
  58. * 备注
  59. */
  60. private String remark;
  61. }


第二步: 在 mapper 目录新建 MenuMapper 接口。作用是定义mapper,其中提供一个方法可以根据userid查询权限信息

  1. package com.huanf.mapper;
  2. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  3. import com.huanf.domain.Menu;
  4. import java.util.List;
  5. import org.springframework.stereotype.Service;
  6. @Service
  7. //BaseMapper是mybatisplus官方提供的接口,里面提供了很多单表查询的方法
  8. public interface MenuMapper extends BaseMapper<Menu> {
  9. //由于是多表联查,mybatisplus的BaseMapper接口没有提供,我们需要自定义方法,所以需要创建对应的mapper文件,定义对应的sql语句
  10. List<String> selectPermsByUserId(Long id);
  11. }


第三步: 在 resources 目录新建 mapper目录,接着在这个mapper目录新建File,名字叫 MenuMapper.xml,写入如下

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
  3. <mapper namespace="com.huanf.mapper.MenuMapper">
  4. <select id="selectPermsByUserId" resultType="java.lang.String">
  5. SELECT
  6. DISTINCT m.`perms`
  7. FROM
  8. sys_user_role ur
  9. LEFT JOIN `sys_role` r ON ur.`role_id` = r.`id`
  10. LEFT JOIN `sys_role_menu` rm ON ur.`role_id` = rm.`role_id`
  11. LEFT JOIN `sys_menu` m ON m.`id` = rm.`menu_id`
  12. WHERE
  13. user_id = #{userid}
  14. AND r.`status` = 0
  15. AND m.`status` = 0
  16. </select>
  17. </mapper>


第四步: 把application.yml修改为如下,作用是告诉mybatisplus,刚刚写的MenuMapper.xml文件是在哪个地方

  1. mybatis-plus:
  2. # 配置MenuMapper.xml文件的路径
  3. # 也可以不写,因为默认就是在类加载路径(resouces)下的mapper目录的任意层级的后缀为xml的文件,都会被扫描到
  4. mapper-locations: classpath*:/mapper/**/*.xml


第五步: 测试。这里只是检查mybatismlus能不能拿到数据库的权限字符串。在MapperTest类添加如下

  1. @Autowired
  2. private MenuMapper menuMapper;
  3. @Test
  4. public void testSelectPermsByUserId(){
  5. //L表示Long类型
  6. List<String> list = menuMapper.selectPermsByUserId(2L);
  7. System.out.println(list);
  8. }


4. RBAC权限模型的实现


不要把RBAC模型想得很难,其实难的话只是数据库表的设计和SQL语句的编写,需要5张表。数据库设计好之后就很简单了,使用mybatis-plus去查询数据库表的权限字符串(例如我们的权限字符串是放在sys_menu表),然后把你查到的数据去替换死数据就好了。我们只剩最后一步,就是替换死数据,如下
第一步: 把MyUserDetailServiceImpl类修改为如下,我们只是增加了查询来自数据库的权限信息的代码

  1. package com.huanf.service.impl;
  2. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  3. import com.huanf.domain.LoginUser;
  4. import com.huanf.domain.User;
  5. import com.huanf.mapper.MenuMapper;
  6. import com.huanf.mapper.UserMapper;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.security.core.userdetails.UserDetails;
  9. import org.springframework.security.core.userdetails.UserDetailsService;
  10. import org.springframework.security.core.userdetails.UsernameNotFoundException;
  11. import org.springframework.stereotype.Service;
  12. import java.util.ArrayList;
  13. import java.util.Arrays;
  14. import java.util.List;
  15. import java.util.Objects;
  16. @Service
  17. public class MyUserDetailServiceImpl implements UserDetailsService {
  18. @Autowired
  19. private UserMapper userMapper;
  20. @Autowired
  21. //MenuMapper是我们在mapper目录写好的接口,作用是查询来自数据库的权限信息
  22. private MenuMapper menuMapper;
  23. @Override
  24. //UserDetails是Security官方提供的接口
  25. public UserDetails loadUserByUsername(String xxusername) throws UsernameNotFoundException {
  26. //查询用户信息。我们写的userMapper接口里面是空的,所以调用的是mybatis-plus提供的方法
  27. LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
  28. //eq方法表示等值匹配,第一个参数是数据库的用户名,第二个参数是我们传进来的用户名,这两个参数进行比较是否相等
  29. queryWrapper.eq(User::getUserName,xxusername);
  30. User user = userMapper.selectOne(queryWrapper);
  31. //如果用户传进来的用户名,但是数据库没有这个用户名,就会导致我们是查不到的情况,那么就进行下面的判断。避免程序安全问题
  32. if(Objects.isNull(user)){//判断user对象是否为空。当在数据库没有查到数据时,user就会为空,也就会进入这个判断
  33. throw new RuntimeException("用户名或者密码错误");
  34. }
  35. //--------------------------------查询用户权限信息----------------------------------
  36. //由于我们自定义了3个权限,所以用List集合存储。注意权限实际就是'有特殊含义的字符串',所以下面的三个字符串就是自定义的
  37. //下面那行就是我们的权限集合,等下还要在LoginUser类做权限集合的转换
  38. //List<String> list = new ArrayList<>(Arrays.asList("test","adminAuth","huanfAuth"));
  39. //上面那行的list就不用死数据啦,我们用下面那行的list,是数据库获取到的权限字符串信息的数据
  40. //-------------------------------查询来自数据库的权限信息--------------------------------
  41. List<String> list = menuMapper.selectPermsByUserId(user.getId());
  42. //-------------------------------------------------------------------------------
  43. //把查询到的user结果,封装成UserDetails类型,然后返回。
  44. //但是由于UserDetails是个接口,所以我们先需要在domino目录新建LoginUser类,作为UserDetails的实现类,再写下面那行
  45. return new LoginUser(user,list); //这里传了第二个参数,表示的是权限信息
  46. }
  47. }


第二步: 测试。由于我们知道数据库传过来的权限字符串是 system:dept:list 和 system:test:list,所以我们要把HelloController类的权限字符串修改为如下

system:test:list


system:dept:list


第三步: 本地打开你的redis

redis-server.exe redis.windows.conf


第四步: 运行TokenApplication引导类
第五步: 测试。打开你的postman,发送如下的POST请求,作用是先登录一个用户,这样就能生成这个用户对应的token值

localhost:8080/user/login


注意还要带上如下JSON类型的Body数据

  1. {
  2. "userName":"huanf",
  3. "password":"112233"
  4. }


第六步: 测试。继续在你的postman,发送如下GET请求,作用是拿着刚刚的token值,去访问我们的业务接口,看在有登录状态的情况下,能不能访问

http://localhost:8080/hello


注意还要带上你刚刚复制的token值,粘贴到消息头的Value输入框


第七步: 测试。修改HelloController类的@PreAuthorize注解的权限字符串,我们改为 xxxsystem:test:list。然后重新运行Application引导类
第八步: 测试。把第八步的测试再做一遍,看还能访问吗


自定义异常处理


上面的我们学习了 '认证' 和 '授权',实现了基本的权限管理,然后也学习了从数据库获取授权的 '授权-RBAC权限模型',实现了从数据库获取用户具备的权限字符串。到此,我们完整地实现了权限管理的功能,但是,当认证或授权出现报错时,我们希望响应回来的json数据有实体类的code、msg、data这三个字段,怎么实现呢
我们需要学习Spring Security的异常处理机制,就可以在认证失败或者是授权失败的情况下也能和我们的接口一样返回相同结构的json,这样可以让前端能对响应进行统一的处理


在SpringSecurity中,如果我们在认证或者授权的过程中出现了异常会被ExceptionTranslationFilter捕获到,如上图。在ExceptionTranslationFilter中会去判断是认证失败还是授权失败出现的异常,其中有如下两种情况
一、如果是认证过程中出现的异常会被封装成AuthenticationException然后调用AuthenticationEntryPoint对象的方法去进行异常处理。
二、如果是授权过程中出现的异常会被封装成AccessDeniedException然后调用AccessDeniedHandler对象的方法去进行异常处理。
总结: 如果我们需要自定义异常处理,我们只需要创建AuthenticationEntryPoint和AccessDeniedHandler的实现类对象,然后配置给SpringSecurity即可
第一步: 在 src/main/java/com.huanf 目录新建 handler.AuthenticationEntryPointImpl类,写入如下,作用是自定义认证的实现类

  1. package com.huanf.handler;
  2. import com.alibaba.fastjson.JSON;
  3. import com.huanf.domain.ResponseResult;
  4. import com.huanf.utils.WebUtils;
  5. import org.springframework.http.HttpStatus;
  6. import org.springframework.security.core.AuthenticationException;
  7. import org.springframework.security.web.AuthenticationEntryPoint;
  8. import org.springframework.stereotype.Component;
  9. import javax.servlet.ServletException;
  10. import javax.servlet.http.HttpServletRequest;
  11. import javax.servlet.http.HttpServletResponse;
  12. import java.io.IOException;
  13. @Component
  14. //这个类只处理认证异常,不处理授权异常
  15. public class AuthenticationEntryPointImpl implements AuthenticationEntryPoint {
  16. @Override
  17. //第一个参数是请求对象,第二个参数是响应对象,第三个参数是异常对象。把异常封装成授权的对象,然后封装到handle方法
  18. public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException, ServletException {
  19. //ResponseResult是我们在domain目录写好的实体类。HttpStatus是spring提供的枚举类,UNAUTHORIZED表示401状态码
  20. ResponseResult result = new ResponseResult(HttpStatus.UNAUTHORIZED.value(), "用户认证失败,请重新登录");
  21. //把上面那行拿到的result对象转换为JSON字符串
  22. String json = JSON.toJSONString(result);
  23. //WebUtils是我们在utils目录写好的类
  24. WebUtils.renderString(response,json);
  25. }
  26. }


第二步: 在handler目录新建 AccessDeniedHandlerImpl 类,写入如下,作用是自定义授权的实现类

  1. package com.huanf.handler;
  2. import com.alibaba.fastjson.JSON;
  3. import com.huanf.domain.ResponseResult;
  4. import com.huanf.utils.WebUtils;
  5. import org.springframework.http.HttpStatus;
  6. import org.springframework.security.access.AccessDeniedException;
  7. import org.springframework.security.web.access.AccessDeniedHandler;
  8. import org.springframework.stereotype.Component;
  9. import javax.servlet.ServletException;
  10. import javax.servlet.http.HttpServletRequest;
  11. import javax.servlet.http.HttpServletResponse;
  12. import java.io.IOException;
  13. @Component
  14. //这个类只处理授权异常,不处理认证异常
  15. public class AccessDeniedHandlerImpl implements AccessDeniedHandler {
  16. @Override
  17. //第一个参数是请求对象,第二个参数是响应对象,第三个参数是异常对象。把异常封装成认证的对象,然后封装到handle方法
  18. public void handle(HttpServletRequest request, HttpServletResponse response, AccessDeniedException accessDeniedException) throws IOException, ServletException {
  19. //ResponseResult是我们在domain目录写好的实体类。HttpStatus是spring提供的枚举类,FORBIDDEN表示403状态码
  20. ResponseResult result = new ResponseResult(HttpStatus.FORBIDDEN.value(), "您没有权限进行访问");
  21. //把上面那行拿到的result对象转换为JSON字符串
  22. String json = JSON.toJSONString(result);
  23. //WebUtils是我们在utils目录写好的类
  24. WebUtils.renderString(response,json);
  25. }
  26. }


第三步: 把 SecurityConfig 类修改为如下,作用是把刚刚两个异常处理的实现类配置在Spring Security里面

  1. package com.huanf.config;
  2. import com.huanf.filter.JwtAuthenticationTokenFilter;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.security.authentication.AuthenticationManager;
  7. import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
  8. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  9. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  10. import org.springframework.security.config.http.SessionCreationPolicy;
  11. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  12. import org.springframework.security.crypto.password.PasswordEncoder;
  13. import org.springframework.security.web.AuthenticationEntryPoint;
  14. import org.springframework.security.web.access.AccessDeniedHandler;
  15. import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
  16. @Configuration
  17. @EnableGlobalMethodSecurity(prePostEnabled = true)
  18. //实现Security提供的WebSecurityConfigurerAdapter类,就可以改变密码校验的规则了
  19. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  20. @Bean
  21. //把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验
  22. //注意也可以注入PasswordEncoder,效果是一样的,因为PasswordEncoder是BCry..的父类
  23. public PasswordEncoder passwordEncoder(){
  24. return new BCryptPasswordEncoder();
  25. }
  26. //---------------------------认证过滤器的实现----------------------------------
  27. @Autowired
  28. //注入我们在filter目录写好的类
  29. private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
  30. //---------------------------登录接口的实现----------------------------------
  31. @Bean
  32. @Override
  33. public AuthenticationManager authenticationManagerBean() throws Exception {
  34. return super.authenticationManagerBean();
  35. }
  36. @Override
  37. protected void configure(HttpSecurity http) throws Exception {
  38. http
  39. //由于是前后端分离项目,所以要关闭csrf
  40. .csrf().disable()
  41. //由于是前后端分离项目,所以session是失效的,我们就不通过Session获取SecurityContext
  42. .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
  43. .and()
  44. //指定让spring security放行登录接口的规则
  45. .authorizeRequests()
  46. // 对于登录接口 anonymous表示允许匿名访问
  47. .antMatchers("/user/login").anonymous()
  48. // 除上面外的所有请求全部需要鉴权认证
  49. .anyRequest().authenticated();
  50. //---------------------------认证过滤器的实现----------------------------------
  51. //把token校验过滤器添加到过滤器链中
  52. //第一个参数是上面注入的我们在filter目录写好的类,第二个参数表示你想添加到哪个过滤器之前
  53. http.addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class);
  54. //---------------------------异常处理的相关配置-------------------------------
  55. http.exceptionHandling()
  56. //配置认证失败的处理器
  57. .authenticationEntryPoint(authenticationEntryPoint)
  58. //配置授权失败的处理器
  59. .accessDeniedHandler(accessDeniedHandler);
  60. }
  61. @Autowired
  62. //注入Security提供的认证失败的处理器,这个处理器里面的AuthenticationEntryPointImpl实现类,用的不是官方的了,
  63. //而是用的是我们在handler目录写好的AuthenticationEntryPointImpl实现类,因为我们也是添加到容器把官方的这个实现类覆盖了
  64. private AuthenticationEntryPoint authenticationEntryPoint;
  65. @Autowired
  66. //注入Security提供的授权失败的处理器,这个处理器里面的AccessDeniedHandlerImpl实现类,用的不是官方的了,
  67. //而是用的是我们在handler目录写好的AccessDeniedHandlerImpl实现类,因为我们也是添加到容器把官方的这个实现类覆盖了
  68. private AccessDeniedHandler accessDeniedHandler;
  69. //--------------------------------------------------------------------------
  70. }


第四步: 本地打开你的redis


第五步: 运行TokenApplication引导类
第六步: 测试认证异常。打开你的postman,发送如下的POST请求,作用是登录一个不存在的用户,模拟认证异常

localhost:8080/user/login


注意还要带上如下JSON类型的Body数据

  1. {
  2. "userName":"xxhuanf",
  3. "password":"112233"
  4. }


第七步: 测试授权异常。先在HelloController类修改PreAuthorize注解的权限字符串,修改成huanf用户不存在的权限字符串,接着重新运行TokenApplication引导类,然后去正常登录一个用户并访问 /hello 业务接口,必然会报权限异常,然后我们看一下响应回来的数据格式,是不是我们定义的json格式


跨域


我这里跟教程视频的不一致,教程视频大概想讲的是只有同时配置springboot和security的跨域,那么外界用户才能访问我们的接口,但是我实际操作的却不一致,不清楚是不是版本的问题,总之都学一下吧,我的操作证明出来的是security的跨域写了跟没写都无效,只要是boot配置了跨域,那么跨域问题就解决了


1. 跨域的后端解决


由于我们的SpringSecurity负责所有请求和资源的管理,当请求经过SpringSecurity时,如果SpringSecurity不允许跨域,那么也是会被拦截,所以下面我们将学习并解决跨域问题。前面我们在测试时,是在postman测试,因此没有出现跨域问题的情况,postman只是负责发请求跟浏览器没关系
浏览器出于安全的考虑,使用 XMLHttpRequest 对象发起HTTP请求时必须遵守同源策略,否则就是跨域的HTTP请求,默认情况下是被禁止的。 同源策略要求源相同才能正常进行通信,即协议、域名、端口号都完全一致。 前后端分离项目,前端项目和后端项目一般都不是同源的,所以肯定会存在跨域请求的问题
我们要实现如下两个需求 (我实际做出的效果跟教程视频不一致,第二个需求其实没必要存在,boot解决了跨域就都解决了):
1、开启SpringBoot的允许跨域访问
2、开启SpringSecurity的允许跨域访问
第一步: 开启SpringBoot的允许跨域访问。在 config 目录新建 CorsConfig 类,写入如下

  1. package com.huanf.config;
  2. import org.springframework.context.annotation.Configuration;
  3. import org.springframework.web.servlet.config.annotation.CorsRegistry;
  4. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  5. @Configuration
  6. public class CorsConfig implements WebMvcConfigurer {
  7. @Override
  8. //重写spring提供的WebMvcConfigurer接口的addCorsMappings方法
  9. public void addCorsMappings(CorsRegistry registry) {
  10. // 设置允许跨域的路径
  11. registry.addMapping("/**")
  12. // 设置允许跨域请求的域名
  13. .allowedOriginPatterns("*")
  14. // 是否允许cookie
  15. .allowCredentials(true)
  16. // 设置允许的请求方式
  17. .allowedMethods("GET", "POST", "DELETE", "PUT")
  18. // 设置允许的header属性
  19. .allowedHeaders("*")
  20. // 跨域允许时间
  21. .maxAge(3600);
  22. }
  23. }


第二步: 开启SpringSecurity的允许跨域访问。在把 SecurityConfig 修改为如下。增加了一点代码,我会用红框框出来

  1. package com.huanf.config;
  2. import com.huanf.filter.JwtAuthenticationTokenFilter;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.security.authentication.AuthenticationManager;
  7. import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
  8. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  9. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  10. import org.springframework.security.config.http.SessionCreationPolicy;
  11. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  12. import org.springframework.security.crypto.password.PasswordEncoder;
  13. import org.springframework.security.web.AuthenticationEntryPoint;
  14. import org.springframework.security.web.access.AccessDeniedHandler;
  15. import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
  16. @Configuration
  17. @EnableGlobalMethodSecurity(prePostEnabled = true)
  18. //实现Security提供的WebSecurityConfigurerAdapter类,就可以改变密码校验的规则了
  19. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  20. @Bean
  21. //把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验
  22. //注意也可以注入PasswordEncoder,效果是一样的,因为PasswordEncoder是BCry..的父类
  23. public PasswordEncoder passwordEncoder(){
  24. return new BCryptPasswordEncoder();
  25. }
  26. //---------------------------认证过滤器的实现----------------------------------
  27. @Autowired
  28. //注入我们在filter目录写好的类
  29. private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
  30. //---------------------------登录接口的实现------------------------------------
  31. @Bean
  32. @Override
  33. public AuthenticationManager authenticationManagerBean() throws Exception {
  34. return super.authenticationManagerBean();
  35. }
  36. @Override
  37. protected void configure(HttpSecurity http) throws Exception {
  38. http
  39. //由于是前后端分离项目,所以要关闭csrf
  40. .csrf().disable()
  41. //由于是前后端分离项目,所以session是失效的,我们就不通过Session获取SecurityContext
  42. .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
  43. .and()
  44. //指定让spring security放行登录接口的规则
  45. .authorizeRequests()
  46. // 对于登录接口 anonymous表示允许匿名访问
  47. .antMatchers("/user/login").anonymous()
  48. // 除上面外的所有请求全部需要鉴权认证
  49. .anyRequest().authenticated();
  50. //---------------------------认证过滤器的实现-------------------------------
  51. //把token校验过滤器添加到过滤器链中
  52. //第一个参数是上面注入的我们在filter目录写好的类,第二个参数表示你想添加到哪个过滤器之前
  53. http.addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class);
  54. //---------------------------
    声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Cpp五条/article/detail/518169
    推荐阅读
    相关标签