JWT (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.json.jwt.JWT

All Implemented Interfaces:

RegisteredPayload<JWT>
```
public class JWT
extends Object
implements RegisteredPayload<JWT>
```
JSON Web Token (JWT)，基于JSON的开放标准（(RFC 7519)用于在网络应用环境间传递声明。

结构：header.payload.signature
- header：主要声明了JWT的签名算法
- payload：主要承载了各种声明并传递明文数据
- signature：拥有该部分的JWT被称为JWS，也就是签了名的JWS
详细介绍见；https://www.jianshu.com/p/576dbf44b2ae
Since:

5.7.0

Author:

looly

Field Summary
- Fields inherited from interface org.dromara.hutool.json.jwt.RegisteredPayload
  AUDIENCE, EXPIRES_AT, ISSUED_AT, ISSUER, JWT_ID, NOT_BEFORE, SUBJECT

Constructor Summary

Constructors
Constructor and Description

JWT()
构造

JWT(String token)
构造

Constructors
Constructor and Description
`JWT()` 构造
`JWT(String token)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JWT`	`addHeaders(Map<String,?> headers)` 增加JWT头信息
`JWT`	`addPayloads(Map<String,?> payloads)` 增加JWT载荷信息
`String`	`getAlgorithm()` 获取算法ID(alg)头信息
`JWTHeader`	`getHeader()` 获取头
`Object`	`getHeader(String name)` 获取头信息
`JSONObject`	`getHeaders()` 获取所有头信息
`JWTPayload`	`getPayload()` 获取载荷对象
`Object`	`getPayload(String name)` 获取载荷信息
`<T> T`	`getPayload(String propertyName, Type propertyType)` 获取payload并获取类型
`JSONObject`	`getPayloads()` 获取所有载荷信息
`JWTSigner`	`getSigner()` 获取JWT算法签名器
`static JWT`	`of()` 创建空的JWT对象
`static JWT`	`of(String token)` 创建并解析JWT对象
`JWT`	`parse(String token)` 解析JWT内容
`JWT`	`setCharset(Charset charset)` 设置编码
`JWT`	`setHeader(String name, Object value)` 设置JWT头信息
`JWT`	`setKey(byte[] key)` 设置密钥，默认算法是：HS256(HmacSHA256)
`JWT`	`setPayload(String name, Object value)` 设置JWT载荷信息
`JWT`	`setSigner(JWTSigner signer)` 设置签名算法
`JWT`	`setSigner(String algorithmId, byte[] key)` 设置签名算法
`JWT`	`setSigner(String algorithmId, Key key)` 设置签名算法
`JWT`	`setSigner(String algorithmId, KeyPair keyPair)` 设置非对称签名算法
`String`	`sign()` 签名生成JWT字符串
`String`	`sign(JWTSigner signer)` 签名生成JWT字符串，计算方式为（以HS256为例）： HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload), secret) 此方法会补充如下的header：当用户未定义"typ"时，不设置默认值当用户未定义"alg"时，根据传入的`JWTSigner`对象类型，赋值对应ID
`boolean`	`validate(long leeway)` 验证JWT是否有效，验证包括： Token是否正确 `RegisteredPayload.NOT_BEFORE`：生效时间不能晚于当前时间 `RegisteredPayload.EXPIRES_AT`：失效时间不能早于当前时间 `RegisteredPayload.ISSUED_AT`：签发时间不能晚于当前时间
`boolean`	`verify()` 验证JWT Token是否有效
`boolean`	`verify(JWTSigner signer)` 使用指定签名器，验证JWT Token是否有效如果签名器为`null`，或者`NoneJWTSigner`，表示这个JWT无签名，签名部分必须为空

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dromara.hutool.json.jwt.RegisteredPayload
setAudience, setExpiresAt, setIssuedAt, setIssuer, setJWTId, setNotBefore, setSubject

- Constructor Detail
  - JWT
```
public JWT()
```
    构造
  - JWT
```
public JWT(String token)
```
    构造
    
    Parameters:
    
    token - JWT Token字符串，格式为xxxx.yyyy.zzzz
- Method Detail
  - of
```
public static JWT of()
```
    创建空的JWT对象
    
    Returns:
    
    JWT
  - of
```
public static JWT of(String token)
```
    创建并解析JWT对象
    
    Parameters:
    
    token - JWT Token字符串，格式为xxxx.yyyy.zzzz
    
    Returns:
    
    JWT
  - parse
```
public JWT parse(String token)
          throws IllegalArgumentException
```
    解析JWT内容
    
    Parameters:
    
    token - JWT Token字符串，格式为xxxx.yyyy.zzzz，不能为空
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - 给定字符串为空
  - setCharset
```
public JWT setCharset(Charset charset)
```
    设置编码
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    this
  - setKey
```
public JWT setKey(byte[] key)
```
    设置密钥，默认算法是：HS256(HmacSHA256)
    
    Parameters:
    
    key - 密钥
    
    Returns:
    
    this
  - setSigner
```
public JWT setSigner(String algorithmId,
                     byte[] key)
```
    设置签名算法
    
    Parameters:
    
    algorithmId - 签名算法ID，如HS256
    
    key - 密钥
    
    Returns:
    
    this
  - setSigner
```
public JWT setSigner(String algorithmId,
                     Key key)
```
    设置签名算法
    
    Parameters:
    
    algorithmId - 签名算法ID，如HS256
    
    key - 密钥
    
    Returns:
    
    this
    
    Since:
    
    5.7.2
  - setSigner
