结合redis使token失效

一、问题

token生成后即使用户退出登录、修改密码了，拿着该token值访问后端还是有效果。

二、解决

用户退出登录，修改密码后让原先的token值失效

本文代码不是完整的，只是传递一个实现思想

三、代码实现

1、导入redis的pom依赖

        <!--    redis     -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

2、配置文件中配置redis相关配置

# redis配置
spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.password=
# 连接超时时间（毫秒）
spring.redis.timeout=36000ms
# Redis默认情况下有16个分片，默认0
spring.redis.database=0
# 连接池最大连接数（使用负值表示没有限制） 默认 8
spring.redis.lettuce.pool.max-active=8
# 连接池最大阻塞等待时间（使用负值表示没有限制） 默认 -1
spring.redis.lettuce.pool.max-wait=-1ms
# 连接池中的最大空闲连接 默认 8
spring.redis.lettuce.pool.max-idle=8
# 连接池中的最小空闲连接 默认 0
spring.redis.lettuce.pool.min-idle=0

3、编写redis配置类

@Configuration
public class RedisConfig {

    /**
     * RedisConnectionFactory：Redis的连接工厂，根据配置文件中的Redis的配置做Redis连接和连接池的管理
     * 该对象在项目初始化时被创建,springboot2默认使用实现类LettuceConnectionFactory
     */
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        //创建原生的RedisTemplate对象
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        //设置连接工厂
        redisTemplate.setConnectionFactory(connectionFactory);
        // 使用Jackson2JsonRedisSerialize替换 默认的JDK序列化
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        //创建JSON序列化的对象，value使用JSON序列化方式
        ObjectMapper om = new ObjectMapper();
        //设置序列化的策略
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        //启用默认的类型
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        //引用JSON序列化
        jackson2JsonRedisSerializer.setObjectMapper(om);
        //创建String序列化，我们的key使用String序列化方式
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        // key采用String的序列化方式
        redisTemplate.setKeySerializer(stringRedisSerializer);
        // hash的key也采用String的序列化方式
        redisTemplate.setHashKeySerializer(stringRedisSerializer);
        // value序列化方式采用JSON
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        // hash的value序列化方式采用JSON
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
        //使用该配置
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

}

4、编写redis工具类封装redis的相关操作

@Component
public class RedisUtils {

    @Autowired
    public RedisTemplate redisTemplate;

    // =============================common============================

