cn.stylefeng.roses.kernel.jwt.api

接口 JwtApi

public interface JwtApi

jwt相关的操作api

作者:

fengshuonan

方法概要

限定符和类型	方法和说明
String	generateToken(Map<String,Object> payload) 生成token
String	generateTokenDefaultPayload(DefaultJwtPayload defaultJwtPayload) 生成token，用默认的payload格式
DefaultJwtPayload	getDefaultPayload(String token) 获取jwt的payload（限定默认格式）
Map<String,Object>	getJwtPayloadClaims(String token) 获取jwt的payload（通用的）
boolean	validateToken(String token) 校验jwt token是否正确 不正确的token有两种： 1.
boolean	validateTokenIsExpired(String token) 校验jwt token是否失效了
void	validateTokenWithException(String token) 校验jwt token是否正确，如果参数token是错误的会抛出对应异常 不正确的token有两种： 1.

方法详细资料

generateToken

String generateToken(Map<String,Object> payload)

生成token

参数:

payload - jwt的载体信息

返回:

jwt token

generateTokenDefaultPayload

String generateTokenDefaultPayload(DefaultJwtPayload defaultJwtPayload)

生成token，用默认的payload格式

参数:

defaultJwtPayload - jwt的载体信息

返回:

jwt token

getJwtPayloadClaims

Map<String,Object> getJwtPayloadClaims(String token)

获取jwt的payload（通用的）

参数:

token - jwt的token

返回:

jwt的payload

getDefaultPayload

DefaultJwtPayload getDefaultPayload(String token)

获取jwt的payload（限定默认格式）

参数:

token - jwt的token

返回:

返回默认格式的payload

validateToken

boolean validateToken(String token)

校验jwt token是否正确

不正确的token有两种：

1. 第一种是jwt token过期了 2. 第二种是jwt本身是错误的

本方法只会响应正确还是错误

参数:

token - jwt的token

返回:

true-token正确，false-token错误或失效

validateTokenWithException

void validateTokenWithException(String token)
                         throws JwtException

校验jwt token是否正确，如果参数token是错误的会抛出对应异常

不正确的token有两种：

1. 第一种是jwt token过期了 2. 第二种是jwt本身是错误的

参数:

token - jwt的token

抛出:

JwtException - Jwt相关的业务异常

validateTokenIsExpired

boolean validateTokenIsExpired(String token)

校验jwt token是否失效了

参数:

token - jwt token

返回:

true-token失效，false-token没失效