Spring-boot中实现通用Auth认证，有哪几种方式？

前言

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

很久没输出了，因而挑一个方面总结一下，但愿在梳理过程当中再了解一些其余的东西。因为 Java 繁荣的生态，下面每个模块都有大量的文章专门讲述。因此我选了另一个角度，从实际问题出发，将这些分散的知识串联起来，各位能够做为一个综述来看。各个模块的极致详细介绍，你们能够去翻官方文档或看网络上的其余博客。另外关注：码猿技术专栏，在后台回复：“面试宝典”能够获取，高清PDF最新版3625页互联网大厂面试题。

需求很简单清晰，跟产品们提的妖艳需求一点也不同：在咱们的 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() {
    }
  }

复制代码

4. 在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 接口。

实现

1. 定义自定义参数类型 AuthParam，类内有 appkey 相关字段；
2. 定义 AuthParamResolver 并实现 HandlerMethodArgumentResolver 接口；
3. 实现 supportsParameter() 接口方法将 AuthParam 与 AuthParamResolver 适配起来；
4. 实现 resolveArgument() 接口方法解析 reqest 对象生成 AuthParam 对象，并在此校验 AuthParam ，确认 appkey 是否在白名单内；
5. 在 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 被拦截了天然不须要后续再进行处理，而后是 参数解析器，最后才是 切面的切点。我将四种方式在一个项目内所有实现后，输出日志也证实了这个结论。

另外，做者已经完成了两个专栏的文章Mybatis进阶、Spring Boot 进阶 ，已经将专栏文章整理成书，有须要的公众号回复关键词Mybatis 进阶、Spring Boot 进阶免费获取。

跳出具体实现，转身来看这些实现，其实都有一些面向切面的影子。因为以前本身的编程方式更偏向于面向过程编程，在使用 Java 面向对象后对比 AOP 和 面向过程当中的勾子，有些感悟，改日写文整理一下。