devbox
从前慢现在也慢
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

基于spring boot的RBAC超详细实现_springboot rbac

作者：从前慢现在也慢 | 2024-04-16 23:37:06

赞

踩

springboot rbac

基于spring boot + mybatis + jwt + shiro + redis + postgresql的RBAC实现

码云源码地址：https://gitee.com/loveleaveslove/rbac-demo.git。

一、搭建数据库

1、用户表

  1. -- auto-generated definition
  2. create table t_user
  3. (
  4.     id       bigint       not null
  5.         constraint "T_USER_pkey"
  6.             primary key,
  7.     username varchar(64)  not null,
  8.     password varchar(128) not null,
  9.     name     varchar(64),
  10.     roleid   bigint       not null,
  11.     age      integer,
  12.     icon     varchar(128),
  13.     sex      varchar(2),
  14.     phone    varchar(11),
  15.     email    varchar(64),
  16.     area     varchar(128)
  17. );
  18. comment on table t_user is '用户表';
  19. comment on column t_user.id is '用户ID';
  20. comment on column t_user.username is '用户名';
  21. comment on column t_user.password is '用户密码';
  22. comment on column t_user.roleid is '角色ID';
  23. alter table t_user  owner to postgres;
字段类型备注
idserial4用户编号
usernamevarchar用户名
passwordsvarchar用户密码
roleidint4用户权限编号

2、角色表（由于是简单实现其功能，所以此处简单代替）

  1. create table t_role
  2. (
  3.     id       bigint not null
  4.         constraint "T_ROLE_pkey"
  5.             primary key,
  6.     name     varchar(64),
  7.     auths    varchar(128),
  8.     parentid bigint
  9. );
  10. comment on table t_role is '角色表';
  11. comment on column t_role.id is '角色ID ';
  12. comment on column t_role.name is '角色编号';
  13. comment on column t_role.auths is '权限ID';
  14. comment on column t_role.parentid is '父级角色ID';
  15. alter table t_role owner to postgres;
字段类型备注
idserial4角色编号
rolenamevarchar角色名称
authsvarchar角色描述
parentidInteger父级角色ID

二、pom.xml中导入依赖

  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.3.7.RELEASE</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.leaves.auth</groupId>
  12.     <artifactId>rbac-demo</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>rbac-demo</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <!--spring-web-->
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-web</artifactId>
  24.         </dependency>
  25.         <!--spring-reids-->
  26.         <dependency>
  27.             <groupId>org.springframework.boot</groupId>
  28.             <artifactId>spring-boot-starter-data-redis</artifactId>
  29.         </dependency>
  30.         <!--JDBC-->
  31.         <dependency>
  32.             <groupId>org.springframework.boot</groupId>
  33.             <artifactId>spring-boot-starter-jdbc</artifactId>
  34.         </dependency>
  35.         <!--mybatis-->
  36.         <dependency>
  37.             <groupId>org.mybatis.spring.boot</groupId>
  38.             <artifactId>mybatis-spring-boot-starter</artifactId>
  39.             <version>2.1.4</version>
  40.         </dependency>
  41.         <!--postgresql-->
  42.         <dependency>
  43.             <groupId>org.postgresql</groupId>
  44.             <artifactId>postgresql</artifactId>
  45.             <scope>runtime</scope>
  46.         </dependency>
  47.         <!--lombok-->
  48.         <dependency>
  49.             <groupId>org.projectlombok</groupId>
  50.             <artifactId>lombok</artifactId>
  51.             <optional>true</optional>
  52.         </dependency>
  53.         <!--druid-->
  54.         <dependency>
  55.             <groupId>com.alibaba</groupId>
  56.             <artifactId>druid</artifactId>
  57.             <version>1.1.21</version>
  58.         </dependency>
  59.         <!--redis-Jedis-->
  60.         <dependency>
  61.             <groupId>redis.clients</groupId>
  62.             <artifactId>jedis</artifactId>
  63.             <version>2.9.0</version>
  64.         </dependency>
  65.         <!--shiro-reids-->
  66.         <dependency>
  67.             <groupId>org.crazycake</groupId>
  68.             <artifactId>shiro-redis</artifactId>
  69.             <version>3.2.3</version>
  70.         </dependency>
  71.         <!-- Shiro -->
  72.         <dependency>
  73.             <groupId>org.apache.shiro</groupId>
  74.             <artifactId>shiro-spring</artifactId>
  75.             <version>1.3.2</version>
  76.         </dependency>
  77.         <dependency>
  78.             <groupId>org.apache.shiro</groupId>
  79.             <artifactId>shiro-ehcache</artifactId>
  80.             <version>1.2.5</version>
  81.         </dependency>
  82.         <!-- JWT -->
  83.         <dependency>
  84.             <groupId>com.auth0</groupId>
  85.             <artifactId>java-jwt</artifactId>
  86.             <version>3.5.0</version>
  87.         </dependency>
  88.         <!--slf4j-->
  89.         <dependency>
  90.             <groupId>org.slf4j</groupId>
  91.             <artifactId>slf4j-api</artifactId>
  92.             <version>1.7.25</version>
  93.         </dependency>
  94.         <!--上传下载文件-->
  95.         <dependency>
  96.             <groupId>commons-fileupload</groupId>
  97.             <artifactId>commons-fileupload</artifactId>
  98.             <version>1.3.1</version>
  99.         </dependency>
  100.         <dependency>
  101.             <groupId>commons-io</groupId>
  102.             <artifactId>commons-io</artifactId>
  103.             <version>1.4</version>
  104.         </dependency>
  105.         <!--添加通用mapper依赖-->
  106.         <dependency>
  107.             <groupId>tk.mybatis</groupId>
  108.             <artifactId>mapper-spring-boot-starter</artifactId>
  109.             <version>2.1.5</version>
  110.         </dependency>
  111.         <!--添加分页依赖-->
  112.         <dependency>
  113.             <groupId>com.github.pagehelper</groupId>
  114.             <artifactId>pagehelper-spring-boot-starter</artifactId>
  115.             <version>1.2.5</version>
  116.         </dependency>
  117.         <!--工具库hutool库-->
  118.         <!-- https://mvnrepository.com/artifact/cn.hutool/hutool-all -->
  119.         <dependency>
  120.             <groupId>cn.hutool</groupId>
  121.             <artifactId>hutool-all</artifactId>
  122.             <version>5.4.3</version>
  123.         </dependency>
  124.         <dependency>
  125.             <groupId>org.springframework.boot</groupId>
  126.             <artifactId>spring-boot-starter-test</artifactId>
  127.             <scope>test</scope>
  128.             <exclusions>
  129.                 <exclusion>
  130.                     <groupId>org.junit.vintage</groupId>
  131.                     <artifactId>junit-vintage-engine</artifactId>
  132.                 </exclusion>
  133.             </exclusions>
  134.         </dependency>
  135.     </dependencies>
  136. ​
  137.     <build>
  138.         <finalName>RBAC-DEMO</finalName>
  139.         <plugins>
  140.             <plugin>
  141.                 <groupId>org.springframework.boot</groupId>
  142.                 <artifactId>spring-boot-maven-plugin</artifactId>
  143.                 <configuration>
  144.                     <excludes>
  145.                         <exclude>
  146.                             <groupId>org.projectlombok</groupId>
  147.                             <artifactId>lombok</artifactId>
  148.                         </exclude>
  149.                     </excludes>
  150.                 </configuration>
  151.             </plugin>
  152.         </plugins>
  153.     </build>
  154. ​
  155. </project>

三、配置application.yml

  1. #端口号
  2. server:
  3.   port: 8088
  4. spring:
  5.   #数据库连接配置
  6.   datasource:
  7.     driver-class-name: org.postgresql.Driver
  8.     type: com.alibaba.druid.pool.DruidDataSource
  9.     url: jdbc:postgresql://localhost:5432/rbac?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8&socketTimeout=30000
  10.     username: rbac
  11.     password: 123456
  12.     jackson:
  13.       date-format: yyyy-MM-dd HH:mm:ss
  14.       time-zone: GMT+8
  15.   #允许运行程序中存在多个main函数
  16.   main:
  17.     allow-bean-definition-overriding: true
  18.   #Redis
  19.   redis:
  20.     host: localhost
  21.     port: 6379
  22.     database: 0
  23.     jedis:
  24.       pool:
  25.         max-active: 8
  26.         max-idle: 8
  27.         max-wait: -1
  28.         min-idle: 0
  29.     timeout: 3000ms
  30.     #文件上传配置
  31.     autoconfigure:
  32.       exclude: org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration
  33. #mybatis配置
  34. mybatis:
  35.   type-aliases-package: com.leaves.auth.entity
  36.   mapper-locations: classpath*:/mapper/*.xml
  37. #日志等级
  38. logging:
  39.   level:
  40.     com:
  41.       leaves:
  42.         auth:
  43.           mapper: debug
  44.   config: classpath:logback-spring.xml
  45. #文件上传保存地址
  46. upload:
  47.   local:
  48.     path: D:/uploadFile/file

四、工具类redisUitls包

1、Constant

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:   常量
  6.  */
  7. private Constant() {}
  8. ​
  9.     /**
  10.      * redis-OK
  11.      */
  12.     public static final String OK = "OK";
  13. ​
  14.     /**
  15.      * redis过期时间，以秒为单位，一分钟
  16.      */
  17.     public static final int EXRP_MINUTE = 60;
  18. ​
  19.     /**
  20.      * redis过期时间，以秒为单位，一小时
  21.      */
  22.     public static final int EXRP_HOUR = 60 * 60;
  23. ​
  24.     /**
  25.      * redis过期时间，以秒为单位，一天
  26.      */
  27.     public static final int EXRP_DAY = 60 * 60 * 24;
  28. ​
  29.     /**
  30.      * redis-key-前缀-shiro:cache:
  31.      */
  32.     public static final String PREFIX_SHIRO_CACHE = "shiro:cache:";
  33. ​
  34.     /**
  35.      * redis-key-前缀-shiro:access_token:
  36.      */
  37.     public static final String PREFIX_SHIRO_ACCESS_TOKEN = "shiro:access_token:";
  38. ​
  39.     /**
  40.      * redis-key-前缀-shiro:refresh_token:
  41.      */
  42.     public static final String PREFIX_SHIRO_REFRESH_TOKEN = "shiro:refresh_token:";
  43. ​
  44.     /**
  45.      * JWT-account:
  46.      */
  47.     public static final String ACCOUNT = "account";
  48. ​
  49.     /**
  50.      * JWT-currentTimeMillis:
  51.      */
  52.     public static final String CURRENT_TIME_MILLIS = "currentTimeMillis";
  53. ​
  54.     /**
  55.      * PASSWORD_MAX_LEN
  56.      */
  57.     public static final Integer PASSWORD_MAX_LEN = 8;

