SpringBoot拦截器（超简单版）

Maiko Star

已于 2023-08-01 10:33:46 修改

阅读量2k

点赞数 1

分类专栏： SpringBoot 文章标签： spring boot

于 2023-07-25 09:14:21 首次发布

本文链接：https://blog.csdn.net/weixin_55772633/article/details/131909840

版权

SpringBoot 专栏收录该内容

39 篇文章 9 订阅

订阅专栏

文章介绍了如何在SpringBoot应用中创建和注册拦截器，以实现在请求处理前后的定制操作，如登录验证和权限检查。首先，需要创建一个实现HandlerInterceptor接口的拦截器类，然后通过实现WebMvcConfigurer接口并使用addInterceptors方法将其注册。最后，可以使用addPathPatterns配置拦截规则，以控制拦截器作用的请求路径。

摘要由CSDN通过智能技术生成

在Spring Boot中，拦截器（Interceptor）是一种用于在请求处理过程中进行预处理和后处理的机制。Spring Boot的拦截器与Servlet规范中的过滤器（Filter）类似，但提供更丰富的功能和更便捷的使用方式。

要在Spring Boot中使用拦截器，您可以按照以下步骤进行操作：

1.创建一个拦截器类

首先，你需要创建一个实现HandlerInterceptor接口的拦截器类。这个接口定义了在请求处理期间，你可以在请求的不同阶段执行的方法。你可以根据需要实现preHandle（在请求处理之前执行）、postHandle（在请求处理之后执行）、afterCompletion（在渲染视图之后执行）方法。下面是一个简单的拦截器示例：

public class MyInterceptor implements HandlerInterceptor {
    // 在请求处理前执行，返回值表示是否中断请求
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 进行预处理，例如登录验证、权限检查等
        return true; // 返回true表示继续执行请求，返回false表示中断请求
    }

    // 在请求处理后执行，但在视图被渲染之前（Controller方法调用之后）
    @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 {
        // 进行资源清理工作
    }
}

2.注册拦截器

接下来，你需要将拦截器注册到Spring Boot应用程序中。可以通过实现WebMvcConfigurer接口来实现此操作，并在addInterceptors方法中进行注册。下面是一个示例：

记得一定要加@Configuration注解，交由Spring管理。

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 MyInterceptorConfig implements WebMvcConfigurer {

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

3.配置拦截规则

默认情况下，拦截器将应用于所有请求。如果你只想拦截特定的请求路径，你可以使用addPathPatterns方法来配置拦截规则。下面是一个示例：

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new MyInterceptor())
            .addPathPatterns("/api/**"); // 只拦截路径以"/api/"开头的请求
}

以上是使用Spring Boot拦截器的基本步骤。你可以在拦截器中执行自定义的逻辑，例如身份验证、日志记录等。记得在使用拦截器时要小心避免可能的性能问题。