SpringBoot實現(xiàn)JWT token自動續(xù)期的示例代碼

更新時間：2023年01月18日 14:40:32 作者：z.jiaminf

本文主要介紹了SpringBoot實現(xiàn)JWT token自動續(xù)期的示例代碼，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

為什么要 token自動續(xù)期

token中一般會包含用戶的基本信息，為了保證token的安全性，一般會將token的過期時間設置的比較短，但是這樣會導致用戶因為token過期需要頻繁登錄，因此需要token自動續(xù)期。

 //創(chuàng)建token
String token = JwtUtil.createToken(sysUser.getId(), user.getUserName());
//將token放入redis中,key為用戶的手機號+"token"
redisUtil.set(sysUser.getPhone() + GlobalConstant.TOKEN, token, JwtUtil.EXPIRE_TIME*2);

在攔截器中重寫public boolean preHandle(HttpServletRequest request,HttpServletResponse response, Object handler)方法

/**
 * token自動續(xù)期
 *
 * @param sysUser 用戶實體
 * @return 是否刷新成功
 */
private boolean refreshToken(SysUser sysUser) {
    String token = request.getHeader(GlobalConstant.TOKEN);
    String cacheToken = (String) (redisUtil.get(sysUser.getPhone() + GlobalConstant.TOKEN));
    //請求頭中不存在token，返回false
    if (StringUtil.isEmpty(token)) {
        logger.error("請求頭中token不存在");
        return false;
    }
    //用戶是否登錄只根據(jù)redis中token是否存在決定，redis中不存在token，返回false
    if (StringUtil.isEmpty(cacheToken)) {
        logger.error("用戶未登錄");
        return false;
    }
    try {
        //驗證請求頭中的token是否合法
        JwtUtil.verify(token);
    } catch (TokenExpiredException tokenExpiredException) {
        /*若拋出token過期異常，檢查請求頭中的token與redis中的token是否相同
        如果相同，說明用戶仍在操作，只是請求頭中的token已經(jīng)過期，此時需要對token進行續(xù)期*/
        if (cacheToken.equals(token)) {
            //重新刷新redis中的token的過期時間
            redisUtil.set(sysUser.getPhone() + GlobalConstant.TOKEN, token, JwtUtil.EXPIRE_TIME * 2);
            return true;
        } else {
            return false;
        }
    } catch (Exception e) {
        //若拋出除token過期異常之外的其他異常，說明該token不合法
        logger.error("token不合法");
        return false;
    }
    return true;
}

攔截器所有代碼如下

@Component
public class LoginInterceptor implements HandlerInterceptor {
 
    private final Logger logger = LoggerFactory.getLogger(getClass());
    @Resource
    private SysUserDao sysUserDao;
    @Resource
    private RedisUtil redisUtil;
    @Resource
    private HttpServletRequest request;
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        logger.info("進入攔截器 uri:" + request.getRequestURI());
        // 不是controller的方法不攔截
        if (!(handler instanceof HandlerMethod)) {
            return true;
        }
        //檢查方法上是否有@PreAuth注解，沒有則不攔截
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        PreAuth preAuth = handlerMethod.getMethodAnnotation(PreAuth.class);
        if (preAuth == null) {
            return true;
        }
        Long userId = JwtUtil.getUserIdByToken(request);
        SysUser sysUser = sysUserDao.selectById(userId);
        //用戶不存在，進行攔截
        if (sysUser == null) {
            logger.error("用戶不存在");
            return false;
        }
        if (!refreshToken(sysUser)) {
            return false;
        }
        //判斷用戶是否有對應權(quán)限
        Set<String> authList = this.sysUserDao.queryAuthList(userId);
        if (!authList.contains(preAuth.value())) {
            logger.error("無權(quán)限");
            return false;
        }
        return true;
    }
 
    /**
     * token自動續(xù)期
     *
     * @param sysUser 用戶實體
     * @return 是否刷新成功
     */
    private boolean refreshToken(SysUser sysUser) {
        String token = request.getHeader(GlobalConstant.TOKEN);
        String cacheToken = (String) (redisUtil.get(sysUser.getPhone() + GlobalConstant.TOKEN));
        //請求頭中不存在token，返回false
        if (StringUtil.isEmpty(token)) {
            logger.error("請求頭中token不存在");
            return false;
        }
        //用戶是否登錄只根據(jù)redis中token是否存在決定，redis中不存在token，返回false
        if (StringUtil.isEmpty(cacheToken)) {
            logger.error("用戶未登錄");
            return false;
        }
        try {
            //驗證請求頭中的token是否合法
            JwtUtil.verify(token);
        } catch (TokenExpiredException tokenExpiredException) {
            /*若拋出token過期異常，檢查redis中的是否存在token以及請求頭中的token與redis中的token是否相同
            如果相同，說明用戶仍在操作，只是請求頭中的token已經(jīng)過期，此時需要對token進行續(xù)期*/
            if (cacheToken.equals(token)) {
                //重新刷新redis中的token的過期時間
                redisUtil.set(sysUser.getPhone() + GlobalConstant.TOKEN, token, JwtUtil.EXPIRE_TIME * 60 * 2);
                return true;
            } else {
                return false;
            }
        } catch (Exception e) {
            //若拋出除token過期異常之外的其他異常，說明該token不合法
            logger.error("token不合法");
            return false;
        }
        return true;
    }
}

JwtUtil工具類如下

import com.admin.common.constant.GlobalConstant;
import com.auth0.jwt.JWT;
import com.auth0.jwt.algorithms.Algorithm;
 
import javax.servlet.http.HttpServletRequest;
import java.util.Calendar;
import java.util.Date;
 
public class JwtUtil {
    /**
     * token私鑰，不可以暴露
     */
    public static final String TOKEN_SECRET_KEY = "tokenSecretKey";
    /**
     * token過期時間（秒）
     */
    public static final int EXPIRE_TIME = 60;
 
    /**
     * 創(chuàng)建token
     *
     * @param userId   用戶ID
     * @param userName 用戶名
     * @return token
     */
    public static String createToken(Long userId, String userName) {
        Calendar calendar = Calendar.getInstance();
        calendar.add(Calendar.SECOND, EXPIRE_TIME);
        return JWT.create()
                //簽發(fā)對象
                .withAudience(userId + "")
                //載荷
                .withClaim("userName", userName)
                //簽發(fā)時間
                .withIssuedAt(new Date())
                //有效時間
                .withExpiresAt(calendar.getTime())
                //加密
                .sign(Algorithm.HMAC256(TOKEN_SECRET_KEY));
    }
 
    /**
     * 驗證token合法性
     *
     * @param token token
     * @return token是否合法
     */
    public static void verify(String token) {
        JWT.require(Algorithm.HMAC256(TOKEN_SECRET_KEY)).build().verify(token);
    }
 
  /**
     * 通過token獲取userId
     *
     * @return userId
     */
    public static Long getUserIdByToken(HttpServletRequest request) {
        String token = request.getHeader(GlobalConstant.TOKEN);
        String userId = JWT.decode(token).getAudience().get(0);
        return Long.valueOf(userId);
    }
}

到此這篇關于SpringBoot實現(xiàn)JWT token自動續(xù)期的示例代碼的文章就介紹到這了,更多相關SpringBoot JWT token自動續(xù)期內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: