一、前言过滤器Filter和拦截器Interceptor是Web项目中常用的两个功能本文将简单介绍在Spring Boot中使用过滤器和拦截器来计算Controller中方法的执行时长并且简单对比两者的区别。现有如下ControllerRestControllerRequestMapping(test)publicclassTestController{GetMapping(/{id:\\d})publicvoidget(PathVariableStringid){System.out.println(id);}}下面通过配置过滤器和拦截器来实现对get方法执行时间计算的功能。二、过滤器2.1 代码编写定义一个TimeFilter类实现javax.servlet.FilterpublicclassTimeFilterimplementsFilter{Overridepublicvoidinit(FilterConfigfilterConfig)throwsServletException{System.out.println(过滤器初始化);}OverridepublicvoiddoFilter(ServletRequestservletRequest,ServletResponseservletResponse,FilterChainfilterChain)throwsIOException,ServletException{System.out.println(开始执行过滤器);LongstartnewDate().getTime();filterChain.doFilter(servletRequest,servletResponse);System.out.println(【过滤器】耗时 (newDate().getTime()-start));System.out.println(结束执行过滤器);}Overridepublicvoiddestroy(){System.out.println(过滤器销毁);}}TimeFilter重写了Filter的三个方法方法名称已经很直白的描述了其作用这里不再赘述。2.2 配置方式一可通过在TimeFilter上加上如下注解ComponentWebFilter(urlPatterns{/*})publicclassTimeFilterimplementsFilter{Overridepublicvoidinit(FilterConfigfilterConfig)throwsServletException{System.out.println(过滤器初始化);}OverridepublicvoiddoFilter(ServletRequestservletRequest,ServletResponseservletResponse,FilterChainfilterChain)throwsIOException,ServletException{System.out.println(开始执行过滤器);LongstartnewDate().getTime();filterChain.doFilter(servletRequest,servletResponse);System.out.println(【过滤器】耗时 (newDate().getTime()-start));System.out.println(结束执行过滤器);}Overridepublicvoiddestroy(){System.out.println(过滤器销毁);}}Component注解让TimeFilter成为Spring上下文中的一个BeanWebFilter注解的urlPatterns属性配置了哪些请求可以进入该过滤器/*表示所有请求。启动项目时可以看到控制台输出了过滤器初始化启动后访问http://localhost:8080/test/1控制台输出如下开始执行过滤器 1 【过滤器】耗时 31 结束执行过滤器2.3 配置方式二除了在过滤器类上加注解外我们也可以通过FilterRegistrationBean来注册过滤器。定义一个WebConfig类加上Configuration注解表明其为配置类然后通过FilterRegistrationBean来注册过滤器:ConfigurationpublicclassWebConfig{BeanpublicFilterRegistrationBeantimeFilter(){FilterRegistrationBeanfilterRegistrationBeannewFilterRegistrationBean();TimeFiltertimeFilternewTimeFilter();filterRegistrationBean.setFilter(timeFilter);ListStringurlListnewArrayList();urlList.add(/*);filterRegistrationBean.setUrlPatterns(urlList);returnfilterRegistrationBean;}}FilterRegistrationBean除了注册过滤器TimeFilter外还通过setUrlPatterns方法配置了URL匹配规则。重启项目访问http://localhost:8080/test/1我们可以看到和上面一样的效果。注意通过过滤器我们只可以获取到servletRequest对象所以并不能获取到方法的名称所属类参数等额外的信息。三、拦截器3.1 代码编写定义一个TimeInterceptor类实现org.springframework.web.servlet.HandlerInterceptor接口:ComponentpublicclassTimeInterceptorimplementsHandlerInterceptor{OverridepublicbooleanpreHandle(HttpServletRequesthttpServletRequest,HttpServletResponsehttpServletResponse,Objecto)throwsException{System.out.println(处理拦截之前);httpServletRequest.setAttribute(startTime,newDate().getTime());System.out.println(((HandlerMethod)o).getBean().getClass().getName());System.out.println(((HandlerMethod)o).getMethod().getName());returntrue;}OverridepublicvoidpostHandle(HttpServletRequesthttpServletRequest,HttpServletResponsehttpServletResponse,Objecto,ModelAndViewmodelAndView)throwsException{System.out.println(开始处理拦截);Longstart(Long)httpServletRequest.getAttribute(startTime);System.out.println(【拦截器】耗时 (newDate().getTime()-start));}OverridepublicvoidafterCompletion(HttpServletRequesthttpServletRequest,HttpServletResponsehttpServletResponse,Objecto,Exceptione)throwsException{System.out.println(处理拦截之后);Longstart(Long)httpServletRequest.getAttribute(startTime);System.out.println(【拦截器】耗时 (newDate().getTime()-start));System.out.println(异常信息 e);}}TimeInterceptor实现了HandlerInterceptor接口的三个方法。preHandle方法在处理拦截之前执行postHandle只有当被拦截的方法没有抛出异常成功时才会处理afterCompletion方法无论被拦截的方法抛出异常与否都会执行。通过这三个方法的参数可以看到相较于过滤器拦截器多了Object和Exception对象所以可以获取的信息比过滤器要多的多。但过滤器仍无法获取到方法的参数等信息我们可以通过切面编程来实现这个目的具体可参考《Spring-Boot-AOP记录用户操作日志》。3.2 配置要使拦截器在Spring Boot中生效还需要如下配置在WebConfig中通过InterceptorRegistry注册过滤器:ConfigurationpublicclassWebConfigimplementsWebMvcConfigurer{AutowiredprivateTimeInterceptortimeInterceptor;OverridepublicvoidaddInterceptors(InterceptorRegistryregistry){registry.addInterceptor(timeInterceptor);}}SpringBoot2使用的Spring5因此将WebMvcConfigurerAdapter改为WebMvcConfigurer使用WebMvcConfigurer扩展SpringMVC好处既保留了SpringBoot的自动配置又能用到我们自己的配置如果我们需要全面接管SpringBoot中的SpringMVC配置则开启EnableWebMvc此注解开启后SpringMVC的自动配置将会失效。启动项目访问http://localhost:8080/test/1控制台输出如下处理拦截之前 com.wno704.boot.controller.TestController get 1 开始处理拦截 【拦截器】耗时 1 处理拦截之后 【拦截器】耗时 1 异常信息 null从输出中我们可以了解到三个方法的执行顺序并且三个方法都被执行了。我们在TestController新增方法手动抛出一个异常RestControllerRequestMapping(test)publicclassTestController{GetMapping(/t/{id:\\d})publicvoidgett(PathVariableStringid){System.out.println(id);thrownewRuntimeException(user not exist);}}重启项目后访问http://localhost:8080/test/t/1控制台输出如下处理拦截之前org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorControllererrorHtml 开始处理拦截 【拦截器】耗时23处理拦截之后 【拦截器】耗时28异常信息null可看到postHandle方法并没有被执行。四、执行时机对比我们将过滤器和拦截器都配置上然后启动项目访问http://localhost:8080/test/1开始执行过滤器 处理拦截之前com.wno704.boot.controller.TestControllerget1开始处理拦截 【拦截器】耗时0处理拦截之后 【拦截器】耗时0异常信息null【过滤器】耗时1结束执行过滤器可看到过滤器要先于拦截器执行晚于拦截器结束。下图很好的描述了它们的执行时间区别