拦截器

SpringMVC 中的 Interceptor 拦截器是非常重要和相当有用的,它的主要作用是拦截指定的用户请求,并进行相应的预处理与后处理。其拦截的时间点在“处理器映射器根据用户提交的请求映射出了所要执行的处理器类,并且也找到了要执行该处理器类的处理器适配器,在处理器适配器执行处理器之前”。当然,在处理器映射器映射出所要执行的处理器类时,已经将拦截器与处理器组合为了一个处理器执行链,并返回给了中央调度器。

自定义拦截器实现步骤

SpringMVC拦截器_拦截器

拦截器的执行

自定义拦截器,需要实现 HandlerInterceptor 接口。而该接口中含有三个方法:

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
该方法在处理器方法执行之前执行。其返回值为 boolean,若为 true,则紧接着会执行处理器方法,且会将 afterCompletion()方法放入到一个专门的方法栈中等待执行。

postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
该方法在处理器方法执行之后执行。处理器方法若最终未被执行,则该方法不会执行。由于该方法是在处理器方法执行完后执行,且该方法参数中包含ModelAndView,所以该方法可以修改处理器方法的处理结果数据,且可以修改跳转方向。

afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
当 preHandle()方法返回 true 时,会将该方法放到专门的方法栈中,等到对请求进行响应的所有工作完成之后才执行该方法。即该方法是在中央调度器渲染(数据填充)了响应页面之后执行的,此时对 ModelAndView 再操作也对响应无济于事。
afterCompletion 最后执行的方法,清除资源,例如在 Controller 方法中加入数据。

拦截器中方法与处理器方法的执行顺序如下图:
SpringMVC拦截器_mvc_02

多个拦截器执行

当有多个拦截器时,形成拦截器链。拦截器链的执行顺序,与其注册顺序一致。需要再次强调一点的是,当某一个拦截器的 preHandle()方法返回 true 并被执行到时,会向一个专门的方法栈中放入该拦截器的 afterCompletion()方法。

多个拦截器中方法与处理器方法的执行顺序如下图:
SpringMVC拦截器_执行顺序_03
从图中可以看出,只要有一个 preHandle()方法返回 false,则上部的执行链将被断开,其后续的处理器方法与 postHandle()方法将无法执行。但,无论执行链执行情况怎样,只要方法栈中有方法,即执行链中只要有 preHandle()方法返回 true,就会执行方法栈中的afterCompletion()方法。最终都会给出响应。

拦截器登入验证例子
  1. 创建controller,doLogin方法不进行拦截,doSome方法进行拦截。doLogin方法进行验证登入信息。
@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/login.do")
    public ModelAndView doLogin(HttpSession session, String name, Integer age){
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("uname",name);
        modelAndView.addObject("uage",age);
        modelAndView.setViewName("forward:/user/some.do");
        if(name.equals("黄振聪")) {
            session.setAttribute("uname",name);
        }
        return modelAndView;
    }
    @RequestMapping("/some.do")
    public String doSome(){
        return "target";
    }
}
  1. 创建拦截器实现类。
public class UserInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("执行preHandle...");
        HttpSession session = request.getSession();
        String uname = (String) session.getAttribute("uname");
        if(uname != null){
            return true;
        }
        return false;
    }

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

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

  1. 在主配置文件中声明拦截器
<mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/user/some.do"/>
            <bean class="com.hzc.interceptor.UserInterceptor" />
        </mvc:interceptor>
    </mvc:interceptors>
  1. 创建登入界面与结果界面
<body>
    <form action="user/login.do">
        姓名:<input type="text" name="name"><br>
        年龄:<input type="text" name="age"><br>
        <input type="submit" value="登入">
    </form>
</body>



<body>
    <h2>姓名:${requestScope.uname}</h2>
    <h2>年龄:${requestScope.uage}</h2>
</body>