【Java必学框架】一文搞懂Spring拦截器

1.概念

我们知道，j2ee中自带过滤器，其是web三大组件之一。多个过滤器形成的过滤链可以对请求进行一系列的加工处理，鉴权转发等预处理与后处理。

那么什么是拦截器呢？

Spring MVC 的拦截器类似于 Servlet 开发中的过滤器 Filter，用于对处理器进行预处理和后处理。 将拦截器按一定的顺序联结成一条链，这条链称为拦截器链（Interceptor Chain）。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。拦截器也是AOP思想的具体实现。

以下是过滤器与拦截器的区别：

区别	过滤器（Filter）	拦截器（Interceptor）
使用范围	是 servlet 规范中的一部分，任何 Java Web 工程都可以使用	是 SpringMVC 框架自己的，只有使用了 SpringMVC 框架的工程才能用
拦截范围	在 url-pattern 中配置了/*之后， 可以对所有要访问的资源拦截	在中配置了/**之 后，会对所有资源进行拦截。但是可以通过标签排除不需要拦截的资源

2.快速入门

步骤：

​ 1.创建拦截器类实现HandlerInterceptor接口

​ 2.在spring-mvc.xml文件中声明拦截器

以下进行演示：

HandlerInterceptor类里面包含的三个方法不是抽象方法，而是默认方法。我们可以按需选取进行重写。其中preHandle是请求处理之前进行调用，返回值为true表示放行。

public class LoginInterceptor implements HandlerInterceptor {

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterHandle...");
    }
}

配置拦截器

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="venture.study.interceptor.LoginInterceptor">bean>
    mvc:interceptor>
mvc:interceptors>

测试类:

@RequestMapping("/test")
@ResponseBody
public void test(){
    System.out.println("拦截器测试...");
}

访问/test，控制台输出如下：

preHandle…
拦截器测试…
postHandle…
afterHandle…

根据以上输出结果，我们可以将三个方法被调用时期以及作用整理如下表:

方法	说明
preHandler	该方法在请求处理之前进行调用，该方法的返回值是布尔值Boolean类型的。返回值为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，或者执行Controller1
postHandler	该方法是在当前请求进行处理之后被调用，前提是preHandle 方法的返回值为 true 时才能被调用，且它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作
afterCompletion	该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行，前提是preHandle 方法的返回值为true 时才能被调用

3.拦截器链

有多个拦截器的时候拦截器是如何工作的呢？

这里说明一下，拦截器的先后执行顺序与配置先后有关，先配置的拦截器先执行。访问/test，输出结果如下：

preHandle…
第二个preHandle…
拦截器测试…
第二个postHandle…
postHandle…
第二个afterHandle…
afterHandle…

分析结果，我们可以看到先配置的preHandle方法先执行，但是postHandle与afterHandle方法却后执行，后进先出，跟队列差不多。

4.利用拦截器实现登录鉴权

登录控制器：

@RequestMapping("/user-login")
public String userLogin(String username, String password, HttpServletRequest request){
    User user = userService.login(username,password);
    if(user != null){
        request.getSession().setAttribute("user",user);//存session
        return "redirect:/user/user-list";
    }else{
        return "redirect:/login.jsp";
    }
}

鉴权拦截器，只需处理preHandle方法

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    User user = (User)request.getSession().getAttribute("user");
    if(user != null){
        return true;//登陆了则放行
    }else{
        response.sendRedirect( request.getContextPath() +  "/login.jsp");//没有登陆则跳转到登录界面
        return false;
    }
}

配置拦截器，这里需要对登录控制器user-login进行放行

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/user/user-login">mvc:exclude-mapping>
        <bean class="venture.study.interceptor.LoginInterceptor">bean>
    mvc:interceptor>
mvc:interceptors>

---

1. 如果有还有下一个拦截器，就接着调用下一个interceptor的preHandler()方法,否则就执行Controller ↩︎