2、SerializableUtil

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:   Serializable工具(JDK)(也可以使用Protobuf自行百度)
  6.  */
  7. @Slf4j
  8. public class SerializableUtil {
  9. ​
  10.     private SerializableUtil() {}
  11. ​
  12.     /**
  13.      * 序列化
  14.      */
  15.     public static byte[] serializable(Object object) {
  16.         ByteArrayOutputStream baos = null;
  17.         ObjectOutputStream oos = null;
  18.         try {
  19.             baos = new ByteArrayOutputStream();
  20.             oos = new ObjectOutputStream(baos);
  21.             oos.writeObject(object);
  22.             return baos.toByteArray();
  23.         } catch (IOException e) {
  24.             log.error("SerializableUtil工具类序列化出现IOException异常:{}", e.getMessage());
  25.             throw new CustomException("SerializableUtil工具类序列化出现IOException异常:" + e.getMessage());
  26.         } finally {
  27.             try {
  28.                 if (oos != null) {
  29.                     oos.close();
  30.                 }
  31.                 if (baos != null) {
  32.                     baos.close();
  33.                 }
  34.             } catch (IOException e) {
  35.                 log.error("SerializableUtil工具类反序列化出现IOException异常:{}", e.getMessage());
  36.                 throw new CustomException("SerializableUtil工具类反序列化出现IOException异常:" + e.getMessage());
  37.             }
  38.         }
  39.     }
  40. ​
  41.     /**
  42.      * 反序列化
  43.      */
  44.     public static Object unserializable(byte[] bytes) {
  45.         ByteArrayInputStream bais = null;
  46.         ObjectInputStream ois = null;
  47.         try {
  48.             bais = new ByteArrayInputStream(bytes);
  49.             ois = new ObjectInputStream(bais);
  50.             return ois.readObject();
  51.         } catch (ClassNotFoundException e) {
  52.             log.error("SerializableUtil工具类反序列化出现ClassNotFoundException异常:{}", e.getMessage());
  53.             throw new CustomException("SerializableUtil工具类反序列化出现ClassNotFoundException异常:" + e.getMessage());
  54.         } catch (IOException e) {
  55.             log.error("SerializableUtil工具类反序列化出现IOException异常:{}", e.getMessage());
  56.             throw new CustomException("SerializableUtil工具类反序列化出现IOException异常:" + e.getMessage());
  57.         } finally {
  58.             try {
  59.                 if (ois != null) {
  60.                     ois.close();
  61.                 }
  62.                 if (bais != null) {
  63.                     bais.close();
  64.                 }
  65.             } catch (IOException e) {
  66.                 log.error("SerializableUtil工具类反序列化出现IOException异常:{}", e.getMessage());
  67.                 throw new CustomException("SerializableUtil工具类反序列化出现IOException异常:" + e.getMessage());
  68.             }
  69.         }
  70.     }
  71. ​
  72. }

3、StringUtil

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:   String工具
  6.  */
  7. public class StringUtil {
  8. ​
  9.     private StringUtil() {}
  10. ​
  11.     /**
  12.      * 定义下划线
  13.      */
  14.     private static final char UNDERLINE = '_';
  15. ​
  16.     /**
  17.      * String为空判断(不允许空格)
  18.      * @param str
  19.      * @return
  20.      */
  21.     public static boolean isBlank(String str) {
  22.         return str == null || "".equals(str.trim());
  23.     }
  24. ​
  25.     /**
  26.      * String不为空判断(不允许空格)
  27.      * @param str
  28.      * @return
  29.      */
  30.     public static boolean isNotBlank(String str) {
  31.         return !isBlank(str);
  32.     }
  33. ​
  34.     /**
  35.      * Byte数组为空判断
  36.      * @param bytes
  37.      * @return boolean
  38.      */
  39.     public static boolean isNull(byte[] bytes) {
  40.         // 根据byte数组长度为0判断
  41.         return bytes == null || bytes.length == 0;
  42.     }
  43. ​
  44.     /**
  45.      * Byte数组不为空判断
  46.      * @param bytes
  47.      * @return boolean
  48.      */
  49.     public static boolean isNotNull(byte[] bytes) {
  50.         return !isNull(bytes);
  51.     }
  52. ​
  53.     /**
  54.      * 驼峰转下划线工具
  55.      * @param param
  56.      * @return java.lang.String
  57.      */
  58.     public static String camelToUnderline(String param) {
  59.         if (isNotBlank(param)) {
  60.             int len = param.length();
  61.             StringBuilder sb = new StringBuilder(len);
  62.             for (int i = 0; i < len; i++) {
  63.                 char c = param.charAt(i);
  64.                 if (Character.isUpperCase(c)) {
  65.                     sb.append(UNDERLINE);
  66.                     sb.append(Character.toLowerCase(c));
  67.                 } else {
  68.                     sb.append(c);
  69.                 }
  70.             }
  71.             return sb.toString();
  72.         } else {
  73.             return "";
  74.         }
  75.     }
  76. ​
  77.     /**
  78.      * 下划线转驼峰工具
  79.      * @param param
  80.      * @return java.lang.String
  81.      */
  82.     public static String underlineToCamel(String param) {
  83.         if (isNotBlank(param)) {
  84.             int len = param.length();
  85.             StringBuilder sb = new StringBuilder(len);
  86.             for (int i = 0; i < len; i++) {
  87.                 char c = param.charAt(i);
  88.                 if (c == 95) {
  89.                     i++;
  90.                     if (i < len) {
  91.                         sb.append(Character.toUpperCase(param.charAt(i)));
  92.                     }
  93.                 } else {
  94.                     sb.append(c);
  95.                 }
  96.             }
  97.             return sb.toString();
  98.         } else {
  99.             return "";
  100.         }
  101.     }
  102. ​
  103.     /**
  104.      * 在字符串两周添加''
  105.      * @param param
  106.      * @return java.lang.String
  107.      */
  108.     public static String addSingleQuotes(String param) {
  109.         return "\'" + param + "\'";
  110.     }
  111. }

五、配置类redis

1、JedisConfig

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年11月02日 15时22分18秒
  4.  * @Version 1.0
  5.  */
  6. @Configuration
  7. public class JedisConfig {
  8. ​
  9.     @Value("${spring.redis.host}")
  10.     private String host;
  11.     @Value("${spring.redis.port}")
  12.     private int port ;
  13.     @Bean
  14.     public Jedis getJedis(){
  15.        return  new Jedis("127.0.0.1",6379);
  16.     }
  17. //    封装jedispool对象（将配置对象注入其中）
  18.     @Bean
  19.     public JedisPool jedisPool(@Qualifier("jedisPoolConfig") JedisPoolConfig jedisPoolConfig ){
  20.         JedisPool pool = new JedisPool(jedisPoolConfig,host,port);
  21.         return pool;
  22.     }
  23. //    封装jedispool配置对象
  24.     @Bean("jedisPoolConfig")
  25.     public JedisPoolConfig jedisPoolConfig(){
  26.         JedisPoolConfig poolConfig = new JedisPoolConfig();
  27.         poolConfig.setMaxIdle(1);
  28.         poolConfig.setMaxTotal(10);
  29.         return poolConfig;
  30.     }
  31. }

