全面了解SpringBoot拦截器

2023-06-28 21:30:00

在本文中，我们将详细介绍SpringBoot中的拦截器，包括拦截器的概念、作用、实现方式、执行顺序、生命周期以及高级应用。最后，我们还将探讨拦截器的性能优化策略和常见问题。

1. 拦截器的概念和作用

1.1 什么是拦截器

拦截器（Interceptor）是一种特殊的组件，它可以在请求处理的过程中对请求和响应进行拦截和处理。拦截器可以在请求到达目标处理器之前、处理器处理请求之后以及视图渲染之前执行特定的操作。拦截器的主要目的是在不修改原有代码的情况下，实现对请求和响应的统一处理。

1.2 拦截器的作用

拦截器可以用于实现以下功能：

  1. 权限控制：拦截器可以在请求到达处理器之前进行权限验证，从而实现对不同用户的访问控制。
  2. 日志记录：拦截器可以在请求处理过程中记录请求和响应的详细信息，便于后期分析和调试。
  3. 接口幂等性校验：拦截器可以在请求到达处理器之前进行幂等性校验，防止重复提交。
  4. 数据校验：拦截器可以在请求到达处理器之前对请求数据进行校验，确保数据的合法性。
  5. 缓存处理：拦截器可以在请求处理之后对响应数据进行缓存，提高系统性能。

1.3 拦截器与过滤器的区别

拦截器和过滤器都可以实现对请求和响应的拦截和处理，但它们之间存在以下区别：

  1. 执行顺序：过滤器在拦截器之前执行，拦截器在处理器之前执行。
  2. 功能范围：过滤器可以对所有请求进行拦截，而拦截器只能对特定的请求进行拦截。
  3. 生命周期：过滤器由Servlet容器管理，拦截器由Spring容器管理。
  4. 使用场景：过滤器适用于对请求和响应的全局处理，拦截器适用于对特定请求的处理。

2. SpringBoot中的拦截器实现

2.1 实现HandlerInterceptor接口

要在SpringBoot中实现拦截器，首先需要创建一个类并实现HandlerInterceptor接口。HandlerInterceptor接口包含以下三个方法：

  1. preHandle：在请求到达处理器之前执行，可以用于权限验证、数据校验等操作。如果返回true，则继续执行后续操作；如果返回false，则中断请求处理。
  2. postHandle：在处理器处理请求之后执行，可以用于日志记录、缓存处理等操作。
  3. afterCompletion：在视图渲染之前执行，可以用于资源清理等操作。

以下是一个简单的拦截器实现示例：

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("preHandle: " + request.getRequestURI());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        System.out.println("postHandle: " + request.getRequestURI());
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        System.out.println("afterCompletion: " + request.getRequestURI());
    }
}

2.2 注册拦截器到InterceptorRegistry

要让拦截器生效，需要将其注册到InterceptorRegistry中。这可以通过实现WebMvcConfigurer接口并重写addInterceptors方法来实现。以下是一个简单的注册示例：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor());
    }
}

2.3 配置拦截器的拦截规则

在注册拦截器时，可以通过addPathPatterns和excludePathPatterns方法来配置拦截器的拦截规则。addPathPatterns方法用于指定需要拦截的请求路径，excludePathPatterns方法用于指定不需要拦截的请求路径。以下是一个配置示例：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/login", "/register");
    }
}

在上述示例中，我们配置了拦截器拦截所有请求，但排除了登录和注册请求。

3. 拦截器的执行顺序和生命周期

3.1 拦截器的执行顺序

当有多个拦截器时，它们的执行顺序取决于注册顺序。先注册的拦截器先执行，后注册的拦截器后执行。在请求处理过程中，拦截器的preHandle方法按注册顺序执行，而postHandle和afterCompletion方法按注册顺序的逆序执行。

3.2 拦截器的生命周期

拦截器的生命周期由Spring容器管理。当Spring容器启动时，拦截器会被实例化并初始化；当Spring容器关闭时，拦截器会被销毁。

3.3 多个拦截器的执行流程

当有多个拦截器时，它们的执行流程如下：

  1. 执行所有拦截器的preHandle方法，按注册顺序执行。如果某个拦截器的preHandle方法返回false，则中断请求处理，直接执行已执行拦截器的afterCompletion方法。
  2. 执行处理器的处理方法。
  3. 执行所有拦截器的postHandle方法，按注册顺序的逆序执行。
  4. 渲染视图。
  5. 执行所有拦截器的afterCompletion方法，按注册顺序的逆序执行。

