SpringMVC中使用Interceptor拦截器

时间  2019-11-12
标签 springmvc 使用 interceptor 拦截 栏目 Spring 繁體版
原文   原文链接

SpringMVC 中的Interceptor 拦截器也是至关重要和至关有用的，它的主要做用是拦截用户的请求并进行相应的处理。好比经过它来进行权限验证，或者是来判断用户是否登录，或者是像12306 那样子判断当前时间是不是购票时间。java

   1、定义Interceptor实现类

 

   SpringMVC 中的Interceptor 拦截请求是经过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor 很是简单，主要有两种方式，第一种方式是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口，或者是这个类继承实现了HandlerInterceptor 接口的类，好比Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ；第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。web

   （一）实现HandlerInterceptor接口

   HandlerInterceptor 接口中定义了三个方法，咱们就是经过这三个方法来对用户的请求进行拦截处理的。spring

   （1 ）preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顾名思义，该方法将在请求处理以前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中能够同时存在多个Interceptor 。每一个Interceptor 的调用会依据它的声明顺序依次执行，并且最早执行的都是Interceptor 中的preHandle 方法，因此能够在这个方法中进行一些前置初始化操做或者是对当前请求的一个预处理，也能够在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，若是已是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。spring-mvc

   （2 ）postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，由preHandle 方法的解释咱们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理以后，也就是Controller 方法调用以后执行，可是它会在DispatcherServlet 进行视图返回渲染以前被调用，因此咱们能够在这个方法中对Controller 处理以后的ModelAndView 对象进行操做。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的，只是在Struts2 里面须要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用，而后每个Interceptor 中在invoke 方法调用以前的内容都是按照声明顺序执行的，而invoke 方法以后的内容就是反向的。session

   （3 ）afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，该方法也是须要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束以后，也就是在DispatcherServlet 渲染了对应的视图以后执行。这个方法的主要做用是用于进行资源清理工做的。mvc

下面是一个简单的代码说明：app

 

Java代码 复制代码 收藏代码ide

  1. import javax.servlet.http.HttpServletRequest;  
  2. import javax.servlet.http.HttpServletResponse;  
  3.   
  4. import org.springframework.web.servlet.HandlerInterceptor;  
  5. import org.springframework.web.servlet.ModelAndView;  
  6.   
  7. public class SpringMVCInterceptor implements HandlerInterceptor {  
  8.   
  9.   
  10.     /** 
  11.      * preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理以前进行调用，SpringMVC中的Interceptor拦截器是链式的，能够同时存在 
  12.      * 多个Interceptor，而后SpringMVC会根据声明的先后顺序一个接一个的执行，并且全部的Interceptor中的preHandle方法都会在 
  13.      * Controller方法调用以前调用。SpringMVC的这种Interceptor链式结构也是能够进行中断的，这种中断方式是令preHandle的返 
  14.      * 回值为false，当preHandle的返回值为false的时候整个请求就结束了。 
  15.      */  
  16.     @Override  
  17.     public boolean preHandle(HttpServletRequest request,  
  18.             HttpServletResponse response, Object handler) throws Exception {  
  19.         // TODO Auto-generated method stub  
  20.         return false;  
  21.     }  
  22.       
  23.     /** 
  24.      * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之 
  25.      * 后，也就是在Controller的方法调用以后执行，可是它会在DispatcherServlet进行视图的渲染以前执行，也就是说在这个方法中你能够对ModelAndView进行操 
  26.      * 做。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像， 
  27.      * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor 
  28.      * 或者是调用action，而后要在Interceptor以前调用的内容都写在调用invoke以前，要在Interceptor以后调用的内容都写在调用invoke方法以后。 
  29.      */  
  30.     @Override  
  31.     public void postHandle(HttpServletRequest request,  
  32.             HttpServletResponse response, Object handler,  
  33.             ModelAndView modelAndView) throws Exception {  
  34.         // TODO Auto-generated method stub  
  35.           
  36.     }  
  37.   
  38.     /** 
  39.      * 该方法也是须要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成以后，也就是DispatcherServlet渲染了视图执行， 
  40.      * 这个方法的主要做用是用于清理资源的，固然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。 
  41.      */  
  42.     @Override  
  43.     public void afterCompletion(HttpServletRequest request,  
  44.             HttpServletResponse response, Object handler, Exception ex)  
  45.     throws Exception {  
  46.         // TODO Auto-generated method stub  
  47.           
  48.     }  
  49.       
  50. }  
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

