Spring Boot实战：拦截器与过滤器

时间 2019-12-05

原文原文链接

1、拦截器与过滤器

在讲Spring boot以前，咱们先了解一下过滤器和拦截器。这二者在功能方面很相似，可是在具体技术实现方面，差距仍是比较大的。在分析二者的区别以前，咱们先理解一下AOP的概念，AOP不是一种具体的技术，而是一种编程思想。在面向对象编程的过程当中，咱们很容易经过继承、多态来解决纵向扩展。web

可是对于横向的功能，好比，在全部的service方法中开启事务，或者统一记录日志等功能，面向对象的是没法解决的。因此AOP——面向切面编程实际上是面向对象编程思想的一个补充。而咱们今天讲的过滤器和拦截器都属于面向切面编程的具体实现。spring

而二者的主要区别包括如下几个方面：

Filter是依赖于Servlet容器，属于Servlet规范的一部分，而拦截器则是独立存在的，能够在任何状况下使用。编程
Filter的执行由Servlet容器回调完成，而拦截器一般经过动态代理的方式来执行。安全
Filter的生命周期由Servlet容器管理，而拦截器则能够经过IoC容器来管理，所以能够经过注入等方式来获取其余Bean的实例，所以使用会更方便。服务器

2、过滤器的配置

如今咱们经过过滤器来实现记录请求执行时间的功能，其实现以下：app

public class LogCostFilter implements Filter {ide
@Overridepost
public void init(FilterConfig filterConfig) throws ServletException {url
}spa
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
long start = System.currentTimeMillis();
filterChain.doFilter(servletRequest,servletResponse);
System.out.println("Execute cost="+(System.currentTimeMillis()-start));
}
@Override
public void destroy() {
}
}

这段代码的逻辑比较简单，就是在方法执行前先记录时间戳，而后经过过滤器链完成请求的执行，在返回结果之间计算执行的时间。这里须要主要，这个类必须继承Filter类，这个是Servlet的规范，这个跟之前的Web项目没区别。

可是，有了过滤器类之后，之前的web项目能够在web.xml中进行配置，可是spring boot项目并无web.xml这个文件，那怎么配置？在Spring boot中，咱们须要FilterRegistrationBean来完成配置。其实现过程以下：

@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean registFilter() {
FilterRegistrationBean registration = new FilterRegistrationBean();
registration.setFilter(new LogCostFilter());
registration.addUrlPatterns("/*");
registration.setName("LogCostFilter");
registration.setOrder(1);
return registration;
}
}

这样配置就完成了，须要配置的选项主要包括实例化Filter类，而后指定url的匹配模式，设置过滤器名称和执行顺序，这个过程和在web.xml中配置其实没什么区别，只是形式不一样而已。如今咱们能够启动服务器访问任意URL：

你们能够看到上面的配置已经生效了。除了经过 FilterRegistrationBean 来配置之外，还有一种更直接的办法，直接经过注解就能够完成了：

@WebFilter(urlPatterns = "/*", filterName = "logFilter2")
public class LogCostFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
long start = System.currentTimeMillis();
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));
}
@Override
public void destroy() {
}
}

这里直接用@WebFilter就能够进行配置，一样，能够设置url匹配模式，过滤器名称等。这里须要注意一点的是@WebFilter这个注解是Servlet3.0的规范，并非Spring boot提供的。除了这个注解之外，咱们还需在配置类中加另一个注解：@ServletComponetScan，指定扫描的包。

@SpringBootApplication
@MapperScan("com.pandy.blog.dao")
@ServletComponentScan("com.pandy.blog.filters")
public class Application {
public static void main(String[] args) throws Exception {
SpringApplication.run(Application.class, args);
}
}

如今，咱们再来访问一下任意URL：

能够看到，咱们配置的两个过滤器都生效了。细心的读者会发现，第二个Filter咱们并无指定执行的顺序，可是却在第一个Filter以前执行。这里须要解释一下，@WebFilter这个注解并无指定执行顺序的属性，其执行顺序依赖于Filter的名称，是根据Filter类名（注意不是配置的filter的名字）的字母顺序倒序排列，而且@WebFilter指定的过滤器优先级都高于FilterRegistrationBean配置的过滤器。有兴趣的朋友能够本身实验一下。

3、拦截器的配置

上面咱们已经介绍了过滤器的配置方法，接下来咱们再来看看如何配置一个拦截器。咱们使用拦截器来实现上面一样的功能，记录请求的执行时间。首先咱们实现拦截器类：

public class LogCostInterceptor implements HandlerInterceptor {
long start = System.currentTimeMillis();
@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
start = System.currentTimeMillis();
return true;
}
@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
System.out.println("Interceptor cost="+(System.currentTimeMillis()-start));
}
@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
}
}

这里咱们须要实现HandlerInterceptor这个接口，这个接口包括三个方法，preHandle是请求执行前执行的，postHandler是请求结束执行的，但只有preHandle方法返回true的时候才会执行，afterCompletion是视图渲染完成后才执行，一样须要preHandle返回true，该方法一般用于清理资源等工做。除了实现上面的接口外，咱们还需对其进行配置：

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");
super.addInterceptors(registry);
}
}

这里咱们继承了WebMVCConfigurerAdapter，看过前面的文章的朋友应该已经见过这个类了，在进行静态资源目录配置的时候咱们用到过这个类。这里咱们重写了addInterceptors这个方法，进行拦截器的配置，主要配置项就两个，一个是指定拦截器，第二个是指定拦截的URL。如今咱们再启动系统访问任意一个URL：

能够看到，咱们经过拦截器实现了一样的功能。不过这里还要说明一点的是，其实这个实现是有问题的，由于preHandle和postHandle是两个方法，因此咱们这里不得不设置一个共享变量start来存储开始值，可是这样就会存在线程安全问题。固然，咱们能够经过其余方法来解决，好比经过ThreadLocal就能够很好的解决这个问题，有兴趣的同窗能够本身实现。不过经过这一点咱们其实能够看到，虽然拦截器在不少场景下优于过滤器，可是在这种场景下，过滤器比拦截器实现起来更简单。

4、总结

本文主要对基于Spring boot对过滤器和拦截器的配置进行的讲解。不管是过滤器仍是拦截器都属于AOP（面向切面编程）思想的具体实现。除了这两种实现咱们还见过另外一种更灵活的AOP实现技术，即Aspect，咱们能够经过Aspect来完成更多更强大的功能。这个后续再给你们分享。

文章来源：https://mp.weixin.qq.com/s/rE4-dVpLyydTqKxX51NRTg