SPringMVC-拦截器_springmvc的拦截器可以保护代码吗-优快云博客

本文详细介绍了SpringMVC中的拦截器概念、使用场景及其实现方式，包括如何定义拦截器类、配置拦截规则以及与过滤器的区别。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringMVC--拦截器

什么是SpringMVC拦截器：

java里的拦截器是动态拦截Action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行，同时也提供了一种可以提取action中可重用部分的方式。在AOP（Aspect-Oriented Programming）中拦截器用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。

为什么要使用SpringMVC拦截器：

虽然OOP和结构化编程相比具有很多的优势，但是在企业级的开发中仍然是力不从心。例如，事务处理、异常处理、日志、数据校验、国际化及权限管理等方面的代码都是技术实现代码，这些代码和业务处理逻辑代码都混在一起，会使项目中产生大量的重复代码。

通过使用拦截器，可以使代码可读性增强，同时有利于维护

我们什么时候使用SpringMVC-拦截器

例如，事务处理、异常处理、日志、数据校验、国际化及权限管理等方面就会用到SpringMVC拦截器

我们怎么使用SpringMVC-拦截器

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

一、定义Interceptor实现类

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

（一）实现HandlerInterceptor接口

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

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

（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 方法之后的内容就是反向的。

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

下面我们来实现一个简单的拦截器的例子：

 
 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  

}

}

以上先是实现拦截器的接口

接下来是请求拦截的内容

 
 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 +  
 "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=" 
 );  

}

}

  紧接着： 

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

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

 
         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"

下面是我的声明示例：

 
         < 
         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拦截器链中的拦截器

 
         < 
         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子标签来定义需要进行拦截的请求路径。

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

最后我们和过滤器做个比较

什么是过滤器，用来干吗？和SpringMvc拦截器的区别又在哪？

过滤器是一个程序，它先于与之相关的servlet或JSP页面运行在服务器上。过滤器可附加到一个或多个servlet或JSP页面上，并且可以检查进入这些资源的请求信息。在这之后，过滤器可以作如下的选择：
①以常规的方式调用资源（即，调用servlet或JSP页面）。
②利用修改过的请求信息调用资源。
③调用资源，但在发送响应到客户机前对其进行修改。
④阻止该资源调用，代之以转到其他的资源，返回一个特定的状态代码或生成替换输出。

在Servlet作为过滤器使用时，它可以对客户的请求进行处理。处理完成后，它会交给下一个过滤器处理，这样，客户的请求在过滤链里逐个处理，直到请求发送到目标为止。例如，某网站里有提交“修改的注册信息”的网页，当用户填写完修改信息并提交后，服务器在进行处理时需要做两项工作：判断客户端的会话是否有效；对提交的数据进行统一编码。这两项工作可以在由两个过滤器组成的过滤链里进行处理。当过滤器处理成功后，把提交的数据发送到最终目标；如果过滤器处理不成功，将把视图派发到指定的错误页面。
 
2、拦截器与过滤器的区别 ： 
     1. 拦截器是基于java的反射机制的，而过滤器是基于函数回调。
     2. 拦截器不依赖与servlet容器，过滤器依赖与servlet容器。 
     3. 拦截器只能对action请求起作用，而过滤器则可以对几乎所有的请求起作用。
     4. 拦截器可以访问action上下文、值栈里的对象，而过滤器不能访问。 
     5. 在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次