Spring OpenFeign如何通过Baggage设置自定义请求头？

问题背景 #

我正在开发一个Spring Boot 3应用，需要调用若干远程HTTP服务。应用内有执行业务逻辑的任务，业务逻辑中包含远程服务调用。我希望关联不同HTTP请求：当业务逻辑处理ID为123456的特定对象时，设置自定义请求头x-object-id，值为123456。业务逻辑不直接与Feign客户端交互，而是通过适配器调用。

已添加的依赖：

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-micrometer</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-tracing</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-tracing-bridge-brave</artifactId>
</dependency>

配置了自定义Baggage字段：

@Bean
BaggageField userIdField() {
    return BaggageField.create("baggage1");
}

测试代码：

try (BaggageInScope scope = this.tracer.createBaggageInScope("baggage1", "value1")) {
    // 在此调用业务逻辑
}

但执行后，Feign客户端并未发送baggage1请求头。请问哪里操作有误？使用Baggage注入Feign自定义请求头是否是正确方式？

问题分析与解决方案 #

1. 核心配置缺失 #

你仅定义了Baggage字段，但未配置Baggage自动注入Feign请求头的规则，也未指定Baggage对应的请求头名称。默认情况下，Micrometer Tracing不会自动将所有Baggage字段转发到Feign请求中。

2. 正确配置步骤 #

步骤1：配置Baggage的请求头映射

通过配置文件或Java Bean，指定Baggage字段对应的请求头名称，同时开启Feign的Baggage传播：

方式一：application.yml配置

micrometer:
  tracing:
    baggage:
      fields: baggage1
      remote-fields: baggage1
      correlation:
        enabled: true
        fields: baggage1
feign:
  micrometer:
    enabled: true

• micrometer.tracing.baggage.fields：声明要跟踪的Baggage字段
• micrometer.tracing.baggage.remote-fields：声明要跨服务传递的Baggage字段（自动映射为请求头）
• feign.micrometer.enabled：开启Feign与Micrometer的集成，确保追踪上下文传递

方式二：Java Bean配置（自定义请求头名称）
如果需要将Baggage映射为你需要的x-object-id请求头，可手动配置BaggagePropagationCustomizer：

@Bean
BaggagePropagationCustomizer baggagePropagationCustomizer() {
    return builder -> builder
            .add(SingleBaggageField.remote(BaggageField.create("baggage1"), "x-object-id"));
}

此配置会自动将baggage1字段注入到Feign请求的x-object-id头中。

步骤2：确保Tracer正确注入

测试代码中使用的tracer必须是Spring容器注入的实例，避免自行实例化。通过构造函数注入：

private final Tracer tracer;

public YourService(Tracer tracer) {
    this.tracer = tracer;
}

步骤3：检查自定义拦截器

若Feign客户端有自定义RequestInterceptor，需确保它不会清除或覆盖Micrometer Tracing添加的请求头。

3. Baggage是否为正确方式 #

是的，Baggage是Spring Boot 3中跨服务传递上下文（如对象ID）的推荐方案之一，它能在追踪上下文中自动传递，无需业务逻辑直接操作Feign客户端，完全适配你的适配器调用场景。

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