SpringBoot 过滤器、拦截器、监听器对比及使用场景分析

过滤器是处于客户端和服务器资源文件之间的一道过滤网，这篇文章主要介绍了SpringBoot 过滤器、拦截器、监听器对比及使用场景分析,需要的朋友可以参考下

一、关系图理解

二、区别

1.过滤器

过滤器是在web应用启动的时候初始化一次, 在web应用停止的时候销毁

可以对请求的URL进行过滤, 对敏感词过滤

挡在拦截器的外层

实现的是 javax.servlet.Filter 接口，是 Servlet 规范的一部分

在请求进入容器后，但在进入servlet之前进行预处理，请求结束是在servlet处理完以后

依赖Web容器

会多次执行

过滤器简介

过滤器的英文名称为 Filter, 是 Servlet 技术中最实用的技术。如同它的名字一样，过滤器是处于客户端和服务器资源文件之间的一道过滤网，帮助我们过滤掉一些不符合要求的请求，通常用作 Session 校验，判断用户权限，如果不符合设定条件，则会被拦截到特殊的地址或者基于特殊的响应。

过滤器的使用

首先需要实现 Filter接口然后重写它的三个方法

•init 方法：在容器中创建当前过滤器的时候自动调用

•destory 方法：在容器中销毁当前过滤器的时候自动调用

•doFilter 方法：过滤的具体操作

1.1HttpServletRequestWrapper

在请求到达之前对 request 进行修改