public class SpringMVCInterceptor implements HandlerInterceptor {


	/**
	 * preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理以前进行调用，SpringMVC中的Interceptor拦截器是链式的，能够同时存在
	 * 多个Interceptor，而后SpringMVC会根据声明的先后顺序一个接一个的执行，并且全部的Interceptor中的preHandle方法都会在
	 * Controller方法调用以前调用。SpringMVC的这种Interceptor链式结构也是能够进行中断的，这种中断方式是令preHandle的返
	 * 回值为false，当preHandle的返回值为false的时候整个请求就结束了。
	 */
	@Override
	public boolean preHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler) throws Exception {
		// TODO Auto-generated method stub
		return false;
	}
	
	/**
	 * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之
	 * 后，也就是在Controller的方法调用以后执行，可是它会在DispatcherServlet进行视图的渲染以前执行，也就是说在这个方法中你能够对ModelAndView进行操
	 * 做。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像，
	 * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor
	 * 或者是调用action，而后要在Interceptor以前调用的内容都写在调用invoke以前，要在Interceptor以后调用的内容都写在调用invoke方法以后。
	 */
	@Override
	public void postHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		// TODO Auto-generated method stub
		
	}

	/**
	 * 该方法也是须要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成以后，也就是DispatcherServlet渲染了视图执行，
	 * 这个方法的主要做用是用于清理资源的，固然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。
	 */
	@Override
	public void afterCompletion(HttpServletRequest request,
			HttpServletResponse response, Object handler, Exception ex)
	throws Exception {
		// TODO Auto-generated method stub
		
	}
	
}

 

 

   （二）实现WebRequestInterceptor 接口

  WebRequestInterceptor 中也定义了三个方法，咱们也是经过这三个方法来实现拦截的。这三个方法都传递了同一个参数WebRequest ，那么这个WebRequest 是什么呢？这个WebRequest 是Spring 定义的一个接口，它里面的方法定义都基本跟HttpServletRequest 同样，在WebRequestInterceptor 中对WebRequest 进行的全部操做都将同步到HttpServletRequest 中，而后在当前请求中一直传递。post

   （1 ）preHandle(WebRequest request) 方法。该方法将在请求处理以前进行调用，也就是说会在Controller 方法调用以前被调用。这个方法跟HandlerInterceptor 中的preHandle 是不一样的，主要区别在于该方法的返回值是void ，也就是没有返回值，因此咱们通常主要用它来进行资源的准备工做，好比咱们在使用Hibernate 的时候能够在这个方法中准备一个Hibernate 的Session 对象，而后利用WebRequest 的setAttribute(name, value, scope) 把它放到WebRequest 的属性中。这里能够说说这个setAttribute 方法的第三个参数scope ，该参数是一个Integer 类型的。在WebRequest 的父层接口RequestAttributes 中对它定义了三个常量：ui

   SCOPE_REQUEST ：它的值是0 ，表明只有在request 中能够访问。

   SCOPE_SESSION ：它的值是1 ，若是环境容许的话它表明的是一个局部的隔离的session，不然就表明普通的session，而且在该session范围内能够访问。

   SCOPE_GLOBAL_SESSION ：它的值是2 ，若是环境容许的话，它表明的是一个全局共享的session，不然就表明普通的session，而且在该session 范围内能够访问。

   （2 ）postHandle(WebRequest request, ModelMap model) 方法。该方法将在请求处理以后，也就是在Controller 方法调用以后被调用，可是会在视图返回被渲染以前被调用，因此能够在这个方法里面经过改变数据模型ModelMap 来改变数据的展现。该方法有两个参数，WebRequest 对象是用于传递整个请求数据的，好比在preHandle 中准备的数据均可以经过WebRequest 来传递和访问；ModelMap 就是Controller 处理以后返回的Model 对象，咱们能够经过改变它的属性来改变返回的Model 模型。

   （3 ）afterCompletion(WebRequest request, Exception ex) 方法。该方法会在整个请求处理完成，也就是在视图返回并被渲染以后执行。因此在该方法中能够进行资源的释放操做。而WebRequest 参数就能够把咱们在preHandle 中准备的资源传递到这里进行释放。Exception 参数表示的是当前请求的异常对象，若是在Controller 中抛出的异常已经被Spring 的异常处理器给处理了的话，那么这个异常对象就是是null 。

 

   下面是一个简单的代码说明：

