SpringMVC学习笔记 | SpringMVC拦截器详解：自定义拦截器、拦截器执行顺序的分析

自定义拦截器

SpringMVC可以使用拦截器对请求进行拦截处理，用户可以自定义拦截器来实现特定的功能，自定义拦截器必须实现HandlerInterceptor接口。

步骤

• 编写一个拦截器类，需要实现HandlerInterceptor接口。
  示例：

package com.cerr.springmvc.interceptor;


import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class FirstInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("afterCompletion");
    }
}

• 在配置文件中配置该拦截器，使用来进行配置
  配置示例：

对HandlerInterceptor接口的三个方法的解析

public boolean preHandle(HttpServletRequest httpServletRequest, 
            HttpServletResponse httpServletResponse, Object o){};

该方法在目标方法执行前被调用，该方法若返回值为true，则继续调用后续的拦截器和目标方法；若返回值为false，则不会再调用后续的拦截器和目标方法。
可以考虑做权限，日志，事务等等。

public void postHandle(HttpServletRequest httpServletRequest, 
        HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView){};

该方法在目标方法执行之后、渲染视图之前被调用，可以对请求域中的属性或视图作出修改。

public void afterCompletion(HttpServletRequest httpServletRequest, 
         HttpServletResponse httpServletResponse, Object o, Exception e){};

该方法在渲染视图之后被调用，释放资源。

拦截器方法执行顺序图

从该图我们可以看出，拦截器先调的 preHandle，然后再去调目标方法，然后再调 postHandle，然后再渲染视图，最后调 afterCompletion，然后结束。

关于拦截器的其他配置

上面中我们说了拦截器可以通过来配置，而对于这个标签中，里面还有一个子标签我们还没说到，它就是。其里面有两个子标签和。

• 
  表示该拦截器拦截该请求（path里面的值）
• 
  表示该拦截器不拦截该请求（path里面的值）

例如我们配置如下：

SecondInterceptor拦截器代码：

package com.cerr.springmvc.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class SecondInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("SecondInterceptor:preHandle");
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("SecondInterceptor:postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("SecondInterceptor:afterCompletion");
    }
}

配置后，对于SecondInterceptor拦截器，只拦截emps请求，而emps请求会被FirstInterceptor和SecondInterceptor拦截。

运行后访问emps结果如下：

红框为第二个拦截器，绿框为第一个拦截器。

而如果访问一个其他的（例如i18n）结果如下：

绿框为第一个拦截器，只被第一个拦截器所拦截。

多个拦截器的拦截方法执行顺序

从执行顺序图我们可以看出，对于 preHandle方法，先配置的先执行；对于 postHandle方法，先配置的后执行；对于 afterCompletion方法，先配置的后执行。

有一点需要注意的是：对于afterCompletion方法是否执行是取决于preHandle方法的，在某一个拦截器的prehandle方法返回false前的所有拦截器都会执行afterCompletion方法。例如现在有4个拦截器，而第三个拦截器的prehandle返回了false，所以会执行afterCompletion方法的拦截器有拦截器1、拦截器2。