云e办学习笔记（五）jwt工具类的编写

前言

本系列博客基于B站的云e办管理系统，前端和后端我都自己敲了一遍，这里做一个学习记录。云e办的原始视频链接如下：https://www.bilibili.com/video/BV1Ai4y1P7Tk?p=1

---

在server模块的pom中加入jwt和SpringSecurity的依赖

配置文件中加入jwt的配置

创建jwt工具类

package com.xxxx.server.config.security;

import io.jsonwebtoken.*;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.stereotype.Component;

import java.nio.channels.CancelledKeyException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

/**
 * @author LinLinD
 * @Create 2022-04-13-3:24
 * JWT工具类
 */
@Component
public class JwtTokenUtil {
//    用户名key，JWT创建时间key
    private static final String CLAIM_KEY_USERNAME = "sub";
    private static final String CLAIM_KEY_CREATED = "created";
//    自定义的密钥，生效时间从yaml配置里面获得
    @Value("${jwt.secret}")
    private String secret;
    @Value("${jwt.expiration}")
    private long expiration;

    /**
     * 可以被第三方调用
     * 根据用户信息生成token
     */

    public String generatorToken(UserDetails userDetails) {
        Map<String, Object> claims = new HashMap<>();
        claims.put(CLAIM_KEY_USERNAME,userDetails.getUsername());
        claims.put(CLAIM_KEY_CREATED,new Date());
        return generatorToken(claims);
    }

    /**
     * 可以被第三方调用
     * 从token中获取登录用户名
     */

    public String getUserNameFromToken(String token) {
        String username;
        try {
            Claims claims = getClaimsFromToken(token);
            username = claims.getSubject();
        } catch (Exception e) {
            username = null;
        }
        return username;
    }

    /**
     * 可以被第三方调用
     * 判断用户信息是否有效
     */

    public boolean validateToken(String token,UserDetails userDetails) {
//        成功获取用户名并且token没有失效
        String username = getUserNameFromToken(token);
        return username.equals(userDetails.getUsername()) && !isTokenExpired(token);
    }

    /**
     * 可以被第三方调用
     * 判断token是否可以被刷新
     * @param token
     * @return
     */
    public boolean canRefresh(String token) {
        return !isTokenExpired(token);
    }

    /**
     * 可以被第三方调用
     * 刷新token
     * @param token
     * @return
     */
    public String refreshToken(String token) {
        Claims claims = getClaimsFromToken(token);
        claims.put(CLAIM_KEY_CREATED,new Date());
        return generatorToken(claims);
    }

    /**
     * 判断token是否失效
     * @param token
     * @return
     */
    private boolean isTokenExpired(String token) {
        Date expireDate = getExpiredDateFromToken(token);
        return expireDate.before(new Date());
    }

    /**
     * 从token中获取失效时间
     * @param token
     * @return
     */
    private Date getExpiredDateFromToken(String token) {
       Claims claims = getClaimsFromToken(token);
       return claims.getExpiration();
    }

    /**
     * 解析荷载token
     */

    private Claims getClaimsFromToken(String token) {
        Claims claims = null;
        try {
            claims = Jwts.parser()
                    .setSigningKey(secret)
                    .parseClaimsJws(token)
                    .getBody();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return claims;
    }

    /**
     * 根据荷载生成token
     */

    private String generatorToken(Map<String,Object> claims) {
//        生效时间、算法、盐
        return Jwts.builder()
                .setClaims(claims)
                .setExpiration(generateExpirationDate())
                .signWith(SignatureAlgorithm.HS512,secret)
                .compact();
    }
    /**
     * 生效时间
     */
    private Date generateExpirationDate() {
//        当前系统时间加上自己定义的时间
        return new Date(System.currentTimeMillis() + expiration * 1000);
    }
}

第一个方法，根据用户名生成token。在hashmap中放入用户名和创建时间作为token的有效负载信息：

这个方法为上图方法服务，根据负载信息真正生成token，设置了负载信息，时间转换，生成token使用的算法和加密密钥

生效事件的方法如图

从token中获取用户名：

为上图方法服务，根据解密密钥生成有效负载信息

判断token是否失效：

即能够成功获取用户名并且，token失效方法返回false

判断token是否失效是看时间是否超过配置中的时间。