Spring Boot项目鉴权的4种方法
Posted
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring Boot项目鉴权的4种方法相关的知识,希望对你有一定的参考价值。
参考技术A
文章介绍了spring-boot中实现通用auth的四种方式,包括 传统AOP、拦截器、参数解析器和过滤器,并提供了对应的实例代码,最后简单总结了下他们的执行顺序。
前言
最近一直被无尽的业务需求淹没,没时间喘息,终于接到一个能让我突破代码舒适区的活儿,解决它的过程非常曲折,一度让我怀疑人生,不过收获也很大,代码方面不明显,但感觉自己抹掉了 java、Tomcat、Spring 一直挡在我眼前的一层纱。对它们的理解上了一个新的层次。好久没输出了,于是挑一个方面总结一下,希望在梳理过程中再了解一些其他的东西。
由于 Java 繁荣的生态,下面每一个模块都有大量的文章专门讲述。所以我选了另外一个角度,从实际问题出发,将这些分散的知识串联起来,各位可以作为一个综述来看。各个模块的极致详细介绍,大家可以去翻官方文档或看网络上的其他博客。需求很简单清晰,跟产品们提的妖艳需求一点也不一样:在我们的 web 框架里添加一个 通用 的 appkey 白名单校验功能,希望它的扩展性更好一些。
这个 web 框架是部门前驱者基于 spring-boot 实现的,介于业务和 Spring 框架之间,做一些偏向于业务的通用性功能,如 日志输出、功能开关、通用参数解析等。平常是对业务透明的,最近一直忙于把需求做好,代码写好,甚至从没注意过它的存在。
传统AOP
对于这种需求,首先想到的当然是 Spring-boot 提供的 AOP 接口,只需要在 Controller 方法前添加切点,然后再对切点进行处理即可。
实现
其使用步骤如下:
切面类伪代码如下:
在Controller方法上添加 @Whitelist 注解实现功能。
扩展
本例中使用了 注解 来声明切点,并且我实现了通过注解参数来声明要校验的白名单,如果之后还需要添加其他白名单的话,如通过 UID 来校验,则可以为此注解添加 uid() 等方法,实现自定义校验。此外,spring 的 AOP 还支持 execution(执行方法) 、bean(匹配特定名称的 Bean 对象的执行方法) 等切点声明方法和 @Around(在目标函数执行中执行) 、@After(方法执行后) 等通知方法。如此,功能已经实现了,但领导并不满意=_=,原因是项目中 AOP 用得太多了,都用滥了,建议我换一种方式。嗯,只好搞起。
Interceptor
Spring 的 拦截器(Interceptor) 实现这个功能也非常合适。顾名思义,拦截器用于在 Controller 内 Action 被执行前通过一些参数判断是否要执行此方法,要实现一个拦截器,可以实现 Spring 的 HandlerInterceptor 接口。
实现
实现步骤如下:
AppkeyInterceptor 类如下:
扩展
要启用 拦截器还要显式配置它启用,这里我们使用 WebMvcConfigurerAdapter 对它进行配置。需要注意,继承它的的 MvcConfiguration 需要在 ComponentScan 路径下。
还需要注意,拦截器执行成功后响应码为 200 ,但响应数据为空。
当使用拦截器实现功能后,领导终于祭出大招了:我们已经有一个 Auth 参数了,appkey 可以从 Auth 参数里取到,可以把在不在白名单作为 Auth 的一种方式,为什么不在 Auth 时校验?emmm… 吐血中。
如果您正在学习Spring Boot,那么推荐一个连载多年还在继续更新的免费教程:http://blog.didispace.com/spring-boot-learning-2x/
ArgumentResolver
参数解析器是 Spring 提供的用于解析自定义参数的工具,我们常用的 @RequestParam 注解就有它的影子,使用它,我们可以将参数在进入Controller Action之前就组合成我们想要的样子。Spring 会维护一个 ResolverList , 在请求到达时,Spring 发现有自定义类型参数(非基本类型), 会依次尝试这些 Resolver,直到有一个 Resolver 能解析需要的参数。要实现一个参数解析器,需要实现 HandlerMethodArgumentResolver 接口。
实现
实现的 AuthParamResolver 类如下:
扩展
当然,使用参数解析器也需要单独配置,我们同样在 WebMvcConfigurerAdapter 内配置:
这次实现完了,我还有些不放心,于是在网上查找是否还有其他方式可以实现此功能,发现常见的还有 Filter 。
Filter
Filter 并不是 Spring 提供的,它是在 Servlet 规范中定义的,是 Servlet 容器支持的。被 Filter 过滤的请求,不会派发到 Spring 容器中。它的实现也比较简单,实现 javax.servlet.Filter 接口即可。由于不在 Spring 容器中,Filter 获取不到 Spring 容器的资源,只能使用原生 Java 的 ServletRequest 和 ServletResponse 来获取请求参数。另外,在一个 Filter 中要显示调用 FilterChain 的 doFilter 方法,不然认为请求被拦截。实现类似:
扩展
Filter 也需要显示配置:
小结
四种实现方式都有其适合的场 景,那么它们之间的调用顺序如何呢?Filter 是 Servlet 实现的,自然是最先被调用,后续被调用的是 Interceptor 被拦截了自然不需要后续再进行处理,然后是 参数解析器,最后才是切面的切点。
以上是关于Spring Boot项目鉴权的4种方法的主要内容,如果未能解决你的问题,请参考以下文章
视频+源码登录鉴权的三种方式:tokenjwtsession实战分享
spring-oauth-server实践(1-5)为客户mobile-client开通授权码模式申请access_token,并使用access_token访问需要鉴权的业务
Nacos 1.4.1发布,修复指定特殊UA可绕过所有鉴权的安全漏洞