}
但是在实际操作中,我们往往需要在这个基础上,定制自己的返回信息,这就需要我们对这个东西进行自定义。本文松哥就来和大家聊一聊这里要如何自定义。
敲黑板划重点: 本文还是我们最近 OAuth2 系列的延续,如果没看过本系列之前的文章,一定先阅读一下,这有助于更好的理解本文:
好了,不废话了,我们来看今天的内容。
首先我们要搞清楚,access_token 从哪里来。
在前面的文章中,我们在生成 access_token 的时候,都配置了一个类,叫做 AuthorizationServerTokenServices,如下:
@Bean
AuthorizationServerTokenServices tokenServices() {
DefaultTokenServices services = new DefaultTokenServices();
services.setClientDetailsService(clientDetailsService());
services.setSupportRefreshToken(true);
services.setTokenStore(tokenStore);
TokenEnhancerChain chain = new TokenEnhancerChain();
chain.setTokenEnhancers(Arrays.asList(jwtAccessTokenConverter,externalAccessTokenInfo));
services.setTokenEnhancer(chain);
return services;
}
在这个配置中,我们提供了一个 DefaultTokenServices 实例,这个实例就是默认生成 access_token 的工具,我们进入到 DefaultTokenServices#createAccessToken 方法中,一路追踪,可以看到如下代码:
private OAuth2AccessToken createAccessToken(OAuth2Authentication authentication, OAuth2RefreshToken refreshToken) {
DefaultOAuth2AccessToken token = new DefaultOAuth2AccessToken(UUID.randomUUID().toString());
int validitySeconds = getAccessTokenValiditySeconds(authentication.getOAuth2Request());
if (validitySeconds > 0) {
token.setExpiration(new Date(System.currentTimeMillis() + (validitySeconds * 1000L)));
}
token.setRefreshToken(refreshToken);
token.setScope(authentication.getOAuth2Request().getScope());
return accessTokenEnhancer != null ? accessTokenEnhancer.enhance(token, authentication) : token;
}
从这段代码中,我们可以看到,用来保存 access_token 的实例,其实就是 DefaultOAuth2AccessToken,我们再来看看 DefaultOAuth2AccessToken 的定义:
public class DefaultOAuth2AccessToken implements Serializable, OAuth2AccessToken {
private String value;
private Date expiration;
private String tokenType = BEARER_TYPE.toLowerCase();
private OAuth2RefreshToken refreshToken;
private Set scope;
private Map<String, Object> additionalInformation = Collections.emptyMap();
//省略其他
}
从这段属性的声明中,我们就可以看出来,为什么默认返回的数据只有五项。
大家同时也发现,DefaultOAuth2AccessToken 中其实是提供了一个 additionalInformation 属性用来存储额外信息的,但是,我们在 DefaultTokenServices 类中并没有办法去自定义 DefaultOAuth2AccessToken 中的属性,也就是说,默认情况下,我们没有办法自己去给 additionalInformation 中添加值。
虽然默认情况下,无法添加,但是只要大家看了上面这段源码,就会明白,如果我们想要自定义返回的 access_token 信息,就要想办法自已去定义 DefaultOAuth2AccessToken 信息。
思路有了,接下来看操作。
大家知道,我们在 OAuth2 中返回的令牌信息分为两大类:不透明令牌和透明令牌。
不透明令牌就是一种无可读性的令牌,一般来说就是一段普通的 UUID 字符串。不透明令牌的最大问题在于会降低系统性能和可用性,并且增加延迟(因为必须远程校验令牌)。
透明令牌的典型代表就是 JWT 了,用户信息都保存在 JWT 字符串中,关于 JWT 的信息,大家可以参考这篇文章:想让 OAuth2 和 JWT 在一起愉快玩耍?请看松哥的表演。
在实际开发中,大部分情况下,我们的 OAuth2 都是搭配 JWT 一起来使用的,所以,这里我就主要讲一下在生成的 JWT 中如何定制返回信息。
如果我们使用了 OAuth2+JWT 的方案,那正常情况下,我们还需要配置一个 JwtAccessTokenConverter 的实例(参考:想让 OAuth2 和 JWT 在一起愉快玩耍?请看松哥的表演),JWT 字符串将由 JwtAccessTokenConverter 实例负责生成。
JwtAccessTokenConverter 实例生成 JWT 的方法是在上文列出来的 DefaultTokenServices#createAccessToken 方法之后执行,该方法最后有一句:
accessTokenEnhancer != null ? accessTokenEnhancer.enhance(token, authentication) : token;
这就是说,如果提供了 accessTokenEnhancer ,就进入到 accessTokenEnhancer 的 enhance 方法中对 access_token 做二次处理,accessTokenEnhancer 则就是我们的 JwtAccessTokenConverter 实例。
从这里大家看到,想要自定义 Token 信息,我们有两个时机,第一个时机就是在 DefaultTokenServices#createAccessToken 方法中修改,但是工作量较大,不推荐;第二个时机是在进入到 JwtAccessTokenConverter#enhance 方法之后修改,这是目前比较可行的方法。
如果采用第二种方案,就需要我们自定义一个类继承自 JwtAccessTokenConverter,如下:
public class MyJwt extends JwtAccessTokenConverter {
@Override
public OAuth2AccessToken enhance(OAuth2AccessToken accessToken, OAuth2Authentication authentication) {
Map<String, Object> additionalInformation = new LinkedHashMap<>();
Map<String, Object> info = new LinkedHashMap<>();
info.put(“author”, “江南一点雨”);
info.put(“email”, “wangsong0210@gmail.com”);
info.put(“site”, “www.javaboy.org”);
info.put(“weixin”, “a_java_boy2”);
info.put(“WeChat Official Accounts”, “江南一点雨”);
info.put(“GitHub”, “https://github.com/lenve”);
info.put(“user”, SecurityContextHolder.getContext().getAuthentication().getPrincipal());
additionalInformation.put(“info”, info);
((DefaultOAuth2AccessToken) accessToken).setAdditionalInformation(additionalInformation);
return super.enhance(accessToken, authentication);
}
}
在这里,我们自定义 MyJwt 继承自 JwtAccessTokenConverter 并重写 enhance 方法:
-
首先我们构造自己的附加信息,如果如需要当前登录用户信息,可以从 SecurityContextHolder 中获取。
-
将附加信息放到 OAuth2AccessToken 的 additionalInformation 属性中去。
这样相当于我们就修改了默认生成的 DefaultOAuth2AccessToken 了,然后再把修改后的 DefaultOAuth2AccessToken 实例调用 super.enhance 方法去生成 jwt 字符串,这样生成的 jwt 字符串就有我们的自定义信息了。
最后,在 TokenConfig 中配置 MyJwt 的实例,如下:
@Configuration
public class TokenConfig {
@Bean
TokenStore tokenStore() {
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)
最后
文章中涉及到的知识点我都已经整理成了资料,录制了视频供大家下载学习,诚意满满,希望可以帮助在这个行业发展的朋友,在论坛博客等地方少花些时间找资料,把有限的时间,真正花在学习上,所以我把这些资料,分享出来。相信对于已经工作和遇到技术瓶颈的朋友们,在这份资料中一定都有你需要的内容。
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
mg" style=“zoom: 33%;” />
最后
文章中涉及到的知识点我都已经整理成了资料,录制了视频供大家下载学习,诚意满满,希望可以帮助在这个行业发展的朋友,在论坛博客等地方少花些时间找资料,把有限的时间,真正花在学习上,所以我把这些资料,分享出来。相信对于已经工作和遇到技术瓶颈的朋友们,在这份资料中一定都有你需要的内容。
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!