OAuth2
所生成的AccessToken
以及RefreshToken
都存在过期时间,当在有效期内才可以拿来作为会话身份发起请求,否者认证中心
会直接拦截无效请求提示已过期
,那么我们怎么修改这个过期时间来满足我们的业务场景呢?
目前一线大厂所使用的的AccessToken
的有效期一般都是7200秒
,也就是2小时
,而且有获取的次数限制,所以发起请求的一方必须通过一定的形式保存到本地,以方便下一次发起请求时,写入请求的header
或者作为参数携带。
本章来讲解下使用ApiBoot OAuth
组件该怎么去设置AccessToken
的过期时间,针对memory
(内存方式)、jdbc
(数据库)这两种方式来讲解,更多使用请参考官方文档:
- ApiBoot OAuth官方文档:http://apiboot.minbox.io/zh-cn/docs/api-boot-oauth.html
ApiBoot Security OAuth组件系列文章
- ApiBoot实现零代码整合Spring Security & OAuth2
- ApiBoot零代码整合Spring Security的JDBC方式获取AccessToken
- 见过这么简单的方式整合Spring Security & OAuth2的自定义查询用户吗?
- Spring Security & OAuth2实现短信验证码方式获取AccessToken
- 原来Spring Security整合OAuth2后开放权限拦截路径还能这么玩?
- 我以为OAuth2整合JWT是很困难的事情,直到我使用了ApiBoot,一切都变了!
- 来看看OAuth2怎么设置AccessToken有效期时间时长
- OAuth2使用Redis来存储客户端信息以及AccessToken
默认有效时长
ApiBoot OAuth
在memory
存储方式下为每一个客户端
都提供了一个默认的AccessToken
有效时长,该配置在org.minbox.framework.api.boot.autoconfigure.oauth.ApiBootOauthProperties
,相关源码如下所示:
/**
* Oauth2 Client
* Used to configure multiple clients
*/
@Data
public static class Client {
/**
* oauth2 client id
*/
private String clientId = "ApiBoot";
/**
* oauth2 client secret
*/
private String clientSecret = "ApiBootSecret";
/**
* oauth2 client grant types
* default value is "password,refresh_token"
*/
private String[] grantTypes = new String[]{"password", "refresh_token"};
/**
* oauth2 client scope
* default value is "api"
*/
private String[] scopes = new String[]{"api"};
/**
* oauth2 application resource id
* default value is "api"
*/
private String[] resourceId = new String[]{"api"};
/**
* oauth2 access token validity seconds
* default value is 7200 second
*/
private int accessTokenValiditySeconds = 7200;
}
Client
是ApiBootOauthProperties
的一个内部类,主要是提供了OAuth2 客户端
的相关配置字段,通过spring-boot-configuration-processor
依赖将该类自动解析成配置元数据
,这样我们在application.yml
输入api.xxx
时可以得到相应的提示。
在Client
内部类中有一个字段accessTokenValiditySeconds
,通过该字段我们来修改该客户端下所有用户生成的AccessToken
默认过期时长,值得注意的是,这里的配置值时间单位是秒
,7200秒 = 2小时
。
内存方式
在上面说到了,内存方式时ApiBoot OAuth
会使用ApiBootOauthProperties#Client
内部类的accessTokenValiditySeconds
字段来配置过期时间,所以我们只需要在application.yml
添加如下配置即可:
api:
boot:
oauth:
clients:
- clientId: minbox
clientSecret: chapter
# 配置客户端Token过期时长,单位:秒
accessTokenValiditySeconds: 43200
security:
users:
- username: yuqiyu
password: 123123
在上面配置中,我们添加了一个在内存存储的minbox
客户端,设置accessTokenValiditySeconds
过期时间字段为43200秒 = 12小时
。
JDBC方式
JDBC
方式是ApiBoot OAuth
无法控制的,因为OAuth2
当使用JDBC
方式进行存储客户端、令牌等信息时,都是通过OAuth2
提供的固定的表进行操作,正因为如此我们只需要修改oauth_client_details
表内每一条client
信息的access_token_validity
字段的值即可,时间单位同样也是秒
,如下图所示:
OAuth2
提供的MySQL
版本的建表语句请访问ApiBoot OAuth Starter查看。
运行测试
下面来测试下修改后的过期时间是否已经生效,我们先来启动本章的项目示例。
通过CURL
的方式获取AccessToken
,如下所示:
➜ ~ curl -X POST minbox:chapter@localhost:9090/oauth/token -d 'grant_type=password&username=yuqiyu&password=123123'
{"access_token":"41127985-1b31-4413-ac9f-30d5e26f4aaf","token_type":"bearer","refresh_token":"0a39ca6a-8697-4f80-9bb1-ac59894a45dd","expires_in":43199,"scope":"api"}
通过PostMan
方式获取AccessToken
如下图所示:
我们根据结果可以看到,由原本默认的7200
修改成了我们在application.yml
配置的43200
(结果中的43199
是因为生成token耗时差导致的)。
敲黑板,划重点
ApiBoot
的宗旨就是化繁为简,能使用配置简单搞定的事情,绝不拖泥带水,赶快分享下本篇文章吧,让更多人得到帮助,非常感谢~~~
ApiBoot OAuth
可以一次配置多个客户端,并且为每一个客户端配置不同的过期时间。
签到送书活动进行中
自律改变人生,恒宇少年回馈粉丝,给大家的福利,请访问https://blog.yuqiyu.com/welfare/了解详情。
代码示例
如果您喜欢本篇文章请为源码仓库点个Star
,您的点赞是对我最大的支持,谢谢!!!
本篇文章示例源码可以通过以下途径获取,目录为apiboot-oauth-set-token-expire-time
:
网友评论