```
public JWT setSigner(String algorithmId,
                     KeyPair keyPair)
```
    设置非对称签名算法
    
    Parameters:
    
    algorithmId - 签名算法ID，如HS256
    
    keyPair - 密钥对
    
    Returns:
    
    this
    
    Since:
    
    5.7.2
  - setSigner
```
public JWT setSigner(JWTSigner signer)
```
    设置签名算法
    
    Parameters:
    
    signer - 签名算法
    
    Returns:
    
    this
  - getSigner
```
public JWTSigner getSigner()
```
    获取JWT算法签名器
    
    Returns:
    
    JWT算法签名器
  - getHeaders
```
public JSONObject getHeaders()
```
    获取所有头信息
    
    Returns:
    
    头信息
  - getHeader
```
public JWTHeader getHeader()
```
    获取头
    
    Returns:
    
    头信息
    
    Since:
    
    5.7.2
  - getHeader
```
public Object getHeader(String name)
```
    获取头信息
    
    Parameters:
    
    name - 头信息名称
    
    Returns:
    
    头信息
  - getAlgorithm
```
public String getAlgorithm()
```
    获取算法ID(alg)头信息
    
    Returns:
    
    算法头信息
    
    See Also:
    
    JWTHeader.ALGORITHM
  - setHeader
```
public JWT setHeader(String name,
                     Object value)
```
    设置JWT头信息
    
    Parameters:
    
    name - 头名
    
    value - 头
    
    Returns:
    
    this
  - addHeaders
```
public JWT addHeaders(Map<String,?> headers)
```
    增加JWT头信息
    
    Parameters:
    
    headers - 头信息
    
    Returns:
    
    this
  - getPayloads
```
public JSONObject getPayloads()
```
    获取所有载荷信息
    
    Returns:
    
    载荷信息
  - getPayload
```
public JWTPayload getPayload()
```
    获取载荷对象
    
    Returns:
    
    载荷信息
    
    Since:
    
    5.7.2
  - getPayload
```
public Object getPayload(String name)
```
    获取载荷信息
    
    Parameters:
    
    name - 载荷信息名称
    
    Returns:
    
    载荷信息
  - getPayload
```
public <T> T getPayload(String propertyName,
                        Type propertyType)
```
    获取payload并获取类型
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    propertyName - 需要提取的属性名称
    
    propertyType - 需要提取的属性类型
    
    Returns:
    
    载荷信息
    
    Throws:
    
    ValidateException - 传入的类型不匹配payload类型
    
    Since:
    
    6.0.0
  - setPayload
```
public JWT setPayload(String name,
                      Object value)
```
    设置JWT载荷信息
    
    Specified by:
    
    setPayload in interface RegisteredPayload<JWT>
    
    Parameters:
    
    name - 载荷名
    
    value - 头
    
    Returns:
    
    this
  - addPayloads
```
public JWT addPayloads(Map<String,?> payloads)
```
    增加JWT载荷信息
    
    Parameters:
    
    payloads - 载荷信息
    
    Returns:
    
    this
  - sign
```
public String sign()
```
    签名生成JWT字符串
    
    Returns:
    
    JWT字符串
  - sign
```
public String sign(JWTSigner signer)
```
    签名生成JWT字符串，计算方式为（以HS256为例）：
```
 HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload), secret)
 
```
    此方法会补充如下的header：
    - 当用户未定义"typ"时，不设置默认值
    - 当用户未定义"alg"时，根据传入的JWTSigner对象类型，赋值对应ID
    Parameters:
    
    signer - 自定义JWT签名器，非空
    
    Returns:
    
    JWT字符串
  - verify
```
public boolean verify()
```
    验证JWT Token是否有效
    
    Returns:
    
    是否有效
  - validate
```
public boolean validate(long leeway)
```
    验证JWT是否有效，验证包括：
    - Token是否正确
    - RegisteredPayload.NOT_BEFORE：生效时间不能晚于当前时间
    - RegisteredPayload.EXPIRES_AT：失效时间不能早于当前时间
    - RegisteredPayload.ISSUED_AT：签发时间不能晚于当前时间
    Parameters:
    
    leeway - 容忍空间，单位：秒。当不能晚于当前时间时，向后容忍；不能早于向前容忍。
    
    Returns:
    
    是否有效
    
    Since:
    
    5.7.4
    
    See Also:
    
    JWTValidator
  - verify
```
public boolean verify(JWTSigner signer)
```
    使用指定签名器，验证JWT Token是否有效
    如果签名器为null，或者NoneJWTSigner，表示这个JWT无签名，签名部分必须为空
    
    Parameters:
    
    signer - 签名器（签名算法），如果为null，默认为NoneJWTSigner
    
    Returns:
    
    是否有效

Class JWT

Field Summary

Fields inherited from interface org.dromara.hutool.json.jwt.RegisteredPayload

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.json.jwt.RegisteredPayload

Constructor Detail

JWT

JWT

Method Detail

of

of

parse

setCharset

setKey

setSigner

setSigner

setSigner

setSigner

getSigner

getHeaders

getHeader

getHeader

getAlgorithm

setHeader

addHeaders

getPayloads

getPayload

getPayload

getPayload

setPayload

addPayloads

sign

sign

verify

validate

verify