結合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;
        }
    }

}