Springboot实现通用Auth认证的几种方式

作者:码猿技术专栏 时间:2023-08-05 20:54:58 

    前言

    最近一直被无尽的业务需求淹没,没时间喘息,终于接到一个能让我突破代码舒适区的活儿,解决它的过程非常曲折,一度让我怀疑人生,不过收获也很大,代码方面不明显,但感觉自己抹掉了 java、Tomcat、Spring 一直挡在我眼前的一层纱。对它们的理解上了一个新的层次。

    好久没输出了,于是挑一个方面总结一下,希望在梳理过程中再了解一些其他的东西。由于 Java 繁荣的生态,下面每一个模块都有大量的文章专门讲述。所以我选了另外一个角度,从实际问题出发,将这些分散的知识串联起来,各位可以作为一个综述来看。各个模块的极致详细介绍,大家可以去翻官方文档或看网络上的其他博客。

    需求很简单清晰,跟产品们提的妖艳需求一点也不一样:在我们的 web 框架里添加一个通用的 appkey 白名单校验功能,希望它的扩展性更好一些。

    这个 web 框架是部门前驱者基于 spring-boot 实现的,介于业务和 Spring 框架之间,做一些偏向于业务的通用性功能,如 日志输出、功能开关、通用参数解析等。平常是对业务透明的,最近一直忙于把需求做好,代码写好,甚至从没注意过它的存在。

    传统AOP

    对于这种需求,首先想到的当然是 Spring-boot 提供的 AOP 接口,只需要在 Controller 方法前添加切点,然后再对切点进行处理即可。

    实现

    其使用步骤如下:

    1. 使用 @Aspect 声明一下切面类 WhitelistAspect;

    2. 在切面类内添加一个切点 whitelistPointcut(),为了实现此切点灵活可装配的能力,这里不使用 execution 全部拦截,而是添加一个注解 @Whitelist,被注解的方法才会校验白名单。

    3. 在切面类中使用 spring 的 AOP 注解 @Before 声明一个通知方法 checkWhitelist() 在 Controller 方法被执行之前校验白名单。

    切面类伪代码如下:


    @Aspect
     public class WhitelistAspect {
    @Before(value = "whitelistPointcut() && @annotation(whitelist)")
       public void checkAppkeyWhitelist(JoinPoint joinPoint, Whitelist whitelist) {
           checkWhitelist();
           // 可使用 joinPoint.getArgs() 获取Controller方法的参数
           // 可以使用 whitelist 变量获取注解参数
       }
    @Pointcut("@annotation(com.zhenbianshu.Whitelist)")
       public void whitelistPointCut() {
       }
     }

    在Controller方法上添加 @Whitelist 注解实现功能。

    扩展

    本例中使用了 注解 来声明切点,并且我实现了通过注解参数来声明要校验的白名单,如果之后还需要添加其他白名单的话,如通过 UID 来校验,则可以为此注解添加 uid() 等方法,实现自定义校验。

    此外,spring 的 AOP 还支持 execution(执行方法) 、bean(匹配特定名称的 Bean 对象的执行方法)等切点声明方法和 @Around(在目标函数执行中执行) 、@After(方法执行后) 等通知方法。

    如此,功能已经实现了,但领导并不满意=_=,原因是项目中 AOP 用得太多了,都用滥了,建议我换一种方式。嗯,只好搞起。另外关注:码猿技术专栏,在后台回复:“面试宝典”可以获取,高清PDF最新版3625页互联网大厂面试题。

    Interceptor

    Spring 的 * (Interceptor) 实现这个功能也非常合适。顾名思义, * 用于在 Controller 内 Action 被执行前通过一些参数判断是否要执行此方法,要实现一个 * ,可以实现 Spring 的 HandlerInterceptor 接口。

    实现

    实现步骤如下:

    1. 定义 * 类 AppkeyInterceptor 类并实现 HandlerInterceptor 接口。

    2. 实现其 preHandle() 方法;

    3. 在 preHandle 方法内通过注解和参数判断是否需要拦截请求,拦截请求时接口返回 false;

    4. 在自定义的 WebMvcConfigurerAdapter 类内注册此 * ;

    AppkeyInterceptor 类如下:


    @Component
    public class WhitelistInterceptor implements HandlerInterceptor {
    @Override
       public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
           Whitelist whitelist = ((HandlerMethod) handler).getMethodAnnotation(Whitelist.class);
           // whitelist.values(); 通过 request 获取请求参数,通过 whitelist 变量获取注解参数
           return true;
       }
    @Override
       public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
     // 方法在Controller方法执行结束后执行
       }
    @Override
       public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
     // 在view视图渲染完成后执行
       }
    }

    扩展

    要启用 * 还要显式配置它启用,这里我们使用 WebMvcConfigurerAdapter 对它进行配置。需要注意,继承它的的 MvcConfiguration 需要在 ComponentScan 路径下。


    @Configuration
    public class MvcConfiguration extends WebMvcConfigurerAdapter {
       @Override
       public void addInterceptors(InterceptorRegistry registry) {
           registry.addInterceptor(new WhitelistInterceptor()).addPathPatterns("/*").order(1);
           // 这里可以配置 * 启用的 path 的顺序,在有多个 * 存在时,任一 * 返回 false 都会使后续的请求方法不再执行
       }
    }

    还需要注意, * 执行成功后响应码为 200,但响应数据为空。
    当使用 * 实现功能后,领导终于祭出大招了:我们已经有一个 Auth 参数了,appkey 可以从 Auth 参数里取到,可以把在不在白名单作为 Auth 的一种方式,为什么不在 Auth 时校验?emmm… 吐血中。

    ArgumentResolver

    参数解析器是 Spring 提供的用于解析自定义参数的工具,我们常用的 @RequestParam 注解就有它的影子,使用它,我们可以将参数在进入Controller Action之前就组合成我们想要的样子。Spring 会维护一个 ResolverList, 在请求到达时,Spring 发现有自定义类型参数(非基本类型), 会依次尝试这些 Resolver,直到有一个 Resolver 能解析需要的参数。要实现一个参数解析器,需要实现 HandlerMethodArgumentResolver 接口。

    实现

    • 定义自定义参数类型 AuthParam,类内有 appkey 相关字段;

    • 定义 AuthParamResolver 并实现 HandlerMethodArgumentResolver 接口;

    • 实现 supportsParameter() 接口方法将 AuthParam 与 AuthParamResolver 适配起来;

    • 实现 resolveArgument() 接口方法解析 reqest 对象生成 AuthParam 对象,并在此校验 AuthParam ,确认 appkey 是否在白名单内;

    • 在 Controller Action 方法上签名内添加 AuthParam 参数以启用此 Resolver;

    实现的 AuthParamResolver 类如下:


    @Component
    public class AuthParamResolver implements HandlerMethodArgumentResolver {
    @Override
       public boolean supportsParameter(MethodParameter parameter) {
           return parameter.getParameterType().equals(AuthParam.class);
       }
    @Override
       public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
           Whitelist whitelist = parameter.getMethodAnnotation(Whitelist.class);
           // 通过 webRequest 和 whitelist 校验白名单
           return new AuthParam();
       }
    }

    扩展

    当然,使用参数解析器也需要单独配置,我们同样在 WebMvcConfigurerAdapter内配置:


    @Configuration
    public class MvcConfiguration extends WebMvcConfigurerAdapter {
    @Override
       public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
           argumentResolvers.add(new AuthParamResolver());
       }
    }

    这次实现完了,我还有些不放心,于是在网上查找是否还有其他方式可以实现此功能,发现常见的还有 Filter。

    Filter

    Filter 并不是 Spring 提供的,它是在 Servlet 规范中定义的,是 Servlet 容器支持的。被 Filter 过滤的请求,不会派发到 Spring 容器中。它的实现也比较简单,实现 javax.servlet.Filter接口即可。

    由于不在 Spring 容器中,Filter 获取不到 Spring 容器的资源,只能使用原生 Java 的 ServletRequest 和 ServletResponse 来获取请求参数。

    另外,在一个 Filter 中要显示调用 FilterChain 的 doFilter 方法,不然认为请求被拦截。实现类似:
    public class WhitelistFilter implements javax.servlet.Filter {


       @Override
       public void init(FilterConfig filterConfig) throws ServletException {
     // 初始化后被调用一次
       }
    @Override
       public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // 判断是否需要拦截
          chain.doFilter(request, response); // 请求通过要显示调用
       }
    @Override
       public void destroy() {
        // 被销毁时调用一次
       }
    }

    扩展

    Filter 也需要显示配置:


    @Configuration
    public class FilterConfiguration {
    @Bean
       public FilterRegistrationBean someFilterRegistration() {
           FilterRegistrationBean registration = new FilterRegistrationBean();
           registration.setFilter(new WhitelistFilter());
           registration.addUrlPatterns("/*");
           registration.setName("whitelistFilter");
           registration.setOrder(1); // 设置过滤器被调用的顺序
           return registration;
       }
    }

    小结

    四种实现方式都有其适合的场景,那么它们之间的调用顺序如何呢?

    Filter 是 Servlet 实现的,自然是最先被调用,后续被调用的是 Interceptor 被拦截了自然不需要后续再进行处理,然后是 参数解析器,最后才是 切面的切点。我将四种方式在一个项目内全部实现后,输出日志也证明了这个结论。

    来源:https://juejin.cn/post/6983836836074356773

    标签:Springboot,Auth,认证
    0
    投稿

    猜你喜欢

  • SpringMVC之@requestBody的作用及说明

    2022-06-08 12:35:04
  • Java获得当前时间前指定几个小时具体时间的方法示例

    2023-11-24 04:56:49
  • 基于servlet实现统计网页访问次数

    2021-11-05 08:35:13
  • java实现MD5加密的方法小结

    2022-02-26 20:01:47
  • 你所不知道的Spring自动注入详解

    2021-09-04 19:30:08
  • C# WebApi CORS跨域问题解决方案

    2022-12-21 05:01:33
  • C# 通过反射获取类型的字段值及给字段赋值的操作

    2021-11-14 13:30:23
  • 关于Spring Data Jpa 自定义方法实现问题

    2023-11-28 10:08:32
  • 利用C#快速查出哪些QQ好友空间屏蔽了自己

    2023-10-07 22:14:28
  • C#中OpenCvSharp 通过特征点匹配图片的方法

    2023-07-14 08:10:55
  • Java语言中&&与& ||与|的区别是什么

    2022-06-10 17:44:09
  • c#通过unicode编码判断字符是否为中文示例分享

    2022-01-13 16:33:44
  • Java内存模型JMM与volatile

    2022-03-25 09:33:50
  • 解决javac不是内部或外部命令,也不是可运行程序的报错问题

    2022-07-13 22:39:25
  • C#使用yield关键字构建迭代器详解

    2023-02-09 12:48:49
  • 将15位身份证补全为18位身份证的算法示例详解

    2022-07-15 19:33:43
  • flutter传递值到任意widget(当需要widget嵌套使用需要传递值的时候)

    2022-05-17 22:53:44
  • 关于Mybatis与JPA的优缺点说明

    2023-08-23 22:28:33
  • 基于CXF搭建webService的实例讲解

    2023-07-02 10:41:34
  • 一文详解Java Netty中的Constant类

    2023-03-03 17:17:55
  • asp之家 软件编程 m.aspxhome.com