4. 拦截器的高级应用

4.1 拦截器实现权限控制

拦截器可以在请求到达处理器之前进行权限验证，从而实现对不同用户的访问控制。以下是一个简单的权限控制示例：

public class AuthInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        HttpSession session = request.getSession();
        User user = (User) session.getAttribute("user");
        if (user == null) {
            response.sendRedirect("/login");
            return false;
        }
        return true;
    }
}

在上述示例中，我们在preHandle方法中检查用户是否已登录，如果未登录，则重定向到登录页面并中断请求处理。

4.2 拦截器实现日志记录

拦截器可以在请求处理过程中记录请求和响应的详细信息，便于后期分析和调试。以下是一个简单的日志记录示例：

public class LogInterceptor implements HandlerInterceptor {

    private static final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        logger.info("Request URI: {}", request.getRequestURI());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        logger.info("Response status: {}", response.getStatus());
    }
}

在上述示例中，我们在preHandle方法中记录请求URI，在postHandle方法中记录响应状态。

4.3 拦截器实现接口幂等性校验

拦截器可以在请求到达处理器之前进行幂等性校验，防止重复提交。以下是一个简单的幂等性校验示例：

public class IdempotentInterceptor implements HandlerInterceptor {

    private static final String IDEMPOTENT_TOKEN = "idempotentToken";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        String token = request.getHeader(IDEMPOTENT_TOKEN);
        if (StringUtils.isEmpty(token)) {
            throw new RuntimeException("Idempotent token is missing");
        }
        if (!checkIdempotentToken(token)) {
            throw new RuntimeException("Duplicate request");
        }
        return true;
    }

    private boolean checkIdempotentToken(String token) {
        // Check the token in the cache or database
        // Return true if the token is valid, false otherwise
    }
}

在上述示例中，我们在preHandle方法中检查请求头中的幂等性令牌，如果令牌无效，则抛出异常并中断请求处理。

5. 拦截器的性能优化和常见问题

5.1 拦截器性能优化策略

拦截器在请求处理过程中可能会影响系统性能，以下是一些性能优化策略：

  1. 减少拦截器数量：尽量将相关功能集中到一个拦截器中，避免创建过多的拦截器。
  2. 精确配置拦截规则：通过addPathPatterns和excludePathPatterns方法精确配置拦截规则，避免不必要的拦截。
  3. 使用异步处理：在拦截器中使用异步处理，避免阻塞请求处理过程。
  4. 使用缓存：在拦截器中使用缓存，减少对数据库或其他资源的访问。

5.2 拦截器的常见问题和解决方案

拦截器是一种用于处理请求和响应的中间件，它可以在请求到达目标处理器之前或响应返回客户端之前执行一些操作。然而，在实际使用过程中，我们可能会遇到一些问题，如拦截器不生效、执行顺序错误或影响性能等。接下来，我们将逐一分析这些问题的原因及解决方法。

  1. 拦截器不生效：拦截器不生效的可能原因有很多，其中最常见的包括拦截器未注册到InterceptorRegistry、拦截规则配置错误等。为了解决这个问题，我们需要首先检查拦截器是否已经正确注册到InterceptorRegistry中，然后再检查拦截规则是否配置正确。如果发现问题，需要及时进行调整和修复。
  2. 拦截器执行顺序错误：拦截器执行顺序错误的主要原因是拦截器的注册顺序错误。在实际应用中，拦截器的执行顺序是根据它们在InterceptorRegistry中的注册顺序来决定的。因此，为了解决这个问题，我们需要调整拦截器在InterceptorRegistry中的注册顺序，确保它们按照预期的顺序执行。
  3. 拦截器影响性能：拦截器影响性能的主要原因是拦截器中的处理逻辑过于复杂或资源消耗过大。为了解决这个问题，我们需要对拦截器的处理逻辑进行优化，尽量减少不必要的计算和资源消耗。同时，我们还可以考虑使用一些性能监控工具，如JProfiler等，来对拦截器的性能进行实时监控和分析，从而找到性能瓶颈并进行优化。

拦截器在实际应用中可能会遇到一些问题，但只要我们能够深入了解其原理和机制，就可以找到合适的解决方案。

总结

本文详细介绍了SpringBoot中的拦截器，包括拦截器的概念、作用、实现方式、执行顺序、生命周期以及高级应用。我们还探讨了拦截器的性能优化策略和常见问题。希望本文能帮助您更好地理解和使用SpringBoot中的拦截器。

