SpringMVC 拦截器Interceptor
SpringMVC中的拦截器用于拦截控制器方法的执行;
SpringMVC中的拦截器需要实现HandlerInterceptor接口;
SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置;
自定义Interceptor拦截器
- 自定义一个.java文件,实现HandlerInterceptor接口。
// 包路径,修改为自己的包路径
package com.sbw.mvc.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* preHandle:控制器方法执行之前执行preHandle(),其boolean类型的返回值表示是否拦截或放行,返回true为放行,即调用控制器方法;返回false表示拦截,即不调用控制器方法
* postHandle:控制器方法执行之后执行postHandle()
* afterComplation:处理完视图和模型数据,渲染视图完毕之后执行afterComplation()
* @author
* @date 2022/1/12 16:31
*/
// 将自定义的class 交给Spring容器管理
@Component
public class FirstInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("FirstInterceptor --> 在控制器方法执行之前执行preHandle");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("FirstInterceptor --> 在控制器执行完之后执行postHandle");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("FirstInterceptor --> 在处理完视图和模型数据,渲染视图完成后执行afterCompletion");
}
}
- 修改SpringMVC的配置文件
<!--配置视图控制器-->
<mvc:view-controller path="/" view-name="index"/>
<!--方式一-->
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<mvc:exclude-mapping path="/"/>
<ref bean="firstInterceptor"/>
</mvc:interceptor>
<!--
以上配置方式可以通过ref或bean标签设置拦截器,通过mvc:mapping设置需要拦截的请求,通过
mvc:exclude-mapping设置需要排除的请求,即不需要拦截的请求
-->
</mvc:interceptors>
<!--方式二-->
<mvc:interceptors>
<ref bean="firstInterceptor"></ref>
<!-- 以上配置方式是对DispatcherServlet所处理的所有的请求进行拦截 -->
</mvc:interceptors>
- html页面代码: index.html / success.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>首页</title>
</head>
<body>
<h1>首页</h1>
<a th:href="@{/testSuccess}">点击跳转</a>
</body>
</html>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>目标页面</title>
</head>
<body>
success
</body>
</html>
- 自定义Controller
package com.sbw.mvc.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* @author
* @date 2022/1/12 16:41
*/
@Controller
public class HelloController {
@RequestMapping("/testSuccess")
public String testSuccess(){
System.out.println("---------------控制器方法执行--------------");
return "success";
}
}
- 测试效果
1 使用方式一的配置,会对所有的请求都进行拦截
2 使用方式二的配置,对参数mapping设置的请求路径进行拦截(/** 表示所有请求),对参数exclude-mapping设置的请求路径不进行拦截(/ 表示index 通过视图控制器配置的)
多拦截器的执行顺序
a>若每个拦截器的preHandle()都返回true 此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关:
preHandle()会按照配置的顺序执行,而postHandle()和afterComplation()会按照配置的反序执行
b>若某个拦截器的preHandle()返回了false
preHandle()返回false和它之前的拦截器的preHandle()都会执行,postHandle()都不执行,返回false的拦截器之前的拦截器的afterComplation()会执行
-
查看DispatcherServlet的doDispatch方法
-
查看applyPreHandle方法
-
查看applyPostHandle方法(当所有拦截器的preHandle方法都不返回false时,会执行该方法)
-
查看triggerAfterCompletion方法(无论拦截器是否拦截该控制器方法,都会执行该方法)