SpringBoot集成Auth0 JWT的示例代碼

更新時(shí)間：2021年08月20日 09:32:49 作者：夢想是咸魚

本文主要介紹了SpringBoot集成Auth0 JWT的示例代碼，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

前言

說說JWT，先說下互聯(lián)網(wǎng)服務(wù)常見的兩種用戶認(rèn)證方式：

session認(rèn)證與Token認(rèn)證

session認(rèn)證

傳統(tǒng)的Session認(rèn)證的大體流程可以表示為用戶提供用戶名和密碼登錄后由服務(wù)器存儲一份用戶登錄信息并傳遞給瀏覽器保存為Cookie，并在下次請求中根據(jù)Cookie來識別用戶，但這種方式缺陷明顯：

Session都是保存在內(nèi)存中，隨著認(rèn)證用戶的增多，服務(wù)端的開銷明顯增大
保存在內(nèi)存中的Session限制了分布式的應(yīng)用
Cookie容易被截獲偽造

Token認(rèn)證

Token 泛指身份驗(yàn)證時(shí)使用的令牌，Token鑒權(quán)機(jī)制從某些角度而言與Cookie是一個(gè)作用，其目的是讓后臺知道請求是來自于受信的客戶端，其通過實(shí)現(xiàn)了某種算法加密的Token字符串來完成鑒權(quán)工作，其優(yōu)點(diǎn)在于：

服務(wù)器不需要保存 Session 數(shù)據(jù)（無狀態(tài)），容易實(shí)現(xiàn)擴(kuò)展
有效避免Cookie被截獲引發(fā)的CSRF攻擊
可以存儲一些業(yè)務(wù)邏輯所必要的非敏感信息
便于傳輸，其構(gòu)成非常簡單，字節(jié)占用小

JWT簡介

JWT定義

JWT全稱為Json web token，也就是 Json 格式的 web token，可以這么理解：

Token // 個(gè)人證件
JWT // 個(gè)人身份證

JWT數(shù)據(jù)結(jié)構(gòu)

JWT由三段字符串組成，中間用.分隔，如下：

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOjEsInNjb3BlIjo4LCJleHAiOjE3MTU3NDAyMjIsImlhdCI6MTYyOTM0MDIyMn0.wuRsF5wvLHbDF_21Pocas8SeXQ315rgBl6wm1LRL2bQ

JWT 的三個(gè)部分依次如下：

Header（頭部）// Header 部分是一個(gè) JSON 對象，描述 JWT 的元數(shù)據(jù)，通常是下面的樣子。
Payload（負(fù)載）// Payload 部分是一個(gè) JSON 對象，用來存放實(shí)際需要傳遞的數(shù)據(jù)
Signature（簽名）// Signature 部分是對前兩部分的簽名，防止數(shù)據(jù)篡改

第一段字符串Header：eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9將其 Base64 解碼后得到：

{
	"typ": "JWT", // TOKEN TYPE ,token類型
	"alg": "HS256"  //ALGORITHM，算法 哈希256
}

第二段字符串Payload：eyJ1aWQiOjEsInNjb3BlIjo4LCJleHAiOjE3MTU3NDAyMjIsImlhdCI6MTYyOTM0MDIyMn0

PAYLOAD是數(shù)據(jù)載體，可以有自定義數(shù)據(jù)

{
"uid": "1234567890" // 自定義數(shù)據(jù)
}

第三段字符串Signature：wuRsF5wvLHbDF_21Pocas8SeXQ315rgBl6wm1LRL2bQ

Signature 部分是對前兩部分的簽名，防止數(shù)據(jù)篡改。

JWT的類庫

Java 中的 JWT 有很多類庫，關(guān)于其優(yōu)缺點(diǎn)可以在官網(wǎng)查看：https://jwt.io/，這里我們介紹Auth0的JWT的集成使用方式

Auth0 實(shí)現(xiàn)的 com.auth0 / java-jwt / 3.3.0
Brian Campbell 實(shí)現(xiàn)的 org.bitbucket.b_c / jose4j / 0.6.3
connect2id 實(shí)現(xiàn)的 com.nimbusds / nimbus-jose-jwt / 5.7
Les Hazlewood 實(shí)現(xiàn)的 io.jsonwebtoken / jjwt / 0.9.0
FusionAuth 實(shí)現(xiàn)的 io.fusionauth / fusionauth-jwt / 3.1.0
Vert.x 實(shí)現(xiàn)的 io.vertx / vertx-auth-jwt / 3.5.1

具體實(shí)現(xiàn)

JWT配置

pom.xml