2、JedisUtil

  1. /**
  2.  * 封装常见的jedis操作接口
  3.  * @Author: LEAVES
  4.  * @Date: 2020年11月02日 15时22分18秒
  5.  * @Version 1.0
  6.  */
  7.  
  8. @Component
  9. public class JedisUtil {
  10.     /**
  11.      * 静态注入JedisPool连接池
  12.      * 本来是正常注入JedisUtil，可以在Controller和Service层使用，但是重写Shiro的CustomCache无法注入JedisUtil
  13.      * 现在改为静态注入JedisPool连接池，JedisUtil直接调用静态方法即可
  14.      * https://blog.csdn.net/W_Z_W_888/article/details/79979103
  15.      */
  16.     private static JedisPool jedisPool;
  17.  
  18.     @Autowired
  19.     public void setJedisPool(JedisPool jedisPool) {
  20.         JedisUtil.jedisPool = jedisPool;
  21.     }
  22.  
  23.     /**
  24.      * 获取Jedis实例
  25.      * @param
  26.      * @return redis.clients.jedis.Jedis
  27.      * @Author: LEAVES
  28.      * @Date: 2020年11月02日 15时22分18秒
  29.      */
  30.     public static synchronized Jedis getJedis() {
  31.         try {
  32.             if (jedisPool != null) {
  33.                 return jedisPool.getResource();
  34.             } else {
  35.                 return null;
  36.             }
  37.         } catch (Exception e) {
  38.             throw new CustomException("获取Jedis资源异常:" + e.getMessage());
  39.         }
  40.     }
  41.  
  42.     /**
  43.      * 释放Jedis资源
  44.      * @param
  45.      * @return void
  46.      * @Author: LEAVES
  47.      * @Date: 2020年11月02日 15时22分18秒
  48.      */
  49.     public static void closePool() {
  50.         try {
  51.             jedisPool.close();
  52.         } catch (Exception e) {
  53.             throw new CustomException("释放Jedis资源异常:" + e.getMessage());
  54.         }
  55.     }
  56.  
  57.     /**
  58.      * 获取redis键值-object
  59.      * @param key
  60.      * @return java.lang.Object
  61.      * @Author: LEAVES
  62.      * @Date: 2020年11月02日 15时22分18秒
  63.      */
  64.     public static Object getObject(String key) {
  65.         try (Jedis jedis = jedisPool.getResource()) {
  66.             byte[] bytes = jedis.get(key.getBytes());
  67.             if (StringUtil.isNotNull(bytes)) {
  68.                 return SerializableUtil.unserializable(bytes);
  69.             }
  70.         } catch (Exception e) {
  71.             throw new CustomException("获取Redis键值getObject方法异常:key=" + key + " cause=" + e.getMessage());
  72.         }
  73.         return null;
  74.     }
  75.  
  76.     /**
  77.      * 设置redis键值-object
  78.      * @param key
  79.      * @param value
  80.      * @return java.lang.String
  81.      * @Author: LEAVES
  82.      * @Date: 2020年11月02日 15时22分18秒
  83.      */
  84.     public static String setObject(String key, Object value) {
  85.         try (Jedis jedis = jedisPool.getResource()) {
  86.             return jedis.set(key.getBytes(), SerializableUtil.serializable(value));
  87.         } catch (Exception e) {
  88.             throw new CustomException("设置Redis键值setObject方法异常:key=" + key + " value=" + value + " cause=" + e.getMessage());
  89.         }
  90.     }
  91.  
  92.     /**
  93.      * 设置redis键值-object-expiretime
  94.      * @param key
  95.      * @param value
  96.      * @param expiretime
  97.      * @return java.lang.String
  98.      * @Author: LEAVES
  99.      * @Date: 2020年11月02日 15时22分18秒
  100.      */
  101.     public static String setObject(String key, Object value, int expiretime) {
  102.         String result;
  103.         try (Jedis jedis = jedisPool.getResource()) {
  104.             result = jedis.set(key.getBytes(), SerializableUtil.serializable(value));
  105.             if (Constant.OK.equals(result)) {
  106.                 jedis.expire(key.getBytes(), expiretime);
  107.             }
  108.             return result;
  109.         } catch (Exception e) {
  110.             throw new CustomException("设置Redis键值setObject方法异常:key=" + key + " value=" + value + " cause=" + e.getMessage());
  111.         }
  112.     }
  113.  
  114.     /**
  115.      * 获取redis键值-Json
  116.      * @param key
  117.      * @return java.lang.Object
  118.      * @Author: LEAVES
  119.      * @Date: 2020年11月02日 15时22分18秒
  120.      */
  121.     public static String getJson(String key) {
  122.         try (Jedis jedis = jedisPool.getResource()) {
  123.             return jedis.get(key);
  124.         } catch (Exception e) {
  125.             throw new CustomException("获取Redis键值getJson方法异常:key=" + key + " cause=" + e.getMessage());
  126.         }
  127.     }
  128.  
  129.     /**
  130.      * 设置redis键值-Json
  131.      * @param key
  132.      * @param value
  133.      * @return java.lang.String
  134.      * @Author: LEAVES
  135.      * @Date: 2020年11月02日 15时22分18秒
  136.      */
  137.     public static String setJson(String key, String value) {
  138.         try (Jedis jedis = jedisPool.getResource()) {
  139.             return jedis.set(key, value);
  140.         } catch (Exception e) {
  141.             throw new CustomException("设置Redis键值setJson方法异常:key=" + key + " value=" + value + " cause=" + e.getMessage());
  142.         }
  143.     }
  144.  
  145.     /**
  146.      * 设置redis键值-Json-expiretime
  147.      * @param key
  148.      * @param value
  149.      * @param expiretime
  150.      * @return java.lang.String
  151.      * @Author: LEAVES
  152.      * @Date: 2020年11月02日 15时22分18秒
  153.      */
  154.     public static String setJson(String key, String value, int expiretime) {
  155.         String result;
  156.         try (Jedis jedis = jedisPool.getResource()) {
  157.             result = jedis.set(key, value);
  158.             if (Constant.OK.equals(result)) {
  159.                 jedis.expire(key, expiretime);
  160.             }
  161.             return result;
  162.         } catch (Exception e) {
  163.             throw new CustomException("设置Redis键值setJson方法异常:key=" + key + " value=" + value + " cause=" + e.getMessage());
  164.         }
  165.     }
  166.  
  167.     /**
  168.      * 删除key
  169.      * @param key
  170.      * @return java.lang.Long
  171.      * @Author: LEAVES
  172.      * @Date: 2020年11月02日 15时22分18秒
  173.      */
  174.     public static Long delKey(String key) {
  175.         try (Jedis jedis = jedisPool.getResource()) {
  176.             return jedis.del(key.getBytes());
  177.         } catch (Exception e) {
  178.             throw new CustomException("删除Redis的键delKey方法异常:key=" + key + " cause=" + e.getMessage());
  179.         }
  180.     }
  181.  
  182.     /**
  183.      * key是否存在
  184.      * @param key
  185.      * @return java.lang.Boolean
  186.      * @Author: LEAVES
  187.      * @Date: 2020年11月02日 15时22分18秒
  188.      */
  189.     public static Boolean exists(String key) {
  190.         try (Jedis jedis = jedisPool.getResource()) {
  191.             return jedis.exists(key.getBytes());
  192.         } catch (Exception e) {
  193.             throw new CustomException("查询Redis的键是否存在exists方法异常:key=" + key + " cause=" + e.getMessage());
  194.         }
  195.     }
  196.  
  197.     /**
  198.      * 模糊查询获取key集合(keys的速度非常快，但在一个大的数据库中使用它仍然可能造成性能问题，生产不推荐使用)
  199.      * @param key
  200.      * @return java.util.Set<java.lang.String>
  201.      * @Author: LEAVES
  202.      * @Date: 2020年11月02日 15时22分18秒
  203.      */
  204.     public static Set<String> keysS(String key) {
  205.         try (Jedis jedis = jedisPool.getResource()) {
  206.             return jedis.keys(key);
  207.         } catch (Exception e) {
  208.             throw new CustomException("模糊查询Redis的键集合keysS方法异常:key=" + key + " cause=" + e.getMessage());
  209.         }
  210.     }
  211.  
  212.     /**
  213.      * 模糊查询获取key集合(keys的速度非常快，但在一个大的数据库中使用它仍然可能造成性能问题，生产不推荐使用)
  214.      * @param key
  215.      * @return java.util.Set<java.lang.String>
  216.      * @Author: LEAVES
  217.      * @Date: 2020年11月02日 15时22分18秒
  218.      */
  219.     public static Set<byte[]> keysB(String key) {
  220.         try (Jedis jedis = jedisPool.getResource()) {
  221.             return jedis.keys(key.getBytes());
  222.         } catch (Exception e) {
  223.             throw new CustomException("模糊查询Redis的键集合keysB方法异常:key=" + key + " cause=" + e.getMessage());
  224.         }
  225.     }
  226.  
  227.     /**
  228.      * 获取过期剩余时间
  229.      * @param key
  230.      * @return java.lang.String
  231.      * @Author: LEAVES
  232.      * @Date: 2020年11月02日 15时22分18秒
  233.      */
  234.     public static Long ttl(String key) {
  235.         Long result = -2L;
  236.         try (Jedis jedis = jedisPool.getResource()) {
  237.             result = jedis.ttl(key);
  238.             return result;
  239.         } catch (Exception e) {
  240.             throw new CustomException("获取Redis键过期剩余时间ttl方法异常:key=" + key + " cause=" + e.getMessage());
  241.         }
  242.     }
  243. }

3、RedisOperator

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年11月02日 15时22分18秒
  4.  * @Version 1.0
  5.  * @Description: 使用redisTemplate的操作实现类
  6.  */
  7. @Component
  8. public class RedisOperator {
  9.  
  10.     @Resource
  11.     private StringRedisTemplate redisTemplate;
  12.  
  13.     // Key（键），简单的key-value操作
  14.  
  15.     /**
  16.      * 实现命令：TTL key，以秒为单位，返回给定 key的剩余生存时间(TTL, time to live)。
  17.      *
  18.      * @param key
  19.      * @return
  20.      */
  21.     public long ttl(String key) {
  22.         return redisTemplate.getExpire(key);
  23.     }
  24.  
  25.     /**
  26.      * 实现命令：expire 设置过期时间，单位秒
  27.      *
  28.      * @param key
  29.      * @return
  30.      */
  31.     public void expire(String key, long timeout) {
  32.         redisTemplate.expire(key, timeout, TimeUnit.SECONDS);
  33.     }
  34.  
  35.     /**
  36.      * 实现命令：INCR key，增加key一次
  37.      *
  38.      * @param key
  39.      * @return
  40.      */
  41.     public long incr(String key, long delta) {
  42.         return redisTemplate.opsForValue().increment(key, delta);
  43.     }
  44.  
  45.     /**
  46.      * 实现命令：KEYS pattern，查找所有符合给定模式 pattern的 key
  47.      */
  48.     public Set<String> keys(String pattern) {
  49.         return redisTemplate.keys(pattern);
  50.     }
  51.  
  52.     /**
  53.      * 实现命令：DEL key，删除一个key
  54.      *
  55.      * @param key
  56.      */
  57.     public void del(String key) {
  58.         redisTemplate.delete(key);
  59.     }
  60.  
  61.     // String（字符串）
  62.  
  63.     /**
  64.      * 实现命令：SET key value，设置一个key-value（将字符串值 value关联到 key）
  65.      *
  66.      * @param key
  67.      * @param value
  68.      */
  69.     public void set(String key, String value) {
  70.         redisTemplate.opsForValue().set(key, value);
  71.     }
  72.  
  73.     /**
  74.      * 实现命令：SET key value EX seconds，设置key-value和超时时间（秒）
  75.      *
  76.      * @param key
  77.      * @param value
  78.      * @param timeout
  79.      *            （以秒为单位）
  80.      */
  81.     public void set(String key, String value, long timeout) {
  82.         redisTemplate.opsForValue().set(key, value, timeout, TimeUnit.SECONDS);
  83.     }
  84.  
  85.     /**
  86.      * 实现命令：GET key，返回 key所关联的字符串值。
  87.      *
  88.      * @param key
  89.      * @return value
  90.      */
  91.     public String get(String key) {
  92.         return (String)redisTemplate.opsForValue().get(key);
  93.     }
  94.  
  95.     // Hash（哈希表）
  96.  
  97.     /**
  98.      * 实现命令：HSET key field value，将哈希表 key中的域 field的值设为 value
  99.      *
  100.      * @param key
  101.      * @param field
  102.      * @param value
  103.      */
  104.     public void hset(String key, String field, Object value) {
  105.         redisTemplate.opsForHash().put(key, field, value);
  106.     }
  107.  
  108.     /**
  109.      * 实现命令：HGET key field，返回哈希表 key中给定域 field的值
  110.      *
  111.      * @param key
  112.      * @param field
  113.      * @return
  114.      */
  115.     public String hget(String key, String field) {
  116.         return (String) redisTemplate.opsForHash().get(key, field);
  117.     }
  118.  
  119.     /**
  120.      * 实现命令：HDEL key field [field ...]，删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。
  121.      *
  122.      * @param key
  123.      * @param fields
  124.      */
  125.     public void hdel(String key, Object... fields) {
  126.         redisTemplate.opsForHash().delete(key, fields);
  127.     }
  128.  
  129.     /**
  130.      * 实现命令：HGETALL key，返回哈希表 key中，所有的域和值。
  131.      *
  132.      * @param key
  133.      * @return
  134.      */
  135.     public Map<Object, Object> hgetall(String key) {
  136.         return redisTemplate.opsForHash().entries(key);
  137.     }
  138.  
  139.     // List（列表）
  140.  
  141.     /**
  142.      * 实现命令：LPUSH key value，将一个值 value插入到列表 key的表头
  143.      *
  144.      * @param key
  145.      * @param value
  146.      * @return 执行 LPUSH命令后，列表的长度。
  147.      */
  148.     public long lpush(String key, String value) {
  149.         return redisTemplate.opsForList().leftPush(key, value);
  150.     }
  151.  
  152.     /**
  153.      * 实现命令：LPOP key，移除并返回列表 key的头元素。
  154.      *
  155.      * @param key
  156.      * @return 列表key的头元素。
  157.      */
  158.     public String lpop(String key) {
  159.         return (String)redisTemplate.opsForList().leftPop(key);
  160.     }
  161.  
  162.     /**
  163.      * 实现命令：RPUSH key value，将一个值 value插入到列表 key的表尾(最右边)。
  164.      *
  165.      * @param key
  166.      * @param value
  167.      * @return 执行 LPUSH命令后，列表的长度。
  168.      */
  169.     public long rpush(String key, String value) {
  170.         return redisTemplate.opsForList().rightPush(key, value);
  171.     }
  172.  
  173.     //zset
  174.  
  175.     /**
  176.      * 实现命令：zset存入值
  177.      * @param key
  178.      * @param value
  179.      * @param score
  180.      */
  181.     public void zSet(String key, String value, double score){
  182.         redisTemplate.opsForZSet().add(key,value,score);
  183.     }
  184.  
  185.     public Set<String> zGet(String key, long start, long end){
  186.         return  redisTemplate.opsForZSet().range(key,start,end);
  187.     }
  188. }

