一、Spring MVC中过滤器和拦截器
过滤器Filter
过滤器Filter是Web应用程序的组件,他可以在请求到达Servlet容器之前对请求进行拦截,也可以在响应信息返回到客户端之前进行拦截
Filter接口包含三个方法:
- init方法是Filter的初始化方法,在Servlet容器创建过滤器实例的时候会调用,确保过滤器能够正常工作
- doFilter过滤器的核心方法
- 对每一个拦截的请求执行自定义的操作,典型应用,在request到达Servlet容器之前拦截request,可以根据需要修改request
- destroy方法,负责过滤器的销毁,释放资源,在所有doFilter线程执行完之后执行
过滤器是一个链式处理,Filter链式调用流程
执行流程类似数据结构中的栈,先进后出
拦截器Interceptor
拦截器是AOP策略的一种实现策略,用于在某个方法或者字段被访问前对它进行拦截,然后在其之前或者之后加上某些操作,拦截器也是链式调用。
看源码
- preHandler拦截器方法的前置处理,在请求处理之前调用,可以进行一些前置的初始化操作,也可以进行权限校验,返回true机会调用下一个拦截器的preHandler方法,如果是最后一个拦截器就会调用请求所对应的Controller中的方法,返回false,请求执行结束,后续的拦截器和Controller也不会再执行了
- postHandler后置处理,在Controller执行之后调用该方法,在dispatchServlet返回渲染之前执行,可以对Controller处理之后的响应再去进行一些操作
- afterCompletion方法请求处理完成之后在dispatchServlet渲染之后执行,主要是进行一些资源清理工作
二、Filter和HandlerInterceptor实现日志功能
Filter实现日志记录
新建filter包,增加LogFilter过滤器类实现Filter接口
@Slf4j @WebFilter(urlPatterns = "/*", filterName = "LogFilter") public class LogFilter implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { long startTime = System.currentTimeMillis(); chain.doFilter(request,response); log.info("LogFilter Print Log: {} -> {}",((HttpServletRequest) request).getRequestURI(),(System.currentTimeMillis() - startTime)); } } 复制代码
使用@WebFilter注解标记该类为一个Filter注解,并设置对所有的URL都生效;在主启动类上增加扫描注解
@ServletComponentScan("com.citi.spring.traps") 复制代码
HandlerInterceptor实现日志记录
新增interceptor包,在包中定义一个LogInterceptor
@Slf4j @Component public class LogInterceptor implements HandlerInterceptor { long startTime = System.currentTimeMillis(); // 记录请求时间 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { startTime = System.currentTimeMillis(); HandlerMethod handlerMethod = (HandlerMethod) handler; log.info("LogInterceptor:{}", handlerMethod.getBean().getClass().getName()); log.info("LogInterceptor:{}", handlerMethod.getMethod().getName()); return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { log.info("LogInterceptor Print Log:{} -> {}", request.getRequestURI(),System.currentTimeMillis() - startTime); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { } } 复制代码
增加WebInterceptorAdapter,注册LogInterceptor拦截器,并对所有的请求都进行拦截
@Component @Configuration public class WebInterceptorAdapter implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**").order(0); } } 复制代码
启动应用并清空控制台的日志,执行spring_mvc_traps_date_transfer.http中的GET请求,控制台打印出LogFilter和LogInterceptor拦截请求生成的日志
LogInterceptor中startTime是全局变量,当多个线程同时请求时是线程非安全的。
在interceptor包中增加第二个日志拦截器SecondLogInterceptor
@Slf4j @Component public class SecondLogInterceptor implements HandlerInterceptor { // 记录请求时间 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { request.setAttribute("startTime",System.currentTimeMillis()); return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { log.info("SecondLogInterceptor Print Log:{} -> {}", request.getRequestURI(),System.currentTimeMillis() - (long)request.getAttribute("startTime")); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { } } 复制代码
在WebInterceptorAdapter中注册SecondLogInterceptor
@Component @Configuration public class WebInterceptorAdapter implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**").order(0); registry.addInterceptor(new SecondLogInterceptor()).addPathPatterns("/**").order(1); } } 复制代码
这里定义了两个拦截器,LogInterceptor的优先级为0先执行,SecondLogInterceptor优先级为1后执行,但是拦截器也是链式执行的,执行的顺序也是类似栈这种数据结构,所以SecondInterceptor的postHandler会先执行,然后再执行LogInterceptor的postHandler方法。
重启应用,重启完成之后清空控制台的日志,再次执行GET请求
Filter VS Interceptor
Spring的拦截器Interceptor与Servlet的过滤器Filter有相似之处,两者都是AOP面向切面变成思想的体现,都可以针对request实现权限检查,日志记录等功能。
不同之处体现在:
- 使用范围不同:过滤器是是Servlet中的组件,只能应用在Web应用中;拦截器既可以在Web程序中使用也可以在普通的应用程序中使用
- 规范不同:过滤器是Servlet规范中定义的,是Servlet所支持的,拦截器是Spring容器定义的,是Spring Framework支持的
- 使用的资源不同:拦截器是Spring容器中的的Bean,是由Spring容器所管理的,过滤器是Servlet规范定义的,不是Spring所管理的
- 深度不同:过滤器只在request到Servlet容器前后进行操作,拦截器可以深入到方法前后以及异常抛出前后,拦截器的使用范围更大。
总结:Spring项目中,几乎所有过滤器能实现的功能,拦截器都能实现,当然过滤器能实现的拦截器也能实现,但是建议优先考虑使用拦截器,可以被Spring所管理,可以更好的应用Spring容器。