如何通过Spring Cloud Sleuth将更新后的Baggage Key从远程服务回传至调用方

核心思路 #

利用Spring Cloud Sleuth内置的Baggage响应传播机制，通过配置让自定义Baggage Key支持双向（请求+响应）传播，无需手动处理响应头，让Sleuth自动完成B服务更新后的Baggage回传与A服务上下文更新。

步骤实现 #

1. 全局配置自定义Baggage双向传播

在A、B、C三个服务的application.yml（或application.properties）中添加以下配置，指定自定义Baggage Key同时支持请求传播和响应携带：

spring:
  sleuth:
    baggage:
      # 配置请求中需要传播的Baggage Key
      remote-fields: custom-baggage-key
      # 配置响应中需要携带回传的Baggage Key
      response-fields: custom-baggage-key

注：remote-fields确保请求从A→B→C时携带该Baggage；response-fields确保B服务响应时将更新后的Baggage放入响应头。

2. B服务中更新自定义Baggage

通过Sleuth的Tracer组件获取当前Span上下文，直接更新Baggage值，Sleuth会自动将更新后的值写入响应头：

@Service
public class BService {
    private final Tracer tracer;

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

    public String handleRequestFromA() {
        // 可选：从请求上下文获取初始Baggage值
        String initialValue = tracer.currentSpan().context().getBaggage("custom-baggage-key");
        
        // 更新自定义Baggage值
        tracer.currentSpan().context().putBaggage("custom-baggage-key", "updated-by-service-B");
        
        return "processed-by-B";
    }
}

3. A服务自动接收并更新上下文

Sleuth自动为RestTemplate/WebClient注入拦截器，会自动解析B服务响应头中的Baggage字段，并更新A服务当前请求的Span上下文，无需手动处理响应头：

@Service
public class AService {
    private final RestTemplate restTemplate;
    private final Tracer tracer;

    public AService(RestTemplate restTemplate, Tracer tracer) {
        this.restTemplate = restTemplate;
        this.tracer = tracer;
    }

    public void invokeServiceB() {
        // 初始化自定义Baggage
        tracer.currentSpan().context().putBaggage("custom-baggage-key", "initial-from-service-A");
        
        // 调用B服务
        String response = restTemplate.getForObject("http://service-b/handle", String.class);
        
        // 此时当前Span的Baggage已自动更新为B服务返回的值
        String updatedBaggage = tracer.currentSpan().context().getBaggage("custom-baggage-key");
        System.out.println("Updated Baggage: " + updatedBaggage); // 输出: updated-by-service-B
    }
}

关键注意事项 #

• 确保所有涉及的服务都配置了相同的remote-fields和response-fields，否则传播会中断。
• 若使用自定义HTTP客户端（而非RestTemplate/WebClient），需手动集成Sleuth的响应解析逻辑：提取响应头中对应Baggage的字段（默认头格式为baggage: custom-baggage-key=updated-value），然后通过Tracer更新当前Span上下文。
• Sleuth的Baggage响应传播默认基于baggage响应头，无需自定义头名，降低手动维护成本。

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