过滤器(Filter)和拦截器(Interceptor)是Web项目中常用的两个功能,本文将简单介绍在Spring Boot中使用过滤器和拦截器来计算Controller中方法的执行时长,并且简单对比两者的区别。
现有如下Controller:
@RestController@RequestMapping("user")publicclassUserController{@GetMapping("/{id:\\d+}")publicvoidget(@PathVariableStringid){System.out.println(id);}}
下面通过配置过滤器和拦截器来实现对get
方法执行时间计算的功能。
一、过滤器
定义一个TestFilter
类,实现javax.servlet.Filter
:
publicclassTestFilterimplementsFilter{@Overridepublicvoidinit(FilterConfigfilterConfig)throwsServletException{System.out.println("过滤器初始化");}@OverridepublicvoiddoFilter(ServletRequestservletRequest,ServletResponseservletResponse,FilterChainfilterChain)throwsIOException,ServletException{System.out.println("开始执行过滤器");Longstart=newDate().getTime();filterChain.doFilter(servletRequest,servletResponse);System.out.println("【过滤器】耗时"+(newDate().getTime()-start));System.out.println("结束执行过滤器");}@Overridepublicvoiddestroy(){System.out.println("过滤器销毁");}}
TestFilter
重写了Filter
的三个方法,方法名称已经很直白的描述了其作用,这里不再赘述。
要使该过滤器在Spring Boot中生效,还需要一些配置。这里主要有两种配置方式。
配置方式一
可通过在TestFilter
上加上如下注解:
@Component@WebFilter(urlPatterns={"/*"})publicclassTestFilterimplementsFilter{...}
@Component
注解让TestFilter
成为Spring上下文中的一个Bean,@WebFilter
注解的urlPatterns
属性配置了哪些请求可以进入该过滤器,/*
表示所有请求。
启动项目时可以看到控制台输出了过滤器初始化
,启动后访问http://localhost:8080/user/1, 控制台输出如下:
开始执行过滤器1【过滤器】耗时31结束执行过滤器
配置方式二
除了在过滤器类上加注解外,我们也可以通过FilterRegistrationBean
来注册过滤器。
定义一个WebConfig
类,加上@Configuration
注解表明其为配置类,然后通过FilterRegistrationBean
来注册过滤器:
@ConfigurationpublicclassWebConfig{@BeanpublicFilterRegistrationBeantestFilter(){FilterRegistrationBeanfilterRegistrationBean=newFilterRegistrationBean();TestFiltertestFilter=newTestFilter();filterRegistrationBean.setFilter(testFilter);List<String>urlList=newArrayList<>();urlList.add("/*");filterRegistrationBean.setUrlPatterns(urlList);returnfilterRegistrationBean;}}
FilterRegistrationBean
除了注册过滤器TestFilter
外还通过setUrlPatterns
方法配置了URL匹配规则。重启项目访问http://localhost:8080/user/1 ,我们可以看到和上面一样的效果。
通过过滤器我们只可以获取到servletRequest对象,所以并不能获取到方法的名称,所属类,参数等额外的信息。
二、拦截器
定义一个TestInterceptor
类,实现org.springframework.web.servlet.HandlerInterceptor
接口:
publicclassTestInterceptorimplementsHandlerInterceptor{@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);}}
TestInterceptor
实现了HandlerInterceptor
接口的三个方法。preHandle
方法在处理拦截之前执行,postHandle
只有当被拦截的方法没有抛出异常成功时才会处理,afterCompletion
方法无论被拦截的方法抛出异常与否都会执行。
通过这三个方法的参数可以看到,相较于过滤器,拦截器多了Object和Exception对象,所以可以获取的信息比过滤器要多的多。但过滤器仍无法获取到方法的参数等信息,我们可以通过切面编程来实现这个目的。
要使拦截器在Spring Boot中生效,还需要如下两步配置:
1.在拦截器类上加入@Component
注解;
2.在WebConfig
中通过InterceptorRegistry
注册过滤器:
@ConfigurationpublicclassWebConfigextendsWebMvcConfigurerAdapter{@AutowiredprivateTestInterceptortestInterceptor;@OverridepublicvoidaddInterceptors(InterceptorRegistryregistry){registry.addInterceptor(testInterceptor).addPathPatterns("/**").excludePathPatterns("/**","/","/login","/register");}}
启动项目,访问http://localhost:8080/user/1, 控制台输出如下:
处理拦截之前cn.ycf.controller.UserControllerget1开始处理拦截【拦截器】耗时24处理拦截之后【拦截器】耗时24异常信息null
从输出中我们可以了解到三个方法的执行顺序,并且三个方法都被执行了。
我们在UserController
的get
方法中手动抛出一个异常:
@GetMapping("/{id:\\d+}")publicvoidget(@PathVariableStringid){System.out.println(id);thrownewRuntimeException("usernotexist");}
重启项目后,访问http://localhost:8080/user/1, 控制台输出如下:
处理拦截之前cn.ycf.controller.UserControllerget1处理拦截之后【拦截器】耗时0异常信息java.lang.RuntimeException:usernotexist
可看到,postHandle
方法并没有被执行。
三、执行时机对比
我们将过滤器和拦截器都配置上,然后启动项目访问http://localhost:8080/user/1:
publicclassTestFilterimplementsFilter{@Overridepublicvoidinit(FilterConfigfilterConfig)throwsServletException{System.out.println("过滤器初始化");}@OverridepublicvoiddoFilter(ServletRequestservletRequest,ServletResponseservletResponse,FilterChainfilterChain)throwsIOException,ServletException{System.out.println("开始执行过滤器");Longstart=newDate().getTime();filterChain.doFilter(servletRequest,servletResponse);System.out.println("【过滤器】耗时"+(newDate().getTime()-start));System.out.println("结束执行过滤器");}@Overridepublicvoiddestroy(){System.out.println("过滤器销毁");}}0
可看到过滤器要先于拦截器执行,晚于拦截器结束。下图很好的描述了它们的执行时间区别: