devbox
我家小花儿
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringBoot2.6 + SpringSecurity 分离版_securityconfig

作者：我家小花儿 | 2024-03-03 07:03:02

赞

踩

securityconfig

目录

一：初始化项目

二：简单原理介绍

三：认证（UsernamePasswordAuthenticationFiter）

四：授权（FilterSecurityInterceptor）

五：失败处理(ExceptionTranslationFilter)

六：跨域

七：代码

1.POM文件

2.application.yml

3.config 配置文件（10个）

3.1.授权失败

3.2.认证失败

3.3.Springboot 跨域配置类

3.4.Redis使用FastJson序列化

3.5.token认证过滤器

3.6.Jwt工具类

3.7.redis工具

3.8.redis配置类

3.9.SpringSecurity 核心配置类

3.10.WebUtils

4.测试类

5.Login类

5.1.controller（1个）

5.2.dao（2个）

5.3.entity（4个）

5.4.mapper包（1个）

5.5.service包（2个接口，3个实现）

6.启动类

八：配置swagger

1.Swagger文档地址: http://localhost:8080/doc.html

2.yml文件配置

3.SecurityConfig 配置类

4.pom文件

5.swagger配置文件

九：SQL资料 参考

一：初始化项目

1、创建SpringBoot项目 

  1.         <!--spring boot-->
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-web</artifactId>
  5.         </dependency>

2、整合MyBatis

  1.         <!-- mybatis -->
  2.         <dependency>
  3.             <groupId>org.mybatis.spring.boot</groupId>
  4.             <artifactId>mybatis-spring-boot-starter</artifactId>
  5.             <version>1.3.2</version>
  6.         </dependency>
  7.         <!-- mysql -->
  8.         <dependency>
  9.             <groupId>mysql</groupId>
  10.             <artifactId>mysql-connector-java</artifactId>
  11.             <scope>runtime</scope>
  12.         </dependency>

3、引入SpringSecurity

  1.         <!--spring security 启动器-->
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-security</artifactId>
  5.         </dependency>
  6.         <!--jwt-->
  7.         <dependency>
  8.             <groupId>io.jsonwebtoken</groupId>
  9.             <artifactId>jjwt</artifactId>
  10.             <version>0.9.0</version>
  11.         </dependency>

4、创建测试接口http://localhost:8080/hello，进行测试。
当引入security成功之后，在登录测试接口时就会跳转到默认的登录页http://localhost:8080/login。
(默认用户名：user，密码：控制台输出)

二：简单原理介绍

1、登录校验流程

 2、SpringSecurity简单过滤器链（完整的过滤器大概是14个），前后端分离一般用jwt，前后端不分离一般采用session

三：认证（UsernamePasswordAuthenticationFiter）

1、登录流程：

 ①、登录、自定义登录接口：
调用ProviderManager的方法进行认证，如果认证通过生成jwt和把用户信息存到redis中。

  1. // 认证 实现代码类
  2. UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(sysUser.getUserName(), sysUser.getPassword());
  3. Authentication authenticate = authenticationManager.authenticate(authenticationToken);
  4. // 认证通过 生成jwt
  5. LoginUser loginUser = (LoginUser) authenticate.getPrincipal();
  6. String userId = loginUser.getSysUser().getId().toString();
  7. String jwt = JwtUtil.createJWT(userId);// 使用userId生成 jwt
  8. Map<String, String> map = new HashMap<>(1);
  9. map.put("token", jwt);
  10. // 认证通过 存入 redis
  11. redisCache.setCacheObject("login:" + userId, loginUser);
  12.  
  13.  
  14. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  15.     //认证 配置代码
  16.     @Override
  17.     protected void configure(HttpSecurity http) throws Exception {
  18.     // ......
  19. 	}
  20. }

②、登录、自定义UserDetailsService：
实现到db中查询用户信息，因为原接口是从内存中查询的。

  1. //重写 UserDetailsService 的 loadUserByUsername 方法
  2. public class UserDetailsServiceImpl implements UserDetailsService{
  3.     @Override
  4.     public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
  5. 		//......
  6.     }
  7. }
  8.  
  9. //重写UserDetails返回的用户信息
  10. public class LoginUser implements UserDetails {
  11. 	//......
  12. }

 2、token认证：

 ①、校验、定义jwt认证过滤器：
获取toekn、解析token获取其中的userId、从redis中获取用户信息、使用SecurityContextHolder.getContext().setAuthentication()方法存储该对象，这样其他过滤器会通过SecurityContextHolder来获取当前用户信息。

  1. // token认证过滤器
  2. @Component
  3. public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
  4.     @Override
  5.     protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
  6.         // 省略......  拦截到 token不合法等情况 
  7.         // 将 Authentication对象存入 SecurityContextHolder
  8.         UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(loginUser, null, loginUser.getAuthorities());
  9.         SecurityContextHolder.getContext().setAuthentication(authenticationToken);
  10.         //放行
  11.         filterChain.doFilter(request, response);
  12.     }
  13. }

四：授权（FilterSecurityInterceptor）

1、将用户的权限信息封装到Authentcation当中，存到SecurityContextHolder中。

  1. @Service
  2. public class UserDetailsServiceImpl implements UserDetailsService {
  3.     @Override
  4.     public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
  5.     	// 省略 ......
  6.     	// 根据用户id查询权限字符串集合
  7.         List<String> list = sysMenuDao.selectPermsByUserId(userInfo.getId());
  8.         return new LoginUser(userInfo, list);
  9.     }
  10. }
  11.  
  12.  
  13. public class LoginUser implements UserDetails {
  14. 	// ......
  15. 	@JSONField(serialize = false) //fastjson注解,表示此属性不会被序列化到redis当中
  16.     private List<SimpleGrantedAuthority> authorities;
  17.     @Override
  18.     public Collection<? extends GrantedAuthority> getAuthorities() {
  19.         // 权限为空的时候才往遍历，不为空直接返回
  20.         if (authorities != null) {
  21.             return authorities;
  22.         }
  23.         //把permissions中String类型的权限信息封装成SimpleGrantedAuthority对象
  24.         authorities = new ArrayList<>();
  25.         for (String permission : permissions) {
  26.             SimpleGrantedAuthority authority = new SimpleGrantedAuthority(permission);
  27.             authorities.add(authority);
  28.         }
  29.         return authorities;
  30.     }
  31.     
  32.     // ......
  33. }
  34.  
  35.  
  36. // token过滤器中（ JwtAuthenticationTokenFilter ）
  37. // 将Authentication对象（用户信息、已认证状态、权限信息）存入 SecurityContextHolder
  38. UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(loginUser, null, loginUser.getAuthorities());
  39. SecurityContextHolder.getContext().setAuthentication(authenticationToken);

