来看看OAuth2怎么设置AccessToken有效期时间时长

OAuth2所生成的AccessToken以及RefreshToken都存在过期时间,当在有效期内才可以拿来作为会话身份发起请求,否者认证中心会直接拦截无效请求提示已过期,那么我们怎么修改这个过期时间来满足我们的业务场景呢?

目前一线大厂所使用的的AccessToken的有效期一般都是7200秒,也就是2小时,而且有获取的次数限制,所以发起请求的一方必须通过一定的形式保存到本地,以方便下一次发起请求时,写入请求的header或者作为参数携带。

本章来讲解下使用ApiBoot OAuth组件该怎么去设置AccessToken的过期时间,针对memory(内存方式)、jdbc(数据库)这两种方式来讲解,更多使用请参考官方文档:

默认有效时长

ApiBoot OAuthmemory存储方式下为每一个客户端都提供了一个默认的AccessToken有效时长,该配置在org.minbox.framework.api.boot.autoconfigure.oauth.ApiBootOauthProperties,相关源码如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/**
* 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;
}

ClientApiBootOauthProperties的一个内部类,主要是提供了OAuth2 客户端的相关配置字段,通过spring-boot-configuration-processor依赖将该类自动解析成配置元数据,这样我们在application.yml输入api.xxx时可以得到相应的提示。

Client内部类中有一个字段accessTokenValiditySeconds,通过该字段我们来修改该客户端下所有用户生成的AccessToken默认过期时长,值得注意的是,这里的配置值时间单位是7200秒 = 2小时

内存方式

在上面说到了,内存方式时ApiBoot OAuth会使用ApiBootOauthProperties#Client内部类的accessTokenValiditySeconds字段来配置过期时间,所以我们只需要在application.yml添加如下配置即可:

1
2
3
4
5
6
7
8
9
10
11
12
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,如下所示:

1
2
➜ ~ 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可以一次配置多个客户端,并且为每一个客户端配置不同的过期时间。

代码示例

如果您喜欢本篇文章请为源码仓库点个Star,谢谢!!!
本篇文章示例源码可以通过以下途径获取,目录为apiboot-oauth-set-token-expire-time

本文由恒宇少年 - 于起宇编写,遵循CC 4.0 BY-SA版权协议,转载请注明文章出处,如需公众号转载,请联系「微信

文章标签: ApiBoot

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×