4 种 SpringBoot 项目鉴权方式

传统 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(方法执行后) 等通知方法。如此,功能已经实现了,但领导并不满意,原因是项目中 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();  
    }  
}  

扩展

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

@Configuration
public class MvcConfiguration extends WebMvcConfigurerAdapter {

@Override  
public void addArgumentResolvers(List 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 被拦截了自然不需要后续再进行处理,然后是 参数解析器,最后才是切面的切点。

关键词:java培训

你可能感兴趣的:(springboot)