2、从SecurityContextHolder中获取Authentcation对象，再获取其中的权限信息。

  1. // token过滤器中（ JwtAuthenticationTokenFilter ）
  2. String redisKey = "login:" + userId;
  3. LoginUser loginUser = redisCache.getCacheObject(redisKey);// 从redis中获取用户信息

3、设置每个资源（方法）所需要的权限（注解形式设置权限）
RBAC(基于角色的权限控制)

  1. //SecurityConfig 配置类开启权限注解功能
  2. @EnableGlobalMethodSecurity(prePostEnabled = true)
  3.  
  4. /***** 对应资源（方法）上授权 *****/
  5. //常用，该用户在数据库中有 system:dept:list 这个权限标识才能访问
  6. @PreAuthorize("hasAuthority('system:dept:list')")
  7. @PreAuthorize("hasAnyAuthority()")
  8. @PreAuthorize("hasAnyRole()")
  9. @PreAuthorize("hasAnyRole()")
  10. @PreAuthorize("hasPermission()")

五：失败处理(ExceptionTranslationFilter)

  1. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  2. 	// ......
  3.     @Override
  4.     protected void configure(HttpSecurity http) throws Exception {
  5.         http.exceptionHandling() // 配置异常处理器
  6.                 .authenticationEntryPoint(authenticationEntryPoint)// 认证失败
  7.                 .accessDeniedHandler(accessDeniedHandler); // 授权失败
  8.     }
  9.     // ......
  10. }

1、认证失败处理器

  1. @Component
  2. public class AuthenticationEntryPointImpl implements AuthenticationEntryPoint {
  3. 	// ......
  4. }

2、授权失败处理器

  1. @Component
  2. public class AccessDeniedHandlerImpl implements AccessDeniedHandler {
  3. 	// ......
  4. }

六：跨域

同时处理 springboot跨域 和 springsecurity跨域

  1. // springboot 跨域配置类
  2. @Configuration
  3. public class CorsConfig implements WebMvcConfigurer {
  4. 	// ......
  5. }
  6.  
  7.  
  8. // SecurityConfig配置类
  9. http.cors();// spring security 允许跨域

七：代码

1.POM文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.6.6</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.example</groupId>
  12.     <artifactId>boot_security</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>boot_security</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <!--spring boot-->
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-web</artifactId>
  24.         </dependency>
  25.         <!--lombok-->
  26.         <dependency>
  27.             <groupId>org.projectlombok</groupId>
  28.             <artifactId>lombok</artifactId>
  29.             <optional>true</optional>
  30.         </dependency>
  31.         <!--spring security 启动器-->
  32.         <dependency>
  33.             <groupId>org.springframework.boot</groupId>
  34.             <artifactId>spring-boot-starter-security</artifactId>
  35.         </dependency>
  36.         <!--redis-->
  37.         <dependency>
  38.             <groupId>org.springframework.boot</groupId>
  39.             <artifactId>spring-boot-starter-data-redis</artifactId>
  40.         </dependency>
  41.         <!--fastjson-->
  42.         <dependency>
  43.             <groupId>com.alibaba</groupId>
  44.             <artifactId>fastjson</artifactId>
  45.             <version>1.2.33</version>
  46.         </dependency>
  47.         <!--jwt-->
  48.         <dependency>
  49.             <groupId>io.jsonwebtoken</groupId>
  50.             <artifactId>jjwt</artifactId>
  51.             <version>0.9.0</version>
  52.         </dependency>
  53.         <!-- mybatis -->
  54.         <dependency>
  55.             <groupId>org.mybatis.spring.boot</groupId>
  56.             <artifactId>mybatis-spring-boot-starter</artifactId>
  57.             <version>1.3.2</version>
  58.         </dependency>
  59.         <!-- mysql -->
  60.         <dependency>
  61.             <groupId>mysql</groupId>
  62.             <artifactId>mysql-connector-java</artifactId>
  63.             <scope>runtime</scope>
  64.         </dependency>
  65.     </dependencies>
  66.     <build>
  67.         <!--mybatis加载配置文件-->
  68.         <resources>
  69.             <resource>
  70.                 <directory>src/main/resources</directory>
  71.             </resource>
  72.             <resource>
  73.                 <directory>src/main/java</directory>
  74.                 <includes>
  75.                     <include>**/*.xml</include>
  76.                 </includes>
  77.             </resource>
  78.         </resources>
  79.         <plugins>
  80.             <plugin>
  81.                 <groupId>org.springframework.boot</groupId>
  82.                 <artifactId>spring-boot-maven-plugin</artifactId>
  83.             </plugin>
  84.         </plugins>
  85.     </build>
  86. </project>

2.application.yml

  1. server:
  2.   port: 8080
  3.  
  4. spring:
  5.   # 数据源配置
  6.   datasource:
  7.     url: jdbc:mysql://localhost:3306/security?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
  8.     username: root
  9.     password: root
  10.     driver-class-name: com.mysql.cj.jdbc.Driver
  11.   # redis配置
  12.   redis:
  13.     host: localhost
  14.     port: 6379
  15.     password: 123456
  16.  
  17. # mybatis配置
  18. mybatis:
  19.   # 配置SQL映射文件路径
  20.   # mapper-locations: classpath:/mapper/*.xml
  21.   mapper-locations: classpath*:com/example/boot_security/**/mapper/*.xml
  22.   # 驼峰命名
  23.   configuration:
  24.     mapUnderscoreToCamelCase: true

3.config 配置文件（10个）

3.1.授权失败

  1. /**
  2.  * 授权失败
  3.  */
  4. @Component
  5. public class AccessDeniedHandlerImpl implements AccessDeniedHandler {
  6.     @Override
  7.     public void handle(HttpServletRequest request, HttpServletResponse response, AccessDeniedException accessDeniedException) throws IOException, ServletException {
  8.         ResponseResult result = new ResponseResult(403, "您的权限不足！");
  9.         String json = JSON.toJSONString(result);
  10.         // 将字符串渲染到客户端
  11.         WebUtils.renderString(response, json);
  12.     }
  13. }