六、统一异常处理Exception

1、CustomException

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:   自定义异常(CustomException)
  6.  */
  7. public class CustomException extends AuthenticationException {
  8.  
  9.     public CustomException(String msg){
  10.         super(msg);
  11.     }
  12.  
  13.     public CustomException() {
  14.         super();
  15.     }
  16. }

2、DefaultExceptionHandler

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:   自定义异常处理器
  6.  */
  7. @Slf4j
  8. @ControllerAdvice  //不指定包默认加了@Controller和@RestController都能控制
  9. public class DefaultExceptionHandler {
  10.  
  11.     /**
  12.      * @param  ex
  13.      * @Description: 运行时异常
  14.      */
  15.     @ExceptionHandler(com.leaves.auth.exception.CustomException.class)
  16.     public ResponseData CustomExceptionHandler(com.leaves.auth.exception.CustomException ex) {
  17.         log.error(ex.getMessage(), ex);
  18.         ResponseData responseData=new ResponseData<>();
  19.         responseData.setCode(400);
  20.         responseData.setMsg(ex.getMessage());
  21.         return responseData;
  22.     }
  23.  
  24.     /**
  25.      * @param  ex
  26.      * @Description: 权限认证异常
  27.      */
  28.     @ExceptionHandler(UnauthorizedException.class)
  29.     @ResponseBody
  30.     public ResponseData unauthorizedExceptionHandler(Exception ex) {
  31.         log.error(ex.getMessage(), ex);
  32.         return ResponseDataUtil.fail("对不起，您没有相关权限！");
  33.     }
  34.  
  35.     @ExceptionHandler(UnauthenticatedException.class)
  36.     @ResponseBody
  37.     public ResponseData unauthenticatedException(UnauthenticatedException ex) {
  38.         log.error(ex.getMessage(), ex);
  39.         return ResponseDataUtil.fail("对不起，您未登录！");
  40.     }
  41.  
  42.     /**
  43.      *
  44.      * @param ex
  45.      * @return
  46.      */
  47.     @ExceptionHandler(AuthorizationException.class)
  48.     @ResponseBody
  49.     public ResponseData authorizationException(AuthorizationException ex) {
  50.         log.error(ex.getMessage(), ex);
  51.         return ResponseDataUtil.fail("无效token，请重新登录！");
  52.     }
  53.  
  54.     /**
  55.      * 空指针异常
  56.      * @param ex
  57.      * @return
  58.      */
  59.     @ExceptionHandler(NullPointerException.class)
  60.     @ResponseBody
  61.     public ResponseData nullPointerException(NullPointerException ex) {
  62.         log.error(ex.getMessage(), ex);
  63.         return ResponseDataUtil.fail(500,"空指针异常！");
  64.     }
  65.  
  66.     /**
  67.      * 认证异常
  68.      * @param ex
  69.      * @return
  70.      */
  71.     @ExceptionHandler(AuthenticationException.class)
  72.     @ResponseBody
  73.     public ResponseData authenticationException(AuthenticationException ex) {
  74.         log.error(ex.getMessage(), ex);
  75.         return ResponseDataUtil.fail("token为空，请重新登录！");
  76.     }
  77.  
  78.     /**
  79.      * 文件上传异常
  80.      * @param ex
  81.      * @return
  82.      */
  83.     @ExceptionHandler(IOException.class)
  84.     @ResponseBody
  85.     public ResponseData ioException(IOException ex) {
  86.         log.error(ex.getMessage(), ex);
  87.         return ResponseDataUtil.fail("文件上传异常！");
  88.     }
  89.  
  90.     /**
  91.      * 异常统一自定义处理
  92.      */
  93.     @ExceptionHandler({MyException.class})
  94.     @ResponseBody
  95.     public ResponseData MyException(MyException e) {
  96.         return ResponseDataUtil.fail(500,e.getMessage());
  97.     }
  98.  
  99.     /**
  100.      * 异常统一处理(最后的异常处理)
  101.      */
  102.     @ExceptionHandler({Exception.class})
  103.     @ResponseStatus(HttpStatus.OK)
  104.     @ResponseBody
  105.     public ResponseData allException(Exception e) {
  106.         log.info(e.getMessage());
  107.         return ResponseDataUtil.fail(500,"系统异常！");
  108.     }
  109. }

3、MyException

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:   自定义异常
  6.  */
  7. @Data
  8. public class MyException extends RuntimeException {
  9.  
  10.     /**
  11.      * 自定义返回状态码
  12.      */
  13.     private Integer code;
  14.  
  15.  
  16.     /**
  17.      * 返回自定义的状态码和异常描述
  18.      * @param code
  19.      * @param message
  20.      */
  21.     public MyException(Integer code, String message) {
  22.         super(message);
  23.         this.code = code;
  24.     }
  25.  
  26.     /**
  27.      * 只返回异常信息(默认返回500)
  28.      * @param message
  29.      */
  30.     public MyException(String message) {
  31.  
  32.         super(message);
  33.     }
  34. }

七、统一返回格式response

1、ResponseData

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:    统一返回格式
  6.  */
  7. @Data
  8. public class ResponseData<T> {
  9.  
  10.     /**
  11.      * 统一返回码
  12.      */
  13.     public Integer code;
  14.  
  15.     /**
  16.      * 统一消息
  17.      */
  18.     public String msg;
  19.  
  20.     /**
  21.      * 结果对象
  22.      */
  23.     @JsonInclude(JsonInclude.Include.NON_NULL)
  24.     public T data;
  25.  
  26. }

2、ResponseDataUtil

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时06分23秒
  4.  * @Version 1.0
  5.  * @Description:    统一返回格式封装
  6.  */
  7. @Slf4j
  8. public class ResponseDataUtil {
  9.  
  10.     /**
  11.      * 返回成功的描述      状态码、说明
  12.      * @param msg
  13.      * @return
  14.      */
  15.     public static ResponseData success(String msg){
  16.         ResponseData responseData = new ResponseData();
  17.         responseData.setCode(200);
  18.         responseData.setMsg(msg);
  19.         return responseData;
  20.     }
  21.  
  22.     /**
  23.      * 返回成功的描述      状态码、说明
  24.      * @param code
  25.      * @param msg
  26.      * @return
  27.      */
  28.     public static <T> ResponseData success(Integer code, String msg){
  29.         ResponseData responseData = new ResponseData();
  30.         responseData.setCode(code);
  31.         responseData.setMsg(msg);
  32.         return responseData;
  33.     }
  34.  
  35.     /**
  36.      * 返回成功的描述      状态码、说明、数据
  37.      * @param msg
  38.      * @param data
  39.      * @param <T>
  40.      * @return
  41.      */
  42.     public static <T> ResponseData success(String msg, T data){
  43.         ResponseData responseData = new ResponseData();
  44.         responseData.setCode(200);
  45.         responseData.setMsg(msg);
  46.         responseData.setData(data);
  47.         return responseData;
  48.     }
  49.  
  50.     /**
  51.      * 返回成功的描述      状态码、说明、令牌
  52.      * @param code
  53.      * @param msg
  54.      * @param data
  55.      * @param <T>
  56.      * @return
  57.      */
  58.     public static <T> ResponseData success(Integer code, String msg, T data){
  59.         ResponseData responseData = new ResponseData();
  60.         responseData.setCode(code);
  61.         responseData.setMsg(msg);
  62.         responseData.setData(data);
  63.         return responseData;
  64.     }
  65.  
  66.     /**
  67.      * 返回失败的描述  状态码
  68.      * @param msg
  69.      * @return
  70.      */
  71.     public static ResponseData fail(String msg){
  72.         ResponseData responseData=new ResponseData();
  73.         responseData.setCode(405);
  74.         responseData.setMsg(msg);
  75.         return responseData;
  76.     }
  77.  
  78.     /**
  79.      * 返回失败的描述  状态码、说明
  80.      * @param code
  81.      * @param msg
  82.      * @return
  83.      */
  84.     public static ResponseData fail(Integer code, String msg){
  85.         ResponseData responseData=new ResponseData();
  86.         responseData.setCode(code);
  87.         responseData.setMsg(msg);
  88.         return responseData;
  89.     }
  90.  
  91.     /**
  92.      * 返回失败的描述  状态码、说明
  93.      * @param code
  94.      * @param msg
  95.      * @param data
  96.      * @param <T>
  97.      * @return
  98.      */
  99.     public static <T> ResponseData fail(Integer code, String msg, T data){
  100.         ResponseData responseData=new ResponseData();
  101.         responseData.setCode(code);
  102.         responseData.setMsg(msg);
  103.         responseData.setData(data);
  104.         return responseData;
  105.     }
  106. }

八、工具类

1、IsNotEmptyUtil

  1. * @Author: LEAVES
  2.  * @Date: 2020年12月30日 14时29分15秒
  3.  * @Version 1.0
  4.  * @Description:    非空判断
  5.  */
  6. public class IsNotEmptyUtil {
  7.     public static boolean isEmpty(Object object) {
  8.         if (object == null) {
  9.             return (true);
  10.         }
  11.         if ("".equals(object)) {
  12.             return (true);
  13.         }
  14.         if ("null".equals(object)) {
  15.             return (true);
  16.         }
  17.         return (false);
  18.     }
  19.  
  20.     public static boolean isNotEmpty(Object object) {
  21.         if (object != null && !object.equals("") && !object.equals("null")) {
  22.             return (true);
  23.         }
  24.         return (false);
  25.     }
  26. }

