SpringMVC拦截器-青岛软件培训-Java培训-Python培训学校-万码学堂

2019-11-03 16:42

SpringMVC拦截器

王姐姐

JavaEE

(1115)

(0)

(1)

SpringMVC的处理器拦截器,类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

（1）过滤器：

依赖于servlet容器。在实现上基于函数回调，可以对几乎所有请求进行过滤，但是缺点是一个过滤器实例只能在容器初始化时调用一次。使用过滤器的目的是用来做一些过滤操作，比如：在过滤器中修改字符编码；在过滤器中修改HttpServletRequest的一些参数，包括：过滤低俗文字、危险字符等。

（2）拦截器：

依赖于web框架，在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。

1、常见应用场景

1）日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。

2）权限检查：如登录检测，进入处理器检测是否登录，如果没有直接返回到登录页面；

3）性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

4）通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个Controller中的处理方法都需要的，我们就可以使用拦截器实现。

5）OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。

…………本质也是AOP（面向切面编程），也就是说符合横切关注点的所有功能都可以放入拦截器实现。

2、SpringMVC提供的拦截器接口：HandlerInterceptor

public interface HandlerInterceptor {
	boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
	    throws Exception;
 
	void postHandle(
			HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
			throws Exception;
 
	void afterCompletion(
			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception;
}

拦截器一个有3个回调方法，而一般的过滤器Filter才两个:

preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；

postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器才会执行afterCompletion。

3、拦截器适配器：HandlerInterceptorAdapter

有时我们可能只需要实现三个回调方法中的某一个，如果实现HandlerInterceptor接口的话，三个方法必须实现，此时spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。

public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
		throws Exception {
		return true;
	}
 
	public void postHandle(
			HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
			throws Exception {
	}
 
	public void afterCompletion(
			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
	}
 
	public void afterConcurrentHandlingStarted(
			HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
	}
}

二、自定义拦截器实例

1) 自定义两个拦截器（继承拦截器适配器：HandlerInterceptorAdapter）：HandlerInterceptor1 和 HandlerInterceptor2

public class HandlerInterceptor1 extends HandlerInterceptorAdapter{
 
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
		System.out.println("--1--HandlerInterceptor1.preHandle");
		return true;
	}
 
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		System.out.println("--1--HandlerInterceptor1.postHandle");
	}
 
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
		System.out.println("--1--HandlerInterceptor1.afterCompletion");
	}
}

2）在 springmvc.xml 配置文件中配置拦截器：

（1）拦截所有Controller类里的所有处理方法

	<!-- 配置拦截器：-->
	<mvc:interceptors>
		<!-- 会拦截所有Controller类里的所有处理方法 -->
		<bean class="cn.jq.sshweb.web.HandlerInterceptor1"></bean>
		<bean class="cn.jq.sshweb.web.HandlerInterceptor2"></bean>
	</mvc:interceptors>

访问：http://127.0.0.1:8080/sshweb/

如果 HandlerInterceptor2 中 preHandle 方法返回 false , 在访问：http://127.0.0.1:8080/sshweb/ ，视图没有渲染

（2）只拦截某个请求路径的处理方法

	<!-- 配置拦截器：-->
	<mvc:interceptors>
		<!-- 会拦截所有Controller类里的所有处理方法 -->
		<bean class="cn.jq.sshweb.web.HandlerInterceptor1"></bean>
		<mvc:interceptor>
			<!-- 只拦截该路径 -->
			<mvc:mapping path="/users"/>
			<bean class="cn.jq.sshweb.web.HandlerInterceptor2"></bean>
		</mvc:interceptor>
	</mvc:interceptors>

访问：http://127.0.0.1:8080/sshweb/

访问：http://127.0.0.1:8080/sshweb/users

（3）拦截器深入配置：注意 /** (任意分层路径下) ，/* (该任意单路径下) 和配置順序（先所有后排除）

	<!-- 配置拦截器：-->
	<mvc:interceptors>
		<!-- 会拦截所有Controller类里的所有处理方法 -->
		<bean class="cn.jq.sshweb.web.HandlerInterceptor1"></bean>
		<mvc:interceptor>
			<!-- 只拦截该路径 -->
			<mvc:mapping path="/users"/>
			<bean class="cn.jq.sshweb.web.HandlerInterceptor2"></bean>
		</mvc:interceptor>
		<mvc:interceptor>
			<!-- 拦截所有请求，排除拦截 /toAdd 请求 -->
			<mvc:mapping path="/**"/>
			<mvc:exclude-mapping path="/toAdd"/>
			<bean class="cn.jq.sshweb.web.HandlerInterceptor3"></bean>
		</mvc:interceptor>
	</mvc:interceptors>

访问：http://127.0.0.1:8080/sshweb/