3.2.认证失败

  1. /**
  2.  * 认证失败
  3.  */
  4. @Component
  5. public class AuthenticationEntryPointImpl implements AuthenticationEntryPoint {
  6.     @Override
  7.     public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException, ServletException {
  8.         ResponseResult result = new ResponseResult(401, "认证失败，请重新登录！");
  9.         String json = JSON.toJSONString(result);
  10.         // 将字符串渲染到客户端
  11.         WebUtils.renderString(response, json);
  12.     }
  13. }

3.3.Springboot 跨域配置类

  1. /**
  2.  * springboot 跨域配置类
  3.  */
  4. @Configuration
  5. public class CorsConfig implements WebMvcConfigurer {
  6.  
  7.     @Override
  8.     public void addCorsMappings(CorsRegistry registry) {
  9.         // 设置允许跨域的路径
  10.         registry.addMapping("/**")
  11.                 // 设置允许跨域请求的域名
  12.                 .allowedOriginPatterns("*")
  13.                 // 是否允许cookie
  14.                 .allowCredentials(true)
  15.                 // 设置允许的请求方式
  16.                 .allowedMethods("GET", "POST", "DELETE", "PUT")
  17.                 // 设置允许的header属性
  18.                 .allowedHeaders("*")
  19.                 // 跨域允许时间
  20.                 .maxAge(3600);
  21.     }
  22. }

3.4.Redis使用FastJson序列化

  1. /**
  2.  * Redis使用FastJson序列化
  3.  */
  4. public class FastJsonRedisSerializer<T> implements RedisSerializer<T> {
  5.  
  6.     public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
  7.  
  8.     private Class<T> clazz;
  9.  
  10.     static {
  11.         ParserConfig.getGlobalInstance().setAutoTypeSupport(true);
  12.     }
  13.  
  14.     public FastJsonRedisSerializer(Class<T> clazz) {
  15.         super();
  16.         this.clazz = clazz;
  17.     }
  18.  
  19.     @Override
  20.     public byte[] serialize(T t) throws SerializationException {
  21.         if (t == null) {
  22.             return new byte[0];
  23.         }
  24.         return JSON.toJSONString(t, SerializerFeature.WriteClassName).getBytes(DEFAULT_CHARSET);
  25.     }
  26.  
  27.     @Override
  28.     public T deserialize(byte[] bytes) throws SerializationException {
  29.         if (bytes == null || bytes.length <= 0) {
  30.             return null;
  31.         }
  32.         String str = new String(bytes, DEFAULT_CHARSET);
  33.  
  34.         return JSON.parseObject(str, clazz);
  35.     }
  36.  
  37.  
  38.     protected JavaType getJavaType(Class<?> clazz) {
  39.         return TypeFactory.defaultInstance().constructType(clazz);
  40.     }
  41. }

3.5.token认证过滤器

  1. /**
  2.  * token认证过滤器
  3.  * 作用：解析请求头中的token。并验证合法性
  4.  * 继承 OncePerRequestFilter 保证请求经过过滤器一次
  5.  */
  6. @Component
  7. public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
  8.  
  9.     @Resource
  10.     private RedisCache redisCache;
  11.  
  12.     @Override
  13.     protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
  14.         String token = request.getHeader("token");
  15.         // 没有token
  16.         if (!StringUtils.hasText(token)) {
  17.             filterChain.doFilter(request, response);//放行,因为后面的会抛出相应的异常
  18.             return;
  19.         }
  20.  
  21.         // 非法token
  22.         String userId;
  23.         try {
  24.             Claims claims = JwtUtil.parseJWT(token);
  25.             userId = claims.getSubject();
  26.         } catch (Exception e) {
  27.             e.printStackTrace();
  28.             throw new RuntimeException("非法token!");
  29.         }
  30.  
  31.  
  32.         String redisKey = "login:" + userId;
  33.         LoginUser loginUser = redisCache.getCacheObject(redisKey);// 从redis中获取用户信息
  34.  
  35.         // redis中用户不存在
  36.         if (Objects.isNull(loginUser)) {
  37.             throw new RuntimeException("redis中用户不存在!");
  38.         }
  39.  
  40.         // 将Authentication对象（用户信息、已认证状态、权限信息）存入 SecurityContextHolder
  41.         UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(loginUser, null, loginUser.getAuthorities());
  42.         SecurityContextHolder.getContext().setAuthentication(authenticationToken);
  43.         //放行
  44.         filterChain.doFilter(request, response);
  45.     }
  46. }