2、MD5

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 17时55分06秒
  4.  * @Version 1.0
  5.  * @Description:     MD5加密
  6.  */
  7. public class MD5Util {
  8.  
  9.     /***
  10.      * MD5加码 生成32位md5码
  11.      */
  12.     public static String string2MD5(String inStr) {
  13.         MessageDigest md5 = null;
  14.         try {
  15.             md5 = MessageDigest.getInstance("MD5");
  16.         } catch (Exception e) {
  17.             System.out.println(e.toString());
  18.             e.printStackTrace();
  19.             return "";
  20.         }
  21.         char[] charArray = inStr.toCharArray();
  22.         byte[] byteArray = new byte[charArray.length];
  23.  
  24.         for (int i = 0; i < charArray.length; i++) {
  25.             byteArray[i] = (byte) charArray[i];
  26.         }
  27.         byte[] md5Bytes = md5.digest(byteArray);
  28.         StringBuffer hexValue = new StringBuffer();
  29.         for (int i = 0; i < md5Bytes.length; i++) {
  30.             int val = ((int) md5Bytes[i]) & 0xff;
  31.             if (val < 16){
  32.                 hexValue.append("0");
  33.             }
  34.             hexValue.append(Integer.toHexString(val));
  35.         }
  36.         return hexValue.toString();
  37.  
  38.     }
  39.  
  40.     /**
  41.      * 加密解密算法 执行一次加密，两次解密
  42.      */
  43.     public static String convertMD5(String inStr) {
  44.  
  45.         char[] a = inStr.toCharArray();
  46.         for (int i = 0; i < a.length; i++) {
  47.             a[i] = (char) (a[i] ^ 't');
  48.         }
  49.         String s = new String(a);
  50.         return s;
  51.  
  52.     }
  53. }

3、含有NULL值属性对象转JSON时使其变成空字符串

  1. /**
  2.  * 处理返回值中的null值
  3.  * @Author: LEAVES
  4.  * @Date: 2020年12月30日 11时06分23秒
  5.  * @Version 1.0
  6.  */
  7. //@EnableWebMvc
  8. @Configuration
  9. public class JsonConfig {
  10.  
  11.     @Bean
  12.     public MappingJackson2HttpMessageConverter mappingJacksonHttpMessageConverter() {
  13.  
  14.         final MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
  15.  
  16.         ObjectMapper mapper = converter.getObjectMapper();
  17.  
  18.         // 为mapper注册一个带有SerializerModifier的Factory，此modifier主要做的事情为：当序列化类型为array，list、set时，当值为空时，序列化成[]
  19.         mapper.setSerializerFactory(mapper.getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));
  20.  
  21.         return converter;
  22.     }
  23.  
  24. }
  1. /**
  2.  * 该类控制将null值处理成空集合还是空字符串
  3.  * @Author: LEAVES
  4.  * @Date: 2020年12月30日 11时06分23秒
  5.  * @Version 1.0
  6.  */
  7. public class MyBeanSerializerModifier extends BeanSerializerModifier {
  8.  
  9.     //  数组类型
  10.     private JsonSerializer _nullArrayJsonSerializer = new MyNullArrayJsonSerializer();
  11.     // 字符串等类型
  12.     private JsonSerializer _nullJsonSerializer = new MyNullJsonSerializer();
  13.     // 对象类型
  14.     private JsonSerializer _nullObjectSerializer = new MyNullObjectJsonSerializer();
  15.  
  16.     @Override
  17.     public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc,
  18.                                                      List beanProperties) {
  19.         //循环所有的beanPropertyWriter
  20.         for (int i = 0; i < beanProperties.size(); i++) {
  21.             BeanPropertyWriter writer = (BeanPropertyWriter) beanProperties.get(i);
  22.             //判断字段的类型，如果是array，list，set则注册nullSerializer
  23.             if (isArrayType(writer)) {
  24.                 //给writer注册一个自己的nullSerializer
  25.                 writer.assignNullSerializer(this._nullArrayJsonSerializer);
  26.             } else if(isStringOrNumberType(writer)){
  27.                 writer.assignNullSerializer(this._nullJsonSerializer);
  28.             }else{
  29.                 writer.assignNullSerializer(this._nullObjectSerializer);
  30.             }
  31.         }
  32.         return beanProperties;
  33.     }
  34.  
  35.     //判断是什么类型
  36.     protected boolean isArrayType(BeanPropertyWriter writer) {
  37.         Class clazz = writer.getPropertyType();
  38.         return clazz.isArray() || clazz.equals(List.class) || clazz.equals(Set.class);
  39.     }
  40.  
  41.     //判断是什么类型
  42.     protected boolean isStringOrNumberType(BeanPropertyWriter writer) {
  43.         Class clazz = writer.getPropertyType();
  44.         return clazz.equals(String.class) || clazz.equals(Integer.class) || clazz.equals(int.class) || clazz.equals(Double.class) || clazz.equals(Short.class)
  45.                 || clazz.equals(Long.class) || clazz.equals(short.class) || clazz.equals(double.class) || clazz.equals(long.class) || clazz.equals(Date.class)
  46.                 || clazz.equals(BigDecimal.class);
  47.     }
  48. }
  1. /**
  2.  * 处理数组类型的null值
  3.  * @Author: LEAVES
  4.  * @Date: 2020年12月30日 11时06分23秒
  5.  * @Version 1.0
  6.  */
  7. public class MyNullArrayJsonSerializer extends JsonSerializer {
  8.  
  9.     @Override
  10.     public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
  11.         if (value == null) {
  12.             jgen.writeStartArray();
  13.             jgen.writeEndArray();
  14.         }
  15.     }
  16. }
  1. /**
  2.  * 处理字符串等类型的null值
  3.  * @Author: LEAVES
  4.  * @Date: 2020年12月30日 11时06分23秒
  5.  * @Version 1.0
  6.  */
  7. public class MyNullJsonSerializer extends JsonSerializer {
  8.  
  9.     @Override
  10.     public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
  11.             throws IOException, JsonProcessingException {
  12.         jsonGenerator.writeString("");
  13.     }
  14. }
  1. /**
  2.  * 处理对象类型的null值
  3.  * @Author: LEAVES
  4.  * @Date: 2020年12月30日 11时06分23秒
  5.  * @Version 1.0
  6.  */
  7. public class MyNullObjectJsonSerializer extends JsonSerializer {
  8.     @Override
  9.     public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
  10.             throws IOException, JsonProcessingException {
  11.         jsonGenerator.writeStartObject();
  12.         jsonGenerator.writeEndObject();
  13.     }
  14. }

九 、JWT

1、JwtToken

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 14时25分08秒
  4.  * @Version 1.0
  5.  * @Description:    Authentication-Token： shiro中负责把username,password生成用于验证的token的封装类，需要自定义一个对象用来包装token。
  6.  */
  7. public class JwtToken implements AuthenticationToken {
  8.  
  9.     private String token;
  10.  
  11.     public JwtToken(String token){
  12.         this.token = token;
  13.     }
  14.  
  15.     @Override
  16.     public Object getPrincipal() {
  17.         return token;
  18.     }
  19.  
  20.     @Override
  21.     public Object getCredentials() {
  22.         return token;
  23.     }
  24. }

2、JwtUtil

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 14时25分08秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. @Slf4j
  8. public class JwtUtil {
  9.  
  10.     //token过期时间     5小时
  11.     private static final long EXPIRE_TIME = 1000 * 60 * 60 * 5;
  12.     //redis中token过期时间   12小时
  13.     public static final Integer REFRESH_EXPIRE_TIME = 60 * 60 * 12;
  14.     //token密钥(自定义)
  15.     private static final String TOKEN_SECRET = "^/zxc*123!@#$%^&*/";
  16.  
  17.  
  18.     /**
  19.      * 校验token是否正确
  20.      * @param token token
  21.      * @param username 用户名
  22.      * @return 是否正确
  23.      */
  24.     public static boolean verify(String token, String username){
  25.         log.info("JwtUtil==verify--->");
  26.         try {
  27.             log.info("JwtUtil==verify--->校验token是否正确");
  28.             //根据密码生成JWT效验器
  29.             Algorithm algorithm = Algorithm.HMAC256(TOKEN_SECRET); //秘钥是密码则省略
  30.             JWTVerifier verifier = JWT.require(algorithm)
  31.                     .withClaim("username", username)
  32. //                    .withClaim("secret",secret)  //秘钥是密码直接传入
  33.                     .build();
  34.             //效验TOKEN
  35.             DecodedJWT jwt = verifier.verify(token);
  36.             log.info("JwtUtil==verify--->jwt = "+jwt.toString());
  37.             log.info("JwtUtil==verify--->JwtUtil验证token成功!");
  38.             return true;
  39.         }catch (Exception e){
  40.             log.error("JwtUtil==verify--->JwtUtil验证token失败!");
  41.             return false;
  42.         }
  43.     }
  44.  
  45.     /**
  46.      * 获取token中的信息（包含用户名）
  47.      * @param token
  48.      * @return
  49.      */
  50.     public static String getUsername(String token) {
  51.         log.info("JwtUtil==getUsername--->");
  52.         if (IsNotEmptyUtil.isEmpty(token)){
  53.             log.error("JwtUtil==getUsername--->token无效或token中未包含用户信息！ ");
  54.             throw new AuthenticationException("认证失败，token无效或token中未包含用户信息！");
  55.         }
  56.         try {
  57.             DecodedJWT jwt = JWT.decode(token);
  58.             System.out.println("token = " + jwt.getToken());
  59.             log.info("JwtUtil==getUsername--->username = "+jwt.getClaim("username").asString());
  60.             return jwt.getClaim("username").asString();
  61.         } catch (JWTDecodeException e) {
  62.             log.error("JwtUtil==getUsername--->JWTDecodeException: " + e.getMessage());
  63.             return null;
  64.         }
  65.     }
  66.  
  67.     /**
  68.      * 生成token签名
  69.      * EXPIRE_TIME 分钟后过期
  70.      * @param username 用户名
  71.      * @return 加密的token
  72.      */
  73.     public static String sign(String username) {
  74.         log.info("JwtUtil==sign--->");
  75.         Map<String, Object> header = new HashMap<>();
  76.         header.put("type","Jwt");
  77.         header.put("alg","HS256");
  78.         long currentTimeMillis = System.currentTimeMillis();
  79.         //设置token过期时间
  80.         Date date = new Date(currentTimeMillis + EXPIRE_TIME);
  81.         Algorithm algorithm = Algorithm.HMAC256(TOKEN_SECRET);//秘钥是密码则省略
  82.         //生成签名
  83.         String sign = JWT.create()
  84.                 .withHeader(header)
  85.                 .withExpiresAt(date)
  86.                 .withClaim("username", username)
  87. //                .withClaim("secret",secret)  //秘钥是密码直接传入
  88.                 .withClaim("currentTime", currentTimeMillis + EXPIRE_TIME)
  89.                 .sign(algorithm);
  90.         log.info("JwtUtil==sign--->sign = " + sign);
  91.         return sign;
  92.     }
  93.  
  94.     /**
  95.      * 获取token中用户信息
  96.      * @param token
  97.      * @return
  98.      */
  99.     public static String getAccount(String token){
  100.         try{
  101.             DecodedJWT decodedJWT=JWT.decode(token);
  102.             return decodedJWT.getClaim("username").asString();
  103.  
  104.         }catch (JWTCreationException e){
  105.             return null;
  106.         }
  107.     }
  108.  
  109.     /**
  110.      * 获取token中用户密码
  111.      * @param token
  112.      * @return
  113.      */
  114.     public static String getSecret(String token){
  115.         try{
  116.             DecodedJWT decodedJWT=JWT.decode(token);
  117.             return decodedJWT.getClaim("secret").asString();
  118.  
  119.         }catch (JWTCreationException e){
  120.             return null;
  121.         }
  122.     }
  123.  
  124.     /**
  125.      * 获取token的时间戳
  126.      * @param token
  127.      * @return
  128.      */
  129.     public static Long getCurrentTime(String token){
  130.         try{
  131.             DecodedJWT decodedJWT=JWT.decode(token);
  132.             return decodedJWT.getClaim("currentTime").asLong();
  133.  
  134.         }catch (JWTCreationException e){
  135.             return null;
  136.         }
  137.     }
  138. }

