cn.dev33.satoken.jwt

类 SaJwtUtil

java.lang.Object

cn.dev33.satoken.jwt.SaJwtUtil

public class SaJwtUtil
extends java.lang.Object

jwt操作工具类封装

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEVICE key：登录设备
static java.lang.String	EFF key：有效截止期 (时间戳)
static java.lang.String	LOGIN_ID key：账号id
static java.lang.String	LOGIN_TYPE key：账号类型
static long	NEVER_EXPIRE 当有效期被设为此值时，代表永不过期

构造器概要

构造器

构造器和说明
SaJwtUtil()

方法概要

限定符和类型	方法和说明
static java.lang.String	createToken(java.lang.Object loginId, java.util.Map<java.lang.String,java.lang.Object> extraData, java.lang.String keyt) 创建 jwt （简单方式）
static java.lang.String	createToken(java.lang.Object loginId, java.lang.String keyt) 已过时。
static java.lang.String	createToken(java.lang.String loginType, java.lang.Object loginId, java.lang.String device, long timeout, java.util.Map<java.lang.String,java.lang.Object> extraData, java.lang.String keyt) 创建 jwt （全参数方式）
static java.lang.String	createToken(java.lang.String loginType, java.lang.Object loginId, java.lang.String device, long timeout, java.lang.String keyt) 已过时。
static java.lang.Object	getLoginId(java.lang.String token, java.lang.String keyt) 获取 jwt 代表的账号id
static java.lang.Object	getLoginIdOrNull(java.lang.String token, java.lang.String keyt) 获取 jwt 代表的账号id (未登录时返回null)
static cn.hutool.json.JSONObject	getPayloads(java.lang.String token, java.lang.String keyt) 获取 jwt 数据载荷 （校验签名和有效期）
static cn.hutool.json.JSONObject	getPayloadsNotCheck(java.lang.String token, java.lang.String keyt) 获取 jwt 数据载荷 （只校验签名，不校验有效期）
static long	getTimeout(java.lang.String token, java.lang.String keyt) 获取 jwt 剩余有效期
static cn.hutool.jwt.JWT	parseToken(java.lang.String token, java.lang.String keyt) jwt 解析（校验签名和有效期）

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

LOGIN_TYPE

public static final java.lang.String LOGIN_TYPE

key：账号类型

另请参阅:

常量字段值

LOGIN_ID

public static final java.lang.String LOGIN_ID

key：账号id

另请参阅:

常量字段值

DEVICE

public static final java.lang.String DEVICE

key：登录设备

另请参阅:

常量字段值

EFF

public static final java.lang.String EFF

key：有效截止期 (时间戳)

另请参阅:

常量字段值

NEVER_EXPIRE

public static final long NEVER_EXPIRE

当有效期被设为此值时，代表永不过期

另请参阅:

常量字段值

构造器详细资料

SaJwtUtil

public SaJwtUtil()

方法详细资料

createToken

public static java.lang.String createToken(java.lang.Object loginId,
                                           java.util.Map<java.lang.String,java.lang.Object> extraData,
                                           java.lang.String keyt)

创建 jwt （简单方式）

参数:

loginId - 账号id

extraData - 扩展数据

keyt - 秘钥

返回:

jwt-token

createToken

public static java.lang.String createToken(java.lang.String loginType,
                                           java.lang.Object loginId,
                                           java.lang.String device,
                                           long timeout,
                                           java.util.Map<java.lang.String,java.lang.Object> extraData,
                                           java.lang.String keyt)

创建 jwt （全参数方式）

参数:

loginType - 账号类型

loginId - 账号id

device - 设备标识

timeout - token有效期 (单位 秒)

extraData - 扩展数据

keyt - 秘钥

返回:

jwt-token

parseToken

public static cn.hutool.jwt.JWT parseToken(java.lang.String token,
                                           java.lang.String keyt)

jwt 解析（校验签名和有效期）

参数:

token - Jwt-Token值

keyt - 秘钥

返回:

解析后的jwt 对象

getPayloads

public static cn.hutool.json.JSONObject getPayloads(java.lang.String token,
                                                    java.lang.String keyt)

获取 jwt 数据载荷 （校验签名和有效期）

参数:

token - token值

keyt - 秘钥

返回:

载荷

getPayloadsNotCheck

public static cn.hutool.json.JSONObject getPayloadsNotCheck(java.lang.String token,
                                                            java.lang.String keyt)

获取 jwt 数据载荷 （只校验签名，不校验有效期）

参数:

token - token值

keyt - 秘钥

返回:

载荷

getLoginId

public static java.lang.Object getLoginId(java.lang.String token,
                                          java.lang.String keyt)

获取 jwt 代表的账号id

参数:

token - Token值

keyt - 秘钥

返回:

值

getLoginIdOrNull

public static java.lang.Object getLoginIdOrNull(java.lang.String token,
                                                java.lang.String keyt)

获取 jwt 代表的账号id (未登录时返回null)

参数:

token - Token值

keyt - 秘钥

返回:

值

getTimeout

public static long getTimeout(java.lang.String token,
                              java.lang.String keyt)

获取 jwt 剩余有效期

参数:

token - JwtToken值

keyt - 秘钥

返回:

值

createToken

@Deprecated
public static java.lang.String createToken(java.lang.Object loginId,
                                                        java.lang.String keyt)

已过时。

创建 jwt （简单方式）

参数:

loginId - 账号id

keyt - 秘钥

返回:

jwt-token

createToken

@Deprecated
public static java.lang.String createToken(java.lang.String loginType,
                                                        java.lang.Object loginId,
                                                        java.lang.String device,
                                                        long timeout,
                                                        java.lang.String keyt)

已过时。

创建 jwt （全参数方式）

参数:

loginType - 账号类型

loginId - 账号id

device - 设备标识

timeout - token有效期 (单位 秒)

keyt - 秘钥

返回:

jwt-token