3.6.Jwt工具类

  1. /**
  2.  * Jwt工具类
  3.  */
  4. public class JwtUtil {
  5.  
  6.     /**
  7.      * 有效期为
  8.      * 60 * 60 *1000  一个小时
  9.      */
  10.     public static final Long JWT_TTL = 60 * 60 * 1000L;
  11.     /**
  12.      * 设置秘钥明文
  13.      */
  14.     public static final String JWT_KEY = "sangeng";
  15.  
  16.  
  17.     public static String getUUID() {
  18.         String token = UUID.randomUUID().toString().replaceAll("-", "");
  19.         return token;
  20.     }
  21.  
  22.     /**
  23.      * 生成 jtw
  24.      *
  25.      * @param subject token中要存放的数据（json格式）
  26.      * @return
  27.      */
  28.     public static String createJWT(String subject) {
  29.         // 设置过期时间 空
  30.         JwtBuilder builder = getJwtBuilder(subject, null, getUUID());
  31.         return builder.compact();
  32.     }
  33.  
  34.     /**
  35.      * 生成 jtw
  36.      *
  37.      * @param subject   token中要存放的数据（json格式）
  38.      * @param ttlMillis token超时时间
  39.      * @return
  40.      */
  41.     public static String createJWT(String subject, Long ttlMillis) {
  42.         // 设置过期时间
  43.         JwtBuilder builder = getJwtBuilder(subject, ttlMillis, getUUID());
  44.         return builder.compact();
  45.     }
  46.  
  47.     private static JwtBuilder getJwtBuilder(String subject, Long ttlMillis, String uuid) {
  48.         SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
  49.         SecretKey secretKey = generalKey();
  50.         long nowMillis = System.currentTimeMillis();
  51.         Date now = new Date(nowMillis);
  52.         if (ttlMillis == null) {
  53.             ttlMillis = JwtUtil.JWT_TTL;
  54.         }
  55.         long expMillis = nowMillis + ttlMillis;
  56.         Date expDate = new Date(expMillis);
  57.         return Jwts.builder()
  58.                 // 唯一的ID
  59.                 .setId(uuid)
  60.                 // 主题  可以是JSON数据
  61.                 .setSubject(subject)
  62.                 // 签发者
  63.                 .setIssuer("sg")
  64.                 // 签发时间
  65.                 .setIssuedAt(now)
  66.                 // 使用 HS256 对称加密算法签名, 第二个参数为秘钥
  67.                 .signWith(signatureAlgorithm, secretKey)
  68.                 .setExpiration(expDate);
  69.     }
  70.  
  71.     /**
  72.      * 创建 token
  73.      *
  74.      * @param id
  75.      * @param subject
  76.      * @param ttlMillis
  77.      * @return
  78.      */
  79.     public static String createJWT(String id, String subject, Long ttlMillis) {
  80.         // 设置过期时间
  81.         JwtBuilder builder = getJwtBuilder(subject, ttlMillis, id);
  82.         return builder.compact();
  83.     }
  84.  
  85.     /**
  86.      * 生成加密后的秘钥 secretKey
  87.      *
  88.      * @return
  89.      */
  90.     public static SecretKey generalKey() {
  91.         byte[] encodedKey = Base64.getDecoder().decode(JwtUtil.JWT_KEY);
  92.         SecretKey key = new SecretKeySpec(encodedKey, 0, encodedKey.length, "AES");
  93.         return key;
  94.     }
  95.  
  96.     /**
  97.      * 解析
  98.      *
  99.      * @param jwt
  100.      * @return
  101.      * @throws Exception
  102.      */
  103.     public static Claims parseJWT(String jwt) throws Exception {
  104.         SecretKey secretKey = generalKey();
  105.         return Jwts.parser()
  106.                 .setSigningKey(secretKey)
  107.                 .parseClaimsJws(jwt)
  108.                 .getBody();
  109.     }
  110.  
  111.     //测试方法
  112.     public static void main(String[] args) throws Exception {
  113.         //JWT加密
  114.         String jwt = createJWT("123456");
  115.         System.out.println(jwt);
  116.         //JWT解密  时间过期会报错，须重新生成再解析
  117.         Claims claims = parseJWT("密文");
  118.         String subject = claims.getSubject();
  119.         System.out.println(subject);
  120.     }
  121. }

3.7.redis工具

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

3.8.redis配置类

  1. /**
  2.  * redis配置类
  3.  * 避免存入redis中的key看上去乱码的现象
  4.  */
  5. @Configuration
  6. public class RedisConfig {
  7.  
  8.     @Bean
  9.     @SuppressWarnings(value = {"unchecked", "rawtypes"})
  10.     public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
  11.         RedisTemplate<Object, Object> template = new RedisTemplate<>();
  12.         template.setConnectionFactory(connectionFactory);
  13.  
  14.         FastJsonRedisSerializer serializer = new FastJsonRedisSerializer(Object.class);
  15.  
  16.         // 使用StringRedisSerializer来序列化和反序列化redis的key值
  17.         template.setKeySerializer(new StringRedisSerializer());
  18.         template.setValueSerializer(serializer);
  19.  
  20.         // Hash的key也采用StringRedisSerializer的序列化方式
  21.         template.setHashKeySerializer(new StringRedisSerializer());
  22.         template.setHashValueSerializer(serializer);
  23.  
  24.         template.afterPropertiesSet();
  25.         return template;
  26.     }
  27. }

3.9.SpringSecurity 核心配置类

  1. /**
  2.  * SpringSecurity 核心配置类
  3.  * prePostEnabled = true 开启注解权限认证功能
  4.  */
  5. @Configuration
  6. @EnableGlobalMethodSecurity(prePostEnabled = true)//开启@PreAuthorize()注解权限功能
  7. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  8.  
  9.     //认证过滤器
  10.     @Autowired
  11.     private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
  12.  
  13.     // 认证失败处理器
  14.     @Autowired
  15.     private AuthenticationEntryPointImpl authenticationEntryPoint;
  16.  
  17.     // 授权失败处理器
  18.     @Autowired
  19.     private AccessDeniedHandlerImpl accessDeniedHandler;
  20.  
  21.  
  22.     /**
  23.      * 密码机密处理器
  24.      * <p>
  25.      * 将BCryptPasswordEncoder对象注入到spring容器中,更换掉原来的 PasswordEncoder加密方式
  26.      * 原PasswordEncoder密码格式为：{id}password。它会根据id去判断密码的加密方式。
  27.      * 如果没替换原来的加密方式，数据库中想用明文密码做测试，将密码字段改为{noop}123456这样的格式
  28.      */
  29.     @Bean
  30.     public PasswordEncoder passwordEncoder() {
  31.         return new BCryptPasswordEncoder();
  32.     }
  33.  
  34.     /**
  35.      * 认证配置
  36.      * anonymous()：匿名访问：未登录可以访问，已登录不能访问
  37.      * permitAll()：有没有认证都能访问：登录或未登录都能访问
  38.      * denyAll(): 拒绝
  39.      * authenticated()：认证之后才能访问
  40.      * hasAuthority（）：包含权限
  41.      */
  42.     @Override
  43.     protected void configure(HttpSecurity http) throws Exception {
  44.         http
  45.                 // 关闭csrf(前后端分离项目要关闭此功能）
  46.                 .csrf().disable()
  47.                 // 禁用session (前后端分离项目，不通过Session获取SecurityContext)
  48.                 .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
  49.                 .and()
  50.                 // 请求认证配置
  51.                 .authorizeRequests()
  52.                 // 允许匿名访问：未登录可以访问，已登录不能访问
  53.                 .antMatchers("/login").anonymous()
  54.                 // .antMatchers("/login").permitAll()// 登录或未登录都能访问
  55.                 // .antMatchers("/textMybatis").hasAuthority("system:dept:list22")
  56.                 // 任意用户，认证之后才可以访问（除上面外的）
  57.                 .anyRequest().authenticated();
  58.  
  59.         // 添加token过滤器
  60.         http.addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class);
  61.  
  62.         // 配置异常处理器
  63.         http.exceptionHandling()
  64.                 // 认证失败
  65.                 .authenticationEntryPoint(authenticationEntryPoint)
  66.                 // 授权失败
  67.                 .accessDeniedHandler(accessDeniedHandler);
  68.  
  69.         // spring security 允许跨域
  70.         http.cors();
  71.     }
  72.  
  73.     /**
  74.      * 注入AuthenticationManager 进行用户认证
  75.      */
  76.     @Bean
  77.     @Override
  78.     public AuthenticationManager authenticationManagerBean() throws Exception {
  79.         return super.authenticationManagerBean();
  80.     }
  81.  
  82. }

