Spring 中的拦截机制

实现拦截机制的三种方法

1. 过滤器 Filter

能够获知原始的请求响应信息，却无法获取具体执行方法的信息和参数

2. 拦截器 Interceptor

能够获知原始的请求响应信息和具体执行方法信息，却无法获取具体执行参数

3. 切片 Aspect

无法获知请求响应信息，但可以获取具体执行方法信息和执行参数

过滤器 (Filter) 拦截实现

对于自定义过滤器，可以通过继承 javax.servlet.Filter 类并重写相关方法实现。为了可以加入到系统的过滤器链中，可以将自定义的过滤器添加注解 @Component 声明为一个组件则默认拦截所有，也可添加注解 @WebFilter 并配置拦截器名称及拦截路径。

// @Component
@WebFilter(filterName = "myFilter", urlPatterns = "/*")
public class MyFilter extends Filter {
    
    @Override
    public void destroy() {
        // ...
    }
    
    @Override
    public void doFilter (ServletRequest request, ServletResponse response, FilterChain chain) {
        // ...
        chain.doFilter(request, response);
        // ...
    }
    
    @Override
    public void init(FilterConfig config) {
        // ...
    }
}

上述对于自定义过滤器可以通过注解声明为 bean 添加到过滤器链中，但是对于第三方不可更改的过滤器而言，可以通过配置的方式添加到过滤器链中，代码示例如下，

@Configuration
public class WebConfig {
    
    @Bean
    public FilterRegistrationBean myFilter() {
        // 新建过滤器注册组件
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        
        // 祖册过滤器
        MyFilter myFilter = new MyFilter();
        registrationBean.setFilter(myFilter);
        
        // 配置过滤的 url，可通过正则匹配
        List<String> urls = new ArrayList<>();
        urls.add("/*");
        registrationBean.setUrlPatterns(urls);
        
        return registrationBean;
    }
}

拦截器 (Interceptor) 拦截实现

拦截器 (Interceptor) 是由 Spring 框架所提供的，会拦截所有的控制器。不同于过滤器 (Filter) 需要依赖 Servlet 容器，拦截器基于动态代理实现处理 Controller 请求。拦截器实现代码如下，

@Component
public class MyInterceptor implements HandlerInterceptor {
    
    /**
     * 在进入 Controller 之前执行
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        //...
        // 返回的结果决定使用执行后续的方法
        return flase;
    }
    
    /**
     * 执行完 Controller 逻辑，在返回 ModelAndView 之前执行
     * 若 Controller 中发生异常则不执行该方法
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        // ...
    }
    
    /**
     * 在最后执行
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception) {
        // ...
    }
}

@Configuration
pubic class WebConfig extends WebMvcConfigurerAdapter {
    
    @Autowired
    private MyInterceptor myInterceptor;
    
    @Override
    public void addInterceprots(InterceptorRegistry registry) {
        // 这里注册拦截器并配置拦截的路径，若不配置拦截路径则默认拦截所有
        registry.addInterceptor(myInterceptor)addPathPatterns("/*");
    }
}

切片 (Aspect) 拦截实现

@Aspect
@Component
public class MyAspect {
    
    /**
     * @Before 前置增强方法
     * @After 后置增强方法
     * @Around 环绕增强方法
     * @AfterThrowing 处理异常的增强方法
     */
    @Around("execution(* com.test.**.controller.*(..))")
    public object handleControllerMethod(ProceedingJoinPoint pjp) {
        // ...
        // 执行具体方法
        Object object = pjp.proceed();
        // ...
        
        return object;
    }
}

拦截机制执行顺序