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

来源 | blog.csdn.net/qq_38020915/article/details/116431612

作者 | dingwen_blog

一、关系图理解

二、区别

1.过滤器

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

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

  • 挡在拦截器的外层

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

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

  • 依赖Web容器

  • 会多次执行

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 进行修改*/
@Slf4j
public class RequestWrapper extends HttpServletRequestWrapper {public RequestWrapper(HttpServletRequest request) {super(request);log.info("RequestWrapper");}@Overridepublic String getParameter(String name) {// 可以对请求参数进行过滤return super.getParameter(name);}@Overridepublic 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是一个比较稳妥的选择。**/
@Slf4j
public class RequestFilter extends OncePerRequestFilter {@Overridepublic void destroy() {super.destroy();log.info("RequestFilter destroy");}/*OncePerRequestFilter.doFilter方法中通过request.getAttribute判断当前过滤器是否已执行若未执行过,则调用doFilterInternal方法,交由其子类实现*/@Overrideprotected 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;/*** 过滤器配置类**/
@Configuration
public class FilterConfig {@Beanpublic RequestFilter requestFilter(){return new RequestFilter();}@Beanpublic FilterRegistrationBean<RequestFilter> registrationBean() {FilterRegistrationBean<RequestFilter> 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;/*** 登录拦截**/
@Component
public class PageInterceptor implements HandlerInterceptor {@Overridepublic 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{// httpresponse.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以后版本使用**/
@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {/** 拦截器依赖于Spring容器,此处拦截了所有,需要对静态资源进行放行*/@Overridepublic 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*/@Overridepublic void addViewControllers(ViewControllerRegistry registry) {registry.addViewController("/page/ajax").setViewName("ajax");}/** 自定义静态资源映射Spring Boot 默认为我们提供了静态资源映射:classpath:/META-INF/resourcesclasspath:/resourcesclasspath:/staticclasspath:/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容器,此处拦截了所有,需要对静态资源进行放行*/@Overridepublic 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

2.登录拦截ajax重定向

由于ajax是异步的,还在当前页面进行的局部请求。当拦截到登录请求时,即使重定向也无法生效。需采用服务端给地址由前端进行跳转。详细见登录拦截器代码。

// 前端处理
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>AJAX</title><script src="https://code.jquery.com/jquery-3.0.0.min.js"></script>
</head>
<body><button>USER</button>
</body>
</html><script>$.ajaxSetup({complete:function(xhr,status){//拦截器实现超时跳转到登录页面let win = window;// 通过xhr取得响应头let REDIRECT = xhr.getResponseHeader("REDIRECT");//如果响应头中包含 REDIRECT 则说明是拦截器返回的需要重定向的请求if (REDIRECT === "REDIRECT"){while (win !== win.top){win = win.top;}win.location.href = xhr.getResponseHeader("CONTEXTPATH");}}});$("button").click(function(){$.get("/page/user", function(result){$("div").html(result);});});
</script>

四、测试

代码地址:https://gitee.com/dingwen-gitee/filter-interceptor-study.git

1.拦截器测试

1.1启动项目访问首页

http://localhost:8080/page/index

由于没有登录,直接重定向到了登录页

1.2输入用户名密码完成登录,调转到用户页

此时在访问首页

1.2 退出登录

成功退出后,访问为授权的页面也相对会被重定向到登录页

1.3 ajax未授权访问测试

点击访问user ,由于未登录,没有全权访问。在前端进行了页面跳转,转到了登录页。

2.过滤器测试

可以看到过滤器进行了相对应的处理,重写的getParameterValues()也生效了。配合使用HttpServletRequestWrapper & OncePerRequestFilter 实现了对request的修改。


往期推荐

Spring为什么建议构造器注入?


11个小技巧,玩转Spring!


超级详细的Spring Boot 注解总结



本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/544721.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java StringBuilder length()方法与示例

StringBuilder类的length()方法 (StringBuilder Class length() method) length() method is available in java.lang package. length()方法在java.lang包中可用。 length() method is used to return the length of this sequence (i.e. it counts the number of characters …

进程通信:匿名管道和命名管道

一、进程间通信方式 管道( pipe )&#xff1a;管道是一种半双工的通信方式&#xff0c;数据只能单向流动&#xff0c;而且只能在具有亲缘关系的进程间使用。进程的亲缘关系通常是指父子进程关系。有名管道 (named pipe) &#xff1a; 有名管道也是半双工的通信方式&#xff0c…

Jenkins Build Radiators(构建发射源)

为什么80%的码农都做不了架构师&#xff1f;>>> information radiators&#xff08;信息发射源&#xff09;的概念通常被用在敏捷的圈子里。 据敏捷专家Alistair Cockburn所说&#xff1a; 一个信息发射源是一个贴在一个地方的显示器&#xff0c;当人们工作或路过时…

线程池是如何重复利用空闲的线程来执行任务的?

来源&#xff1a;blog.csdn.net/anhenzhufeng/article/details/88870374在Java开发中&#xff0c;经常需要创建线程去执行一些任务&#xff0c;实现起来也非常方便&#xff0c;但如果并发的线程数量很多&#xff0c;并且每个线程都是执行一个时间很短的任务就结束了&#xff0c…

strictmath_Java StrictMath nextAfter()方法与示例

strictmathStrictMath类的nextAfter()方法 (StrictMath Class nextAfter() method) Syntax: 句法&#xff1a; public static double nextAfter(double starts , double directions);public static float nextAfter(float starts , double directions);nextAfter() method is …

C# 将程序添加开机启动的三种方式

前言 最近在研究程序随系统启动&#xff0c;发现在 win7 上因为权限的问题&#xff0c;写注册表的时候总是会出现问题&#xff0c;写不进去导致的不能自动启动&#xff0c;随后决定仔细的看一看这方面的问题。 查资料过程中主要发现有三种方式可以添加到启动&#xff0c;分别…

SpringBoot 中的 3 种条件装配!

一、介绍在实际的项目开发中&#xff0c;我们往往需要根据不同的环境做出不同的配置&#xff0c;例如&#xff1a;在开发环境下&#xff0c;我们会使用内存数据库以便快速启动服务并进行开发调试&#xff0c;在test环境、生产环境&#xff0c;会使用对应环境的数据库。如果我们…

java中intvalue_Java Short类intValue()方法及示例

java中intvalue短类intValue()方法 (Short class intValue() method) intValue() method is available in java.lang package. intValue()方法在java.lang包中可用。 intValue() method is used to return the value denoted by this Short object converted to type int (by c…

C# Winform 窗体美化(目录)

最近在看 C# Winform 的窗体美化&#xff0c;发现一些很有用的美化皮肤库&#xff0c;学习过后也把一些资料整理一下。 一、IrisSkin 换肤库&#xff08;IrisSkin4&#xff09; 二、LayeredSkin 界面库&#xff08;LayeredSkinDemo&#xff09; 三、不规则窗体&#xff08;G…

图说 mysql 事务隔离级别

转载于:https://blog.51cto.com/kingbox/1657916

@Autowired报错的4种解决方案和原因分析!

作者 | 王磊来源 | Java中文社群&#xff08;ID&#xff1a;javacn666&#xff09;转载请联系授权&#xff08;微信ID&#xff1a;GG_Stone&#xff09;上图的报错信息相信大部分程序员都遇到过&#xff0c;奇怪的是虽然代码报错&#xff0c;但丝毫不影响程序的正常执行&#x…

C# Winform 窗体美化(一、IrisSkin 换肤库)

IrisSkin 换肤库 IrisSkin 是为Microsoft Visual Studio dotNET开发的最易用的界面增强dotNET(WinForm)组件包。能完全自动的为应用程序添加支持换肤功能。[百度百科] 1、文件 IrisSkin4.dll - 544 KB各种 .ssk 格式的皮肤文件&#xff08;一般在网上搜的是13个皮肤的压缩包…

java double方法_Java Double类compare()方法与示例

java double方法双类compare()方法 (Double class compare() method) compare() method is available in java.lang package. compare()方法在java.lang包中可用。 compare() method is used to check equality or inequality of the given two double values or in other word…

MySQL开发规范

命名规范> 库名、表名、字段名必须使用小写字母并采用下划线分割> 库名、表名、字段名禁止超过32个字符&#xff0c;须见名知意 * 库名、表名、字段名支持最多64个字符&#xff0c;统一规范、易于辨识以及减少传输量不要超过32> 库名、表名、字段名禁止使用MySQL…

厉害了,Spring中bean的12种定义方法!

前言在庞大的java体系中&#xff0c;spring有着举足轻重的地位&#xff0c;它给每位开发者带来了极大的便利和惊喜。我们都知道spring是创建和管理bean的工厂&#xff0c;它提供了多种定义bean的方式&#xff0c;能够满足我们日常工作中的多种业务场景。那么问题来了&#xff0…

C# Winform 窗体美化(二、LayeredSkin 界面库)

二、LayeredSkin 界面库 概况 这部分资源是 Winform 美化最多的了&#xff0c;效果还不错&#xff0c;使用时只需引入 LayeredSkin.dll - 696 KB 即可。 网上能找到的最后 LayeredSkin 版本应该是 LayeredSkin Demo2014-12-10.zip&#xff0c;之后作者就整合成一个更加强大的…

Java Currency getInstance()方法与示例

货币类getInstance()方法 (Currency Class getInstance() method) Syntax: 句法&#xff1a; public static Currency getInstance(Locale lo);public static Currency getInstance(String curr_code);getInstance() method is available in java.util package. getInstance()…

【WebSocket初探 】

众所周知&#xff0c;socket是编写网络通信应用的基本技术&#xff0c;网络数据交换大多直接或间接通过socket进行。对于直接使用socket的client与服务端&#xff0c;一旦连接被建立则均可主动向对方传送数据&#xff0c;而对于使用更上层的HTTP/HTTPS协议的应用&#xff0c;因…

Spring Cache 实战:兼容所有缓存中间件!

作者 | 悟空聊架构来源 | 悟空聊架构&#xff08;ID&#xff1a;PassJava666&#xff09;本篇给大家介绍一种兼容所有缓存中间件的方案&#xff0c;不论我们是使用 Redis 还是 Ehcache&#xff0c;都不需要关心如何操作 Redis 或者 Ehcache&#xff0c;这套方案统统帮你搞定。这…

C# Winform 窗体美化(三、不规则窗体)

三、不规则窗体 概况 之前学习的 LayeredSkin 看到里面有个异形窗口&#xff0c;比较感兴趣&#xff0c;所以就找一下资料研究一下。不规则窗体学习有一个比较好的例子&#xff0c;叫 GoldFishProject&#xff0c;是一条鱼金鱼在屏幕上游。 不规则窗口示例代码 GoldFishProj…