乐趣区

关于后端:码农架构-Spring-Boot-实现通用-Auth-认证的-4-种方式

jiezi

最近始终被无尽的业务需要吞没，没工夫喘息，终于接到一个能让我冲破代码舒服区的活儿，解决它的过程十分波折，一度让我狐疑人生，不过播种也很大，代码方面不显著，但感觉本人抹掉了 java、Tomcat、Spring 始终挡在我眼前的一层纱。对它们的了解上了一个新的档次。
一、前言
好久没输入了，于是挑一个方面总结一下，心愿在梳理过程中再理解一些其余的货色。因为 Java 凋敝的生态，上面每一个模块都有大量的文章专门讲述。所以我选了另外一个角度，从理论问题登程，将这些扩散的常识串联起来，各位能够作为一个综述来看。各个模块的极致具体介绍，大家能够去翻官网文档或看网络上的其余博客。
需要很简略清晰，跟产品们提的妖艳需要一点也不一样：在咱们的 web 框架里增加一个通用的 appkey 白名单校验性能，心愿它的扩展性更好一些。
这个 web 框架是部门前驱者基于 spring-boot 实现的，介于业务和 Spring 框架之间，做一些偏差于业务的通用性性能，如 日志输入、性能开关、通用参数解析等。平时是对业务通明的，最近始终忙于把需要做好，代码写好，甚至从没留神过它的存在。
二、传统 AOP
对于这种需要，首先想到的当然是 Spring-boot 提供的 AOP 接口，只须要在 Controller 办法前增加切点，而后再对切点进行解决即可。
▐ 实现
其应用步骤如下：

应用 @Aspect 申明一下切面类 WhitelistAspect；

在切面类内增加一个切点 whitelistPointcut()，为了实现此切点灵便可拆卸的能力，这里不应用 execution 全副拦挡，而是增加一个注解 @Whitelist，被注解的办法才会校验白名单。

在切面类中应用 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（办法执行后）等告诉办法。https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
https://zhuanlan.zhihu.com/p/…
如此，性能曾经实现了，但领导并不称心 =_=，起因是我的项目中 AOP 用得太多了，都用滥了，倡议我换一种形式。嗯，只好搞起。
三、Interceptor
Spring 的 拦截器 (Interceptor) 实现这个性能也十分适合。顾名思义，拦截器用于在 Controller 内 Action 被执行前通过一些参数判断是否要执行此办法，要实现一个拦截器，能够实现 Spring 的 HandlerInterceptor 接口。
▐ 实现
实现步骤如下：

定义拦截器类 AppkeyInterceptor 类并实现 HandlerInterceptor 接口。

实现其 preHandle() 办法；

在 preHandle 办法内通过注解和参数判断是否须要拦挡申请，拦挡申请时接口返回 false；

在自定义的 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();}

}
j
复制代码
▐ 拓展
当然，应用参数解析器也须要独自配置，咱们同样在 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() {// 被销毁时调用一次}

}
复制代码
复制代码

退出移动版