3、JwtFilter

  1. /**
  2.  * 重写鉴权
  3.  * @Author: LEAVES
  4.  * @Date: 2020年12月30日 14时25分08秒
  5.  * @Version 1.0
  6.  * @Description:    执行流程 preHandle -> isAccessAllowed -> isLoginAttempt -> executeLogin 。
  7.  */
  8. @Slf4j
  9. public class JwtFilter extends BasicHttpAuthenticationFilter {
  10.  
  11.     //默认需要放行的接口 shiroc处判断过，此处可写可不写
  12.     private String[] defalutExcludeUrl = new String[] {
  13.             "/login","/401", "/402", "/noaccess"
  14.             //,"/formLogin",".jpg",".png",".gif",".css",".js",".jpeg"
  15.     };
  16.  
  17.     /**
  18.      * 检测用户是否想要登录
  19.      * 检测header里面是否包含token字段即可
  20.      * @param request
  21.      * @param response
  22.      * @return
  23.      */
  24.     @Override
  25.     protected boolean isLoginAttempt(ServletRequest request, ServletResponse response) {
  26.         log.info("JwtFilter==isLoginAttempt--->");
  27.         HttpServletRequest req = (HttpServletRequest) request;
  28.         String authorization = req.getHeader("Authorization");
  29.         if (authorization != null){
  30.             //去掉token前缀
  31.             authorization = authorization.substring(7);
  32.             log.info("JwtFilter==isLoginAttempt--->authorization = " + authorization);
  33.             log.info("JwtFilter==isLoginAttempt--->用户已经登录过了");
  34.             return authorization != null;
  35.         }else{
  36.             log.info("JwtFilter==isLoginAttempt--->用户未登录");
  37.             return authorization == null;
  38.         }
  39.     }
  40.  
  41.     /**
  42.      * JwtToken实现了AuthenticationToken接口封装了token参数
  43.      * 通过getSubject方法获取 subject对象
  44.      * login()发送身份验证
  45.      * 为什么需要在Filter中调用login,不能在controller中调用login?
  46.      * 由于Shiro默认的验证方式是基于session的，在基于token验证的方式中，不能依赖session做为登录的判断依据．
  47.      * 执行登录
  48.      * @param request
  49.      * @param response
  50.      * @return
  51.      * @throws Exception
  52.      */
  53.     @Override
  54.     protected boolean executeLogin(ServletRequest request, ServletResponse response) throws Exception {
  55.         log.info("JwtFilter==executeLogin--->");
  56.         HttpServletRequest httpServletRequest = (HttpServletRequest) request;
  57.         String authorization = httpServletRequest.getHeader("Authorization");
  58.         //去掉token前缀
  59.         authorization = authorization.substring(7);
  60.         JwtToken token = new JwtToken(authorization);
  61.         // 提交给realm进行登入，如果错误他会抛出异常并被捕获
  62.         try {
  63.             //触发 Shiro Realm 自身的登录控制
  64.             getSubject(request, response).login(token);
  65.             // 如果没有抛出异常则代表登入成功，返回true
  66.             log.info("JwtFilter==executeLogin--->验证登入成功");
  67.             //刷新token
  68.             this.refreshToken(authorization, response);
  69.             return true;
  70.         } catch (Exception e) {
  71.             log.error("JwtFilter==executeLogin--->没有访问权限，原因是：" + e.getMessage());
  72.             //此处跳转到401接口返回错误信息！
  73.             this.responseInvalid(response);
  74.             //throw new AuthenticationException("无效token，请先登录！！！！" + e.getMessage());
  75.             return false;
  76.         }
  77.     }
  78.  
  79.     /**
  80.      * 这里详细说明下为什么最终返回的都是true，即允许访问
  81.      * 例如提供一个地址 GET /article
  82.      * 登入用户和游客看到的内容是不同的
  83.      * 如果在这里返回了false，请求会被直接拦截，用户看不到任何东西
  84.      * 所以在这里返回true，Controller中可以通过 subject.isAuthenticated() 来判断用户是否登入
  85.      * 如果有些资源只有登入用户才能访问，我们只需要在方法上面加上 @RequiresAuthentication 注解即可
  86.      * 但是这样做有一个缺点，就是不能够对GET,POST等请求进行分别过滤鉴权(因为我们重写了官方的方法)，但实际上对应用影响不大
  87.      * @param request
  88.      * @param response
  89.      * @param mappedValue
  90.      * @return
  91.      */
  92.     @Override
  93.     protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) {
  94.         log.info("JwtFilter==isAccessAllowed--->");
  95.         //判断请求的请求头是否带上 "token"
  96.         if (this.isLoginAttempt(request, response)) {
  97.             try {
  98.                 //如果存在，则进入 executeLogin 方法执行登入，检查 token 是否正确
  99.                 if (this.executeLogin(request, response)){
  100.                     String requestURL = ((HttpServletRequest) request).getRequestURL().toString();
  101.                     log.info("JwtFilter==isAccessAllowed--->requestURL="+requestURL);
  102.                     for(String excludeUrl : defalutExcludeUrl){
  103.                         if (requestURL.endsWith(excludeUrl)){
  104.                             return true;
  105.                         }
  106.                     }
  107.                 }
  108.             } catch (Exception e) {
  109.                 log.error("JwtFilter==isAccessAllowed--->Token已失效或为空,JwtFilter过滤验证失败!");
  110.                 //此处跳转到402接口返回错误信息！
  111.                 this.responseInvalid(response);
  112. //                throw new AuthenticationException("token为空，请重新登录！");
  113.             }
  114.         }
  115.         //如果请求头不存在 token，则可能是执行登陆操作或者是游客状态访问，无需检查 token，直接返回 true
  116.         return true;
  117.     }
  118.  
  119.     /**
  120.      * 对跨域提供支持
  121.      * @param request
  122.      * @param response
  123.      * @return
  124.      * @throws Exception
  125.      */
  126.     @Override
  127.     protected boolean preHandle(ServletRequest request, ServletResponse response) throws Exception {
  128.         log.info("JwtFilter==preHandle--->");
  129.         HttpServletRequest httpServletRequest = (HttpServletRequest) request;
  130.         HttpServletResponse httpServletResponse = (HttpServletResponse) response;
  131.         httpServletResponse.setHeader("Access-control-Allow-Origin", httpServletRequest.getHeader("Origin"));
  132.         httpServletResponse.setHeader("Access-Control-Allow-Methods", "GET,POST,OPTIONS,PUT,DELETE");
  133.         httpServletResponse.setHeader("Access-Control-Allow-Headers", httpServletRequest.getHeader("Access-Control-Request-Headers"));
  134.         // 跨域时会首先发送一个option请求，这里我们给option请求直接返回正常状态
  135.         if (httpServletRequest.getMethod().equals(RequestMethod.OPTIONS.name())) {
  136.             httpServletResponse.setStatus(HttpStatus.OK.value());
  137.             return false;
  138.         }
  139.         return super.preHandle(request, response);
  140.     }
  141.  
  142.     /**
  143.      * 刷新token
  144.      * @param authorization
  145.      * @param response
  146.      * @return
  147.      * refreshTokens方法中,当redisToken不为空时返回true,并且如果redisToken验证成功,则将已有的token重新存入一遍,保持redis中的token不过期
  148.      * 如果redisToken验证不通过,重新生成新的token,存入redis并返回给前端;当redisToken为空时返回false,需要重新登录.
  149.      */
  150.     @SneakyThrows
  151.     protected void refreshToken(String authorization, ServletResponse response){
  152.         log.info("-------------刷新token-------------");
  153.         //获取token的用户名
  154.         String account = JwtUtil.getAccount(authorization);
  155.         //获取redis中的token
  156.         String redisToken = JedisUtil.getJson(account);
  157.         //判断redis中的token是否为空
  158.         if (IsNotEmptyUtil.isNotEmpty(redisToken)){
  159.             //将现有的token重新存入redis中
  160.             JedisUtil.setJson(account, authorization, REFRESH_EXPIRE_TIME);
  161.             //给前端返回新生成的token
  162.             HttpServletResponse httpServletResponse = (HttpServletResponse) response;
  163.             httpServletResponse.setHeader("token", authorization);
  164.             httpServletResponse.setHeader("Access-Control-Expose-Headers", "token");
  165.             log.info("redis中的token还未过期！");
  166.         } else {
  167.             //生成新的token
  168.             String newToken = JwtUtil.sign(account);
  169.             //将新生成的token重新存入redis中
  170.             JedisUtil.setJson(account, newToken, REFRESH_EXPIRE_TIME);
  171.             //给前端返回原来请求的token
  172.             HttpServletResponse httpServletResponse = (HttpServletResponse) response;
  173.             httpServletResponse.setHeader("token", newToken);
  174.             httpServletResponse.setHeader("Access-Control-Expose-Headers", "token");
  175.             log.info("redis中的token已过期！");
  176.         }
  177.     }
  178.  
  179.     /**
  180.      * 将非法请求跳转到 /401    暂无token!
  181.      * @param response
  182.      */
  183.     private void responseInvalid(ServletResponse response) {
  184.         log.info("JwtFilter==response401--->");
  185.         try {
  186.             HttpServletResponse httpServletResponse = (HttpServletResponse) response;
  187.             httpServletResponse.sendRedirect("/invalid");
  188.         } catch (IOException e) {
  189.             log.error(e.getMessage());
  190.         }
  191.     }
  192.  
  193.     // /**
  194.     //  * 无需转发，直接返回Response信息
  195.     //  */
  196.     // private void response401(ServletResponse response, String msg) {
  197.     //     HttpServletResponse httpServletResponse = WebUtils.toHttp(response);
  198.     //     httpServletResponse.setStatus(HttpStatus.UNAUTHORIZED.value());
  199.     //     httpServletResponse.setCharacterEncoding("UTF-8");
  200.     //     httpServletResponse.setContentType("application/json; charset=utf-8");
  201.     //     try (PrintWriter out = httpServletResponse.getWriter()) {
  202.     //         String data = JsonConvertUtil.objectToJson(new ResponseBean(HttpStatus.UNAUTHORIZED.value(), "无权访问(Unauthorized):" + msg, null));
  203.     //         out.append(data);
  204.     //     } catch (IOException e) {
  205.     //         log.error("直接返回Response信息出现IOException异常:{}", e.getMessage());
  206.     //         throw new CustomException("直接返回Response信息出现IOException异常:" + e.getMessage());
  207.     //     }
  208.     // }
  209. }

