SpringMvc拦截器与过滤器

StandsSpringBoot: 学习

过滤器

Filters :: Spring Framework

@Component
public class CorsFilter extends OncePerRequestFilter {
   @Override
   protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws ServletException, IOException {
       // 不使用*，自动适配跨域域名，避免携带Cookie时失效
       String origin = request.getHeader("Origin");
       if(StringUtils.isNotBlank(origin)) {
           response.setHeader("Access-Control-Allow-Origin", origin);
       }

       // 自适应所有自定义头
       String headers = request.getHeader("Access-Control-Request-Headers");
       if(StringUtils.isNotBlank(headers)) {
           response.setHeader("Access-Control-Allow-Headers", headers);
           response.setHeader("Access-Control-Expose-Headers", headers);
       }

       // 允许跨域的请求方法类型
       response.setHeader("Access-Control-Allow-Methods", "*");
       // 预检命令（OPTIONS）缓存时间，单位：秒
       response.setHeader("Access-Control-Max-Age", "3600");
       // 明确许可客户端发送Cookie，不允许删除字段即可
       response.setHeader("Access-Control-Allow-Credentials", "true");

       chain.doFilter(request, response);
   }

   @Bean
   public FilterRegistrationBean registerFilter() {
       FilterRegistrationBean<CorsFilter> bean = new FilterRegistrationBean<>();
       bean.addUrlPatterns("/*");
       bean.setFilter(new CorsFilter());
       // 过滤顺序，从小到大依次过滤
       bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
       return bean;
   }
}

implements Filter  注入变量的问题

方式一

import jakarta.servlet.*;

public class AccessFilter implements Filter {

    private RestTemplate restTemplate;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        //解决filter无法依赖注入的问题
        ServletContext sc = filterConfig.getServletContext();
        WebApplicationContext webApplicationContext = WebApplicationContextUtils.getWebApplicationContext(sc);
        restTemplate = webApplicationContext.getBean(RestTemplate.class);
    }

    @Override
    public void destroy() {}

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        filterChain.doFilter(servletRequest, servletResponse);
    }
}

 方式二

@Component
@RequiredArgsConstructor
public class AccessFilter implements Filter {
    
    private final RestTemplate restTemplate;
    
    @Override
    public void destroy() {}

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        filterChain.doFilter(servletRequest, servletResponse);
    }
}

拦截器

Interceptors :: Spring Framework

ublic class BaseFilter implements HandlerInterceptor {

    /**
     * 这个方法在业务处理器处理请求之前被调用
     * 如果截器对请求进行拦截后还要调用其他的拦截器，或者是业务处理器去进行处理，则返回true；
     * 如果决定不需要再调用其他的组件去处理请求，则返回false。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        return true;
    }

    /**
     *业务处理器处理后，但是DispatcherServlet向客户端返回响应前被调用，
     * 在该方法中对用户请求request进行处理。
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

    /**
       DispatcherServlet 完全处理完请求后被调用，可以在该方法中进行一些资源清理的操作。
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}

@Configuration
public class MyFilterConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new BaseFilter()).addPathPatterns("/async/*")
                .order(1);
    }
}

 拦截器和过滤器的区别

1. 过滤器

1. 依赖于servlet容器；

2. 在实现上基于函数回调，可以对几乎所有请求进行过滤；（范围大）

3. 缺点是一个过滤器实例只能在容器初始化时调用一次；（只调用一次）

4. 使用过滤器的目的是用来做一些过滤操作，获取我们想要获取的数据，比如：在过滤器中修改字符编码；在过滤器中修改HttpServletRequest的一些参数，包括：过滤低俗文字、危险字符等。

2. 拦截器

1. 依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架

2. 在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用；

3. 缺点是只能对controller请求进行拦截，对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理；

4. 由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。（依赖spring容器）