package com.dingwen.lir.filter; import lombok.extern.slf4j.Slf4j; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequestWrapper; import java.util.Arrays; /** * 在请求到达之前对 request 进行修改 * * @author dingwen * 2021.04.30 14:54 */ @Slf4j public class RequestWrapper extends HttpServletRequestWrapper { public RequestWrapper(HttpServletRequest request) { super(request); log.info("RequestWrapper"); } @Override public String getParameter(String name) { // 可以对请求参数进行过滤 return super.getParameter(name); } @Override public String[] getParameterValues(String name) { // 对请求参数值进行过滤 // String[] values =super.getRequest().getParameterValues(name); // return super.getParameterValues(name); return "t e s t".split(" "); } }

1.2 OncePerRequestFilter

OncePerRequestFilter，顾名思义，它能够确保在一次请求中只通过一次filter

package com.dingwen.lir.filter; import lombok.extern.slf4j.Slf4j; import org.springframework.web.filter.OncePerRequestFilter; import javax.servlet.FilterChain; import javax.servlet.servletexception; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.io.PrintWriter; import java.util.Arrays; /** * 请求过滤器 * OncePerRequestFilter: * OncePerRequestFilter，顾名思义，它能够确保在一次请求中只通过一次filter. * 大家常识上都认为，一次请求本来就只filter一次，为什么还要由此特别限定呢，往往我们的常识和实际的实现并不真的一样，经过一番资料的查阅，此方法是为了兼容不同的web container， * 也就是说并不是所有的container都入我们期望的只过滤一次，servlet版本不同，执行过程也不同， * 因此，为了兼容各种不同运行环境和版本，默认filter继承OncePerRequestFilter是一个比较稳妥的选择。 * * @author dingwen * 2021.04.30 15:59 */ @Slf4j public class RequestFilter extends OncePerRequestFilter { @Override public void destroy() { super.destroy(); log.info("RequestFilter destroy"); } /* OncePerRequestFilter.doFilter方法中通过request.getAttribute判断当前过滤器是否已执行若未执行过，则调用doFilterInternal方法，交由其子类实现 */ @Override protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws servletexception, IOException { try { RequestWrapper requestWrapper = new RequestWrapper(httpServletRequest); filterChain.doFilter(requestWrapper, httpServletResponse); log.info("RequestFilter"); log.info(Arrays.toString(requestWrapper.getParameterValues("name"))); } catch (Exception exception) { httpServletResponse.setCharacterEncoding("utf-8"); httpServletResponse.setContentType("application/json; charset=utf-8"); PrintWriter writer = httpServletResponse.getWriter(); writer.write(exception.toString()); } } }

1.3 配置

package com.dingwen.lir.configuration; import com.dingwen.lir.filter.RequestFilter; import com.dingwen.lir.filter.RequestWrapper; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import javax.servlet.Filter; /** * 过滤器配置类 * * @author dingwen * 2021.04.30 16:10 */ @Configuration public class FilterConfig { @Bean public RequestFilter requestFilter(){ return new RequestFilter(); } @Bean public FilterRegistrationBean registrationBean() { FilterRegistrationBean registrationBean = new FilterRegistrationBean(); registrationBean.setFilter(requestFilter()); registrationBean.addUrlPatterns("/filter/*"); registrationBean.setName("RequestFilter"); //过滤器的级别，值越小级别越高越先执行 registrationBean.setorder(1); return registrationBean; } }

2.拦截器

实现 org.springframework.web.servlet.handlerinterceptor 接口，动态代理

拦截器应用场景, 性能分析, 权限检查, 日志记录

是一个Spring组件，并由spring容器管理，并不

依赖Tomcat等容器，是可以单独使用的。不仅能应用在web程序中，也可以用于Application、Swing等程序中

是在请求进入servlet后，在进入Controller之前进行预处理的，Controller 中渲染了对应的视图之后请求结束

2.1登录拦截

package com.dingwen.lir.interceptor; import com.dingwen.lir.entity.User; import org.springframework.stereotype.Component; import org.springframework.util.ObjectUtils; import org.springframework.web.servlet.handlerinterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; /** * 登录拦截 * * @author dingwen * 2021.04.25 13:50 */ @Component public class PageInterceptor implements handlerinterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { User user = (User)request.getSession().getAttribute("user"); if (!ObjectUtils.isEmpty(user)) { return true; } else { // 不管是转发还是重定向，必须返回false。否则出现多次提交响应的错误 redirect(request, response); return false; } } /* * 对于请求是ajax请求重定向问题的处理方法 * @param request * @param response * */ public void redirect(HttpServletRequest request, HttpServletResponse response) throws IOException { if("XMLHttpRequest".equals(request.getHeader("X-Requested-With"))){// ajax //获取当前请求的路径 response.setHeader("Access-Control-Expose-Headers", "REDIRECT,CONTENT_PATH"); //告诉ajax我是重定向 response.setHeader("REDIRECT", "REDIRECT"); //告诉ajax我重定向的路径 StringBuffer url = request.getRequestURL(); String contextpath = request.getcontextpath(); response.setHeader("CONTENT_PATH", url.replace(url.indexOf(contextpath) + contextpath.length(), url.length(), "/").toString()); }else{// http response.sendRedirect( "/page/login"); } response.getWriter().write(403); response.setStatus(HttpServletResponse.SC_FORBIDDEN); } }

2.2配置

package com.dingwen.lir.configuration; import com.dingwen.lir.interceptor.PageInterceptor; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; /** * mvc 控制器配置 * MyWebMvcConfigurer: Springboot2.x以后版本使用 * * @author dingwen * 2021.04.26 17:52 */ @Configuration public class MyWebMvcConfigurer implements WebMvcConfigurer { /* * 拦截器依赖于spring容器，此处拦截了所有，需要对静态资源进行放行 */ @Override public void addInterceptors(InterceptorRegistry registry) { // 拦截器默认的执行顺序，就是它的注册顺序，也可以通过Order手动设置控制，值越小越先执行。 // registry.addInterceptor(new PageInterceptor()).addpathPatterns("/**").order() registry.addInterceptor(new PageInterceptor()).addpathPatterns("/**") .excludePathPatterns("/page/login", "/user/login","/page/ajax","/static/**"); } /* * 不要要写控制器即可完成页面跳转访问 * @param registry */ @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/page/ajax").setViewName("ajax"); } /* * 自定义静态资源映射 Spring Boot 默认为我们提供了静态资源映射： classpath:/meta-inf/resources classpath:/resources classpath:/static classpath:/public 优先级：meta-inf/resources > resources > static > public * @param registry * */ // @Override // public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/"); registry.addResourceHandler("/static/**").addResourceLocations("file:E:/static/"); // } }

3.监听器

实现 javax.servlet.ServletRequestListener, javax.servlet.http.HttpSessionListener, javax.servlet.servletcontextlistener 等等接口

主要用来监听对象的创建与销毁的发生, 比如 session 的创建销毁, request 的创建销毁, ServletContext 创建销毁

三、注意

1.静态资源问题

SpringBoot2.x以后版本拦截器也会拦截静态资源，在配置拦截器是需要将姿态资源放行。

/* * 拦截器依赖于spring容器，此处拦截了所有，需要对静态资源进行放行 */ @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new PageInterceptor()).addpathPatterns("/**") .excludePathPatterns("/page/login", "/user/login","/page/ajax","/static/**"); }

SpringBoot2.x 自定义静态资源映射

spring: mvc: static-path-pattern: /static/**

默认目录

classpath:/meta-inf/resources

classpath:/resources

classpath:/static

classpath:/public

优先级：meta-inf/resources > resources > static > public