十、Shiro配置

1、MyRealm

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 14时25分08秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. @Slf4j
  8. @Component
  9. public class MyRealm extends AuthorizingRealm {
  10.  
  11.     @Resource
  12.     private IRoleService roleService;
  13.     @Resource
  14.     private IUserService userService;
  15.     
  16.     /**
  17.      * 必须重写此方法，否则Shiro会报错
  18.      * @param token
  19.      * @return
  20.      */
  21.     @Version
  22.     public boolean supports(AuthenticationToken token) {
  23.         return token instanceof JwtToken;
  24.     }
  25.  
  26.     /**
  27.      * 授权
  28.      * 只有当需要检测用户权限的时候才会调用此方法，例如checkRole,checkPermission之类的
  29.      * @param principals
  30.      * @return
  31.      */
  32.     @Override
  33.     protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) throws AuthorizationException {
  34.         //授权
  35.         log.info("-------------用户授权-------------");
  36.         log.info("MyRealm==doGetAuthorizationInfo--->");
  37.         //如果身份认证的时候没有传入User对象，这里只能取到userName
  38.         TUser tUser = (TUser) principals.getPrimaryPrincipal();
  39.         String username = tUser.getUsername();
  40. //        //通过调用JwtUtil.getUsername()方法得到token中的username
  41. //        String username = JwtUtil.getUsername(principals.toString());
  42.         if (IsNotEmptyUtil.isEmpty(username)){
  43.             throw new AuthorizationException("无效token,请重新登录！");
  44.         }
  45.         //调用业务方法获取用户的角色
  46.         Set<String> permissions = roleService.getPermissionByUserName(username);
  47. //        String role = userService.getRole(username);
  48.         //调用业务方法获取用户权限
  49. //        List<Permissions> list = roleService.getPermissionsByUsername(username);
  50.         //每个用户可以设置新的权限
  51. //        String permission = userService.getPermission(username);
  52.         //将List换成set去掉重复权限
  53. //        Set<String> stringPermissions = new HashSet<>();
  54. //        Set<String> roleSet = new HashSet<>();
  55. //        if (list !=null){
  56. //            for (Permissions permissions : list){
  57. //                log.info(username + "拥有的权限有：" + permissions);
  58. //                stringPermissions.add(permissions.getPername());
  59. //            }
  60. //        }
  61.     SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo();
  62.         //设置该用户拥有的角色和权限
  63. //        authorizationInfo.setRoles(roleSet);
  64.         authorizationInfo.setStringPermissions(permissions);
  65. //        authorizationInfo.setStringPermissions(stringPermissions);
  66.         return authorizationInfo;
  67.     }
  68.  
  69.     /**
  70.      * 认证
  71.      * 默认使用此方法进行用户名正确与否验证，错误抛出异常即可。
  72.      * @param auth
  73.      * @return
  74.      * @throws AuthenticationException
  75.      */
  76.     @Override
  77.     protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken auth) throws AuthenticationException {
  78.         log.info("-------------用户认证-------------");
  79.         //获取用户token信息
  80.         String token = (String) auth.getCredentials();
  81.         // 帐号为空
  82.         if (IsNotEmptyUtil.isEmpty(token)) {
  83.             throw new AuthenticationException("暂无token!");
  84.         }
  85.         log.info("MyRealm==doGetAuthenticationInfo--->token = " + token);
  86.         //判断token中是否包含用户信息
  87.         String username = null;
  88.         try {
  89.             //这里工具类没有处理空指针等异常这里处理一下(这里处理科学一些)
  90.             //解密获得username，用于和数据库进行对比
  91.             username = JwtUtil.getUsername(token);
  92.             log.info("MyRealm==doGetAuthenticationInfo--->从token中解析出的username = " + username);
  93.         } catch (Exception e) {
  94.             log.info("MyRealm==doGetAuthenticationInfo--->AuthenticationException：token拼写错误或者值为空！");
  95.             throw new AuthenticationException("token拼写错误或者值为空");
  96.         }
  97.         if (username == null) {
  98.             log.error("MyRealm==doGetAuthenticationInfo--->token无效(空''或者null都不行!)");
  99.             throw new AuthenticationException("认证失败，token无效或token中未包含用户信息！");
  100.         }
  101.         //根据用户信息查询数据库获取后端的用户身份，转交给securityManager判定
  102.         //调用业务方法从数据库中获取用户信息
  103.         TUser tUser = userService.getUserByUserName(username);
  104.         //判断从数据库中获取用户信息是否为空
  105.         if (tUser == null) {
  106.             log.error("MyRealm==doGetAuthenticationInfo--->用户不存在!)");
  107.             throw new AuthenticationException("用户" + username + "不存在!");
  108.         }
  109.         //认证
  110.         return new SimpleAuthenticationInfo(tUser, token, "my_realm");
  111.     }
  112. }

2、ShiroConfig

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 14时23分12秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. @Slf4j
  8. @Configuration
  9. public class ShiroConfig {
  10.  
  11.     @Bean
  12.     public MyRealm myRealm() {
  13.         return new MyRealm();
  14.     }
  15.  
  16.     /**
  17.      * 注入安全过滤器
  18.      * @param securityManager
  19.      * @return
  20.      */
  21.     @Bean("shiroFilter")
  22.     public ShiroFilterFactoryBean shiroFilter(SecurityManager securityManager) {
  23.         log.info("ShiroConfig==shiroFilter--->");
  24.         ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
  25.         shiroFilterFactoryBean.setSecurityManager(securityManager);
  26.         //拦截器
  27.         Map<String, String> filterChainDefinitionMap = new LinkedHashMap<String, String>();
  28.         // 配置不会被拦截的链接 顺序判断
  29.         filterChainDefinitionMap.put("/", "anon");
  30.         filterChainDefinitionMap.put("/login", "anon");
  31.         // 添加自己的过滤器并且取名为jwt
  32.         Map<String, Filter> filterMap = new HashMap<String, Filter>(1);
  33.         filterMap.put("jwt", new JwtFilter());
  34.         log.info("ShiroConfig==shiroFilter--->new JwtFilter() ： " + new JwtFilter());
  35.         shiroFilterFactoryBean.setFilters(filterMap);
  36.         //<!-- 过滤链定义，从上向下顺序执行，一般将/**放在最为下边
  37.         filterChainDefinitionMap.put("/api/**", "jwt");
  38.         //未授权界面;
  39.         shiroFilterFactoryBean.setUnauthorizedUrl("/noaccess");
  40.         shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap);
  41.         return shiroFilterFactoryBean;
  42.     }
  43.  
  44.     /**
  45.      * 注入安全管理器
  46.      * @param myRealm
  47.      * @return
  48.      */
  49.     @Bean("securityManager")
  50.     public SecurityManager securityManager(MyRealm myRealm) {
  51.         log.info("ShiroConfig==securityManager--->");
  52.         DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
  53.         securityManager.setRealm(myRealm);
  54.  
  55.         /*
  56.          * 关闭shiro自带的session，详情见文档
  57.          * http://shiro.apache.org/session-management.html#SessionManagement-StatelessApplications%28Sessionless%29
  58.          */
  59.         DefaultSubjectDAO subjectDAO = new DefaultSubjectDAO();
  60.         DefaultSessionStorageEvaluator defaultSessionStorageEvaluator = new DefaultSessionStorageEvaluator();
  61.         defaultSessionStorageEvaluator.setSessionStorageEnabled(false);
  62.         subjectDAO.setSessionStorageEvaluator(defaultSessionStorageEvaluator);
  63.         securityManager.setSubjectDAO(subjectDAO);
  64.         return securityManager;
  65.  
  66.     }
  67.  
  68.     /**
  69.      * 自动创建代理，没有这个鉴权可能会出错
  70.      * @return
  71.      */
  72.     @Bean
  73.     public DefaultAdvisorAutoProxyCreator getDefaultAdvisorAutoProxyCreator() {
  74.         log.info("ShiroConfig==getDefaultAdvisorAutoProxyCreator--->");
  75.         DefaultAdvisorAutoProxyCreator autoProxyCreator = new DefaultAdvisorAutoProxyCreator();
  76.         autoProxyCreator.setProxyTargetClass(true);
  77.         return autoProxyCreator;
  78.     }
  79.     /**
  80.      * 开启shiro aop注解支持.
  81.      * 使用代理方式;所以需要开启代码支持;
  82.      * @param
  83.      * @return
  84.      */
  85.     @Bean
  86.     public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(SecurityManager securityManager) {
  87.         log.info("ShiroConfig==authorizationAttributeSourceAdvisor--->");
  88.         AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor();
  89.         authorizationAttributeSourceAdvisor.setSecurityManager(securityManager);
  90.         return authorizationAttributeSourceAdvisor;
  91.     }
  92. }

十一、业务实现

（整个过程中省略了mapper与xml的实现，以及实体类的。mapper、xml、entity、service、controller都可根据实际情况进行修改。）

