【SpringMVC】 4.3 拦截器


SpringMVC学习记录

注意:以下内容是学习 北京动力节点 的SpringMVC视频后所记录的笔记、源码以及个人的理解等,记录下来仅供学习


第4章 SpringMVC 核心技术

4.3 拦截器

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

4.3.1 一个拦截器的执行

自定义拦截器

package com.bjpowernode.handler;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

//拦截器类:拦截用户的请求。
public class MyInterceptor implements HandlerInterceptor {

    private long btime = 0;
    /*
     * preHandle叫做预处理方法。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        btime = System.currentTimeMillis();
        System.out.println("拦截器的MyInterceptor的preHandle()");
        //计算的业务逻辑,根据计算结果,返回true或者false
        //给浏览器一个返回结果     //request.getRequestDispatcher("/tips.jsp").forward(request,response);
        return true;
    }

    /*
       postHandle:后处理方法。
     */
    @Override
    public void postHandle(HttpServletRequest request,
                           HttpServletResponse response,
                           Object handler, ModelAndView mv) throws Exception {
        System.out.println("拦截器的MyInterceptor的postHandle()");
        //对原来的doSome执行结果,需要调整。
        if( mv != null){
            //修改数据
            mv.addObject("mydate",new Date());
            //修改视图
            mv.setViewName("other");
        }
    }

    /*
      afterCompletion:最后执行的方法
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                                Object handler, Exception ex) throws Exception {
        System.out.println("拦截器的MyInterceptor的afterCompletion()");

        long etime = System.currentTimeMillis();
        System.out.println("计算从preHandle到请求处理完成的时间:"+(etime - btime ));
    }
}

自定义拦截器,需要实现Handlerinterceptor接口。而该接口中含有三个方法:
1、 preHandle(request,response, Object handler) 预处理方法:
??该方法在处理器方法执行之前执行。其返回值为boolean,若为true,则紧接着会执行处理器方 法,且会将afterCompletion()方法放入到一个专门的方法栈中等待执行。

重要:
是整个项目的入口,门户。 当preHandle返回true 请求可以被处理。 preHandle返回false,请求到此方法就截止。
参数:
 Object handler : 被拦截的控制器对象
返回值boolean
  true:请求是通过了拦截器的验证,可以执行处理器方法。
  拦截器的MyInterceptor的preHandle()
  =====执行MyController中的doSome方法=====
  拦截器的MyInterceptor的postHandle()
  拦截器的MyInterceptor的afterCompletion()
 
  false:请求没有通过拦截器的验证,请求到达拦截器就截止了。 请求没有被处理
  拦截器的MyInterceptor的preHandle()

特点:
	a.方法在控制器方法(MyController的doSome)之前先执行的。 用户的请求首先到达此方法
	b.在这个方法中可以获取请求的信息, 验证请求是否符合要求。可以验证用户是否登录, 验证用户是否有权限访问某个连接地址(url)。
如果验证失败,可以截断请求,请求不能被处理。
如果验证成功,可以放行请求,此时控制器方法才能执行。

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

参数:
    Object handler:被拦截的处理器对象MyController
    ModelAndView mv:处理器方法的返回值

特点:
     a.在处理器方法之后执行的(MyController.doSome())
     b.能够获取到处理器方法的返回值ModelAndView,可以修改ModelAndView中的
     数据和视图,可以影响到最后的执行结果。
     c.主要是对原来的执行结果做二次修正,

     ModelAndView mv = MyController.doSome();
     postHandle(request,response,handler,mv);

3、afterCompletion(request,response, Object handler, Exception ex)最后执行的方法:

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

参数
    Object handler:被拦截器的处理器对象
    Exception ex:程序中发生的异常
  特点:
   a.在请求处理完成后执行的。框架中规定是当你的视图处理完成后,对视图执行了forward。就认为请求处理完成。
   b.一般做资源回收工作的, 程序请求过程中创建了一些对象,在这里可以删除,把占用的内存回收。

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

换一种表现方式,也可以这样理解:

(1) 注册拦截器

springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>


    
    

    
    
        
        
        
        
    

    
    
        
        
            
            
            
            
        
    


mvc:mapping/用于指定当前所注册的拦截器可以拦截的请求路径,而 /**表示拦截所 有请求。

(2) 修改 index 页面

index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%
    String basePath = request.getScheme() + "://" +
            request.getServerName() + ":" + request.getServerPort() +
            request.getContextPath() + "/";
%>


    Title
    


    

一个拦截器

姓名:
年龄:

(3) 修改处理器

MyController.java

package com.bjpowernode.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

/**
 * @RequestMapping:
 *    value : 所有请求地址的公共部分,叫做模块名称
 *    位置: 放在类的上面
 */
@Controller
public class MyController {
    @RequestMapping(value = "/some.do")
    public ModelAndView doSome(String name,Integer age)  {
        System.out.println("=====执行MyController中的doSome方法=====");
        //处理some.do请求了。 相当于service调用处理完成了。
        ModelAndView mv  = new ModelAndView();
        mv.addObject("myname",name);
        mv.addObject("myage",age);
        mv.setViewName("show");
        return mv;
    }
}

(4) 修改 show 页面

show.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    Title


    

/WEB-INF/view/show.jsp从request作用域获取数据


myname数据:${myname}


myage数据:${myage}

4.3.2 多个拦截器的执行

项目在4.3.1的基础上
项目结构

(1) 再定义一个拦截器

MyInterceptor2 .java

package com.bjpowernode.handler;

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

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

//拦截器类:拦截用户的请求。
public class MyInterceptor2 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("22222-拦截器的MyInterceptor的preHandle()");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request,
                           HttpServletResponse response,
                           Object handler, ModelAndView mv) throws Exception {
        System.out.println("22222-拦截器的MyInterceptor的postHandle()");
    }
    
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                                Object handler, Exception ex) throws Exception {
        System.out.println("22222-拦截器的MyInterceptor的afterCompletion()");
    }
}

(2) 多个拦截器的注册与执行

springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>


    
    

    
    
        
        
        
        
    

    
    
        
        
            
            
            
        
        
        
            
            
        
    


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

从图中可以看出,只要有一个preHandle()方法返回false,则上部的执行链将被断开, 其后续的处理器方法与postHandle()方法将无法执行。但,无论执行链执行情况怎样,只要 方法栈中有方法,即执行链中只要有preHandle()方法返回true,就会执行方法栈中的 afterCompletion()方法。最终都会给出响应。
换一种表现方式,也可以这样理解:

4.3.3 公共资源

(1) pom.xml

<?xml version="1.0" encoding="UTF-8"?>


  4.0.0

  com.bjpowernode
  ch11-interceptor2
  1.0-SNAPSHOT
  war

  
    UTF-8
    1.8
    1.8
  

  
    
      junit
      junit
      4.11
      test
    
    
    
      javax.servlet
      javax.servlet-api
      3.1.0
      provided
    
    
    
      javax.servlet.jsp
      jsp-api
      2.2.1-b03
      provided
    
    
    
      org.springframework
      spring-webmvc
      5.2.5.RELEASE
    
  

  
    
      
      
        maven-compiler-plugin
        3.1
        
          1.8
          1.8
        
      
    
  


(2) web.xml

<?xml version="1.0" encoding="UTF-8"?>


    
    
        myweb
        org.springframework.web.servlet.DispatcherServlet

        
        
            
            contextConfigLocation
            
            classpath:springmvc.xml
        

        
        1
    

    
        myweb
        
        *.do