Spring Sleuth与JAX-WS SOAP调用的Baggage传播指南

sleuth:
  async:
    enabled: true
  baggage:
    remote-fields:
      - Caller-Id

Request headers: {Accept=[application/json; distances], Authorization=[Bearer ...], X-B3-TraceId=[...], X-B3-SpanId=[...], X-B3-Sampled=[1], caller-id=[value]}

SOAP Headers - {Authorization=[Bearer...]}

import brave.baggage.BaggageField;
import javax.xml.namespace.QName;
import javax.xml.soap.SOAPEnvelope;
import javax.xml.soap.SOAPHeader;
import javax.xml.soap.SOAPHeaderElement;
import javax.xml.soap.SOAPMessage;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;
import java.util.Collections;
import java.util.Set;

/**
 * 自定义SOAP处理器，用于将Spring Sleuth的Baggage字段注入到SOAP消息头中。
 */
public class SleuthBaggageSOAPClientHandler implements SOAPHandler<SOAPMessageContext> {

    // 定义要传播的Baggage字段名称
    private static final String CALLER_ID_FIELD_NAME = "Caller-Id";
    // 定义SOAP头元素的命名空间，根据实际需求调整
    private static final String SOAP_HEADER_NAMESPACE_URI = "http://your.service.namespace/headers";
    private static final String SOAP_HEADER_PREFIX = "hdr"; // 可选前缀

    @Override
    public Set<QName> getHeaders() {
        // 声明此Handler可能处理或添加的SOAP头QName
        return Collections.singleton(new QName(SOAP_HEADER_NAMESPACE_URI, CALLER_ID_FIELD_NAME));
    }

    @Override
    public boolean handleMessage(SOAPMessageContext context) {
        Boolean outboundProperty = (Boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);

        if (outboundProperty) { // 仅处理出站消息（客户端发出的请求）
            try {
                SOAPMessage soapMessage = context.getMessage();
                SOAPEnvelope soapEnvelope = soapMessage.getSOAPPart().getEnvelope();
                SOAPHeader soapHeader = soapEnvelope.getHeader();

                // 如果SOAP头不存在，则创建
                if (soapHeader == null) {
                    soapHeader = soapEnvelope.addHeader();
                }

                // 从Sleuth的当前追踪上下文中获取Caller-Id Baggage字段的值
                // BaggageField.getByName()会从当前TraceContext中查找字段
                String callerIdValue = BaggageField.getByName(CALLER_ID_FIELD_NAME).value();

                if (callerIdValue != null && !callerIdValue.isEmpty()) {
                    // 创建SOAP头元素并设置值
                    QName callerIdQName = new QName(SOAP_HEADER_NAMESPACE_URI, CALLER_ID_FIELD_NAME, SOAP_HEADER_PREFIX);
                    SOAPHeaderElement headerElement = soapHeader.addHeaderElement(callerIdQName);
                    headerElement.setValue(callerIdValue);
                    System.out.println("SleuthBaggageSOAPClientHandler: Added Caller-Id to SOAP header: " + callerIdValue);
                } else {
                    System.out.println("SleuthBaggageSOAPClientHandler: Caller-Id baggage field is null or empty, not added to SOAP header.");
                }

                // 保存对SOAP消息的更改
                soapMessage.saveChanges();

            } catch (Exception e) {
                System.err.println("Error in SleuthBaggageSOAPClientHandler while adding baggage: " + e.getMessage());
                // 根据需要决定是否抛出异常或继续处理
                return false; // 阻止消息继续处理
            }
        }
        return true; // 允许消息继续处理
    }

    @Override
    public boolean handleFault(SOAPMessageContext context) {
        // 错误处理逻辑（可选）
        return true;
    }

    @Override
    public void close(MessageContext context) {
        // 清理资源（可选）
    }
}

import javax.xml.ws.BindingProvider;
import javax.xml.ws.handler.Handler;
import java.util.ArrayList;
import java.util.List;

// 假设这是你的JAX-WS服务接口和实现
// import com.example.soap.YourSoapService;
// import com.example.soap.YourSoapPort;

public class SoapClientConfig {

    public YourSoapPort createSoapClient() {
        // 1. 创建JAX-WS服务和端口实例
        YourSoapService service = new YourSoapService(); // 替换为你的服务类
        YourSoapPort port = service.getYourSoapPort();   // 替换为你的端口类

        // 2. 获取客户端代理的BindingProvider
        BindingProvider bindingProvider = (BindingProvider) port;

        // 3. 获取当前的Handler链
        List<Handler> handlerChain = bindingProvider.getBinding().getHandlerChain();
        if (handlerChain == null) {
            handlerChain = new ArrayList<>();
        }

        // 4. 将自定义的SleuthBaggageSOAPClientHandler添加到Handler链中
        handlerChain.add(new SleuthBaggageSOAPClientHandler());

        // 5. 设置更新后的Handler链
        bindingProvider.getBinding().setHandlerChain(handlerChain);

        // 可选：设置SOAP服务的endpoint地址
        // bindingProvider.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:8080/your/soap/service");

        return port;
    }

    // 示例使用
    public static void main(String[] args) {
        SoapClientConfig config = new SoapClientConfig();
        YourSoapPort client = config.createSoapClient();
        // 现在，当通过client调用SOAP方法时，Sleuth Baggage将自动注入
        // client.someSoapOperation("data");
    }
}