3.10.WebUtils

  1. /**
  2.  * 将字符串渲染到客户端
  3.  * 向响应之中写入中聚类
  4.  *
  5.  * @author bing_  @create 2022/1/4-22:20
  6.  */
  7. public class WebUtils {
  8.     /**
  9.      * 将字符串渲染到客户端
  10.      *
  11.      * @param response 渲染对象
  12.      * @param string   待渲染的字符串
  13.      * @return null
  14.      */
  15.     public static String renderString(HttpServletResponse response, String string) {
  16.         try {
  17.             response.setStatus(200);
  18.             response.setContentType("application/json");
  19.             response.setCharacterEncoding("utf-8");
  20.             response.getWriter().print(string);
  21.         } catch (IOException e) {
  22.             e.printStackTrace();
  23.         }
  24.         return null;
  25.     }
  26. }

4.测试类

  1. /**
  2.  * 测试接口 账户名：sg  密码：1111
  3.  */
  4. @RestController
  5. @RequestMapping("/test")
  6. public class HelloController {
  7.  
  8.     @Autowired
  9.     private SysUserDao sysUserDao;
  10.  
  11.     /**
  12.      * 测试 springBoot
  13.      */
  14.     @GetMapping("/SpringBoot")
  15.     @PreAuthorize("hasAuthority('system:dept:list')")//授权
  16.     public String testSpringBoot(){
  17.         return "测试 springBoot";
  18.     }
  19.  
  20.     /**
  21.      * 测试 mybatis
  22.      */
  23.     @GetMapping("/Mybatis")
  24.     public SysUser textMybatis(){
  25.         return sysUserDao.getUserInfo("sg");
  26.     }
  27. }

5.Login类

5.1.controller（1个）

1.LoginController 

  1. /**
  2.  * 一个坑：退出路径如果只有 "/logout" 会报403 ，原因不明
  3.  * 解决方法：前面添加个前路径，或者换一个名就可以了
  4.  */
  5. @RestController
  6. public class LoginController {
  7.  
  8.     @Autowired
  9.     private LoginService loginService;
  10.  
  11.     /**
  12.      * 登录
  13.      */
  14.     @PostMapping("/login")
  15.     public ResponseResult login(@RequestBody SysUser sysUser) {
  16.         return loginService.login(sysUser);
  17.     }
  18.  
  19.     /**
  20.      * 退出登录
  21.      */
  22.     @GetMapping("/user/logout")
  23.     public ResponseResult logout() {
  24.         return loginService.logout();
  25.     }
  26. }

5.2.dao（2个）

5.2.1.SysMenuDao 

  1. public interface SysMenuDao {
  2.     /**
  3.      * 根据用户id查询权限字符串集合
  4.      */
  5.     List<String> selectPermsByUserId(Long userId);
  6. }

5.2.2.SysUserDao  

  1. public interface SysUserDao {
  2.     /**
  3.      * 获取用户信息
  4.      */
  5.     @Select("select * from sys_user where user_name = #{username}")
  6.     SysUser getUserInfo(String username);
  7. }

5.3.entity（4个）

5.3.1.SysUser 

  1. /**
  2.  * 用户表（sys_user）实体表
  3.  */
  4. @Data
  5. @AllArgsConstructor
  6. @NoArgsConstructor
  7. public class SysUser {
  8.     private Long id;//主键
  9.     private String userName;//用户名
  10.     private String nickName;//昵称
  11.     private String password;//密码
  12.     private String status;//账号状态（0正常 1停用）
  13.     private String email;//邮箱
  14.     private String phonenumber;//手机号
  15.     private String sex;//用户性别（0男，1女，2未知）
  16.     private String avatar;//头像
  17.     private String userType;//用户类型（0管理员，1普通用户）
  18.     private Long createBy;//创建人的用户id
  19.     private LocalDateTime createTime;//创建时间
  20.     private Long updateBy;//更新人
  21.     private LocalDateTime updateTime;//更新时间
  22.     private Integer delFlag;//删除标志（0代表未删除，1代表已删除）
  23. }

5.3.2.LoginUser  

  1. /**
  2.  * 重写UserDetails返回的用户信息
  3.  * SpringSecurity返回的用户信息实体类
  4.  */
  5. @Data
  6. @NoArgsConstructor
  7. public class LoginUser implements UserDetails {
  8.  
  9.     private SysUser sysUser;//用户信息
  10.  
  11.     private List<String> permissions;//权限信息
  12.  
  13.     public LoginUser(SysUser sysUser, List<String> permissions) {
  14.         this.sysUser = sysUser;
  15.         this.permissions = permissions;
  16.     }
  17.  
  18.     @JSONField(serialize = false) //fastjson注解,表示此属性不会被序列化，因为SimpleGrantedAuthority这个类型不能在redis中序列化
  19.     private List<SimpleGrantedAuthority> authorities;
  20.  
  21.     /**
  22.      * 获取权限信息
  23.      */
  24.     @Override
  25.     public Collection<? extends GrantedAuthority> getAuthorities() {
  26.         // 权限为空的时候才往遍历，不为空直接返回
  27.         if (authorities != null) {
  28.             return authorities;
  29.         }
  30.         //把permissions中String类型的权限信息封装成SimpleGrantedAuthority对象
  31.         authorities = new ArrayList<>();
  32.         for (String permission : permissions) {
  33.             SimpleGrantedAuthority authority = new SimpleGrantedAuthority(permission);
  34.             authorities.add(authority);
  35.         }
  36.         return authorities;
  37.     }
  38.  
  39.     /**
  40.      * 获取密码
  41.      */
  42.     @Override
  43.     public String getPassword() {
  44.         return sysUser.getPassword();
  45.     }
  46.  
  47.     /**
  48.      * 获取用户名
  49.      */
  50.     @Override
  51.     public String getUsername() {
  52.         return sysUser.getUserName();
  53.     }
  54.  
  55.     /**
  56.      * 判断是否过期
  57.      */
  58.     @Override
  59.     public boolean isAccountNonExpired() {
  60.         return true;
  61.     }
  62.  
  63.     /**
  64.      * 是否锁定
  65.      */
  66.     @Override
  67.     public boolean isAccountNonLocked() {
  68.         return true;
  69.     }
  70.  
  71.     /**
  72.      * 是否没有超时
  73.      */
  74.     @Override
  75.     public boolean isCredentialsNonExpired() {
  76.         return true;
  77.     }
  78.  
  79.     /**
  80.      * 是否可用
  81.      */
  82.     @Override
  83.     public boolean isEnabled() {
  84.         return true;
  85.     }
  86. }

