程序包 cn.dev33.satoken.temp

类 SaTempUtil

java.lang.Object

cn.dev33.satoken.temp.SaTempUtil

public class SaTempUtil
extends Object

Sa-Token 临时 token 验证模块 - 工具类

有效期很短的一种token，一般用于一次性接口防盗用、短时间资源访问等业务场景

从以下版本开始:

1.20.0

作者:

click33

方法概要

修饰符和类型	方法	说明
static String	createToken(Object value, long timeout)	为指定 value 创建一个临时 token (如果多条业务线均需要创建临时 token，请自行在 value 拼接不同前缀)
static String	createToken(Object value, long timeout, boolean isRecordIndex)	为指定 业务标识、指定 value 创建一个 Token
static void	deleteToken(String token)	删除一个 token
static List<String>	getTempTokenList(Object value)	获取指定 value 的 temp-token 列表记录
static long	getTimeout(String token)	获取指定指定 Token 的剩余有效期，单位：秒
static Object	parseToken(String token)	解析 Token 获取 value
static <T> T	parseToken(String token, Class<T> cs)	解析 Token 获取 value，并转换为指定类型
static <T> T	parseToken(String token, String cutPrefix, Class<T> cs)	解析 token 获取 value，并裁剪指定前缀，然后转换为指定类型
static void	saveToken(String token, Object value, long timeout)	保存 token

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

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

方法详细资料

createToken

public static String createToken(Object value,
 long timeout)

为指定 value 创建一个临时 token (如果多条业务线均需要创建临时 token，请自行在 value 拼接不同前缀)

参数:

value - 指定值

timeout - 有效时间，单位：秒，-1 代表永久有效

返回:

生成的 token

createToken

public static String createToken(Object value,
 long timeout,
 boolean isRecordIndex)

为指定 业务标识、指定 value 创建一个 Token

参数:

value - 指定值

timeout - 有效期，单位：秒，-1 代表永久有效

isRecordIndex - 是否记录索引，以便后续使用 value 反查 token

返回:

生成的token

saveToken

public static void saveToken(String token,
 Object value,
 long timeout)

保存 token

参数:

token - /

value - /

timeout - /

parseToken

public static Object parseToken(String token)

解析 Token 获取 value

参数:

token - 指定 Token

返回:

/

parseToken

public static <T> T parseToken(String token,
 Class<T> cs)

解析 Token 获取 value，并转换为指定类型

类型参数:

T - 默认值的类型

参数:

token - 指定 Token

cs - 指定类型

返回:

/

parseToken

public static <T> T parseToken(String token,
 String cutPrefix,
 Class<T> cs)

解析 token 获取 value，并裁剪指定前缀，然后转换为指定类型

请注意此方法在旧版本（<= v1.41.0） 时的三个参数为：service, token, class
新版本三个参数为：token, cutPrefix, class
请注意其中的逻辑变化

类型参数:

T - 默认值的类型

参数:

token - 指定 Token

cs - 指定类型

返回:

/

getTimeout

public static long getTimeout(String token)

获取指定指定 Token 的剩余有效期，单位：秒

返回值 -1 代表永久，-2 代表 token 无效

参数:

token - /

返回:

/

deleteToken

public static void deleteToken(String token)

删除一个 token

参数:

token - 指定 Token

getTempTokenList

public static List<String> getTempTokenList(Object value)

获取指定 value 的 temp-token 列表记录

参数:

value - /

返回:

/