Java代码 复制代码 收藏代码

  1. import org.springframework.ui.ModelMap;  
  2. import org.springframework.web.context.request.WebRequest;  
  3. import org.springframework.web.context.request.WebRequestInterceptor;  
  4.   
  5. public class AllInterceptor implements WebRequestInterceptor {  
  6.       
  7.     /** 
  8.      * 在请求处理以前执行，该方法主要是用于准备资源数据的，而后能够把它们当作请求属性放到WebRequest中 
  9.      */  
  10.     @Override  
  11.     public void preHandle(WebRequest request) throws Exception {  
  12.         // TODO Auto-generated method stub  
  13.         System.out.println("AllInterceptor...............................");  
  14.         request.setAttribute("request", "request", WebRequest.SCOPE_REQUEST);//这个是放到request范围内的，因此只能在当前请求中的request中获取到  
  15.         request.setAttribute("session", "session", WebRequest.SCOPE_SESSION);//这个是放到session范围内的，若是环境容许的话它只能在局部的隔离的会话中访问，不然就是在普通的当前会话中能够访问  
  16.         request.setAttribute("globalSession", "globalSession", WebRequest.SCOPE_GLOBAL_SESSION);//若是环境容许的话，它能在全局共享的会话中访问，不然就是在普通的当前会话中访问  
  17.     }  
  18.   
  19.     /** 
  20.      * 该方法将在Controller执行以后，返回视图以前执行，ModelMap表示请求Controller处理以后返回的Model对象，因此能够在 
  21.      * 这个方法中修改ModelMap的属性，从而达到改变返回的模型的效果。 
  22.      */  
  23.     @Override  
  24.     public void postHandle(WebRequest request, ModelMap map) throws Exception {  
  25.         // TODO Auto-generated method stub  
  26.         for (String key:map.keySet())  
  27.             System.out.println(key + "-------------------------");;  
  28.         map.put("name3", "value3");  
  29.         map.put("name1", "name1");  
  30.     }  
  31.   
  32.     /** 
  33.      * 该方法将在整个请求完成以后，也就是说在视图渲染以后进行调用，主要用于进行一些资源的释放 
  34.      */  
  35.     @Override  
  36.     public void afterCompletion(WebRequest request, Exception exception)  
  37.     throws Exception {  
  38.         // TODO Auto-generated method stub  
  39.         System.out.println(exception + "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=");  
  40.     }  
  41.       
  42. }  
import org.springframework.ui.ModelMap;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.context.request.WebRequestInterceptor;

public class AllInterceptor implements WebRequestInterceptor {
	