5.3.3. SysMenu

  1. /**
  2.  * 菜单表（sys_menu）实体表
  3.  */
  4. @Data
  5. public class SysMenu{
  6.  
  7.     private Long id;
  8.     private String menuName;//菜单名
  9.     private String path;//路由地址
  10.     private String component;//组件路径
  11.     private String visible;//菜单状态（0显示 1隐藏）
  12.     private String status;//菜单状态（0正常 1停用）
  13.     private String perms;//权限标识
  14.     private String icon;//菜单图标
  15.     private Long createBy;
  16.     private LocalDateTime createTime;
  17.     private Long updateBy;
  18.     private LocalDateTime updateTime;
  19.     private Integer delFlag;//是否删除（0未删除 1已删除）
  20.     private String remark;//备注
  21. }

5.3.4.SysUser 

  1. /**
  2.  * 用户表（sys_user）实体表
  3.  */
  4. @Data
  5. @AllArgsConstructor
  6. @NoArgsConstructor
  7. public class SysUser {
  8.     private Long id;//主键
  9.     private String userName;//用户名
  10.     private String nickName;//昵称
  11.     private String password;//密码
  12.     private String status;//账号状态（0正常 1停用）
  13.     private String email;//邮箱
  14.     private String phonenumber;//手机号
  15.     private String sex;//用户性别（0男，1女，2未知）
  16.     private String avatar;//头像
  17.     private String userType;//用户类型（0管理员，1普通用户）
  18.     private Long createBy;//创建人的用户id
  19.     private LocalDateTime createTime;//创建时间
  20.     private Long updateBy;//更新人
  21.     private LocalDateTime updateTime;//更新时间
  22.     private Integer delFlag;//删除标志（0代表未删除，1代表已删除）
  23. }

5.4.mapper包（1个）

5.4.1.SysMenuMapper.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.example.boot_security.sysSecurity.dao.SysMenuDao">
  4.  
  5.     <!--根据用户id查询权限字符串集合-->
  6.     <select id="selectPermsByUserId" resultType="java.lang.String">
  7.         SELECT DISTINCT m.perms
  8.         FROM sys_user_role ur
  9.                  LEFT JOIN sys_role r ON ur.role_id = r.id
  10.                  LEFT JOIN sys_role_menu rm ON r.id = rm.role_id
  11.                  LEFT JOIN sys_menu m ON rm.menu_id = m.id
  12.         WHERE ur.user_id = #{userId}
  13.     </select>
  14. </mapper>

5.5.service包（2个接口，3个实现）

5.5.1.LoginService 接口

  1. public interface LoginService {
  2.     /**
  3.      * 登录
  4.      */
  5.     ResponseResult login(SysUser sysUser);
  6.  
  7.     /**
  8.      * 退出登录
  9.      */
  10.     ResponseResult logout();
  11. }

5.5.2.SysUserService 接口

  1. public interface SysUserService {
  2.  
  3.     /**
  4.      * 根据用户名获取用户信息
  5.      */
  6.     SysUser getUserInfo(String username);
  7. }

5.5.3.impl实现类

5.5.3.1.LoginServiceImpl

  1. @Service
  2. public class LoginServiceImpl implements LoginService {
  3.  
  4.     @Autowired
  5.     private AuthenticationManager authenticationManager;
  6.  
  7.     @Autowired
  8.     private RedisCache redisCache;
  9.  
  10.     @Override
  11.     public ResponseResult login(SysUser sysUser) {
  12.         // 认证
  13.         UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(sysUser.getUserName(), sysUser.getPassword());
  14.         Authentication authenticate = authenticationManager.authenticate(authenticationToken);
  15.         // 认证没通过
  16.         if (Objects.isNull(authenticate)) {
  17.             throw new RuntimeException("用户名或密码错误!");
  18.         }
  19.         // 认证通过 生成jwt
  20.         LoginUser loginUser = (LoginUser) authenticate.getPrincipal();
  21.         String userId = loginUser.getSysUser().getId().toString();
  22.         String jwt = JwtUtil.createJWT(userId);
  23.         Map<String, String> map = new HashMap<>(1);
  24.         map.put("token", jwt);
  25.         // 认证通过 存入 redis
  26.         redisCache.setCacheObject("login:" + userId, loginUser);
  27.         return new ResponseResult(200, "登录成功", map);
  28.     }
  29.  
  30.     @Override
  31.     public ResponseResult logout() {
  32.         LoginUser loginUser = (LoginUser) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
  33.         Long userId = loginUser.getSysUser().getId();
  34.         // 清空redis
  35.         redisCache.deleteObject("login:" + userId);
  36.         return new ResponseResult(200, "退出成功");
  37.     }
  38. }

5.5.3.2.SysUserServiceImpl

  1. @Service
  2. public class SysUserServiceImpl implements SysUserService {
  3.  
  4.     @Autowired
  5.     private SysUserDao systemUserDao;
  6.  
  7.     /**
  8.      * 根据用户名获取用户信息
  9.      */
  10.     @Override
  11.     public SysUser getUserInfo(String username) {
  12.         return systemUserDao.getUserInfo(username);
  13.     }
  14. }

5.5.3.3.UserDetailsServiceImpl

  1. /**
  2.  * 重写框架的 UserDetailsService 的 loadUserByUsername 方法
  3.  * 从数据库中查询用户信息
  4.  * 因为原框架的内用信息是存在内存中的
  5.  */
  6. @Service
  7. public class UserDetailsServiceImpl implements UserDetailsService {
  8.  
  9.     @Autowired
  10.     private SysUserService sysUserService;
  11.  
  12.     @Autowired
  13.     private SysMenuDao sysMenuDao;
  14.  
  15.     @Override
  16.     public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
  17.         SysUser userInfo = sysUserService.getUserInfo(username);
  18.         if (Objects.isNull(userInfo)) {
  19.             throw new RuntimeException("用户名和密码错误！");
  20.         }
  21.         List<String> list = sysMenuDao.selectPermsByUserId(userInfo.getId());
  22.         // 把数据封装成 UserDetails 返回，参数：用户信息、权限列表
  23.         return new LoginUser(userInfo, list);
  24.     }
  25. }

