SpringCloud Alibaba实战二十七 - Oauth2认证服务器自定义异常
创始人
2025-01-18 04:03:20
0次

“error”: “unsupported_grant_type”,

“error_description”: “Unsupported grant type: password1”

}

密码错误

在认证时故意输错 username 或 password 会出现如下异常错误:

{

“error”: “invalid_grant”,

“error_description”: “Bad credentials”

}

客户端错误

在认证时故意输错 client_id 或 client_secret

{

“error”: “invalid_client”,

“error_description”: “Bad client credentials”

}

上面的返回结果很不友好,而且前端代码也很难判断是什么错误,所以我们需要对返回的错误进行统一的异常处理,让其返回统一的异常格式。

问题剖析


如果只关注解决方案,可以直接跳转到解决方案模块!

OAuth2Exception异常处理

在Oauth2认证服务器中认证逻辑最终调用的是 TokenEndpoint#postAccessToken()方法,而一旦认证出现 OAuth2Exception异常则会被 handleException()捕获到异常。如下图展示的是当出现用户密码异常时debug截图:

认证服务器在捕获到 OAuth2Exception后会调用 WebResponseExceptionTranslator#translate()方法对异常进行翻译处理。

默认的翻译处理实现类是 DefaultWebResponseExceptionTranslator,处理完成后会调用 handleOAuth2Exception()方法将处理后的异常返回给前端,这就是我们之前看到的异常效果。

处理方法

熟悉Oauth2套路的同学应该知道了如何处理此类异常,就是**「自定义一个异常翻译类让其返回我们需要的自定义格式,然后将其注入到认证服务器中。」**

但是这种处理逻辑只能解决 OAuth2Exception异常,即前言部分中的**「授权模式异常」和「账号密码类的异常」**,并不能解决我们客户端的异常。

客户端异常处理

客户端认证的异常是发生在过滤器 ClientCredentialsTokenEndpointFilter上,其中有后置添加失败处理方法,最后把异常交给 OAuth2AuthenticationEntryPoint这个所谓认证入口处理。执行顺序如下所示:

然后跳转到父类的 AbstractOAuth2SecurityExceptionHandler#doHandle()进行处理:

最终由 DefaultOAuth2ExceptionRenderer#handleHttpEntityResponse()方法将异常输出给客户端

处理方法

通过上面的分析我们得知客户端的认证失败异常是过滤器 ClientCredentialsTokenEndpointFilter转交给 OAuth2AuthenticationEntryPoint得到响应结果的,既然这样我们就可以重写 ClientCredentialsTokenEndpointFilter然后使用自定义的 AuthenticationEntryPoint替换原生的 OAuth2AuthenticationEntryPoint,在自定义 AuthenticationEntryPoint处理得到我们想要的异常数据。

解决方案


为了解决上面这些异常,我们首先需要编写不同异常的错误代码:ReturnCode.java

CLIENT_AUTHENTICATION_FAILED(1001,“客户端认证失败”),

USERNAME_OR_PASSWORD_ERROR(1002,“用户名或密码错误”),

UNSUPPORTED_GRANT_TYPE(1003, “不支持的认证模式”);

OAuth2Exception异常

如上所说我们编写一个自定义异常翻译类 CustomWebResponseExceptionTranslator

@Slf4j

public class CustomWebResponseExceptionTranslator implements WebResponseExceptionTranslator {

@Override

public ResponseEntity translate(Exception e) throws Exception {

log.error(“认证服务器异常”,e);

ResultData response = resolveException(e);

return new ResponseEntity<>(response, HttpStatus.valueOf(response.getHttpStatus()));

}

/**

* 构建返回异常

* @param e exception

* @return

*/

private ResultData resolveException(Exception e) {

// 初始值 500

ReturnCode returnCode = ReturnCode.RC500;

int httpStatus = HttpStatus.UNAUTHORIZED.value();

//不支持的认证方式

if(e instanceof UnsupportedGrantTypeException){

returnCode = ReturnCode.UNSUPPORTED_GRANT_TYPE;

//用户名或密码异常

}else if(e instanceof InvalidGrantException){

returnCode = ReturnCode.USERNAME_OR_PASSWORD_ERROR;

}

ResultData failResponse = ResultData.fail(returnCode.getCode(), returnCode.getMessage());

failResponse.setHttpStatus(httpStatus);

return failResponse;

}

}

然后在认证服务器配置类中注入自定义异常翻译类

@Override

