Spring MVC 拦截器

Posted 2021-09-15 shi_zi_183

拦截器

概述

Spring MVC中的拦截器(Interceptor)类似于Servlet中的过滤器(Filter)，它主要用于拦截用户请求并做响应的处理。

拦截器的定义

要使用Spring MVC中的拦截器，就需要对拦截器进行定义和配置。通常拦截器类可以通过两种方式来定义。一种是通过实现HandlerInterceptor接口，或继承HandlerInterceptor接口的实现类(如HandlerInterceptorAdater)来定义；另一种是通过实现WebRequestInterceptor接口或继承实现WebRequestInterceptor接口的实现类来定义。

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
public class CustomInterceptor implements HandlerInterceptor {
	@Override
	public void afterCompletion(HttpServletRequest request,
			HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
		// TODO Auto-generated method stub

	}
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response,
			Object handler, ModelAndView modelAndView) throws Exception {
		// TODO Auto-generated method stub

	}
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
			Object handler) throws Exception {
		// TODO Auto-generated method stub
		return false;
	}
}

1、preHandler()方法：该方法会在控制器前执行，其返回值表示是否中断后续操作。当其返回值为true时，表示继续向下执行；当其返回值为false时，会中断后续的所有操作(包括调用下一个拦截器和控制器类中的方法执行等)
2、postHandler()方法：该方法会在控制器方法调用之后，且解析视图之前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改
3、afterCompletion()方法：该方法会在整个请求完成，即视图渲染结束之后执行。可以通过此方法实现一些资源清理、记录日志信息等工作。

拦截器的配置

要使自定义的拦截器生效，还需要在Spring MVC配置文件中进行配置

	<mvc:interceptors>
		<!-- 使用bean直接定义在mvc:interceptors下面Interceptor将拦截所有请求 -->
		<bean class="com.ex.interceptor.CustomInterceptor"/>
		<!-- 拦截器1 -->
		<mvc:interceptor>
			<!-- 配置拦截器作用的路径 -->
			<mvc:mapping path="/**"/>
			<!-- 配置不需要拦截器作用的路径 -->
			<mvc:exclude-mapping path=""/>
			<!-- 定义在mvc:interceptor下面的，表示对匹配路径的请求才进行拦截 -->
			<bean class="com.ex.interceptor.Interceptor1"/>
		</mvc:interceptor>
		<mvc:interceptor>
			<mvc:mapping path="/hello"/>
			<bean class="com.ex.interceptor.Interceptor2"/>
		</mvc:interceptor>
	</mvc:interceptors>

<mvc:interceptors>用于配置一组拦截器，其子元素<bean>中定义的是全局拦截器，他会拦截所有的请求；而<mvc:interceptor>元素中定义的是指定路径的拦截器，它会对指定路径下的请求生效。<mvc:interceptor>元素的子元素<mvc:mapping >用于配置拦截器作用的路径，该路径在其属性path中定义。如上述代码中path的属性值/**表示拦截所有路径，/hello表示拦截所有以/hello结尾的路径。如果在请求路径中包含不需要拦截的内容，还可以通过<mvc:exclude-mapping>元素进行配置。
需要注意的是，<mvc:interceptor>中的子元素必须按照上述代码的配置顺序进行编写，即<mvc:mapping >-><mvc:exclude-mapping>-><bean >的顺序，否则文件会报错。

拦截器的执行流程

单个拦截器的执行流程

在运行程序时，拦截器的执行是有一定顺序的，该顺序与配置文件中所定义的拦截器的顺序相关。如果在项目中只定义了一个拦截器，那么该拦截器在程序中的执行流程
程序会先执行拦截器的preHandle()方法，如果该方法的返回值为true，则程序会继续向下执行处理器中的方法，否则将不再向下执行；在业务处理器(即控制器)处理玩请求后，会执行postHandle()方法，然后会通过DispatcherServlet向客户端返回响应；在DispatcherServlet处理完请求后，才会执行afterCompletion()方法。
1）在Eclipse中，创建一个名为chapter15的Web项目，将Spring MVC程序运行所需JAR包复制到项目的lib目录中，并发布到类路径下。
2）在web.xml中，配置Spring MVC的前端过滤器和初始化加载配置文件等信息
3）在src目录下，创建一个com.ex.controller包，并在包中创建控制器类HelloController

package com.ex.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";
	}
}

4）在src目录下，创建一个com.ex.interceptor包，并在包中创建拦截器类CustomIntceptor。该类需要实现HandlerInterceptor接口，并且在实现方法中需要编写输出语句来输出信息。

package com.ex.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
public class CustomIntceptor implements HandlerInterceptor {
	@Override
	public void afterCompletion(HttpServletRequest arg0,
			HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {
		System.out.println("CustomerInterceptor...afterCompletion");
	}
	@Override
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1,
			Object arg2, ModelAndView arg3) throws Exception {
		System.out.println("CustomerInterceptor...postHandle");

	}
	@Override
	public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1,
			Object arg2) throws Exception {
		System.out.println("CustomerInterceptor...preHandle");
		return true;
	}
}

5）在src目录下，创建并配置Spring MVC的配置文件

<?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:mvc="http://www.springframework.org/schema/mvc"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:tx="http://www.springframework.org/schema/tx"
    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
        http://www.springframework.org/schema/tx
        http://www.springframework.org/schema/tx/spring-mvc.xsd">
	<context:component-scan base-package="com.ex.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直接定义在mvc:interceptors下面Interceptor将拦截所有请求 -->
		<bean class="com.ex.interceptor.CustomInterceptor"/>
	</mvc:interceptors>
</beans>

6）在WEB-INF目录下，创建一个jsp文件夹，并在该文件夹中创建一个页面文件success.jsp，然后在页面文件的<body>元素内编写任意显示信息
7）将项目发布到Tomcat服务器并启动，在浏览器中访问

多个拦截器的执行流程

当有多个浏览器同时工作时，它们的preHandle()方法会按照配置文件中拦截器的配置顺序执行，而它们的postHandle()方法和afterCompletion()方法则会按照配置顺序的反序执行。
1）在com.ex.interceptor包中，创建两个拦截器类Interceptor1和Interceptor2
2）在配置文件spring-config.xml中的mvc:interceptors元素内配置上面所定义的两个拦截器

	<mvc:interceptors>
		<!-- 使用bean直接定义在mvc:interceptors下面Interceptor将拦截所有请求 -->
		<mvc:interceptor>
			<mvc:mapping path="/**"/>
			<bean class="com.ex.interceptor.Interceptor1"/>
		</mvc:interceptor>
		<mvc:interceptor>
			<mvc:mapping path="/hello"/>
			<bean class="com.ex.interceptor.Interceptor2"/>
		</mvc:interceptor>
	</mvc:interceptors>

3）发布并重启服务器，浏览器查看