Spring Boot 拦截器如何创建

在Spring Boot中，拦截器（Interceptor）是一种非常有用的机制，它允许我们在请求到达控制器之前或之后执行一些额外的逻辑。拦截器通常用于处理日志记录、权限验证、请求参数处理等任务。本文将详细介绍如何在Spring Boot中创建和使用拦截器。

1. 拦截器简介

拦截器是Spring MVC框架中的一部分，它允许我们在请求处理的不同阶段插入自定义逻辑。与过滤器（Filter）不同，拦截器是基于Spring的上下文工作的，因此它可以访问Spring的Bean和其他资源。

拦截器的主要方法包括：

• preHandle：在请求处理之前执行。如果返回true，则继续执行后续的拦截器和控制器；如果返回false，则中断请求处理。
• postHandle：在请求处理之后、视图渲染之前执行。
• afterCompletion：在请求完成之后执行，通常用于资源清理。

2. 创建拦截器

要在Spring Boot中创建拦截器，我们需要实现HandlerInterceptor接口，并重写其中的方法。以下是一个简单的拦截器示例：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前执行
        System.out.println("Pre Handle method is Calling");
        return true; // 继续执行后续的拦截器和控制器
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在请求处理之后、视图渲染之前执行
        System.out.println("Post Handle method is Calling");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在请求完成之后执行
        System.out.println("After Completion method is Calling");
    }
}

3. 注册拦截器

创建拦截器后，我们需要将其注册到Spring Boot的配置中。这可以通过实现WebMvcConfigurer接口并重写addInterceptors方法来完成。

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

    @Autowired
    private CustomInterceptor customInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(customInterceptor)
                .addPathPatterns("/**") // 拦截所有路径
                .excludePathPatterns("/public/**"); // 排除特定路径
    }
}

在上面的代码中，我们将CustomInterceptor注册为拦截器，并指定了拦截的路径模式。addPathPatterns方法用于指定需要拦截的路径，而excludePathPatterns方法用于排除不需要拦截的路径。

4. 测试拦截器

完成拦截器的创建和注册后，我们可以启动Spring Boot应用程序并测试拦截器是否正常工作。当访问应用程序的路径时，控制台应该会输出拦截器中定义的消息。

例如，访问/example路径时，控制台可能会输出：

Pre Handle method is Calling
Post Handle method is Calling
After Completion method is Calling

5. 总结

通过本文的介绍，我们了解了如何在Spring Boot中创建和使用拦截器。拦截器是一种强大的工具，可以帮助我们在请求处理的不同阶段插入自定义逻辑。通过合理地使用拦截器，我们可以实现日志记录、权限验证、请求参数处理等功能，从而提高应用程序的灵活性和可维护性。

希望本文对你理解和使用Spring Boot拦截器有所帮助！