Spring Boot 拦截器和过滤器

Spring Boot 拦截器和过滤器

文章概览

• 拦截器
• 过滤器

拦截器

---

我们可以使用拦截器做一些处理在一下两种状态：

• 发送请求到controller之前
• 响应信息到客户端之前

拦截器步骤：

• 定义一个拦截器
• 注册定义的拦截器

例子：在一个请求在到达controller之前，我们可以用拦截器给这个请求增加request header 的属性；或在一个响应返回到客户端之前，我们用拦截器给这个响应增加response header。

自定义拦截器，需要我们实现HandlerInterceptor接口，还要 @Component 注解的支持。

下面是三个方法来自HandlerInterceptor接口

• preHandle()：该方法用来做一些处理，在请求到达controller之前。返回true时，才会返回响应给客户端。
• postHandle()：该方法用来做一些处理，在响应到达客户端之前。
• afterCompletion()：该方法做一些处理，在完成请求和响应后。

代码如下：

@Component
public class ProductServiceInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("pre Handle method is Calling");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("Post Handle method is Calling");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("Request and Response is completed");
    }
}

注册拦截器，我们需要InterceptorRegistry 来注册拦截器，要实现WebMvcConfigurer 接口

@Component
public class ProductServiceInterceptorAppConfig implements WebMvcConfigurer {
    @Autowired
    ProductServiceInterceptor productServiceInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(productServiceInterceptor);
    }
}

拦截器执行大概流程如下：

过滤器

---

过滤器用来拦截HTTP的请求和响应，我们可以使用过滤器处理一些操作：

• 在请求到达controller之前
• 在响应到达client之前

自定义一个过滤器(Filter)，需要实现Filter接口，需要 @Component支持。Filter的三个方法：

• init()：在初始化过滤器的时候就执行
• doFilter()：可能会到过滤器，调用过滤器执行链。
• destroy()：在销毁过滤器时执行

代码如下

@Component
public class SimpleFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("filter start init");
    }

    @Override
    public void destroy() {
        System.out.println("filter end!!!");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Remote Host:"+servletRequest.getRemoteHost());
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("Remote1 Host:"+servletRequest.getRemoteHost());
    }
}

过滤器的执行大概流程：

拦截器和过滤器的区别

• 过滤器能做的，拦截器能做
• 他们执行顺序不一致
  

参考

Spring Boot - Interceptor