Spring Boot 2.7.x中为WebTestClient添加默认请求头失败求助

你的两种配置方式未生效，核心原因是WebTestClient的构建方式与集成测试场景不匹配，或配置未被正确加载，以下是针对性解决方案：

一、先排查基础问题 #

• 确保测试类通过@Import(WebTestClientConfig.class)或@SpringBootTest(classes = {你的主启动类.class, WebTestClientConfig.class})加载了配置类。
• 测试类中不要手动创建WebTestClient实例，必须通过@Autowired注入配置好的Bean。
• 确认API_KEY_HEADER和API_KEY_VALUE是已正确定义的常量，无拼写错误。

二、方案1：使用Spring Boot自动配置的WebTestClient（推荐） #

WebTestClientBuilderCustomizer用于定制Spring Boot自动生成的WebTestClient.Builder，配置正确时，自动注入的WebTestClient会携带默认头。

配置类（无需修改原Customizer代码，确保测试类加载即可） #

@TestConfiguration
public class WebTestClientConfig {
    private static final String API_KEY_HEADER = "X-API-KEY";
    private static final String API_KEY_VALUE = "test-key-123";

    @Bean
    public WebTestClientBuilderCustomizer webTestClientBuilderCustomizer() {
        return builder -> builder.defaultHeader(API_KEY_HEADER, API_KEY_VALUE);
    }
}

测试类示例 #

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@Import(WebTestClientConfig.class)
public class YourIntegrationTest {

    @Autowired
    private WebTestClient webTestClient;

    @Test
    void testApiWithDefaultHeader() {
        webTestClient.get()
                .uri("/your-api-path")
                .exchange()
                .expectStatus().isOk();
        // 请求已自动携带X-API-KEY头
    }
}

三、方案2：自定义绑定到当前应用的WebTestClient Bean #

你之前用bindToServer()是连接外部服务器的逻辑，集成测试需绑定到当前Spring应用上下文，修改Bean构建方式：

修改配置类 #

@TestConfiguration
public class WebTestClientConfig {
    private static final String API_KEY_HEADER = "X-API-KEY";
    private static final String API_KEY_VALUE = "test-key-123";

    @Bean
    public WebTestClient webTestClient(ApplicationContext context) {
        return WebTestClient.bindToApplicationContext(context)
                .responseTimeout(Duration.ofMinutes(2))
                .defaultHeader(API_KEY_HEADER, API_KEY_VALUE)
                .exchangeStrategies(ExchangeStrategies.withDefaults())
                .build();
    }
}

测试类注入使用 #

@SpringBootTest
@Import(WebTestClientConfig.class)
public class YourIntegrationTest {

    @Autowired
    private WebTestClient webTestClient;

    @Test
    void testApiWithDefaultHeader() {
        webTestClient.post()
                .uri("/your-post-api")
                .bodyValue(new YourRequest())
                .exchange()
                .expectStatus().isCreated();
    }
}

四、切片测试场景（如@WebFluxTest） #

如果使用@WebFluxTest这类切片测试，同样可通过WebTestClientBuilderCustomizer实现，只需确保配置类被加载：

@WebFluxTest(YourController.class)
@Import(WebTestClientConfig.class)
public class YourControllerTest {

    @Autowired
    private WebTestClient webTestClient;

    // 测试方法...
}

内容的提问来源于stack exchange，提问作者Ben