SpringMVC（五）之拦截器

转载自《SpringMVC拦截器的使用详解》

拦截器简介

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

常见应用场景

1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。
2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；
3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；
4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。
5、OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。

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

SpringMVC的默认控制器

1、DispatcherServlet

SpringMVC具有统一的入口DispatcherServlet，所有的请求都通过DispatcherServlet。DispatcherServlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，Servlet拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标Controller来处理。 所以我们现在web.xml中加入以下配置：

<servlet>  
  <servlet-name>springMybatis</servlet-name>  
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
  <load-on-startup>1</load-on-startup>  
</servlet>  
<servlet-mapping>  
  <servlet-name>springMybatis</servlet-name>  
  <!-- 所有的的请求，都会被DispatcherServlet处理 -->  
  <url-pattern>/</url-pattern>  
</servlet-mapping>  

初始化 DispatcherServlet时，该框架在 web应用程序WEB-INF目录中寻找一个名为[servlet-名称]-servlet.xml的文件， 并在那里定义相关的Beans，重写在全局中定义的任何Beans。

2、配置静态资源文件不拦截

如果只配置拦截类似于*.do格式的url，则对静态资源的访问是没有问题的，但是如果配置拦截了所有的请求（如我们上面配置的“/”），就会造成js文件、css文件、图片文件等静态资源无法访问。一般实现拦截器主要是为了权限管理，主要是拦截一些url请求，所以不对静态资源进行拦截。要过滤掉静态资源一般有两种方式。

第一种是采用<mvc:default-servlet-handler />，（一般Web应用服务器默认的Servlet名称是”default”，所以这里我们激活Tomcat的defaultServlet来处理静态文件，在web.xml里配置如下代码即可：）

<servlet-mapping>  
    <servlet-name>default</servlet-name>  
    <url-pattern>/js/*</url-pattern>  
    <url-pattern>/css/*</url-pattern>  
    <url-pattern>/images/*</url-pattern>  
    <url-pattern>/fonts/*</url-pattern>  
</servlet-mapping>  

Tomcat, Jetty, JBoss, and GlassFish 默认 Servlet的名字 – “default”
Resin 默认 Servlet的名字 – “resin-file”
WebLogic 默认 Servlet的名字 – “FileServlet”
WebSphere 默认 Servlet的名字 – “SimpleFileServlet”

第二种是采用，在springmvc的配置文件中加入以下代码：

<mvc:resources mapping="/js/**" location="/static_resources/javascript/"/>    
<mvc:resources mapping="/styles/**" location="/static_resources/css/"/>    
<mvc:resources mapping="/images/**" location="/static_resources/images/"/>  

自定义拦截器

在springmvc中，定义拦截器要实现HandlerInterceptor接口，并实现该接口中提供的三个方法。

1、拦截器接口HandlerInterceptor

package org.springframework.web.servlet;  
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;  
}  

• preHandle

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

• postHandle

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

• afterCompletion

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

---

局部拦截器

针对单个处理器映射器，就叫局部拦截器。

全局拦截器

springmvc.xml

<!-- 配置springmvc全局拦截器 -->
<mvc:interceptors>
    <!-- 多个拦截器，按顺序执行 -->
    <mvc:interceptor>
        <mvc:mapping path="/**"/><!-- 表示拦截所有的url包括子url路径 -->
        <bean class="com.zyj.inteceptor.Inteceptor1"></bean>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="com.zyj.inteceptor.Inteceptor2"></bean>
    </mvc:interceptor>
</mvc:interceptors>

Inteceptor1.java

public class Inteceptor1 implements HandlerInterceptor {

    // 在执行处理器映射器之前执行
    //return false:拦截
    //return true:放行
    @Override
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
        System.out.println("Inteceptor1--->preHandle");
        return true;
    }
    // 在还没有调用Controller，还没返回modelAndView之前执行
    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {
        System.out.println("Inteceptor1--->postHandle");
    }
    // 在返回ModelAndView之后执行
    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("Inteceptor1--->afterCompletion");
    }
}

Inteceptor2.java

public class Inteceptor2 implements HandlerInterceptor {

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

    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {
        System.out.println("Inteceptor2--->postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("Inteceptor2--->afterCompletion");
    }
}

1.两个拦截器都放行

Inteceptor1--->preHandle
Inteceptor2--->preHandle

Inteceptor2--->postHandle
Inteceptor1--->postHandle

Inteceptor2--->afterCompletion
Inteceptor1--->afterCompletion

2.第一个放行，第二个拦截

Inteceptor1--->preHandle
Inteceptor2--->preHandle

Inteceptor1--->afterCompletion

这里大家可能会好奇，Inteceptor1放行，Inteceptor2拦截，那应该执行完Inteceptor2的preHandle方法后就结束了，怎么会出现Inteceptor1--->afterCompletion

Springmvc规定：凡是preHandle返回true，afterCompletion必须执行。

拦截器的使用

从第二种情况来看，比如现在要写一个统一异常处理的逻辑，那么要将该拦截器放在拦截器链的第一个位置，且一定要放行，因为只有放行了，才会去执行afterCompletion，而且放在拦截器链的第一个的话，afterCompletion方法会最后执行，才能在里面执行统一异常处理的逻辑。 再比如，登陆认证拦截器，放在拦截器链接中第一个位置（如果有统一异常处理，那么应该放在统一异常处理的后面）。权限校验拦截器，放在登陆认证拦截器之后（因为登陆通过后才校验权限）。

上一篇：《SpringMVC（四）之requestParam、requestBody、responseBody》
下一篇：《SpringMVC+Jersey实现跨服务器上传图片》