	/**
	 * 在请求处理以前执行，该方法主要是用于准备资源数据的，而后能够把它们当作请求属性放到WebRequest中
	 */
	@Override
	public void preHandle(WebRequest request) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("AllInterceptor...............................");
		request.setAttribute("request", "request", WebRequest.SCOPE_REQUEST);//这个是放到request范围内的，因此只能在当前请求中的request中获取到
		request.setAttribute("session", "session", WebRequest.SCOPE_SESSION);//这个是放到session范围内的，若是环境容许的话它只能在局部的隔离的会话中访问，不然就是在普通的当前会话中能够访问
		request.setAttribute("globalSession", "globalSession", WebRequest.SCOPE_GLOBAL_SESSION);//若是环境容许的话，它能在全局共享的会话中访问，不然就是在普通的当前会话中访问
	}

	/**
	 * 该方法将在Controller执行以后，返回视图以前执行，ModelMap表示请求Controller处理以后返回的Model对象，因此能够在
	 * 这个方法中修改ModelMap的属性，从而达到改变返回的模型的效果。
	 */
	@Override
	public void postHandle(WebRequest request, ModelMap map) throws Exception {
		// TODO Auto-generated method stub
		for (String key:map.keySet())
			System.out.println(key + "-------------------------");;
		map.put("name3", "value3");
		map.put("name1", "name1");
	}

	/**
	 * 该方法将在整个请求完成以后，也就是说在视图渲染以后进行调用，主要用于进行一些资源的释放
	 */
	@Override
	public void afterCompletion(WebRequest request, Exception exception)
	throws Exception {
		// TODO Auto-generated method stub
		System.out.println(exception + "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=");
	}
	
}

 

 

  2、把定义的拦截器类加到SpringMVC的拦截体系中

 

         1.在SpringMVC的配置文件中加上支持MVC的schema

Xml代码 复制代码 收藏代码

  1.     xmlns:mvc="http://www.springframework.org/schema/mvc"  
  2.     xsi:schemaLocation=" http://www.springframework.org/schema/mvc  
  3.         http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"  
xmlns:mvc="http://www.springframework.org/schema/mvc"
	xsi:schemaLocation=" http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"

 

         下面是个人声明示例：

Xml代码 复制代码 收藏代码

  1. <beans xmlns="http://www.springframework.org/schema/beans"  
  2.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"  
  3.     xmlns:mvc="http://www.springframework.org/schema/mvc"  
  4.     xsi:schemaLocation="http://www.springframework.org/schema/beans  
  5.      http://www.springframework.org/schema/beans/spring-beans-3.0.xsd  
  6.      http://www.springframework.org/schema/context  
  7.      http://www.springframework.org/schema/context/spring-context-3.0.xsd  
  8.      http://www.springframework.org/schema/mvc  
  9.      http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">  
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
     http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
     http://www.springframework.org/schema/context
     http://www.springframework.org/schema/context/spring-context-3.0.xsd
     http://www.springframework.org/schema/mvc
     http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

         这样在SpringMVC的配置文件中就可使用mvc标签了，mvc标签中有一个mvc:interceptors是用于声明SpringMVC的拦截器的。

 

        （二）使用mvc:interceptors标签来声明须要加入到SpringMVC拦截器链中的拦截器

Xml代码 复制代码 收藏代码

  1. <mvc:interceptors>  
  2.     <!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截全部的请求 -->  
  3.     <bean class="com.host.app.web.interceptor.AllInterceptor"/>  
  4.     <mvc:interceptor>  
  5.         <mvc:mapping path="/test/number.do"/>  
  6.         <!-- 定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的 -->  
  7.         <bean class="com.host.app.web.interceptor.LoginInterceptor"/>  
  8.     </mvc:interceptor>  
  9. </mvc:interceptors>  
<mvc:interceptors>
		<!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截全部的请求 -->
		<bean class="com.host.app.web.interceptor.AllInterceptor"/>
		<mvc:interceptor>
			<mvc:mapping path="/test/number.do"/>
			<!-- 定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的 -->
			<bean class="com.host.app.web.interceptor.LoginInterceptor"/>
		</mvc:interceptor>
	</mvc:interceptors>

          由上面的示例能够看出能够利用mvc:interceptors标签声明一系列的拦截器，而后它们就能够造成一个拦截器链，拦截器的执行顺序是按声明的前后顺序执行的，先声明的拦截器中的preHandle方法会先执行，然而它的postHandle方法和afterCompletion方法却会后执行。

          在mvc:interceptors标签下声明interceptor主要有两种方式：

                    （1）直接定义一个Interceptor实现类的bean对象。使用这种方式声明的Interceptor拦截器将会对全部的请求进行拦截。

                    （2）使用mvc:interceptor标签进行声明。使用这种方式进行声明的Interceptor能够经过mvc:mapping子标签来定义须要进行拦截的请求路径。

          通过上述两步以后，定义的拦截器就会发生做用对特定的请求进行拦截了。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程