前言
在实际项目中,拦截器的使用是非常普遍的,例如在购物网站中通过拦截器可以拦截未登录的用户,禁止其购买
商品,或者使用它来验证已登录用户是否有相应的操作权限等。Spring MVC中也提供了拦截器功能,通过配置即可对
请求进行拦截处理。
Spring MVC中的拦截器( Interceptor)类似于Servlet中的过滤器(Filter),它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。
1.拦截器的定义
要使用Spring MVC中的拦截器,就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。
以实现HandlerInterceptor接口方式为例,自定义拦截器类的代码如下:
public class CustomInterceptor implements HandlerInterceptor{
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler)throws Exception {
//对拦截的请求进行放行处理
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:该方法会在控制器方法前执行,其返回值表示是否中断后续操作。当其返回值为true时,表示继续向下执行;当其返回值为false时,会中断后续的所有操作。
postHandle:该方法会在控制器方法调用之后,且解析视图之前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改。
afterCompletion:该方法会在整个请求完成,即视图渲染结束之后执行。可以通过此方法实现一些资源清理、记录日志信息等工作。
2.拦截器的配置
要使自定义的拦截器类生效,还需要在SpringMVC的配置文件中进行配置。|
<mvc:interceptors>
<!--使用bean直接定义在<mvc:interceptors>下面的拦截器将拦截所有请求-->
<!-- <bean class="com.itheima.interceptor.CustomInterceptor"/> -->
<mvc:interceptor>
<!-- 配置拦截器作用的路径 -->
<mvc:mapping path="/**" />
<!-- 定义在<mvc:interceptor>下面的表示匹配指定路径的请求才进行拦截的 -->
<bean class="com.itheima.interceptor.Interceptor1" />
</mvc:interceptor>
<mvc:interceptor>
<mvc:mapping path="/hello" /> ///hello表示拦截所有以/hello”结尾的路径
<bean class="com.itheima.interceptor.Interceptor2" />
</mvc:interceptor>
3.拦截器的执行流程
如果在项目中定义了一个拦截器,程序首先会执行拦截器类中的preHandle 方法,如果该方法的返回值为true,程序会继续向下执行处理器中的方法,否则将不再向下执行;在业务处理器即控制器Contrller 类处理完请求后,会执行postHandle 方法,然后会通过DispatcherServlet 向客户端返回响应。DispatcherServlet 处理完请求后,才会执afterCompletion方法。
接下来用案例代码来解释下运行流程:
将SpringMVC应用所需要的jar包复制到lib目录
1、在web xml中配置前端控制器
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-config.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
2、在com.zsj interceptor包中创建一个 拦截器类CustomerInterceptor
package com.zsj.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* 实现了HandlerInterceptor接口的自定义拦截器类
*/
public class CustomInterceptor implements HandlerInterceptor{
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler)throws Exception {
System.out.println("CustomInterceptor...preHandle,正在拦截用户请求!!!");
//对拦截的请求进行放行处理
return true;
}
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("在业务处理器即控制器Controller类处理完请求,执行CustomInterceptor的postHandle方法");
}
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler,
Exception ex) throws Exception {
System.out.println("DispatcherServlet处理完请求后,执行CustomInterceptor的afterCompletion方法");
}
}
3、在src目录下的配置文件springmvc config xml中配置组件扫描器、视图解析器、自定义拦截器CustomInterceptor
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.3.xsd">
<context:component-scan base-package="com.zsj.controller" />
<bean id="viewResolver" class=
"org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/" />
<property name="suffix" value=".jsp" />
</bean>
<mvc:interceptors>
<bean class="com.zsj.interceptor.CustomInterceptor"/>
</mvc:interceptors>
</beans>
4、在com.zsj .controller包中创建一- 个控制器类HelloController
package com.zsj.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HelloController {
/**
* 页面跳转
*/
@RequestMapping("/hello")
public String Hello() {
System.out.println("Hello!请求处理完后");
return "success";
}
}
5、在WEB -INF/jsp目下创建视图页面success jsp
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
恭喜用户朱世纪登陆成功!!!
</body>
</html>
6、部署和运行项目,将项目发布到Tomcat 服务器并启动,在浏览器中访问地址http://localhost:8080/SpringMVCInterceptor/hello
通过上面的这个输出结果图,大家可以看出在运行程序时,拦截器的执行是有一.定顺序的,该顺序与配置文件中所定义的拦截器的顺序相关。
所以呢?大家会不会有这么个疑问?单个拦截器如果是这样的,那么多个拦截器的顺序是否跟它一样呢?
这个谜底见下一篇博客!!!