Java JWT 的基本使用

JWT，JSON Web Token

在 JWT.IO 查看关于 JWT 的一些介绍，以及查找 JWT 各种语言都有哪些实现库

中文博客里，阮一峰的一篇博客还是比较易懂的：JSON Web Token 入门教程 。

JWT.IO 推荐了 6 个 Java 实现库：Libraries for Token Signing/Verification。

经过使用，感觉 Java JWT 还是很好用的。这里记录以下使用这个库的一些小测试，以后就不用到处找了。

Java JWT 的官方 GitHub：Java JWT

Maven 引入：

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

此库需要 Java 8 或更高版本。支持 Java 7 的最后一个版本是 3.11.0。

以下是测试代码（测试工具是 JUnit 4.12）：

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.DecodedJWT;
import org.junit.Test;

import java.util.Date;

/**
 * JwtTest
 * <p>
 * 本类对 Java JWT 库的生成、解码、验证方法进行测试
 * <p>
 * 官方 GitHub：<a href="https://github.com/auth0/java-jwt">Java JWT</a>
 * <p>
 * 翻译：<a href="https://zhuanlan.zhihu.com/p/44907060">Java Web Token 之 java-jwt</a>
 *
 * @author Yin Guiqing
 * @version 1.0
 * @date 2022-02-15 17:06
 */
public class JwtTest {

    /**
     * 测试生成 JWT Token
     */
    @Test
    public void generate() {
        Algorithm algorithm = Algorithm.HMAC256("secret");
        final int duration = 24 * 60 * 60 * 1000;
        String token = JWT.create()
                .withIssuer("YGQ Issuer")
                .withSubject("主题是测试")
                .withClaim("birthday", "1997-10-01")
                .withExpiresAt(new Date(System.currentTimeMillis() + duration))
                .sign(algorithm);
        System.out.println(token);
    }

    /**
     * 测试解码 JWT Token
     */
    @Test
    public void parse() {
        String token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" +
                ".eyJiaXJ0aGRheSI6IjE5OTctMTAtMDEiLCJzdWIiOiLkuLvpopjmmK_mtYvor5UiLCJpc3MiOiJZR1EgSXNzdWVyIiwiZXhwIjoxNjQ1MDA3Mzg4fQ.1IGrhgA9gfyp6GUXFRfOZPpgIMxZNSxelkBpRFrC6T8";
        // 这个方法会尝试将给定的 token 进行解码，解码失败会抛出异常
        // 注意，这个方法只是解码，不会验证 token 的有效性，验证的话请使用 JWTVerifier
        DecodedJWT decodedJWT = JWT.decode(token);
        System.out.println(decodedJWT.getExpiresAt());
        System.out.println(decodedJWT.getClaim("birthday"));
    }

    /**
     * 测试验证 JWT Token
     */
    @Test
    public void verify() {
        String token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" +
                ".eyJiaXJ0aGRheSI6IjE5OTctMTAtMDEiLCJzdWIiOiLkuLvpopjmmK_mtYvor5UiLCJpc3MiOiJZR1EgSXNzdWVyIiwiZXhwIjoxNjQ1MDA3Mzg4fQ.1IGrhgA9gfyp6GUXFRfOZPpgIMxZNSxelkBpRFrC6T8";
        Algorithm algorithm = Algorithm.HMAC256("secret");
        // 创建一个验证器，用于对 token 的验证
        // 可指定特定的值，如果待验证的 token 与验证器不符，则会验证失败
        JWTVerifier jwtVerifier = JWT.require(algorithm)
                .withIssuer("YGQ Issuer")
                .withClaim("birthday", "1999-10-01")
                .build();
        try {
            // 如果验证通过，返回一个经过验证和解码的 JWT
            DecodedJWT decodedJWT = jwtVerifier.verify(token);
            // JWT 的三个部分：Header, Payload, Signature
            // 下面三个方法分别将其切了出来
            System.out.println(decodedJWT.getHeader());
            System.out.println(decodedJWT.getPayload());
            System.out.println(decodedJWT.getSignature());
            // 也可以获得各个部分的真实值
            // 比如获取失效时间
            System.out.println(decodedJWT.getExpiresAt());
        } catch (JWTVerificationException e) {
            // 如果验证失败
            System.out.println(e.getMessage());
        }
    }
}