【Spring MVC】自定义拦截器 Interceptor

一.自定义拦截器

1.拦截器，跟过滤器比较像的技术.
1.1 拦截器和过滤器的区别：
拦截器只能拦Controller，Filter可以拦任何请求
因为Spring的入口是dispatcherServlet，只有能通过Filter，才可以走拦截器
拦截器是SpringMVC的技术，只有当控制器生效时，拦截器才能生效
如果直接走jsp，不走DispatcherServlet，就走不了拦截器

2.发送请求时被拦截器拦截,在控制器的前后添加额外功能.
2.1 跟 AOP 区分开.AOP 在特定方法前后扩充(对ServiceImpl)
2.2 拦截器,请求的拦截.针对点是控制器方法.(对Controller)

3.SpringMVC 拦截器和Filter 的区别
3.1 拦截器只能拦截器Controller
3.2 Filter 可以拦截任何请求.

4.实现自定义拦截器的步骤:
4.1 新建类实现HandlerInterceptor

package cn.hanquan.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 DemoInterceptor implements HandlerInterceptor {
	// 在进入控制器之前执行
	// 如果返回值为false,阻止进入控制器
	// 控制代码
	@Override
	public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("preHandle");
		return true;
		// 如果被拦截了，return false，客户端会显示空白页面，也就是请求成功，但response为空
		// 从用户交互性的角度考虑，此时应该使用sendRedirect指定跳转目标，给用户一个失败返回页面
		// arg1.sendRedirect("some direction");
	}

	// 控制器执行完成,进入到jsp之前执行.
	// 日志记录.
	// 敏感词语过滤
	@Override
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
			throws Exception {

		System.out.println("In postHandle, HttpServletRequest = " + arg0);
		System.out.println("In postHandle, HttpServletResponse = " + arg1);
		System.out.println("In postHandle, Object = " + arg2);
		System.out.println("In postHandle, ModelAndView = " + arg3);

		System.out.println("In postHandle, arg3.getViewName() = " + arg3.getViewName());
		System.out.println("arg3.getModel().get(\"model\") = " + arg3.getModel().get("model"));
		String word = arg3.getModel().get("model").toString();
		String newWord = word.replace("祖国", "**");
		arg3.getModel().put("model", newWord);
//		arg3.getModel().put("model", "修改后的内容");
		System.out.println("postHandle");
	}

	// jsp执行完成后执行
	// 记录执行过程中出现的异常.
	// 可以把异常记录到日志中
	@Override
	public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {
		System.out.println("In afterCompletion, arg3 = " + arg3);
		if (arg3 != null) {
			System.out.println("In afterCompletion, Exception = :" + arg3.getMessage());
		}
	}
}

4.2 在springmvc.xml 配置拦截器需要拦截哪些控制器
4.2.1 拦截所有控制器

	<!-- 拦截器 -->
	<mvc:interceptors>
		<bean class="cn.hanquan.interceptor.DemoInterceptor"></bean>
	</mvc:interceptors>

4.2.2 拦截特定的的url

	<!-- 拦截器 -->
	<mvc:interceptors>
		<mvc:interceptor>
			<mvc:mapping path="/interceptor" />
			<bean class="cn.hanquan.interceptor.DemoInterceptor"></bean>
		</mvc:interceptor>
	</mvc:interceptors>

二. 拦截器栈

1. 多个拦截器同时生效时,组成了拦截器栈
2. 顺序:先进后出.
3. 执行顺序和在 springmvc.xml 中配置顺序有关
4. 设置先配置拦截器A，再配置拦截器B，执行顺序为
   preHandle(A) --> preHandle(B) --> 控制器方法--> postHandle(B)--> postHanle(A) --> JSP --> afterCompletion(B) --> afterCompletion(A)
   

---

示例效果

目录结构：