spring 微服务项目如何自定义拦截器

在Spring微服务项目中，自定义拦截器主要涉及到实现HandlerInterceptor接口或继承WebMvcConfigurerAdapter类（Spring 5.0前）或实现WebMvcConfigurer接口（Spring 5.0及以后）。自定义拦截器主要用于在请求处理之前、之后以及完成后执行特定的操作、例如身份验证、日志记录、权限检查等。在这些操作中，实现HandlerInterceptor接口是最常见且灵活的方法。

接下来，我将重点描述实现HandlerInterceptor接口的过程，这是自定义拦截器中的核心步骤。实现HandlerInterceptor接口需要覆盖三个方法：preHandle()、postHandle()和afterCompletion()。preHandle()方法在控制器处理请求之前调用，可用于进行身份验证等前置处理。如果此方法返回true，则继续向后执行；返回false时，则中断执行，不会调用后续的拦截器和控制器。postHandle()方法在控制器处理请求之后，但在视图被渲染之前调用，可进行一些后处理操作。afterCompletion()方法在整个请求结束之后调用，即在视图渲染之后，可用来进行资源清理等操作。

一、创建拦截器类

首先，需要创建一个类来实现HandlerInterceptor接口。在这个类中，通过覆盖preHandle、postHandle和afterCompletion方法，可以定义在请求处理的不同阶段需要执行的操作。

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在controller执行前调用
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在controller执行后但渲染视图前调用
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在视图渲染后调用
    }
}

二、注册拦截器

实现了HandlerInterceptor接口后，接下来需要在Spring的配置中注册这个拦截器。在Spring Boot中，可以通过实现WebMvcConfigurer接口的方式来添加自定义的拦截器。

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private MyInterceptor myInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/"); // 添加自定义拦截器并设置拦截路径
    }
}

三、拦截器的高级应用

除了基本的请求处理之外，自定义拦截器同时也是实现跨域资源共享（CORS）、请求限流、服务降级等高级功能的有效手段。

跨域资源共享（CORS）

在preHandle方法中设置响应头，添加允许跨域的设置。这样，前端应用即可从不同的源访问后端服务。

请求限流

通过维护一个计数器或使用令牌桶、漏斗算法，可以在preHandle方法中进行请求限流，保护服务免受恶意访问。

四、拦截器与过滤器的区别

虽然拦截器和过滤器在功能上有相似之处，但它们存在显著的差异。拦截器是Spring框架的一部分，依赖于Spring的上下文，能够深度集成Spring的特性，如依赖注入等。而过滤器是基于Servlet规范的，适用于任何Java web应用。

自定义拦截器是Spring微服务项目很常见的需求，通过精心设计拦截器，不仅能提高服务的安全性与效率，还能为后续的功能拓展奠定坚实的基础。

相关问答FAQs：

1. 如何在Spring微服务项目中添加自定义拦截器？
添加自定义拦截器可以通过实现HandlerInterceptor接口来实现。首先，创建一个类，实现HandlerInterceptor接口并重写其中的方法。然后，在Spring Boot的配置类中，通过继承WebMvcConfigurerAdapter类并重写addInterceptors方法来注册自定义拦截器。

2. 自定义拦截器可以在微服务项目中起到什么作用？
自定义拦截器能够在请求之前或之后对请求进行拦截和处理。它可以用于验证用户身份、进行日志记录、计算请求执行时间等操作。通过使用自定义拦截器，可以实现对请求的统一处理，提高代码的复用性和可维护性。

3. 如何在自定义拦截器中传递数据给Controller层？
在自定义拦截器中，可以通过将数据存储到HttpServletRequest对象的Attribute中，在Controller层中通过注解的方式获取数据。另外，也可以通过自定义注解，在拦截器中获取注解的值，并将其作为参数传递给Controller层的方法。这样可以实现将数据从拦截器传递到Controller层的目的。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。