feat: 添加 jwt token 工具类及其配置

Author: cadecode

simple-application/src/main/resources/application.yml

@@ -22,7 +22,7 @@ simple:
         # 数据源类型
         type: com.zaxxer.hikari.HikariDataSource
         # 是否设置为默认数据源
-        defaultFlag: true
+        default-flag: true
         # 数据源配置，根据 type 而定
         config:
           jdbc-url: jdbc:mysql://localhost:3306/demo?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
@@ -32,7 +32,18 @@ simple:
       - name: db2
         type: com.zaxxer.hikari.HikariDataSource
         config:
-          jdbcUrl: jdbc:mysql://localhost:3306/demo_cluster?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
-          driverClassName: com.mysql.cj.jdbc.Driver
+          jdbc-url: jdbc:mysql://localhost:3306/demo_cluster?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
+          driver-class-name: com.mysql.cj.jdbc.Driver
           username: root
           password: xxxx
+  jwt:
+    # token 请求头
+    header: token
+    # refresh token 请求头
+    refresh-header: refresh-token
+    # token 过期时间
+    expiration: 86400
+    # refresh token 过期时间
+    refresh-expiration: 86400
+    # 密钥
+    secret: 12345678123456781234567812345678

simple-application/src/test/java/top/cadecode/common/util/TokenUtilTest.java

@@ -0,0 +1,31 @@
+package top.cadecode.common.util;
+
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import top.cadecode.application.Application;
+
+import java.util.Collections;
+import java.util.Map;
+
+/**
+ * @author Cade Li
+ * @date 2021/12/10
+ * @description Token 工具类测试类
+ */
+@Slf4j
+@SpringBootTest(classes = Application.class)
+public class TokenUtilTest {
+
+    @Autowired
+    TokenUtil tokenUtil;
+
+    @Test
+    public void generateToken() {
+        String token = tokenUtil.generateToken("user", Collections.singletonList("user"));
+        log.info("token: {}", token);
+        Map<String, Object> map = tokenUtil.verifyToken(token);
+        log.info("map: {}", map);
+    }
+}

simple-common/src/main/java/top/cadecode/common/enums/FrameErrorEnum.java

@@ -11,8 +11,10 @@
 @Getter
 public enum FrameErrorEnum implements ResponseCode {
 
-    JSON_TO_STR_ERROR(1000, "对象转 json 字符串失败"),
-    JSON_TO_OBJ_ERROR(1000, "json 字符串转对象失败"),
+    JSON_TO_STR_ERROR(1000, "对象转 json 字符串出错"),
+    JSON_TO_OBJ_ERROR(1001, "json 字符串转对象出错"),
+    JWT_CREATE_ERROR(1003, "创建 token 出错"),
+    JWT_VERIFY_ERROR(1003, "解析 token 出错"),
     ;
 
     private final String code;

simple-common/src/main/java/top/cadecode/common/util/TokenUtil.java

@@ -0,0 +1,77 @@
+package top.cadecode.common.util;
+
+import com.nimbusds.jose.*;
+import com.nimbusds.jose.crypto.MACSigner;
+import com.nimbusds.jose.crypto.MACVerifier;
+import com.nimbusds.jwt.JWTClaimsSet;
+import com.nimbusds.jwt.SignedJWT;
+import lombok.Data;
+import lombok.SneakyThrows;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+import top.cadecode.common.core.exception.CommonException;
+import top.cadecode.common.enums.FrameErrorEnum;
+
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author Cade Li
+ * @date 2021/12/10
+ * @description Token 工具类
+ */
+@Data
+@Component
+@ConfigurationProperties(prefix = "simple.jwt")
+public class TokenUtil {
+
+    private String header;
+    private String refreshHeader;
+    private Long expiration;
+    private Long refreshExpiration;
+    private String secret;
+
+    /**
+     * 生成 token
+     *
+     * @param name  用户名
+     * @param roles 角色
+     * @return token 字符串
+     */
+    public String generateToken(String name, List<String> roles) {
+        long expiredTime = new Date().getTime() + expiration * 1000;
+        JWSHeader jwsHeader = new JWSHeader(JWSAlgorithm.HS256);
+        JWTClaimsSet jwtClaimsSet = new JWTClaimsSet.Builder()
+                .claim("name", name).
+                claim("roles", roles)
+                .expirationTime(new Date(expiredTime)).build();
+        SignedJWT signedJWT = new SignedJWT(jwsHeader, jwtClaimsSet);
+        try {
+            signedJWT.sign(new MACSigner(secret));
+            return signedJWT.serialize();
+        } catch (JOSEException e) {
+            throw CommonException.of(FrameErrorEnum.JWT_CREATE_ERROR).suppressed(e);
+        }
+    }
+
+    /**
+     * 校验 token
+     *
+     * @param token token 字符串
+     * @return 是否通过校验
+     */
+    public Map<String, Object> verifyToken(String token) {
+        try {
+            JWSObject jwsObject = JWSObject.parse(token);
+            JWSVerifier verifier = new MACVerifier(secret);
+            boolean verify = jwsObject.verify(verifier);
+            if (verify) {
+                return jwsObject.getPayload().toJSONObject();
+            }
+            return null;
+        } catch (Exception e) {
+            throw CommonException.of(FrameErrorEnum.JWT_VERIFY_ERROR).suppressed(e);
+        }
+    }
+}