<!-- jwt -->
<dependency>
    <groupId>com.auth0</groupId>
    <artifactId>java-jwt</artifactId>
    <version>3.8.1</version>
</dependency>

application.yml

coisini:
  security:
    jwt-key: coisini
    # 過期時(shí)間
    token-expired-in: 86400000

JWT工具類

JwtUtil.java

import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.exceptions.JWTVerificationException;
import com.auth0.jwt.interfaces.Claim;
import com.auth0.jwt.interfaces.DecodedJWT;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.util.*;

/**
 * @Description JWT工具類
 * @author coisini
 * @date Aug 18, 2021
 * @Version 1.0
 */
@Component
public class JwtUtil {

    /**
     * key
     */
    private static String jwtKey;

    /**
     * 過期時(shí)間
     */
    private static Integer expiredTimeIn;

    /**
     * JWT KEY
     * @param jwtKey
     */
    @Value("${coisini.security.jwt-key}")
    public void setJwtKey(String jwtKey) {
        JwtUtil.jwtKey = jwtKey;
    }

    /**
     * 過期時(shí)間
     * @param expiredTimeIn
     */
    @Value("${coisini.security.token-expired-in}")
    public void setExpiredTimeIn(Integer expiredTimeIn) {
        JwtUtil.expiredTimeIn = expiredTimeIn;
    }

    /**
     * 生成令牌
     * @param uid 用戶id
     * @return
     */
    public static String makeToken(Long uid) {
        return JwtUtil.getToken(uid);
    }

    /**
     * 獲取令牌
     * @param uid 用戶id
     * @param scope 權(quán)限分級數(shù)字
     * @return
     */
    private static String getToken(Long uid) {
        // 指定算法
        Algorithm algorithm = Algorithm.HMAC256(JwtUtil.jwtKey);

        Map<String, Date> dateMap = JwtUtil.calculateExpiredIssues();

        /**
         * withClaim(） 寫入自定義數(shù)據(jù)
         * withExpiresAt() 設(shè)置過期時(shí)間
         * withIssuedAt() 設(shè)置當(dāng)前時(shí)間
         * sign() 簽名算法
         */
        return JWT.create()
                    .withClaim("uid", uid)
                    .withExpiresAt(dateMap.get("expiredTime"))
                    .withIssuedAt(dateMap.get("now"))
                    .sign(algorithm);
    }

    /**
     * 獲取自定義數(shù)據(jù)
     * @param token
     * @return
     */
    public static Optional<Map<String, Claim>> getClaims(String token) {
        DecodedJWT decodedJWT;

        // 指定算法
        Algorithm algorithm = Algorithm.HMAC256(JwtUtil.jwtKey);
        JWTVerifier jwtVerifier = JWT.require(algorithm).build();

        try {
            decodedJWT = jwtVerifier.verify(token);
        } catch (JWTVerificationException e) {
            return Optional.empty();
        }

        return Optional.of(decodedJWT.getClaims());
    }

    /**
     * 驗(yàn)證Token
     * @param token
     * @return
     */
    public static boolean verifyToken(String token) {
        try {
            Algorithm algorithm = Algorithm.HMAC256(JwtUtil.jwtKey);
            JWTVerifier jwtVerifier = JWT.require(algorithm).build();
            jwtVerifier.verify(token);
        } catch (JWTVerificationException e) {
            return false;
        }

        return true;
    }

    /**
     * 計(jì)算過期時(shí)間
     * @return
     */
    private static Map<String, Date> calculateExpiredIssues() {
        Map<String, Date> map = new HashMap<>();
        Calendar calendar = Calendar.getInstance();
        Date now = calendar.getTime();
        calendar.add(Calendar.SECOND, JwtUtil.expiredTimeIn);
        // 當(dāng)前時(shí)間
        map.put("now", now);
        // 過期時(shí)間
        map.put("expiredTime", calendar.getTime());
        return map;
    }
}

測試接口

JwtController.java

@RestController
@RequestMapping("/jwt")
public class JwtController {

    /**
     * 獲取Token
     * @param id
     * @return
     */
    @GetMapping(value = "/get")
    public String getToken(@RequestParam Long id) {
        return JwtUtil.makeToken(id);
    }

    /**
     * 驗(yàn)證Token
     * @param token
     * @return
     */
    @PostMapping("/verify")
    public Map<String, Boolean> verify(@RequestParam String token) {
        Map<String, Boolean> map = new HashMap<>();
        Boolean valid = JwtUtil.verifyToken(token);
        map.put("is_valid", valid);
        return map;
    }

}

測試結(jié)果