浅谈SpringMVC中的拦截器控件

谁践踏了优雅 2023-10-18 23:34 87阅读 0赞

## 1.拦截器的概念 ##

拦截器是 Spring MVC 中的一种十分强大的控件，它可以在进入处理器之前或者在处理器完成后做一些操作，也可以在视图渲染完成后进行操作。（本篇主要讨论的是 Spring4 版本中的拦截器以及开发一个登录拦截器的小例子）

Spring 要求处理器的拦截器都要实现或间接 org.springframework.web.servlet.HandlerInterceptor 接口，在该接口中定义了 3 个方法，其代码如下所示：

public interface HandlerInterceptor {
        
    
    	boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
           throws Exception;
    
      	void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception;
             
      	void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
             throws Exception;
    }

这 3 个方法的具体意义如下：

<table> 
 <thead> 
  <tr> 
   <th>preHandle</th> 
   <th>在处理器之前执行的前置方法，SpringMVC可以在进入处理器前处理一些方法。其返回值为boolean型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>postHandle</td> 
   <td>在处理器之后执行的后置方法，处理器的逻辑完成后运行它。</td> 
  </tr> 
  <tr> 
   <td>afterCompletion</td> 
   <td>无论是否产生异常都会在视图渲染完成之后执行的方法。</td> 
  </tr> 
 </tbody> 
</table>

## 2.拦截器的执行过程 ##

了解拦截器的执行过程有助于我们更好地理解它。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzAwNDA0NA_size_16_color_FFFFFF_t_70]

**注意：对于 preHandler 方法的返回值，当返回 false 时，不再继续执行后面的操作； 当返回 true 时，继续执行后面的操作**

## 3.开发拦截器 ##

由拦截器的设计要求可知，拦截器必须实现 HandlerInterceptor 接口。SpringMVC 的拦截器设计如下图所示：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzAwNDA0NA_size_16_color_FFFFFF_t_70 1]

下面来举一个简单的使用到拦截器的小例子。在开发一些具有登录功能的web应用(使用SSM框架)时，我们可以使用拦截器来帮助后台验证当前访问某个地址的用户是否已经登录。若没有登录，则直接返回到登录页面，阻止当前的操作；若已经登录，则允许接下来的操作。这样一来可以防止非登录用户直接访问其他页面。

### 3.1.定义登录拦截器 ###

package com.web;
    import com.bean.User;
    
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import javax.servlet.http.HttpSession;
    
    
    //登录拦截器
    public class LoginInterceptor implements HandlerInterceptor{
        
    
        /*在拦截器拦截之前判断是否之后的操作
        * @return false：不再继续执行后面的操作
        *         true：继续执行后面的操作
        * */
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
    
            //判断当前的用户是否已经登录
            HttpSession session = request.getSession();
            User loginUser = (User)session.getAttribute("loginUser");
    
            if(loginUser == null){
        
                String path = session.getServletContext().getContextPath();
                response.sendRedirect(path + "/login");
                return false;
            }else{
        
                return true;
            }
        }
    
        //在拦截器拦截完毕之后进行的操作
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
            
        }
        
        //在完成视图渲染之后进行的操作
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
        }
    }

### 3.2.在SpringMVC的配置文件(例如dispatcher-servlet.xml)中添加相应的配置 ###

<mvc:interceptors>
        
        <mvc:interceptor>
            
            <mvc:mapping path="/**"/>
            
            <mvc:exclude-mapping path="/login"/>
            <mvc:exclude-mapping path="/doAjaxLogin"/>
            <mvc:exclude-mapping path="/bootstrap/**"/>
            <mvc:exclude-mapping path="/css/**"/>
            <mvc:exclude-mapping path="/jquery/**"/>
            <bean class="com.web.LoginInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

其中bean中的class配置指定为开发的拦截器类，即LoginInterceptor。元素  
<mvc:mapping path=“”/>中的则是告诉SpringMVC该拦截器拦截什么请求。<mvc:exclude-mapping path=“”/>则是告诉SpringMVC不该拦截器拦截什么请求。当然了，这里只是给出了核心的代码，用来理解拦截器的执行过程。

## 4.多个拦截器的执行顺序 ##

在正常的情况下（即每个preHandler方法都返回true），Spring 会先从第一个拦截器开始进入前置方法，这样前置方法是按配置顺序运行的，然后运行处理器的代码，最后运行后置方法。要注意的是，后置方法和完成方法则是按照配置逆序运行的。当其中的某一个prehandler方法返回false后，按照配置顺序，后面的preHandle方法都不会运行，而控制器和所有的后置方法postHandle 也不会再运行。

好了，关于SpringMVC中的拦截器的一些介绍就先到这里了！这是我第一次写博客，如果大家发现了其中的问题，我希望大家可以直接提出来，我们一起探讨。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzAwNDA0NA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190807200836847.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzAwNDA0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzAwNDA0NA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20190807202507771.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzAwNDA0NA==,size_16,color_FFFFFF,t_70