更多推荐

内网隧道代理技术（二十七）之 DNS隧道介绍

DNS隧道介绍DNS协议介绍域名系统（DomainNameSystem，缩写：DNS）是互联网的一项服务。它作为将域名和IP地址相互映射的一个分布式数据库，能够使人更方便地访问互联网。DNS使用TCP和UDP端口53。当前，对于每一级域名长度的限制是63个字符，域名总长度则不能超过253个字符。DNS协议是用来将域名转

Linux磁盘挂载及扩容操作

Linux磁盘扩容操作全介绍1.新增磁盘分区后挂载至新建/data目录下1.1新增磁盘打开Vmware右键需要添加磁盘的虚拟机，点击设置，选择磁盘添加即可，这里我新增了一块20G的磁盘在当前虚拟机下；fdisk-l#列出指定的外围设备的分区表状况#列出所有可用块设备的信息，而且还能显示他们之间的依赖关系#可以看到新增磁

2023：生成式AI与存储最新发展和趋势分析（下）

1.存储新发展概述近两年存储领域最大的里程碑事件应该是闪存赢得过半市场，Gartner连续几个季度的市场分析数据中也多次都确认了这一点，固态存储取代机械硬盘的趋势不可逆转。在这一大背景下，有三个新发展方向日益引起更多关注，分别是存储新介质，可计算存储（存算一体）和进一步的极致性能追求。2．介质Intel曾经用傲腾推动了

SpringMVC学习笔记——2

SpringMVC学习笔记——2一、SpringMVC的拦截器1.1、拦截器Interceptor简介1.2、拦截器快速入门1.3、拦截器执行顺序1.4、拦截器执行原理二、SpringMVC的全注解开发2.1、spring-mvc.xml中组件转化为注解形式2.1.1、消除spring-mvc.xml2.1.2、消除w

Kubernetes学习篇之对象

Kubernetes学习篇之对象文章目录Kubernetes学习篇之对象前言期望状态对象规约(spec)对象状态(status)描述对象创建对象字段验证前言对象是k8s系统中持久化的实体，k8s中用这些实体表示系统的状态，该博客是从k8s官网消化吸收后总结提炼的期望状态k8s的对象是你期望k8s达到的状态，k8s会逐渐

《Linux操作系统实战》| 面试了两个实习生，Linux 基本命令都不会（一）

😄作者简介：小曾同学.com,一个致力于测试开发的博主⛽️，主要职责：测试开发、CI/CD如果文章知识点有错误的地方，还请大家指正，让我们一起学习，一起进步。😊座右铭：不想当开发的测试，不是一个好测试✌️。如果感觉博主的文章还不错的话，还请点赞、收藏哦！👍文章目录一、前言二、初识LinuxLinux诞生Linux

数据结构——散列函数、散列表

文章目录前言一、散列表的基本概念二、散列函数的构造方法三、处理冲突的方法1.开放定址法：2.拉链法四、散列查找及性能分析总结前言散列表的基本概念散列函数的构造方法处理冲突的方法散列查找及性能分析提示：以下是本篇文章正文内容，下面案例可供参考一、散列表的基本概念概念：之前的算法建立在“比较”基础上，效率取决于比较次数散列

武汉凯迪正大—继电保护测试仪

一、凯迪正大微机继电保护测试仪产品概述KDJB系列微机继电保护校验仪是在参照电力部颁发的《微机型继电保护试验装置技术条件(讨论稿)》的基础上，听取用户意见，总结目前国内同类产品优缺点，充分使用现代的微电子技术和器件实现的一种小型化微机继电保护测试仪。它采用单机独立运行，亦可联接笔记本电脑运行。主机内置新一代高速数字信号

【zookeeper】基于Linux环境安装zookeeper集群

前提，需要有几台linux机器，我们可以准备好诸如finalshell来连接linux并且上传文件；其次Linux需要安装上ssh，并且在/etc/hosts文件中写好其他几台机器的名字和Ip127.0.0.1localhostlocalhost.localdomainlocalhost4localhost4.loca

ChatGLM 大模型外挂(向量)知识库

前言如果我们想往大模型里边注入知识，最先能想到的就是对大模型进行微调。笔者曾实验过，只用几十万量级的数据对大模型进行微调并不能很好的将额外知识注入大模型，笔者在算力这方面囊中羞涩，只有4块卡，这几十万量级的数据训练6B的模型都要训练好几天。。。如果不微调的话，其实还是可以利用外挂数据库的方式让大模型利用额外的知识的，比

