目录
1.什么是拦截器
(1)springmvc中的拦截器(Interceptor)需要实现HandlerInterceptor接口
(2)拦截器类似于servlet中的过滤器(Filter)。
拦截器是拦截用户请求,做请求判断处理的。
过滤器是用来过滤请求参数、设置字符集编码等工作的。
(3)拦截器是全局的,可以对多个Controller做拦截
一个项目中可以有0个或多个拦截器,它们在一起拦截用户的请求
拦截器主要用于拦截用户请求并做出相应的处理。例如通过拦截器可以进行权限验证、 记录请求信息的日志、判断用户是否登录等。
2.拦截器的使用步骤
(1)定义类实现HandlerInterceptor接口
(2)在springmvc配置文件中声明拦截器,让框架知道拦截器的存在
3.拦截器的执行
(1)在请求处理之前,也就是controller类中的方法先被拦截
(2)在控制器方法执行之后也会执行拦截器
(3)在请求处理完成后也会执行拦截器
4.拦截器的使用
(1)创建maven web项目
(2)加入依赖
(3)创建Controller类
(4)创建一个普通类,作为拦截器使用
实现HandlerIerInterceptor接口
实现接口中的三个方法
(5)创建show.jsp页面
(6)创建springmvc的配置文件
创建组件扫描器
声明拦截器,并指定拦截的请求uri地址
(1)单个拦截器
1. 控制器类
@Controller
public class OtherController {
@RequestMapping(value = "/other.do")
public ModelAndView doOther(HttpServletRequest request) {
System.out.println("执行myController中的doOther方法");
ModelAndView mv = new ModelAndView();
mv.addObject("name", request.getParameter("name"));
mv.addObject("age" , request.getParameter("age")) ;
mv.setViewName("show1");
return mv;
}
}
2.拦截器类
HandlerInterceptor接口中的三个方法
/**
* 拦截器类,拦截用户请求
*/
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyInterceptor implements HandlerInterceptor {
/**
* perHandle叫做预处理方法
* 参数:
* Object handler:被拦截的控制器对象
* 返回值boolean
*
* 特点:
* 1.方法在控制器方法之前先执行
* 用户的请求首先到达此方法
*
* 2.在这个方法中可以获取请求的信息,验证请求是否符合要求
* 可以验证用户是否登录,验证用户是否有权限访问某个连接地址
* 如果验证失败,可以截断请求,请求将不会被处理
* 软工验证成功,可以放行请求,此时控制器方法才能够被执行
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("拦截器MyInterceptor的preHandler()方法");
return true;
}
/**
* postHandler:后处理方法
* 参数:
* Object handler:被拦截的处理器对象
* ModelAndView modelAndView:处理器方法的返回值
*
* 特点:
* 1.在处理器方法之后执行的
* 2.能够获取到处理方法的返回值ModelAndView,可以修改ModelAndView中的数据视图,可以影响到最后的执行结果
* 3.主要对原来的执行结果做二次修正
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("拦截器MyInterceptor的postHandle()方法");
}
/**
* afterCompletion:最后执行的方法
* 参数:
* Object handler:被拦截的处理器对象
* Exception ex:程序中发生的异常
* 特点:
* 1.在请求处理完成后执行,框架中规定当你的试图处理完成后,对试图执行forward,就认为请求处理完成。
* 2.一般做资源的回收工作,程序请求过程中创建了一些对象在这里可以进行删除,将占用的内存空间回收
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("拦截器MyInterceptor的afterCompletion()方法");
}
}
3.web.xml配置文件
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 自定义springMVC读取的配置文件的位置 -->
<init-param>
<!-- SpringMVC的配置文件的位置属性 -->
<param-name>contextConfigLocation</param-name>
<!-- 指定自定义文件的位置 -->
<param-value>classpath:springmvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>
4.springmvc.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 创建组件扫描器 -->
<context:component-scan base-package="cn.edu.pdsu"></context:component-scan>
<!-- 声明 springmvc框架中的视图解析器,用来设置视图文件的路径 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 前缀:视图文件的路径 -->
<property name="prefix" value="/WEB-INF/view/"></property>
<!-- 后缀:视图文件的扩展名 -->
<property name="suffix" value=".jsp"></property>
</bean>
<!-- 声明拦截器 -->
<!-- 引入mvc名称空间 -->
<mvc:interceptors>
<!-- 声明的第一个拦截器 -->
<mvc:interceptor>
<!-- 指定拦截的请求uri地址,path就是uri地址,可以使用**,
** : 表示任意的字符,文件或多级目录和目录中的文件 -->
<mvc:mapping path="/**"/> <!-- 拦截所以请求 -->
<!-- 声明拦截器对象 -->
<bean class="cn.edu.pdsu.MyInterceptor" />
</mvc:interceptor>
</mvc:interceptors>
</beans>
5.index.jsp页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<p>一个拦截器</p>
<form action="other.do" method="post">
姓名:<input type="text" name="name"><br>
年龄:<input type="text" name="age"><br>
<input type="submit" value="提交">
</form>
</body>
</html>
6.结果页面show.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<p>拦截器方法</p>
<p>name数据:${name}</p>
<p>age数据:${age}</p>
</body>
</html>
index.jsp页面
填入数据并提交
此时preHandler()方法中return的是true,请求通过了拦截器的验证,可以执行处理器方法
从执行输出的结果中也可以看出,拦截器中的preHandler()方法先于控制器中的方法执行,postHandler()方法后于控制器方法执行,afterCompletion()方法最后执行。
当我们将preHandler的返回值改为false时,再次执行代码
return false;
填入数据并提交却发现页面中什么都没出现
看向编译器的控制台,只有preHandler()方法执行了
我们可以得知,当返回值为preHandler()的返回值为false时,请求没有通过拦截器,到达拦截器就被截止了,请求没有被处理。
拦截器:看作是多个Controller中公用的功能,集中到拦截器统一处理,使用的是aop的思想
postHandler() : 当preHandler()的返回值是true时,才可以进行执行,对原来的执行的结果做二次修正。
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("拦截器MyInterceptor的postHandle()方法");
if(modelAndView != null) {
modelAndView.addObject("date",new Date()) ;
modelAndView.setViewName("other");
}
}
other.jsp页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<p>拦截器方法</p>
<p>name:${name}</p>
<p>age数据:${age}</p>
<p>拦截器中增加的数据</p>
<p>date数据:${date}</p>
</body>
</html>
提交数据后页面显示的结果
(2)多个拦截器
1.拦截器1
/**
* 拦截器类,拦截用户请求
*/
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("拦截器MyInterceptor的preHandler()方法 1");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("拦截器MyInterceptor的postHandle()方法 1");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("拦截器MyInterceptor的afterCompletion()方法 1");
}
}
2.拦截器2
/**
* 拦截器类,拦截用户请求
*/
public class MyInterceptor1 implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("拦截器MyInterceptor的preHandler()方法 2");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("拦截器MyInterceptor的postHandle()方法 2");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("拦截器MyInterceptor的afterCompletion()方法 2");
}
}
3.springmvc.xml配置文件
<!-- 声明拦截器 -->
<!-- 引入mvc名称空间 -->
<mvc:interceptors>
<!-- 声明的第一个拦截器 -->
<mvc:interceptor>
<!-- 指定拦截的请求uri地址,path就是uri地址,可以使用**,
** : 表示任意的字符,文件或多级目录和目录中的文件 -->
<mvc:mapping path="/**"/> <!-- 拦截所以请求 -->
<!-- 声明拦截器对象 -->
<bean class="cn.edu.pdsu.MyInterceptor" />
</mvc:interceptor>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean class="cn.edu.pdsu.MyInterceptor1" />
</mvc:interceptor>
</mvc:interceptors>
在框架中保存多个拦截器时,按照声明的先后顺序放到ArrayList集合中
4.执行结果
执行时先执行拦截器1的preHandler,再执行拦截器2的preHandler,这相当于一个进的过程
执行过preHandler方法后执行了控制器类中的方法,然后是2、1、2、1方法进行执行,这相当于是一个出的过程。
5.执行流程图
当拦截器1的preHandler()方法返回值为true,拦截器2的preHandler()方法的返回值为false时,执行代码得到结果
结果页面空白,什么数据都没有传送,控制台输出三条数据
当preHandler()方法返回是true 的时候,afterCompletion()方法一定会执行
当拦截器1的preHandler()方法返回值为false,拦截器2的preHandler()方法的返回值为true\false没有区别,执行代码得到结果
经过测试我们可以得知,无论有几个拦截器,只要有一个preHandler()方法返回false,控制器方法都不会执行。