SYSTEM
拦截器
src/content/notes/system/拦截器.md 拦截器
基本介绍
拦截器(Interceptor)是一种动态拦截方法调用的机制
作用:
- 在指定的方法调用前后执行预先设定后的的代码
- 阻止原始方法的执行
核心原理:AOP 思想
拦截器链:多个拦截器按照一定的顺序,对原始被调用功能进行增强
拦截器和过滤器对比:
-
归属不同: Filter 属于 Servlet 技术, Interceptor 属于 SpringMVC 技术
-
拦截内容不同: Filter 对所有访问进行增强, Interceptor 仅针对 SpringMVC 的访问进行增强
处理方法
前置处理
原始方法之前运行:
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler) throws Exception {
System.out.println("preHandle");
return true;
}
- 参数:
- request:请求对象
- response:响应对象
- handler:被调用的处理器对象,本质上是一个方法对象,对反射中的Method对象进行了再包装
- handler:public String controller.InterceptorController.handleRun
- handler.getClass():org.springframework.web.method.HandlerMethod
- 返回值:
- 返回值为 false,被拦截的处理器将不执行
后置处理
原始方法运行后运行,如果原始方法被拦截,则不执行:
public void postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("postHandle");
}
参数:
- modelAndView:如果处理器执行完成具有返回结果,可以读取到对应数据与页面信息,并进行调整
异常处理
拦截器最后执行的方法,无论原始方法是否执行:
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) throws Exception {
System.out.println("afterCompletion");
}
参数:
- ex:如果处理器执行过程中出现异常对象,可以针对异常情况进行单独处理
拦截配置
拦截路径:
/**:表示拦截所有映射/*:表示拦截所有/开头的映射/user/*:表示拦截所有 /user/ 开头的映射/user/add*:表示拦截所有 /user/ 开头,且具体映射名称以 add 开头的映射/user/*All:表示拦截所有 /user/ 开头,且具体映射名称以 All 结尾的映射
<mvc:interceptors>
<!--开启具体的拦截器的使用,可以配置多个-->
<mvc:interceptor>
<!--设置拦截器的拦截路径,支持*通配-->
<mvc:mapping path="/handleRun*"/>
<!--设置拦截排除的路径,配置/**或/*,达到快速配置的目的-->
<mvc:exclude-mapping path="/b*"/>
<!--指定具体的拦截器类-->
<bean class="MyInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
拦截器链
责任链模式:责任链模式是一种行为模式
特点:沿着一条预先设定的任务链顺序执行,每个节点具有独立的工作任务 优势:
- 独立性:只关注当前节点的任务,对其他任务直接放行到下一节点
- 隔离性:具备链式传递特征,无需知晓整体链路结构,只需等待请求到达后进行处理即可
- 灵活性:可以任意修改链路结构动态新增或删减整体链路责任
- 解耦:将动态任务与原始任务解耦
缺点:
- 链路过长时,处理效率低下
- 可能存在节点上的循环引用现象,造成死循环,导致系统崩溃
源码解析
DispatcherServlet#doDispatch 方法中:
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
try {
// 获取映射器以及映射器的所有拦截器(运行原理部分详解了源码)
mappedHandler = getHandler(processedRequest);
// 前置处理,返回 false 代表条件成立
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
//请求从这里直接结束
return;
}
//所有拦截器都返回 true,执行目标方法
mv = ha.handle(processedRequest, response, mappedHandler.getHandler())
// 倒序执行所有拦截器的后置处理方法
mappedHandler.applyPostHandle(processedRequest, response, mv);
} catch (Exception ex) {
//异常处理机制
triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
}
}
HandlerExecutionChain#applyPreHandle:前置处理
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
//遍历所有的拦截器
for (int i = 0; i < this.interceptorList.size(); i++) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
//执行前置处理,如果拦截器返回 false,则条件成立,不在执行其他的拦截器,直接返回 false,请求直接结束
if (!interceptor.preHandle(request, response, this.handler)) {
triggerAfterCompletion(request, response, null);
return false;
}
this.interceptorIndex = i;
}
return true;
}
HandlerExecutionChain#applyPostHandle:后置处理
void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv)
throws Exception {
//倒序遍历
for (int i = this.interceptorList.size() - 1; i >= 0; i--) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
interceptor.postHandle(request, response, this.handler, mv);
}
}
DispatcherServlet#triggerAfterCompletion 底层调用 HandlerExecutionChain#triggerAfterCompletion:
-
前面的步骤有任何异常都会直接倒序触发 afterCompletion
-
页面成功渲染有异常,也会倒序触发 afterCompletion
void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
//倒序遍历
for (int i = this.interceptorIndex; i >= 0; i--) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
try {
//执行异常处理的方法
interceptor.afterCompletion(request, response, this.handler, ex);
}
catch (Throwable ex2) {
logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
}
}
}
拦截器的执行流程:
参考文章:https://www.yuque.com/atguigu/springboot/vgzmgh#wtPLU
自定义
-
Contoller层
@Controller public class InterceptorController { @RequestMapping("/handleRun") public String handleRun() { System.out.println("业务处理器运行------------main"); return "page.jsp"; } } -
自定义拦截器需要实现 HandleInterceptor 接口
//自定义拦截器需要实现HandleInterceptor接口 public class MyInterceptor implements HandlerInterceptor { //处理器运行之前执行 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("前置运行----a1"); //返回值为false将拦截原始处理器的运行 //如果配置多拦截器,返回值为false将终止当前拦截器后面配置的拦截器的运行 return true; } //处理器运行之后执行 @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("后置运行----b1"); } //所有拦截器的后置执行全部结束后,执行该操作 @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("完成运行----c1"); } }说明:三个方法的运行顺序为 preHandle → postHandle → afterCompletion,如果 preHandle 返回值为 false,三个方法仅运行preHandle
-
web.xml:
CharacterEncodingFilter + DispatcherServlet -
配置拦截器:spring-mvc.xml
<mvc:annotation-driven/> <context:component-scan base-package="interceptor,controller"/> <mvc:interceptors> <mvc:interceptor> <mvc:mapping path="/handleRun"/> <bean class="interceptor.MyInterceptor"/> </mvc:interceptor> </mvc:interceptors>注意:配置顺序为先配置执行位置,后配置执行类