【Spring 篇】SpringMVC拦截器：给你的应用增添色彩

「爱情、让人受尽委屈。」 2024-04-06 15:04 35阅读 0赞

![在这里插入图片描述][00284c26956d4b778c232f61e9bac424.png]

嗨，亲爱的小伙伴们！欢迎来到这段关于SpringMVC拦截器的奇妙之旅。今天我们要一探究竟，深入挖掘拦截器的神秘面纱，看看它是如何在你的应用中悄然发挥作用的。别怕，我会用最通俗易懂的语言，一步一步带你走进这个充满色彩的世界。

### 什么是拦截器？ ###

首先，我们来谈谈拦截器是个啥玩意。想象一下，拦截器就像是应用的守护神，能够在请求的各个阶段插上一脚。别被这个高大上的名字吓到，实际上它就是一位灵活而强大的小助手。

拦截器的主要职责包括：

*  **预处理请求：** 在请求被处理之前，你可以在这个阶段做些事情，比如检查用户是否登录、记录一些日志等。
 *  **后处理请求：** 在Controller处理完请求，视图还未渲染之前，你可以再搞点事情，比如修改ModelAndView，再次记录一些日志什么的。
 *  **请求完成后处理：** 整个请求处理完成后，无论成功还是失败，你还有机会进行一些资源清理的操作。

### 为什么需要拦截器？ ###

好奇心作祟，你可能想问为啥我们需要拦截器呢？很简单！拦截器的存在使得我们能够在请求的各个时刻灵活地插入自己的逻辑。比如，你可以在用户请求某个路径时，在请求前检查用户的登录状态，或者在请求后记录请求的处理时间。这让我们的应用更加灵活、可控。

### 如何配置拦截器？ ###

配置拦截器其实非常简单。首先，我们需要创建一个类，实现`HandlerInterceptor`接口。这个接口定义了三个方法：`preHandle`、`postHandle`和`afterCompletion`，分别对应请求处理前、请求处理后和请求完成后的时刻。看个简单的例子：

public class MyInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 在请求处理前执行，返回true表示继续执行，返回false中断执行
            // 可以进行身份验证、日志记录等操作
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
            // 在请求处理后但未渲染视图时执行
            // 可以修改ModelAndView，记录日志等操作
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
            // 在请求完成后执行，无论请求成功还是失败都会执行
            // 可以进行资源清理等操作
        }
    }

然后，我们在配置文件（通常是`springmvc-servlet.xml`）中进行配置，将拦截器添加到拦截器链中。比如：

<mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/> 
            <bean class="com.example.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

这样，我们就配置了一个简单的拦截器。当用户请求任何路径时，`MyInterceptor`中的方法就会被调用。

### 拦截器的执行流程 ###

理解拦截器的执行流程对于掌握它的工作原理非常关键。以下是拦截器的基本执行流程：

1.  **DispatcherServlet收到请求：** 当用户发送请求时，DispatcherServlet是第一个感知到的。
2.  **拦截器的preHandle方法：** 在请求进入Controller之前，拦截器的`preHandle`方法会被调用。在这个时刻，我们可以进行一些预处理，比如身份验证、日志记录等。
3.  **Controller处理请求：** 请求通过拦截器后，进入Controller进行处理。
4.  **拦截器的postHandle方法：** 在Controller处理完请求，返回ModelAndView之前，拦截器的`postHandle`方法会被调用。在这个时刻，我们可以修改ModelAndView，记录日志等。
5.  **视图渲染：** ModelAndView包含了Controller处理后的结果，然后进入视图层进行渲染。
6.  **拦截器的afterCompletion方法：** 整个请求处理完成后，无论成功还是失败，拦截器的`afterCompletion`方法都会被调用。在这个时刻，我们可以进行一些资源清理的操作。

### 实战演练 ###

为了更好地理解拦截器，让我们通过一个实际例子来演示。假设我们要在用户请求任何路径时，记录请求的处理时间并打印出来。首先，我们修改拦截器的`postHandle`方法：

@Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
        long startTime = (long) request.getAttribute("startTime");
        long endTime = System.currentTimeMillis();
        long processingTime = endTime - startTime;
        System.out.println("Request processing time: " + processingTime + " ms");
    }

接下来，在`preHandle`方法中记录请求开始时间：

@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
        long startTime = System.currentTimeMillis();
        request.setAttribute("startTime", startTime);
        return true;
    }

这样，每次用户请求进入拦截器时，我们就记录了请求的开始时间。当请求处理完后，`postHandle`方法会被调用，我们计算出请求的处理时间并打印出来。

### 小结 ###

通过这篇博客，我们深入了解了SpringMVC拦截器的原理和用法。拦截器是一个非常灵活的工具，可以在请求的各个时刻插入自定义的逻辑，实现对请求的精细控制。通过实例演示，我们了解了拦截器的配置和执行流程，为使用拦截器提供了一个清晰的指南。希望这篇博客对你理解和使用SpringMVC拦截器有所帮助！如果你有任何问题或建议，欢迎在评论区留言。祝你在编码的路上越走越远，愉快编码！

<table> 
 <tbody> 
  <tr> 
   <td> <strong><font>作者信息</font></strong><br> <br> <font> 作者 ： 繁依Fanyi</font><br> <font>CSDN：</font> <a href="https://blog.csdn.net/qq_21484461?spm=1000.2115.3001.5343" rel="nofollow"><font>https://techfanyi.blog.csdn.net</font></a><br> <font>掘金：</font><a href="https://juejin.cn/user/4154386571867191" rel="nofollow"><font>https://juejin.cn/user/4154386571867191</font></a> </td> 
  </tr> 
 </tbody> 
</table>

[00284c26956d4b778c232f61e9bac424.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/25342ac63ef44347bc54e2db5356bfca.png