JWT低阶入门

ゝ一纸荒年。 2024-03-30 09:13 54阅读 0赞

#### JWT ####

*  1.JWT介绍
 *  2.JWT组成介绍
 *  3.引入依赖
 *  4.代码介绍

## 1.JWT介绍 ##

*  JWT是JSON Web Token的缩写，即JSON Web令牌，是一种自包含令牌。 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准。
 *  JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源。比如用在用户登录上。
 *  JWT最重要的作用就是对 token信息的防伪作用。

## 2.JWT组成介绍 ##

一个JWT由三个部分组成：**JWT头、有效载荷、签名哈希**  
最后由这三者组合进行base64url编码得到JWT

典型的，一个JWT看起来如下图：该对象为一个很长的字符串，字符之间通过"."分隔符分为三个子串。

**JWT头**

JWT头部分是一个描述JWT元数据的JSON对象，通常如下所示。

{
        
      "alg": "HS256",
      "typ": "JWT"
    }

在上面的代码中，alg属性表示签名使用的算法，默认为HMAC SHA256（写为HS256）；

typ属性表示令牌的类型，JWT令牌统一写为JWT。

最后，使用Base64 URL算法将上述JSON对象转换为字符串保存。

**有效载荷**

有效载荷部分，是JWT的主体内容部分，也是一个JSON对象，包含需要传递的数据。 JWT指定七个默认字段供选择。

iss: jwt签发者
    sub: 主题
    aud: 接收jwt的一方
    exp: jwt的过期时间，这个过期时间必须要大于签发时间
    nbf: 定义在什么时间之前，该jwt都是不可用的.
    iat: jwt的签发时间
    jti: jwt的唯一身份标识，主要用来作为一次性token,从而回避重放攻击。

除以上默认字段外，我们还可以自定义私有字段，如下例：

{
        
      "name": "Helen",
      "role": "editor",
      "avatar": "helen.jpg"
    }

请注意，默认情况下JWT是未加密的，任何人都可以解读其内容，因此不要构建隐私信息字段，存放保密信息，以防止信息泄露。

JSON对象也使用Base64 URL算法转换为字符串保存。

**签名哈希**

签名哈希部分是对上面两部分数据签名，通过指定的算法生成哈希，以确保数据不会被篡改。

首先，需要指定一个密码（secret）。该密码仅仅为保存在服务器中，并且不能向用户公开。然后，使用标头中指定的签名算法（默认情况下为HMAC SHA256）根据以下公式生成签名。

HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(claims), secret)    ==>   签名hash

在计算出签名哈希后，JWT头，有效载荷和签名哈希的三个部分组合成一个字符串，每个部分用"."分隔，就构成整个JWT对象。

**Base64URL算法**

如前所述，JWT头和有效载荷序列化的算法都用到了Base64URL。该算法和常见Base64算法类似，稍有差别。

作为令牌的JWT可以放在URL中（例如api.example/?token=xxx）。 Base64中用的三个字符是"+“，”/“和”=“，由于在URL中有特殊含义，因此Base64URL中对他们做了替换：”=“去掉，”+“用”-“替换，”/“用”\_"替换，这就是Base64URL算法。

## 3.引入依赖 ##

<dependency>
        <groupId>io.jsonwebtoken</groupId>
        <artifactId>jjwt-api</artifactId>
        <version>0.11.5</version>
    </dependency>

如果只导入这个jar包，运行代码会报错

Exception in thread "main" java.lang.IllegalStateException: Unable to invoke class method io.jsonwebtoken.impl.crypto.MacProvider#generateKey.  Ensure the necessary implementation is in the runtime classpath.
    
    Caused by: io.jsonwebtoken.lang.UnknownClassException: Unable to load class named [io.jsonwebtoken.impl.crypto.MacProvider] from the thread context, current, or system/application ClassLoaders.  All heuristics have been exhausted.  Class could not be found.  Have you remembered to include the jjwt-impl.jar in your runtime classpath?

还需要导入

<dependency>
        <groupId>io.jsonwebtoken</groupId>
        <artifactId>jjwt-impl</artifactId>
        <version>0.11.5</version>
    </dependency>
    
    <dependency>
        <groupId>io.jsonwebtoken</groupId>
        <artifactId>jjwt-jackson</artifactId>
        <version>0.11.5</version>
    </dependency>

## 4.代码介绍 ##

import io.jsonwebtoken.*;
    import io.jsonwebtoken.security.Keys;
    import lombok.extern.slf4j.Slf4j;
    
    import javax.crypto.SecretKey;
    import java.util.Date;
    
    /**
     * @author 尹稳健~
     * @version 1.0
     * @time 2022/12/14
     */
    @Slf4j
    public class JwtUtil {
        
    
        /** 使用HS512加密算法 签名 */
        static SecretKey key = Keys.secretKeyFor(SignatureAlgorithm.HS512);
    
        /** 设置token过期时间 */
        private static final long EXPIRE_TIME = 1000*2*60;
    
        /**
         * 创建token
         * @param userId
         * @param username
         * @return
         */
        public static String createToken(Long userId,String username){
        
            String token = Jwts.builder()
                    // 可以将基本不重要的对象信息放到claims
                    .claim("userId", userId)
                    .claim("username", username)
                    .signWith(key)
                    .setSubject("AUTH-USER")
                    .setExpiration(new Date(System.currentTimeMillis() + EXPIRE_TIME))
                    .compact();
            return token;
        }
    
        /**
         * 解析token
         * @param token
         * @return
         */
        public static Claims  parseToken(String token){
        
            //顺带说一句，当Jwt设置了有效期，有效期时间过了之后也会抛出异常，解决办法是try
            //catch一下，将异常抛给统一异常处理类
            try {
        
                Claims claims = Jwts.parserBuilder()
                        .setSigningKey(key)
                        .build()
                        .parseClaimsJws(token)
                        .getBody();
                return claims;
            } catch (ExpiredJwtException  eje) {
        
                log.error("===== Token过期 =====", eje);
                throw new RuntimeException(eje.getMessage());
            } catch (Exception e){
        
                log.error("===== token解析异常 =====", e);
                throw new RuntimeException(e.getMessage());
            }
        }
    
        /**
         * 获取用户id
         * @param token
         * @return
         */
        public static Long getUserId(String token){
        
            return (Long) parseToken(token).get("userId");
        }
    
        /**
         * 获取用户名
         * @param token
         * @return
         */
        public static String getUsername(String token){
        
            return (String)parseToken(token).get("username");
        }
        
    	/**
         * 判断是否过期
         * @param token
         * @param base64Security
         * @return
         */
        public static boolean isExpiration(String token, String base64Security) {
        
            return parseToken(token).getExpiration().before(new Date());
        }
    
    }