6.启动类

  1. @SpringBootApplication
  2. @MapperScan("com/example/boot_security/**/dao")
  3. public class BootSecurityApplication {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(BootSecurityApplication.class, args);
  6.     }
  7. }

项目结构 

 

八：配置swagger

1.Swagger文档地址: http://localhost:8080/doc.html

2.yml文件配置

  1. # Spring 高版本Springboot+swagger3.0配置，不然报错
  2. spring:
  3.   mvc:
  4.     pathmatch:
  5.       matching-strategy: ant_path_matcher

3.SecurityConfig 配置类

  1.  @Override
  2.     protected void configure(HttpSecurity http) throws Exception {
  3.         http.authorizeHttpRequests()
  4.                 //对于登录login 注册register 验证码captchaImage 允许匿名访问
  5.                 .antMatchers("/login/**").permitAll()
  6.                 //静态资源，可匿名访问
  7.                 .antMatchers(HttpMethod.GET, "/", "/*.html", "/**/*.html", "/**/*.css", "/**/*.js", "/profile/**").permitAll()
  8.                 .antMatchers("/swagger-ui.html", "/doc.html", "/swagger-resources/**", "/webjars/**", "/*/api-docs", "/druid/**").permitAll()
  9.                 .anyRequest()
  10.                 //所有请求都必须认证
  11.                 .authenticated()
  12.                 .and()
  13.                 .formLogin()
  14.                 .and()
  15.                 .exceptionHandling()
  16.                 //没登录提示信息
  17.                 .authenticationEntryPoint((req, resp, ex) -> {
  18.                     resp.setContentType("application/json;charset=UTF-8");
  19.                     resp.setStatus(HttpStatus.UNAUTHORIZED.value());
  20.                     resp.getWriter().println("必须认证之后才能访问!");
  21.                 })
  22.                 //退出登录提示信息
  23.                 .and().logout().logoutUrl("/logout")
  24.                 .logoutSuccessHandler((req, resp, ex) -> {
  25.                     resp.setContentType("application/json;charset=UTF-8");
  26.                     resp.setStatus(HttpStatus.UNAUTHORIZED.value());
  27.                     resp.getWriter().println("注销成功!");
  28.                 })
  29.                 //跨域处理方案
  30.                 .and().cors().configurationSource(configurationSource())
  31.                 //关闭csrf
  32.                 .and().csrf().disable()
  33.         ;

4.pom文件

  1.          <!--swagger 高版本Springboot2.6+使用3.0以上-->
  2.         <dependency>
  3.             <groupId>io.springfox</groupId>
  4.             <artifactId>springfox-swagger2</artifactId>
  5.             <version>3.0.0</version>
  6.         </dependency>
  7.         <dependency>
  8.             <groupId>io.springfox</groupId>
  9.             <artifactId>springfox-boot-starter</artifactId>
  10.             <version>3.0.0</version>
  11.         </dependency>
  12.         <!--swagger ui 高版本Springboot2.6+使用3.0以上-->
  13.         <dependency>
  14.             <groupId>com.github.xiaoymin</groupId>
  15.             <artifactId>knife4j-spring-boot-starter</artifactId>
  16.             <version>3.0.3</version>
  17.         </dependency>

5.swagger配置文件

  1. import io.swagger.annotations.ApiOperation;
  2. import org.springframework.beans.BeansException;
  3. import org.springframework.beans.factory.config.BeanPostProcessor;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.util.ReflectionUtils;
  7. import org.springframework.web.bind.annotation.RestController;
  8. import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
  9. import springfox.documentation.builders.ApiInfoBuilder;
  10. import springfox.documentation.builders.ParameterBuilder;
  11. import springfox.documentation.builders.PathSelectors;
  12. import springfox.documentation.builders.RequestHandlerSelectors;
  13. import springfox.documentation.schema.ModelRef;
  14. import springfox.documentation.service.*;
  15. import springfox.documentation.spi.DocumentationType;
  16. import springfox.documentation.spi.service.contexts.SecurityContext;
  17. import springfox.documentation.spring.web.plugins.Docket;
  18. import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
  19. import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
  20.  
  21. import java.lang.reflect.Field;
  22. import java.util.ArrayList;
  23. import java.util.Collections;
  24. import java.util.List;
  25. import java.util.stream.Collectors;
  26.  
  27. @Configuration
  28. public class SwaggerConfig {
  29.  
  30.     /**
  31.      * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
  32.      *
  33.      * @return Docket
  34.      */
  35.     @Bean(value = "defaultApi2")
  36.     public Docket defaultApi2() {
  37.         return new Docket(DocumentationType.SWAGGER_2)
  38.                 //是否启用Swagger
  39.                 .enable(true)
  40.                 .apiInfo(apiInfo())
  41.                 .select()
  42.                 //此包路径下的类，才生成接口文档
  43.                 //.apis(RequestHandlerSelectors.basePackage("com.cn"))
  44.                 //扫描所有
  45.                 //.apis(RequestHandlerSelectors.any())
  46.                 //加了ApiOperation注解的类，才生成接口文档
  47.                 .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
  48.                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
  49.                 .paths(PathSelectors.any())
  50.                 .build()
  51.                 //设置自定义swagger请求头
  52.                 .securitySchemes(Collections.singletonList(securityScheme()))
  53.                 .securityContexts(securityContexts());
  54.                 //.globalOperationParameters(setHeaderToken());
  55.     }
  56.     /**
  57.      * 设置自定义swagger请求头
  58.      * @return ApiKey
  59.      */
  60.     @Bean
  61.     SecurityScheme securityScheme() {
  62.         return new ApiKey("Access-Token", "Access-Token", "header");
  63.     }
  64.  
  65.     /**
  66.      * 新增 securityContexts 保持登录状态
  67.      */
  68.     private List<SecurityContext> securityContexts() {
  69.         return new ArrayList(
  70.                 Collections.singleton(SecurityContext.builder()
  71.                         .securityReferences(defaultAuth())
  72.                         .forPaths(PathSelectors.regex("^(?!auth).*$"))
  73.                         .build())
  74.         );
  75.     }
  76.  
  77.     /**
  78.      * 配置
  79.      */
  80.     private List<SecurityReference> defaultAuth() {
  81.         AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
  82.         AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
  83.         authorizationScopes[0] = authorizationScope;
  84.         return new ArrayList(
  85.                 Collections.singleton(new SecurityReference("Access-Token", authorizationScopes)));
  86.     }
  87.  
  88.     /**
  89.      * swagger主页名
  90.      * @return ApiInfo
  91.      */
  92.     private ApiInfo apiInfo() {
  93.         return new ApiInfoBuilder()
  94.                 .title("接口文档")
  95.                 .description("swagger接口文档")
  96.                 .version("1.0")
  97.                 .build();
  98.     }
  99.  
  100.     /**
  101.      * JWT token
  102.      * @return setHeaderToken
  103.      */
  104.     private List<Parameter> setHeaderToken() {
  105.         ParameterBuilder tokenPar = new ParameterBuilder();
  106.         List<Parameter> pars = new ArrayList<>();
  107.         tokenPar.name("Access-Token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
  108.         pars.add(tokenPar.build());
  109.         return pars;
  110.     }
  111.  
  112.     /**
  113.      * 高版本Springboot2.6+务必加入配置类中的springfoxHandlerProviderBeanPostProcessor方法
  114.      * @return BeanPostProcessor
  115.      */
  116.     @Bean
  117.     public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
  118.         return new BeanPostProcessor() {
  119.  
  120.             @Override
  121.             public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
  122.                 if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
  123.                     customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
  124.                 }
  125.                 return bean;
  126.             }
  127.  
  128.             private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
  129.                 List<T> copy = mappings.stream()
  130.                         .filter(mapping -> mapping.getPatternParser() == null)
  131.                         .collect(Collectors.toList());
  132.                 mappings.clear();
  133.                 mappings.addAll(copy);
  134.             }
  135.  
  136.             @SuppressWarnings("unchecked")
  137.             private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
  138.                 try {
  139.                     Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
  140.                     field.setAccessible(true);
  141.                     return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
  142.                 } catch (IllegalArgumentException | IllegalAccessException e) {
  143.                     throw new IllegalStateException(e);
  144.                 }
  145.             }
  146.         };
  147.     }
  148.  
  149. }
  150.  
  151.

