类的使用
cn.dev33.satoken.apikey.model.ApiKeyModel

使用ApiKeyModel的程序包

程序包	说明
cn.dev33.satoken.apikey
cn.dev33.satoken.apikey.loader
cn.dev33.satoken.apikey.model

cn.dev33.satoken.apikey中ApiKeyModel的使用

返回ApiKeyModel的cn.dev33.satoken.apikey中的方法

修饰符和类型	方法	说明
ApiKeyModel	SaApiKeyTemplate.checkApiKey(String apiKey)	校验 ApiKey，成功返回 ApiKeyModel，失败则抛出异常
static ApiKeyModel	SaApiKeyUtil.checkApiKey(String apiKey)	校验 ApiKey，成功返回 ApiKeyModel，失败则抛出异常
ApiKeyModel	SaApiKeyTemplate.createApiKeyModel()	创建一个 ApiKeyModel 对象
ApiKeyModel	SaApiKeyTemplate.createApiKeyModel(Object loginId)	创建一个 ApiKeyModel 对象
static ApiKeyModel	SaApiKeyUtil.createApiKeyModel()	创建一个 ApiKeyModel 对象
static ApiKeyModel	SaApiKeyUtil.createApiKeyModel(Object loginId)	创建一个 ApiKeyModel 对象
ApiKeyModel	SaApiKeyTemplate.currentApiKey()	数据读取：从请求对象中读取 ApiKey，并查询到 ApiKeyModel 信息
static ApiKeyModel	SaApiKeyUtil.currentApiKey()	数据读取：从请求对象中读取 ApiKey，并查询到 ApiKeyModel 信息
ApiKeyModel	SaApiKeyTemplate.getApiKey(String apiKey)	获取 ApiKeyModel，无效的 ApiKey 会返回 null
static ApiKeyModel	SaApiKeyUtil.getApiKey(String apiKey)	获取 ApiKeyModel，无效的 ApiKey 会返回 null
ApiKeyModel	SaApiKeyTemplate.getApiKeyModelFromCache(String apiKey)	根据 apiKey 从 Cache 获取 ApiKeyModel 信息
ApiKeyModel	SaApiKeyTemplate.getApiKeyModelFromDatabase(String apiKey)	根据 apiKey 从 Database 获取 ApiKeyModel 信息

返回变量类型为ApiKeyModel的类型的cn.dev33.satoken.apikey中的方法

修饰符和类型	方法	说明
List<ApiKeyModel>	SaApiKeyTemplate.getApiKeyList(Object loginId)	获取指定 loginId 的 ApiKey 列表记录
static List<ApiKeyModel>	SaApiKeyUtil.getApiKeyList(Object loginId)	获取指定 loginId 的 ApiKey 列表记录

参数类型为ApiKeyModel的cn.dev33.satoken.apikey中的方法

修饰符和类型	方法	说明
void	SaApiKeyTemplate.saveApiKey(ApiKeyModel ak)	持久化：ApiKeyModel
static void	SaApiKeyUtil.saveApiKey(ApiKeyModel ak)	持久化：ApiKeyModel

cn.dev33.satoken.apikey.loader中ApiKeyModel的使用

返回ApiKeyModel的cn.dev33.satoken.apikey.loader中的方法

修饰符和类型	方法	说明
default ApiKeyModel	SaApiKeyDataLoader.getApiKeyModelFromDatabase(String namespace, String apiKey)	根据 apiKey 从数据库获取 ApiKeyModel 信息 （实现此方法无需为数据做缓存处理，框架内部已包含缓存逻辑）

cn.dev33.satoken.apikey.model中ApiKeyModel的使用

返回ApiKeyModel的cn.dev33.satoken.apikey.model中的方法

修饰符和类型	方法	说明
ApiKeyModel	ApiKeyModel.addExtra(String key, Object value)	添加 扩展数据
ApiKeyModel	ApiKeyModel.addScope(String... scope)	添加 Scope
ApiKeyModel	ApiKeyModel.setApiKey(String apiKey)	设置 ApiKey 值
ApiKeyModel	ApiKeyModel.setCreateTime(long createTime)	设置 ApiKey 创建时间，13位时间戳
ApiKeyModel	ApiKeyModel.setExpiresTime(long expiresTime)	设置 ApiKey 到期时间，13位时间戳 (-1=永不过期)
ApiKeyModel	ApiKeyModel.setExtraData(Map<String,Object> extraData)	设置 扩展数据
ApiKeyModel	ApiKeyModel.setIntro(String intro)	设置 介绍
ApiKeyModel	ApiKeyModel.setIsValid(Boolean isValid)	设置 是否有效 (true=生效 false=禁用)
ApiKeyModel	ApiKeyModel.setLoginId(Object loginId)	设置 账号 id
ApiKeyModel	ApiKeyModel.setScopes(List<String> scopes)	设置 授权范围
ApiKeyModel	ApiKeyModel.setTitle(String title)	设置 名称