Java实战：Spring Boot实现自定义拦截器Interceptor

本文将详细介绍如何在Spring Boot应用程序中实现自定义拦截器（Interceptor），以拦截和处理HTTP请求。我们将探讨Spring Boot集成拦截器的基本概念，以及如何使用Spring Boot实现拦截器。最后，我们将通过一个具体示例来演示整个实现过程。本文适合已经具备Spring Boot基础知识的开发者阅读，以加深对Spring Boot中拦截器实现的理解。

一、引言

在开发Web应用程序时，拦截器（Interceptor）是一个非常有用的工具，它可以用于拦截和处理HTTP请求。拦截器可以用于多种场景，例如权限验证、日志记录、事务管理等。Spring Boot为我们提供了一种简便的方式来集成拦截器。本文将介绍如何在Spring Boot应用程序中实现自定义拦截器，并通过具体示例来演示这一过程。

二、Spring Boot集成拦截器的基本概念

1. 什么是拦截器？
拦截器是一种用于拦截和处理HTTP请求的组件。它可以在请求到达目标Controller之前或之后进行处理，从而实现一些额外的功能。拦截器通常用于实现权限验证、日志记录、事务管理等。
2. 如何在Spring Boot中集成拦截器？
在Spring Boot中，我们可以通过创建一个实现HandlerInterceptor接口的类来实现拦截器。这个类需要实现三个方法：preHandle()、postHandle()和afterCompletion()。此外，我们还需要将拦截器注册到Spring MVC的拦截器链中。

三、Spring Boot实现自定义拦截器

1. 创建拦截器类
创建一个实现HandlerInterceptor接口的类，用于实现自定义拦截器。以下是一个简单的拦截器类示例：

package com.example.demo.interceptor;
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 {
        System.out.println("Before handler: " + request.getRequestURI());
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("After handler, before view: " + modelAndView);
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("After view: " + ex);
    }
}

在上面的代码中，我们定义了三个方法：preHandle()、postHandle()和afterCompletion()。这些方法将在请求的不同阶段被调用。preHandle()方法在请求到达目标Controller之前被调用，postHandle()方法在请求到达目标Controller之后、渲染视图之前被调用，afterCompletion()方法在渲染视图之后被调用。
2. 注册拦截器
要使拦截器生效，我们需要将其注册到Spring MVC的拦截器链中。这可以通过实现WebMvcConfigurer接口并重写addInterceptors()方法来实现。以下是一个注册拦截器的示例：

package com.example.demo.config;
import com.example.demo.interceptor.MyInterceptor;
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 {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**") // 添加拦截路径
                .excludePathPatterns("/error", "/login"); // 排除拦截路径
    }
}

    .addPathPatterns("/**") // 添加拦截路径
    .excludePathPatterns("/error", "/login"); // 排除拦截路径
}

在上面的代码中，我们通过addInterceptors()方法向拦截器链中添加了自定义拦截器。我们还指定了拦截器和排除拦截的路径。通过这种方式，我们的拦截器将拦截所有请求（/**），但会排除/error和/login这两个路径。

四、具体示例

现在，我们将通过一个具体示例来演示如何在Spring Boot应用程序中实现自定义拦截器。
1. 创建Spring Boot项目
首先，我们需要创建一个Spring Boot项目。在创建项目时，选择相应的项目模板和依赖。本文以Maven项目为例，添加以下依赖：

<dependencies>
    <!-- Spring Boot Web依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

2. 创建拦截器类
在src/main/java/com/example/demo/interceptor目录下，创建一个名为MyInterceptor.java的文件，用于实现自定义拦截器：

package com.example.demo.interceptor;
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 {
        System.out.println("Before handler: " + request.getRequestURI());
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("After handler, before view: " + modelAndView);
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("After view: " + ex);
    }
}

3. 创建拦截器配置类
在src/main/java/com/example/demo/config目录下，创建一个名为WebMvcConfig.java的文件，用于注册拦截器：

package com.example.demo.config;
import com.example.demo.interceptor.MyInterceptor;
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 {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**") // 添加拦截路径
                .excludePathPatterns("/error", "/login"); // 排除拦截路径
    }
}

4. 创建Controller类
在src/main/java/com/example/demo/controller目录下，创建一个名为HelloController.java的文件，用于测试拦截器：

package com.example.demo.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

5. 运行项目
将以上代码添加到我们的Spring Boot项目中，并运行项目。我们可以使用浏览器或Postman等工具访问http://localhost:8080/hello，观察拦截器的打印输出。

五、总结

本文详细介绍了如何在Spring Boot应用程序中实现自定义拦截器，以及如何将其注册到Spring MVC的拦截器链中。我们首先了解了Spring Boot集成拦截器的基本概念，然后学习了如何使用Spring Boot实现拦截器。通过一个具体示例，我们展示了如何创建一个自定义拦截器，并将其注册到Spring Boot应用程序中。
通过本文，您应该已经掌握了如何在Spring Boot中实现自定义拦截器，以及如何使用拦截器来拦截和处理HTTP请求。这种方法不仅代码简洁，而且易于维护和扩展。希望本文能够帮助您在开发Spring Boot应用程序时更加得心应手。如果您有任何疑问或建议，请随时留言交流。