九：SQL资料 参考

由于RBAC模型主要包含用户、角色、权限。因此本文主要设计了五张表：sys_user（用户表）、sys_menu（菜单表）、sys_role（权限表）、sys_role_menu（角色权限关联表）、sys_user_role（用户角色关联表）。

  1. CREATE TABLE `sys_menu` (
  2. `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  3. `menu_name` varchar(64) NOT NULL DEFAULT 'NULL' COMMENT '菜单名',
  4. `path` varchar(200) DEFAULT NULL COMMENT '路由地址',
  5. `component` varchar(255) DEFAULT NULL COMMENT '组件路径',
  6. `visible` char(1) DEFAULT '0' COMMENT '菜单状态（0显示 1隐藏）',
  7. `status` char(1) DEFAULT '0' COMMENT '菜单状态（0正常 1停用）',
  8. `perms` varchar(255) DEFAULT NULL COMMENT '权限标识',
  9. `icon` varchar(100) DEFAULT '#' COMMENT '菜单图标',
  10. `create_time` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
  11. `modify_time` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
  12. `del_flag` int(11) DEFAULT '0' COMMENT '是否删除（0未删除 1已删除）',
  13. `remark` varchar(500) DEFAULT NULL COMMENT '备注',
  14.  PRIMARY KEY (`id`)
  15. )ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
  16.  
  17. CREATE TABLE `sys_role` (
  18. `id` bigint(200) NOT NULL AUTO_INCREMENT COMMENT '主键',
  19. `name` varchar(64) NOT NULL DEFAULT 'NULL' COMMENT '角色名称',
  20. `role_key` varchar(100) DEFAULT NULL COMMENT '角色权限字符串',
  21. `status` char(1) DEFAULT '0' COMMENT '菜单状态（0正常 1停用）',
  22. `del_flag` int(11) DEFAULT '0' COMMENT '是否删除（0未删除 1已删除）',
  23. `create_time` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
  24. `modify_time` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
  25. `update_by` bigint(200) DEFAULT NULL,
  26. `remark` varchar(500) DEFAULT NULL COMMENT '备注',
  27.  PRIMARY KEY (`id`)
  28. )ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
  29.  
  30. CREATE TABLE `sys_role_menu` (
  31. `role_id` bigint(200) NOT NULL AUTO_INCREMENT COMMENT '角色id',
  32. `menu_id` bigint(200) NOT NULL DEFAULT '0' COMMENT '权限id',
  33.  PRIMARY KEY (`role_id`,`menu_id`)
  34. )ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
  35.  
  36. CREATE TABLE `sys_user` (
  37. `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  38. `user_name` varchar(64) NOT NULL DEFAULT 'NULL' COMMENT '用户名',
  39. `nick_name` varchar(64) NOT NULL DEFAULT 'NULL' COMMENT '昵称',
  40. `password` varchar(64) NOT NULL DEFAULT 'NULL' COMMENT '密码',
  41. `status` char(1) DEFAULT '0' COMMENT '帐号状态（0正常 1停用）',
  42. `email` varchar(64) DEFAULT 'NULL' COMMENT '邮箱',
  43. `mobile` varchar(32) DEFAULT 'NULL' COMMENT '手机号',
  44. `sex` char(1) DEFAULT NULL COMMENT '用户性别（0男，1女，2未知）',
  45. `create_time` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
  46. `modify_time` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
  47. `del_flag` int(11) DEFAULT '0' COMMENT '是否删除（0未删除 1已删除）',
  48. `remark` varchar(500) DEFAULT NULL COMMENT '备注',
  49. PRIMARY KEY (`id`)
  50. )ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
  51.  
  52. CREATE TABLE `sys_user_role` (
  53. `user_id` bigint(200) NOT NULL AUTO_INCREMENT COMMENT '角色id',
  54. `role_id` bigint(200) NOT NULL DEFAULT '0' COMMENT '权限id',
  55. PRIMARY KEY (`user_id`,`role_id`)
  56. )ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; 
  57.  
  58. INSERT INTO `zipkin`.`sys_user` (`id`, `user_name`, `password`, `status`, `create_time`, `modify_time`) VALUES ('1', 'admin', '$2a$10$GoLr2BQF77XaqSM9q3ETqu3fsbaIwOddz4YjvxoL8gGVph486OWmC', '1', '2022-05-26 10:42:58', '2022-05-26 10:42:58');

参考资料：

若依VUE分离版框架：

https://www.wpsshop.cn/w/我家小花儿/article/detail/184011

推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号