Java Spring Boot 中的拦截器自定义与响应头添加详解

在开发Java Web应用时，我们经常需要对HTTP请求和响应进行一些预处理和后处理，比如添加安全响应头以增强应用的安全性。Spring Boot提供了强大的拦截器机制，允许我们在请求处理的不同阶段插入自定义逻辑。本文将详细介绍如何在Spring Boot应用中自定义拦截器以及如何通过拦截器添加响应头。

自定义拦截器的基本概念

在Spring MVC中，HandlerInterceptor接口定义了拦截器的基本行为。实现该接口的类可以介入到请求处理的不同阶段：

preHandle(): 请求进入Controller之前调用。 postHandle(): 请求进入Controller之后，视图渲染之前调用。 afterCompletion(): 请求完成，视图渲染之后调用。

实现自定义拦截器

下面是一个自定义拦截器的示例代码：

import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在这里添加你的逻辑，例如添加响应头
        response.setHeader("XFrameOptions", "SAMEORIGIN");
        response.setHeader("RefererPolicy", "origin");
        response.setHeader("ContentSecurityPolicy", "objectsrc 'self'");
        // ... 其他响应头
        return true; // 返回true继续流程，返回false中断请求
    }

    // 可以重写其他方法，如postHandle和afterCompletion
}

配置拦截器

为了使自定义拦截器生效，我们需要在Spring Boot应用中注册它。这可以通过实现WebMvcConfigurer接口来完成。

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 {

    private final CustomInterceptor customInterceptor;

    public WebConfig(CustomInterceptor customInterceptor) {
        this.customInterceptor = customInterceptor;
    }

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

对比添加响应头的两种方式

有时，我们可能需要在多个地方添加相同的响应头。下面是两种常见的添加响应头的方式对比：

流程和步骤

使用拦截器添加响应头的流程和步骤如下：

多个拦截器的管理

如果应用中需要使用多个拦截器，可以通过InterceptorRegistry来管理它们。以下是多个拦截器的配置示例：

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(firstInterceptor);
    registry.addInterceptor(secondInterceptor)
            .addPathPatterns("/") // 指定拦截器生效的路径
            .excludePathPatterns("/css/", "/js/"); // 指定不拦截的路径
    // ... 配置其他拦截器
}

通过自定义拦截器，我们可以在Spring Boot应用中轻松地添加和管理响应头，从而提高应用的安全性和可维护性。拦截器机制的灵活性也使得我们可以在不同的请求处理阶段插入自定义逻辑，满足各种复杂的业务需求。