Spring Boot 2.X(九):Spring MVC - 拦截器(Interceptor)
拦截器
1.简介
Spring MVC 中的拦截器(Interceptor)类似与 Servlet 开发中的过滤器 Filter,它主要用于拦截用户请求并作相应的处理,它也是 AOP 编程思想的体现,底层通过动态代理模式完成。
2.定义实现类
拦截器有两种实现方式:
1.实现 HandlerInterceptor 接口
2.继承 HandlerInterceptorAdapter 抽象类(看源码最底层也是通过 HandlerInterceptor 接口 实现)
3.HandlerInterceptor方法介绍
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
//进行逻辑判断,如果ok就返回true,不行就返回false,返回false就不会处理请求
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
}
preHandle:在业务处理器处理请求之前被调用。预处理,可以进行编码、安全控制、权限校验等处理;
postHandle:在业务处理器处理请求执行完成后,生成视图之前执行。
afterCompletion:在 DispatcherServlet 完全处理完请求后被调用,可用于清理资源等。
4.应用场景
1.日志记录:记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等;
2.登录鉴权:如登录检测,进入处理器检测检测是否登录;
3.性能监控:检测方法的执行时间;
4.其他通用行为。
5.与 Filter 过滤器的区别
1.拦截器是基于java的反射机制的,而过滤器是基于函数回调。
2.拦截器不依赖于servlet容器,而过滤器依赖于servlet容器。
3.拦截器只能对Controller请求起作用,而过滤器则可以对几乎所有的请求起作用。
4.拦截器可以访问action上下文、值栈里的对象,而过滤器不能访问。
5.在Controller的生命周期中,拦截器可以多次被调用,而过滤器只能在容器初始化时被调用一次。
6.拦截器可以获取IOC容器中的各个bean,而过滤器不行。这点很重要,在拦截器里注入一个service,可以调用业务逻辑。
具体实现
单个拦截器
1.新建拦截器
public class Test1Interceptor implements HandlerInterceptor{
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
System.out.println("执行preHandle方法-->01");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("执行postHandle方法-->02");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("执行afterCompletion方法-->03");
}
}
2.配置拦截器
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
/*
* 拦截器配置
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 注册自定义拦截器,添加拦截路径和排除拦截路径
registry.addInterceptor(new Test1Interceptor()) // 添加拦截器
.addPathPatterns("/**") // 添加拦截路径
.excludePathPatterns(// 添加排除拦截路径
"/hello").order(0);//执行顺序
super.addInterceptors(registry);
}
}
3.测试拦截器
@RestController
public class TestController {
@RequestMapping("/hello")
public String getHello() {
System.out.println("这里是Hello");
return "hello world";
}
@RequestMapping("/test1")
public String getTest1() {
System.out.println("这里是Test1");
return "test1 content";
}
@RequestMapping("/test2")
public String getTest2() {
System.out.println("这里是Test2");
return "test2 content";
}
}
4.单个拦截器的执行流程
通过浏览器测试:
http://127.0.0.1:8080/hello
结果:
这里是Hello
http://127.0.0.1:8080/test1 、http://127.0.0.1:8080/test2
结果:
执行preHandle方法-->01
这里是Test1
执行postHandle方法-->02
执行afterCompletion方法-->03
多个拦截器
1.新建两个拦截器
Test1Interceptor
public class Test1Interceptor implements HandlerInterceptor{
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
System.out.println("执行Test1Interceptor preHandle方法-->01");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("执行Test1Interceptor postHandle方法-->02");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("执行Test1Interceptor afterCompletion方法-->03");
}
}
Test2Interceptor
public class Test2Interceptor extends HandlerInterceptorAdapter{
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
System.out.println("执行Test2Interceptor preHandle方法-->01");
return true;
}
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("执行Test2Interceptor postHandle方法-->02");
}
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("执行Test2Interceptor afterCompletion方法-->03");
}
}
2.配置拦截器
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
/*
* 拦截器配置
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 注册自定义拦截器,添加拦截路径和排除拦截路径
registry.addInterceptor(new Test1Interceptor()) // 添加拦截器1
.addPathPatterns("/**") // 添加拦截路径
.excludePathPatterns(// 添加排除拦截路径
"/hello")
.order(0);
registry.addInterceptor(new Test2Interceptor()) // 添加拦截器2
.addPathPatterns("/**") // 添加拦截路径
.excludePathPatterns(// 添加排除拦截路径
"/test1")
.order(1);
super.addInterceptors(registry);
}
}
3.测试拦截器
@RestController
public class TestController {
@RequestMapping("/hello")
public String getHello() {
System.out.println("这里是Hello");
return "hello world";
}
@RequestMapping("/test1")
public String getTest1() {
System.out.println("这里是Test1");
return "test1 content";
}
@RequestMapping("/test2")
public String getTest2() {
System.out.println("这里是Test2");
return "test2 content";
}
}
4.多个拦截器的执行流程
通过浏览器测试:
http://127.0.0.1:8080/test2
结果:
执行Test1Interceptor preHandle方法-->01
执行Test2Interceptor preHandle方法-->01
这里是Test2
执行Test2Interceptor postHandle方法-->02
执行Test1Interceptor postHandle方法-->02
执行Test2Interceptor afterCompletion方法-->03
执行Test1Interceptor afterCompletion方法-->03
通过示例,简单的说多个拦截器执行流程就是先进后出。
简单的 token 判断示例
1.拦截器
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
System.out.println("执行Test1Interceptor preHandle方法-->01");
String token = request.getParameter("token");
if (StringUtils.isEmpty(token)) {
response.setContentType("text/html");
response.setCharacterEncoding("UTF-8");
response.getWriter().println("token不存在");
return false;
}
return true;
}
2.测试及结果
未传token:
执行Test1Interceptor preHandle方法-->01
传token:
执行Test1Interceptor preHandle方法-->01
页码:1
页码大小:10
执行Test1Interceptor postHandle方法-->02
执行Test1Interceptor afterCompletion方法-->03
示例代码
非特殊说明,本文版权归 朝雾轻寒 所有,转载请注明出处.
原文标题:Spring Boot 2.X(九):Spring MVC - 拦截器(Interceptor)
原文地址:https://www.zwqh.top/article/info/18
如果文章对您有帮助,请扫码关注下我的公众号,文章持续更新中...
原文地址:https://www.cnblogs.com/zwqh/p/11719254.html
- [WCF的Binding模型]之三:信道监听器(Channel Listener)
- zookeeper监控告警
- 扩展ToolBarManager、ListView和Grid控件以实现气球式的ToolTip
- Linux同步机制 - 基本概念(死锁,活锁,饿死,优先级反转,护航现象)
- Linux同步机制 - 多线程开发总结
- 谷歌发布升级版语音合成系统,直接从字符合成语音
- 无锁编程 - 大纲
- 无锁编程(一) - Double-checked Locking
- 无锁编程(二) - 原子操作
- 我所理解的Remoting(3):创建CAO Service Factory使接口和实现相互分离
- 无锁编程(三) - 忙等待
- Enterprise Library深入解析与灵活应用(9):个人觉得比较严重的关于CachingCallHandler的Bug
- 无锁编程(四) - CAS与ABA问题
- Linux Kernel CMPXCHG函数分析
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释
- 数据结构算法操作试题(C++/Python)——合并两个有序链表
- Day11 :二进制中1的个数
- 数据结构算法操作试题(C++/Python)——括号生成
- 数据结构算法操作试题(C++/Python)——合并K个排序链表
- 数据结构算法操作试题(C++/Python)——删除排序数组中的重复项
- 数据结构算法操作试题(C++/Python)——k个一组翻转链表
- 数据结构算法操作试题(C++/Python)——移除元素
- 数据结构算法操作试题(C++/Python)——实现strStr()
- 数据结构算法操作试题(C++/Python)——两数相除
- JavaScript 测试系列实战(三):使用 Mock 模拟模块并处理组件交互
- 数据结构算法操作试题(C++/Python)——串联所有单词的子串
- TypeScript 实战算法系列(九):实现向量与矩阵
- TypeScript 实战算法系列(十):实现动态规划
- 数据结构算法操作试题(C++/Python)——下一个排列
- 最新Spring整合MyBatis详解教程