Python案例｜使用卷积网络对星系图片进行分类

星系动物园（galaxyzoo）是由牛津大学等研究机构组织并邀请公众协助的志愿者科学计划，目的是为超过100万个星系图像进行分类。这是天文学中一次规模浩大的公众星空普查活动，大众参与热情高涨，在近十万名志愿者的积极参与下，只用了175天就完成了第一阶段的星系动物园项目：对95万个星系进行了分类，而且平均每个星系被分类了

热文推荐
  1. 前端代码规范

    HTML编码规约(WC-HTML)-HTML编码规约前言本规约涉及HTML语言的编码风格、最佳实践。参与和反馈对规约有任何意见和建议，欢迎留言讨论：）1【推荐】使用2个空格缩进。统一使用2个空格缩进，不要使用4个空格或tab缩进：<!DOCTYPEhtml><html><head><title>Pagetitle</t

  2. Rust中的结构体

    专栏简介：本专栏作为Rust语言的入门级的文章，目的是为了分享关于Rust语言的编程技巧和知识。对于Rust语言，虽然历史没有C++、和python历史悠远，但是它的优点可以说是非常的多，既继承了C++运行速度，还拥有了Java的内存管理，就我个人来说，还有一个优点就是集成化的编译工具cargo，语句风格和C++极其相

  3. rom修改----安卓系列机型如何内置app 如何选择so文件内置

    系统内置app的需求在与各工作室对接中操作单中，很多需要内置客户特定的有些app到系统里，这样方便客户刷入固件后直接调用。例如内置apk去开机引导去usb调试默认开启usb安全设置等等。那么很多app内置有不同的反应。有的可以直接内置。有的需要加so才能解决我们先来看一张图片1---直接内置方法将需要的app直接放置系

  4. 应急响应LINUX&Windows

    应急响应LINUX&Windowslinux文件名说明/etc/passwd用户信息文件/etc/crontab定时任务文件/etc/anacrontab异步定时任务文件/etc/rc.d/rc.local开机启动项/var/log/btmp登录失败日志，使用last命令查看/var/log/cron定时任务执行日志/

  5. 内存管理之虚拟内存

    本篇遵循内存管理->地址空间->虚拟内存的顺序描述了内存管理、地址空间与虚拟内存见的递进关系，较为详细的介绍了作为在校大学生对于虚拟内存的理解。内存管理引入RAM（内存）是计算机中非常重要的资源，由于造价的昂贵，我们家用的计算机一般是8/16G。对于如此紧俏的资源我们当然需要对它好好管理，尽力做到不浪费，高效压榨它的每

  6. 助力工业物联网，工业大数据之服务域：Shell调度测试【三十三】

    文章目录知识点07：Shell调度测试知识点08：依赖调度测试知识点09：Python调度测试知识点10：Oracle与MySQL调度方法知识点11：大数据组件调度方法知识点07：Shell调度测试目标：实现Shell命令的调度测试实施需求：使用BashOperator调度执行一条Linux命令代码创建#默认的Airf

  7. TorchLens--可视化任何PyTorch模型

    0.简介PyTorch是一个深度学习框架，它使用张量（tensor）作为核心数据结构。在可视化PyTorch模型时，了解每个张量运算的意义非常重要。张量运算作为神经网络模型中的基本操作。它们用于处理输入数据、执行权重更新和生成预测结果。同时张量运算还用于计算损失函数。损失函数衡量了模型预测与真实标签之间的差异。通过使用

  8. docker network

    一、默认的三种网络模式：Bridge模式：这是Docker默认创建的网络模式。在Bridge模式下，Docker会为每个容器创建一个虚拟网络接口，并分配独立的IP地址。容器之间可以相互通信，而且可以通过端口映射让容器内部的服务可以通过主机的IP地址和端口进行访问。Host模式：在Host模式下，容器与主机共享同一个网络

  9. 代码随想录算法训练营第46天| 单词拆分，背包问题总结

    139.单词拆分给你一个字符串s和一个字符串列表wordDict作为字典。请你判断是否可以利用字典中出现的单词拼接出s。注意：不要求字典中出现的单词全部都使用，并且字典中的单词可以重复使用。示例1：输入:s=“leetcode”,wordDict=[“leet”,“code”]输出:true解释:返回true因为“le