public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {

//如果需要使用refresh_token模式则需要注入userDetailService

endpoints

.authenticationManager(this.authenticationManager)

.userDetailsService(userDetailService)

//                注入tokenGranter

.tokenGranter(tokenGranter);

//注入自定义的tokenservice,如果不使用自定义的tokenService那么就需要将tokenServce里的配置移到这里

//                .tokenServices(tokenServices());

// 自定义异常转换类

endpoints.exceptionTranslator(new CustomWebResponseExceptionTranslator());

}

客户端异常

重写客户端认证过滤器,不使用默认的 OAuth2AuthenticationEntryPoint处理异常

public class CustomClientCredentialsTokenEndpointFilter extends ClientCredentialsTokenEndpointFilter {

private final AuthorizationServerSecurityConfigurer configurer;

private AuthenticationEntryPoint authenticationEntryPoint;

public CustomClientCredentialsTokenEndpointFilter(AuthorizationServerSecurityConfigurer configurer) {

this.configurer = configurer;

}

@Override

public void setAuthenticationEntryPoint(AuthenticationEntryPoint authenticationEntryPoint) {

super.setAuthenticationEntryPoint(null);

this.authenticationEntryPoint = authenticationEntryPoint;

}

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)

img

我的面试宝典:一线互联网大厂Java核心面试题库

以下是我个人的一些做法,希望可以给各位提供一些帮助:

整理了很长一段时间,拿来复习面试刷题非常合适,其中包括了Java基础、异常、集合、并发编程、JVM、Spring全家桶、MyBatis、Redis、数据库、中间件MQ、Dubbo、Linux、Tomcat、ZooKeeper、Netty等等,且还会持续的更新…可star一下!

image

283页的Java进阶核心pdf文档

Java部分:Java基础,集合,并发,多线程,JVM,设计模式

数据结构算法:Java算法,数据结构

开源框架部分:Spring,MyBatis,MVC,netty,tomcat

分布式部分:架构设计,Redis缓存,Zookeeper,kafka,RabbitMQ,负载均衡等

微服务部分:SpringBoot,SpringCloud,Dubbo,Docker

image

还有源码相关的阅读学习

image

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
部分:Spring,MyBatis,MVC,netty,tomcat

分布式部分:架构设计,Redis缓存,Zookeeper,kafka,RabbitMQ,负载均衡等

微服务部分:SpringBoot,SpringCloud,Dubbo,Docker

[外链图片转存中…(img-u7Ztb8Bh-1713325136432)]

还有源码相关的阅读学习

[外链图片转存中…(img-epQtiALq-1713325136433)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

相关内容

热门资讯

围绕透视问题开挂妙计!乐友互娱... 围绕透视问题开挂妙计!乐友互娱多功能开挂app,乐友互娱本来真的有辅助app1、实时乐友互娱透视辅助...
热点推荐开挂app!德扑圈多功... 热点推荐开挂app!德扑圈多功能开挂app,德扑圈确实有开挂app1、进入到德扑圈是否有挂之后,能看...
玩家科普辅助器绝活儿!天天竞技... 玩家科普辅助器绝活儿!天天竞技多功能辅助器脚本,天天竞技真是真的是有辅助脚本在进入天天竞技软件靠谱后...
重要通知外挂插件!AAPoKe... 重要通知外挂插件!AAPoKer多功能外挂插件,AAPoKer切实存在有外挂插件1、实时AAPoKe...
玩家必看科普辅助器办法!方片十... 玩家必看科普辅助器办法!方片十三张多功能辅助器插件,方片十三张果然确实有辅助插件方片十三张脚本下载中...
大神推荐辅助器软件!wepok... 大神推荐辅助器软件!wepoker多功能辅助器软件,wepoker本来存在有辅助器软件1.wepok...
每日必看教程透视举措!小皖跑得... 每日必看教程透视举措!小皖跑得快多功能透视脚本,小皖跑得快一直真的是有辅助脚本1、实时小皖跑得快透视...
我来向大家传授开挂技巧!智星德... 我来向大家传授开挂技巧!智星德州扑克多功能开挂技巧,智星德州扑克原来真的是有开挂技巧1、打开软件启动...
重大科普辅助器绝活儿!一两棋牌... 重大科普辅助器绝活儿!一两棋牌多功能辅助器工具,一两棋牌确实真的有辅助工具1、用户打开应用后不用登录...
分享个大家外挂app!智星德州... 分享个大家外挂app!智星德州扑克多功能外挂app,智星德州扑克切实是真的有外挂app1.智星德州扑...