1、UserService以及实现类

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 13时44分34秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. public interface IUserService {
  8.     
  9.     TUser getUserByUserName(String username);
  10.  
  11.     ResponseData login(String username, String password, HttpServletResponse response);
  12.  
  13.     ResponseData logout(HttpServletRequest request);
  14.  
  15.     ResponseData queryUserList();
  16.  
  17.     ResponseData queryUserByUserName(String username);
  18.     
  19. }
  20. /**
  21.  * @Author: LEAVES
  22.  * @Date: 2020年12月30日 13时44分45秒
  23.  * @Version 1.0
  24.  * @Description:
  25.  */
  26. @Service
  27. @Slf4j
  28. public class UserService implements IUserService {
  29.  
  30.     @Resource
  31.     private TUserMapper userMapper;
  32.     @Resource
  33.     private TRoleMapper roleMapper;
  34.  
  35.     /**
  36.      * 根据用户名查询用户信息（程序内部调用）
  37.      * @param username
  38.      * @return
  39.      */
  40.     @Override
  41.     public TUser getUserByUserName(String username) {
  42.         TUser tUser = userMapper.selectByUserName(username);
  43.         log.info("权限认证===>根据用户名查询用户信息：" + tUser.toString());
  44.         return tUser;
  45.     }
  46.  
  47.     /**
  48.      * 登录实现
  49.      * @param username
  50.      * @param password
  51.      * @param response
  52.      * @return
  53.      */
  54.     @Override
  55.     public ResponseData login(String username, String password, HttpServletResponse response) {
  56.         log.info("用户登录");
  57.         //为了简单实现此功能，并也未对前端传来的用户名和密码做正则校验
  58.         //selectUserToRoleByUserName该方法是一对一查询
  59.         TUser tUser = userMapper.selectUserToRoleByUserName(username);
  60. //        Set<String> roleByUserName = tRoleService.getRoleByUserName(username);
  61.         //由于前端+controller两处对username和password进行了判断，所以此处不再做判断
  62.         
  63.         if (tUser != null) {
  64.             //解密数据库中用户密码
  65.             String dbpwd = MD5Util.convertMD5(tUser.getPassword());
  66.             //判断输入的用户名和密码是否与数据库中的用户名、密码一致
  67.             if(tUser.getUsername().equals(username) && dbpwd.equals(password)){
  68.                 //生成token
  69.                 String token = JwtUtil.sign(tUser.getUsername());
  70.                 log.info("登录时生成的token = " + token);
  71.                 //获取当前时间的时间戳
  72.                 long currentTimeMillis = System.currentTimeMillis();
  73.                 //向redis中存入token
  74.                 JedisUtil.setJson(username, token, JwtUtil.REFRESH_EXPIRE_TIME);
  75.                 //向前端返回token
  76.                 HttpServletResponse httpServletResponse = response;
  77.                 httpServletResponse.setHeader("token", token);
  78.                 httpServletResponse.setHeader("Access-Control-Expose-Headers", "token");
  79.                 log.info("登录成功：" + tUser.toString());
  80.                 tUser.setPassword(dbpwd);
  81.                 Map<String, Object> map = new HashMap<>();
  82.                 map.put("user", tUser);
  83.                 map.put("token", token);
  84.                 return ResponseDataUtil.success("登录成功", map);
  85.             }
  86.             return ResponseDataUtil.fail("登录失败，用户名或密码错误！");
  87.         }
  88.         return ResponseDataUtil.fail("登录失败，用户不存在！");
  89.     }
  90.  
  91.     /**
  92.      * 退出登录
  93.      * @param request
  94.      * @return
  95.      */
  96.     @Override
  97.     public ResponseData logout(HttpServletRequest request) {
  98.         log.info("退出登录");
  99.         //获取token
  100.         String token = request.getHeader("Authorization");
  101.         //去掉token前缀
  102.         token = token.substring(7);
  103.         //token非空判断
  104.         if (IsNotEmptyUtil.isEmpty(token)) {
  105.             return ResponseDataUtil.fail("无效的token！");
  106.         }
  107.         //获取token中的用户名
  108.         String username = JwtUtil.getAccount(token);
  109.         //判断该token的用户是否存在
  110.         TUser tUser = userMapper.selectByUserName(username);
  111.         if (tUser != null) {
  112.             log.info(" 用户名: " + username + " 退出登录成功！ ");
  113.             if (JedisUtil.getJson(username) == null){
  114.                 return ResponseDataUtil.fail("已经退出登录过了！");
  115.             }
  116.             //清空redis中用户Token缓存
  117.             Long aLong = JedisUtil.delKey(username);
  118.             return ResponseDataUtil.success("退出登录成功！");
  119.         }
  120.         return ResponseDataUtil.fail("令牌失效，请重新登录！");
  121.     }
  122.  
  123.     /**
  124.      * 查询全部用户信息
  125.      * @return
  126.      */
  127.     @Override
  128.     public ResponseData queryUserList() {
  129.         List<TUser> tUsers = userMapper.selectAll();
  130.         if (!tUsers.isEmpty()){
  131.             for (TUser tUser : tUsers){
  132.                 //密码解密
  133.                 tUser.setPassword(MD5Util.convertMD5(tUser.getPassword()));
  134.             }
  135.             log.info("获取全部用户信息：" + tUsers.toString());
  136.             return ResponseDataUtil.success("查询成功！", tUsers);
  137.         }
  138.         return ResponseDataUtil.fail("暂无用户信息！");
  139.     }
  140.  
  141.     /**
  142.      * 根据用户查询用户信息（接口）
  143.      * @param username
  144.      * @return
  145.      */
  146.     @Override
  147.     public ResponseData queryUserByUserName(String username) {
  148.         TUser tUser = userMapper.selectByUserName(username);
  149.         if (tUser != null){
  150.             return ResponseDataUtil.success("查询成功！", tUser);
  151.         }
  152.         return ResponseDataUtil.fail("暂无该用户信息！");
  153.     }
  154. }

2、RoleServicey以及实现类

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 11时20分48秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. public interface IRoleService<T> {
  8.  
  9.     Set<String> getPermissionByUserName(String username);
  10.  
  11.     ResponseData queryRoleList();
  12. }
  13. /**
  14.  * @Author: LEAVES
  15.  * @Date: 2020年12月30日 11时21分02秒
  16.  * @Version 1.0
  17.  * @Description:
  18.  */
  19. @Service
  20. @Slf4j
  21. public class RoleService implements IRoleService {
  22.  
  23.     @Resource
  24.     private TRoleMapper roleMapper;
  25.  
  26.     /**
  27.      * 根据用户查询用户权限（权限认证时调用）
  28.      * @param username
  29.      * @return
  30.      */
  31.     @Override
  32.     public Set<String> getPermissionByUserName(String username) {
  33.         List<String> permissions = roleMapper.getPermissionByUserName(username);
  34.         log.info("权限鉴别===>通过用户名获取用户权限信息：" + permissions.toString());
  35.         return new HashSet<String>(permissions);
  36.     }
  37.  
  38.     /**
  39.      * 查询全部角色信息
  40.      * @return
  41.      */
  42.     @Override
  43.     public ResponseData queryRoleList() {
  44.         List<TRole> roles = roleMapper.selectAll();
  45.         if (!roles.isEmpty()){
  46.             return ResponseDataUtil.success("查询成功！", roles);
  47.         }
  48.         return ResponseDataUtil.fail("暂无角色数据！");
  49.     }
  50. }

十二、控制层的实现

1、RedirectController（重定向访问）

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 17时36分46秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. @Slf4j
  8. @RestController
  9. @CrossOrigin
  10. public class RedirectController {
  11.     /**
  12.      * 暂无token
  13.      * @return
  14.      */
  15.     @GetMapping("/invalid")
  16.     public Object redirect401(){
  17.         return ResponseDataUtil.fail("token已失效或为空，请先登录！");
  18.     }
  19.  
  20.     /**
  21.      * 权限不足
  22.      * @return
  23.      */
  24.     @GetMapping("/noaccess")
  25.     public Object redirect403(){
  26.         return ResponseDataUtil.fail("对不起，无权限访问！");
  27.     }
  28.  
  29. }

2、LoginController

  1. @Slf4j
  2. @RestController
  3. @CrossOrigin
  4. public class LoginController {
  5.  
  6.     @Resource
  7.     private IUserService userService;
  8.  
  9.     /**
  10.      * 登录
  11.      * @param username
  12.      * @param password
  13.      * @param response
  14.      * @return
  15.      */
  16.     @PostMapping("/login")
  17.     public Object login(@RequestParam("username")String username, @RequestParam("password")String password, HttpServletResponse response){
  18.         //用户名和密码非空判断
  19.         if (StrUtil.isNotBlank(username) && StrUtil.isNotBlank(password)){
  20.             return userService.login(username, password, response);
  21.         } else {
  22.             log.info("******");
  23.             return ResponseDataUtil.fail("登录失败，用户名或密码为空！");
  24.  
  25.         }
  26.     }
  27. }

3、UserController

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 17时41分59秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. @Slf4j
  8. @RestController
  9. @CrossOrigin
  10. @RequestMapping("/api")
  11. public class UserController {
  12.  
  13.     @Resource
  14.     private IUserService userService;
  15.  
  16.     /**
  17.      * 退出登录
  18.      * @param request
  19.      * @return
  20.      */
  21.     @GetMapping("/logout")
  22.     public Object logout(HttpServletRequest request){
  23.         return userService.logout(request);
  24.     }
  25.  
  26.     /**
  27.      * 查询所有用户
  28.      * @return
  29.      */
  30.     @GetMapping("/user/list")
  31.     public Object queryUserList(){
  32.         return userService.queryUserList();
  33.     }
  34.  
  35.     /**
  36.      * 查询所有用户z
  37.      * @return
  38.      */
  39.     @GetMapping("/user/username")
  40.     @RequiresPermissions(value={"3","1"},logical = Logical.OR) //权限限制
  41.     public Object queryUserByUserName(@RequestParam("username") String username){
  42.         return userService.queryUserByUserName(username);
  43.     }
  44. }

4、RoleController

  1. /**
  2.  * @Author: LEAVES
  3.  * @Date: 2020年12月30日 17时59分39秒
  4.  * @Version 1.0
  5.  * @Description:
  6.  */
  7. @Slf4j
  8. @RestController
  9. @CrossOrigin
  10. @RequestMapping("/api")
  11. public class RoleController {
  12.  
  13.     @Resource
  14.     private IRoleService roleService;
  15.  
  16.     /**
  17.      * 查询全部角色信息
  18.      * @return
  19.      */
  20.     @GetMapping("/role/list")
  21.     public Object queryAll(){
  22.         return roleService.queryRoleList();
  23.     }
  24. }

十三、测试结果

1、登录生成token

2、带上刚刚生成的token的访问

3、不带token访问

4、权限测试

码云源码地址：https://gitee.com/loveleaveslove/rbac-demo.git。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/437030
推荐阅读
相关标签

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

  

闽ICP备14008679号