    /**
     * 指定缓存失效时间
     *
     * @param key  键
     * @param time 时间(秒)
     * @return
     */
    public boolean expire(String key, long time) {
        try {
            if (time > 0) {
                redisTemplate.expire(key, time, TimeUnit.SECONDS);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 根据key 获取过期时间
     *
     * @param key 键 不能为null
     * @return 时间(秒) 返回0代表为永久有效
     */
    public long getExpire(String key) {
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }

    /**
     * 判断key是否存在
     *
     * @param key 键
     * @return true 存在 false不存在
     */
    public boolean hasKey(String key) {
        try {
            return redisTemplate.hasKey(key);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除缓存
     *
     * @param key 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public boolean del(String... key) {
        if (key != null && key.length > 0) {
            if (key.length == 1) {
                return redisTemplate.delete(key[0]);
            }
            return redisTemplate.delete(CollectionUtils.arrayToList(key)) > 0 ? true : false;
        }
        return false;
    }

    /**
     * 匹配所有的key
     *
     * @param pettern
     * @return
     */
    public Set<String> keys(String pettern) {
        if (pettern.trim() != "" && pettern != null) {
            return redisTemplate.keys(pettern);
        }
        return null;
    }

    // ============================String=============================

    /**
     * 普通缓存获取
     *
     * @param key 键
     * @return 值
     */
    public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }

    /**
     * 普通缓存放入
     *
     * @param key   键
     * @param value 值
     * @return true成功 false失败
     */
    public boolean set(String key, Object value) {
        try {
            redisTemplate.opsForValue().set(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 普通缓存放入并设置时间
     *
     * @param key      键
     * @param value    值
     * @param time     时间(秒) time要大于0 如果time小于等于0 将设置无限期
     * @param timeUnit 过期时间单位
     * @return true成功 false 失败
     */
    public boolean set(String key, Object value, long time, TimeUnit timeUnit) {
        try {
            if (time > 0) {
                redisTemplate.opsForValue().set(key, value, time, timeUnit);
            } else {
                set(key, value);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 递增
     *
     * @param key   键
     * @param delta 要增加几(大于0)
     * @return
     */
    public long incr(String key, long delta) {
        if (delta < 0) {
            throw new RuntimeException("递增因子必须大于0");
        }
        return redisTemplate.opsForValue().increment(key, delta);
    }

    /**
     * 递减
     *
     * @param key   键
     * @param delta 要减少几(小于0)
     * @return
     */
    public long decr(String key, long delta) {
        if (delta < 0) {
            throw new RuntimeException("递减因子必须大于0");
        }
        return redisTemplate.opsForValue().increment(key, -delta);
    }
    // ================================Map=================================

    /**
     * HashGet
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return 值
     */
    public Object hget(String key, String item) {

        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 获取hashKey对应的所有键值
     *
     * @param key 键
     * @return 对应的多个键值
     */
    public List<Object> hmget(String key) {

        return redisTemplate.opsForHash().values(key);
    }

    /**
     * HashSet
     *
     * @param key 键
     * @param map 对应多个键值
     * @return true 成功 false 失败
     */
    public boolean hmset(String key, Map<String, Object> map) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * HashSet 并设置时间
     *
     * @param key  键
     * @param map  对应多个键值
     * @param time 时间(秒)
     * @return true成功 false失败
     */
    public boolean hmset(String key, Map<String, Object> map, long time) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @param time  时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value, long time) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除hash表中的值
     *
     * @param key  键 不能为null
     * @param item 项 可以使多个 不能为null
     */
    public void hdel(String key, Object... item) {
        redisTemplate.opsForHash().delete(key, item);
    }

    /**
     * 判断hash表中是否有该项的值
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return true 存在 false不存在
     */
    public boolean hHasKey(String key, String item) {
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     *
     * @param key  键
     * @param item 项
     * @param by   要增加几(大于0)
     * @return
     */
    public double hincr(String key, String item, double by) {
        return redisTemplate.opsForHash().increment(key, item, by);
    }

    /**
     * hash递减
     *
     * @param key  键
     * @param item 项
     * @param by   要减少记(小于0)
     * @return
     */
    public double hdecr(String key, String item, double by) {
        return redisTemplate.opsForHash().increment(key, item, -by);
    }

    /**
     * 存储对象
     *
     * @param key
     * @param field
     * @param value
     */
    public void putSome(Class cls, String key, String field, Object value) {
        redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(cls));
        redisTemplate.boundHashOps(key).put(field, value);
    }

    /**
     * 获取对象
     *
     * @param key
     * @param cls
     * @return
     */
    public Cursor<Map.Entry<String, Object>> getSome(String key, Class cls) {
        redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(cls));
        Cursor<Map.Entry<String, Object>> scan = redisTemplate.boundHashOps(key).scan(ScanOptions.scanOptions().build());
        return scan;
    }


    // ============================set=============================

    /**
     * 根据key获取Set中的所有值
     *
     * @param key 键
     * @return
     */
    public Set<Object> sGet(String key) {
        try {
            return redisTemplate.opsForSet().members(key);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 根据value从一个set中查询,是否存在
     *
     * @param key   键
     * @param value 值
     * @return true 存在 false不存在
     */
    public boolean sHasKey(String key, Object value) {
        try {
            return redisTemplate.opsForSet().isMember(key, value);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将数据放入set缓存
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 成功个数
     */
    public long sSet(String key, Object... values) {
        try {
            return redisTemplate.opsForSet().add(key, values);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 将set数据放入缓存
     *
     * @param key    键
     * @param time   时间(秒)
     * @param values 值 可以是多个
     * @return 成功个数
     */
    public long sSetAndTime(String key, long time, Object... values) {
        try {
            Long count = redisTemplate.opsForSet().add(key, values);
            if (time > 0)
                expire(key, time);
            return count;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 获取set缓存的长度
     *
     * @param key 键
     * @return
     */
    public long sGetSetSize(String key) {
        try {
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 移除值为value的
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 移除的个数
     */
    public long setRemove(String key, Object... values) {
        try {
            Long count = redisTemplate.opsForSet().remove(key, values);
            return count;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }
    // ===============================list=================================

    /**
     * 获取list缓存的内容
     *
     * @param key   键
     * @param start 开始
     * @param end   结束 0 到 -1代表所有值
     * @return
     */
    public List<Object> lGet(String key, long start, long end) {
        try {
            return redisTemplate.opsForList().range(key, start, end);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 获取list缓存的长度
     *
     * @param key 键
     * @return
     */
    public long lGetListSize(String key) {
        try {
            return redisTemplate.opsForList().size(key);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 通过索引 获取list中的值
     *
     * @param key   键
     * @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
     * @return
     */
    public Object lGetIndex(String key, long index) {
        try {
            return redisTemplate.opsForList().index(key, index);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public boolean lSet(String key, Object value) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     * @return
     */
    public boolean lSet(String key, Object value, long time) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            if (time > 0)
                expire(key, time);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public boolean lSet(String key, List<Object> value) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     * @return
     */
    public boolean lSet(String key, List<Object> value, long time) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            if (time > 0)
                expire(key, time);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 根据索引修改list中的某条数据
     *
     * @param key   键
     * @param index 索引
     * @param value 值
     * @return
     */
    public boolean lUpdateIndex(String key, long index, Object value) {
        try {
            redisTemplate.opsForList().set(key, index, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 移除N个值为value
     *
     * @param key   键
     * @param count 移除多少个
     * @param value 值
     * @return 移除的个数
     */
    public long lRemove(String key, long count, Object value) {
        try {
            Long remove = redisTemplate.opsForList().remove(key, count, value);
            return remove;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }
}

5、JWT工具类

public class JwtUtils {

    /**
     * token过期时间，单位毫秒，这里设置7天
     */
    public static final long EXPIRE = 7 * 1000 * 60 * 60 * 24;
    /**
     * 秘钥
     */
    public static final String SECRET = "147258369@qwe";

    /**
     * 登录成功后生成Jwt
     *
     * @param userInfo 登录成功的用户对象
     * @return
     */
    public static String createJWT(UserInfo userInfo) {
        Date nowTime = new Date();
        //创建payload的私有声明
        Map<String, Object> claims = new HashMap<>(4);
        claims.put("id", userInfo.getId());
        claims.put("loginName", userInfo.getLoginName());
        claims.put("userName", userInfo.getUserName());
        claims.put("avatar", "https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif");
        // 构建Token
        JwtBuilder builder = Jwts.builder()
                //token头信息
                .setHeaderParam("typ", "JWT")
                .setHeaderParam("alg", "HS256")
                //token有效负载，一些用户信息
                .setClaims(claims)
                //设置签名使用的签名算法和签名使用的秘钥
                .signWith(SignatureAlgorithm.HS256, SECRET)
                // 设置签发时间
                .setIssuedAt(nowTime)
                //设置过期时间
                .setExpiration(new Date(nowTime.getTime() + EXPIRE));
        return builder.compact();
    }


    /**
     * 解密token,解密有问题则会抛出相应异常,获取token中有效负载的信息
     *
     * @param token 加密后的token
     * @return
     */
    public static Claims getTokenInfo(String token) {
        Claims claims = Jwts.parser().setSigningKey(SECRET).parseClaimsJws(token).getBody();
        return claims;
    }

}

6、登录接口的业务逻辑

登录成功时将生成的token放入redis

    public LoginUserInfoDTO login(LoginUserInfoDTO loginUserInfoDTO) {
        //获取登录名和密码
        String loginName = loginUserInfoDTO.getLoginName();
        String password = loginUserInfoDTO.getPassword();
        //登录名和密码非空判断
        if (!StringUtils.hasLength(loginName) || !StringUtils.hasLength(password)) {
            throw new KmapException(KmapStatusEnum.lOGINGNAME_OR_PASSWORD_IS_NULL);
        }
        //查询登录名和密码是否正确
        QueryWrapper<UserInfo> wrapper = new QueryWrapper<>();
        wrapper.eq("login_name", loginName);
        wrapper.eq("password", password);
        UserInfo userInfo = baseMapper.selectOne(wrapper);
        //判断查询对象是否为空
        if (userInfo == null) {
            throw new KmapException(KmapStatusEnum.lOGINGNAME_OR_PASSWORD_ERROR);
        }
        // 登录成功，生成token返回
        String jwtToken = JwtUtils.createJWT(userInfo);
        // 将生成的token放入redis中，key为 token:用户id
        redisUtils.set(ConstantUtils.REDIS_TOKEN_KEY_PRE + userInfo.getId(), jwtToken, 7, TimeUnit.DAYS);
        LoginUserInfoDTO returnLoginUserInfoDTO = new LoginUserInfoDTO();
        returnLoginUserInfoDTO.setId(userInfo.getId());
        returnLoginUserInfoDTO.setLoginName(userInfo.getLoginName());
        returnLoginUserInfoDTO.setSerial(userInfo.getSerial());
        returnLoginUserInfoDTO.setUserName(userInfo.getUserName());
        returnLoginUserInfoDTO.setGroupId(userInfo.getGroupId());
        returnLoginUserInfoDTO.setToken(jwtToken);
        return returnLoginUserInfoDTO;
    }

7、删除用户、修改用户密码、退出登录时把存入redis中对应的token删除

    public void deleteUserInfo(int id) {
        int result = userInfoMapper.deleteById(id);
        // 删除redis中的相应token值
        redisUtils.del(ConstantUtils.REDIS_TOKEN_KEY_PRE + id);
        if (result < 1) {
            throw new KmapException(KmapStatusEnum.DELETE_ERROR);
        }
    }

    public void updateUserPassword(UserInfoDTO userInfoDTO) {
        // 检查提交的id和修改密码是否为空
        if (userInfoDTO.getId() == null) {
            throw new KmapException(KmapStatusEnum.USERINFO_MUST_FILL);
        }
        // 检查密码
        checkUserPassword(userInfoDTO);
        UserInfo userInfo = new UserInfo();
        userInfo.setId(userInfoDTO.getId());
        userInfo.setPassword(userInfoDTO.getPassword());
        // 删除redis中的相应token值
        redisUtils.del(ConstantUtils.REDIS_TOKEN_KEY_PRE + userInfoDTO.getId());
        // 密码加密
        userInfo.setPassword(MD5.encrypt(userInfo.getPassword()));
        int result = userInfoMapper.updateById(userInfo);
        if (result < 1) {
            throw new KmapException(KmapStatusEnum.UPDATE_ERROR);
        }
    }

    public void logout(Integer id) {
        // 删除redis中的相应token值
        redisUtils.del(ConstantUtils.REDIS_TOKEN_KEY_PRE + id);
    }

8、编写访问拦截器

public class JwtInterceptor implements HandlerInterceptor {

    @Autowired
    private RedisUtils redisUtils;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException {
        //OPTIONS请求，放行
        if (HttpMethod.OPTIONS.toString().equals(request.getMethod())) {
            return true;
        }
        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json;charset=utf-8");
        // 获取请求头中的token
        String token = request.getHeader(ConstantUtils.TOKEN_KEY);
        if (!StringUtils.hasLength(token)) {
            response.getWriter().println(new ObjectMapper().writeValueAsString(Result.error().setCode(KmapStatusEnum.NOT_LOGIN.getCode()).setMessage(KmapStatusEnum.NOT_LOGIN.getMsg())));
            return false;
        }
        try {
            // 如果获取token信息出错则会抛出异常
            Claims tokenInfo = JwtUtils.getTokenInfo(token);
            // redis中不存在token（退出登录、密码被修改、用户被删除token会清除），说明登录已失效
            if (!redisUtils.hasKey(ConstantUtils.REDIS_TOKEN_KEY_PRE + tokenInfo.get("id"))) {
                response.getWriter().println(new ObjectMapper().writeValueAsString(Result.error().setCode(KmapStatusEnum.LOGIN_EXPIRED.getCode()).setMessage(KmapStatusEnum.LOGIN_EXPIRED.getMsg())));
                return false;
            }
            // redis中的token和当前token不一致，被异地登录
            if (!redisUtils.get(ConstantUtils.REDIS_TOKEN_KEY_PRE + tokenInfo.get("id")).equals(token)) {
                response.getWriter().println(new ObjectMapper().writeValueAsString(Result.error().setCode(KmapStatusEnum.LOGIN_REMOTE.getCode()).setMessage(KmapStatusEnum.LOGIN_REMOTE.getMsg())));
                return false;
            }
            return true;
        } catch (TokenExpiredException e) {
            //token已过期失效
            response.getWriter().println(new ObjectMapper().writeValueAsString(Result.error().setCode(KmapStatusEnum.LOGIN_EXPIRED.getCode()).setMessage(KmapStatusEnum.LOGIN_EXPIRED.getMsg())));
            return false;
        } catch (Exception e) {
            e.printStackTrace();
            response.getWriter().println(new ObjectMapper().writeValueAsString(Result.error().setCode(KmapStatusEnum.LOGIN_ERROR.getCode()).setMessage(KmapStatusEnum.LOGIN_ERROR.getMsg())));
            return false;
        }
    }

}