0

0

Spring Sleuth 在 SOAP 客户端调用中传播自定义追踪字段的策略

霞舞

霞舞

发布时间:2025-09-23 16:58:01

|

951人浏览过

|

来源于php中文网

原创

Spring Sleuth 在 SOAP 客户端调用中传播自定义追踪字段的策略

本文深入探讨 Spring Sleuth 在分布式追踪中对不同客户端的头传播机制。Sleuth 为 RestTemplate、WebClient 和 Feign 等 REST 客户端提供自动追踪上下文和自定义行李字段传播。但对于 JAX-WS SOAP 客户端,如 jaxws-spring,需要手动配置。教程将指导您如何通过自定义 SOAP 处理器,将 Sleuth 的追踪信息和行李字段注入 SOAP 请求的 HTTP 头中,确保完整的端到端追踪。

1. Spring Sleuth 的自动传播机制

spring cloud sleuth 旨在为 spring 应用程序提供分布式追踪能力,通过集成 openzipkin brave 实现。它能够自动将追踪上下文(trace id、span id、sampled 状态)以及配置的自定义行李字段(baggage fields)传播到下游服务,从而构建完整的调用链。

Sleuth 提供了对多种主流 HTTP 客户端的开箱即用支持,包括:

  • RestTemplate: Spring 提供的同步 HTTP 客户端。
  • WebClient: Spring WebFlux 提供的响应式 HTTP 客户端。
  • Feign: 声明式 REST 客户端,广泛用于微服务间调用。

当应用程序使用这些客户端发起外部调用时,Sleuth 会自动拦截请求,并将 X-B3-TraceId、X-B3-SpanId、X-B3-Sampled 等标准追踪头以及在 sleuth.baggage.remote-fields 中配置的自定义字段(例如 Caller-Id)注入到 HTTP 请求头中。

示例 Sleuth 配置:

spring:
  sleuth:
    async:
      enabled: true # 启用异步操作的追踪上下文传播
    baggage:
      remote-fields: # 定义需要远程传播的自定义字段
        - Caller-Id

对于 RESTful 调用,如使用 Feign 客户端,上述配置能够确保 Caller-Id 等自定义字段被正确传播:

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

2. SOAP 客户端面临的挑战

尽管 Sleuth 对 REST 客户端提供了强大的支持,但对于非标准或非主流的 HTTP 客户端,其自动传播机制可能不会生效。具体到 JAX-WS SOAP 客户端,特别是结合 jaxws-spring 库使用时,我们发现 Sleuth 无法自动将追踪上下文和自定义行李字段注入到 SOAP 调用的 HTTP 请求头中。

例如,一个典型的 SOAP 客户端调用,其 HTTP 头可能仅包含 Authorization 等基本信息,而缺少 Sleuth 相关的追踪头和自定义行李字段:

Cardify卡片工坊
Cardify卡片工坊

使用Markdown一键生成精美的小红书知识卡片

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

这是因为 jaxws-spring 及其底层使用的 HTTP 客户端(通常是 JDK 提供的 HttpURLConnection 或其他自定义实现)并未被 Sleuth 默认的自动配置所覆盖。因此,需要我们手动介入,在 SOAP 消息发送前,将 Sleuth 的追踪信息和行李字段注入到请求中。

3. 解决方案:通过 JAX-WS SOAP 处理器手动注入

为了解决 SOAP 客户端无法自动传播 Sleuth 追踪信息的问题,我们可以利用 JAX-WS 提供的 SOAPHandler 扩展点。SOAPHandler 允许我们在 SOAP 消息发送和接收的各个阶段进行拦截和修改。

3.1 实现自定义 SOAPHandler

我们需要创建一个实现了 javax.xml.ws.handler.soap.SOAPHandler<SOAPMessageContext> 接口的类。在这个处理器中,我们将:

  1. 获取当前的 Sleuth Tracer 实例。
  2. 从 Tracer 中获取当前的追踪上下文(Trace ID 和 Span ID)。
  3. 从 Baggage.current() 中获取所有活跃的自定义行李字段。
  4. 将这些信息作为 HTTP 请求头注入到传出的 SOAP 消息中。
import org.springframework.cloud.sleuth.Tracer;
import org.springframework.cloud.sleuth.CurrentTraceContext;
import org.springframework.cloud.sleuth.Baggage; // 用于获取当前行李字段

import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Collections;
import java.util.Set;
import javax.xml.namespace.QName;

/**
 * SleuthSoapClientHandler 是一个 JAX-WS SOAP 处理器,用于在出站 SOAP 消息中注入 Sleuth 追踪信息和自定义行李字段。
 */
public class SleuthSoapClientHandler implements SOAPHandler<SOAPMessageContext> {

    private final Tracer tracer;

    /**
     * 构造函数,通过 Spring 注入 Tracer 实例。
     * @param tracer Spring Cloud Sleuth 的 Tracer 实例。
     */
    public SleuthSoapClientHandler(Tracer tracer) {
        this.tracer = tracer;
    }

    @Override
    public boolean handleMessage(SOAPMessageContext context) {
        // 判断消息是否是出站消息(即客户端发往服务端的请求)
        Boolean outboundProperty = (Boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);

        if (outboundProperty != null && outboundProperty) { // 如果是出站消息
            // 获取或创建 HTTP 请求头 Map
            Map<String, List<String>> httpHeaders = (Map<String, List<String>>) context.get(MessageContext.HTTP_REQUEST_HEADERS);
            if (httpHeaders == null) {
                httpHeaders = new HashMap<>();
                context.put(MessageContext.HTTP_REQUEST_HEADERS, httpHeaders);
            }

            // 1. 注入 Sleuth 追踪 ID (X-B3-TraceId, X-B3-SpanId, X-B3-Sampled)
            CurrentTraceContext currentTraceContext = tracer.currentTraceContext();
            if (currentTraceContext != null && currentTraceContext.context() != null) {
                String traceId = currentTraceContext.context().traceId();
                String spanId = currentTraceContext.context().spanId();
                httpHeaders.put("X-B3-TraceId", Collections.singletonList(traceId));
                httpHeaders.put("X-B3-SpanId", Collections.singletonList(spanId));
                httpHeaders.put("X-B3-Sampled", Collections.singletonList("1")); // 假设已采样
            }

            // 2. 注入自定义行李字段 (Baggage Fields)
            // 遍历所有当前活跃的行李字段,并将其值作为 HTTP 头注入
            Baggage.current().getAllFields().forEach(baggageField -> {
                if (baggageField.value() != null) {
                    // Sleuth 行李字段通常以其名称作为 HTTP 头名称进行传播
                    httpHeaders.put(baggageField.name(), Collections.singletonList(baggageField.value()));
                }
            });
            // 如果只需要注入特定的行李字段,可以这样获取:
            // BaggageField callerIdField = Baggage.current().getBaggage("Caller-Id");
            // if (callerIdField != null && callerIdField.value() != null) {
            //     httpHeaders.put("Caller-Id", Collections.singletonList(callerIdField.value()));
            // }
        }
        return true; // 继续处理消息
    }

    @Override
    public boolean handleFault(SOAPMessageContext context) {
        // 处理故障消息(如果需要),这里简单返回 true
        return true;
    }

    @Override
    public void close(MessageContext context) {
        // 资源清理(如果需要)
    }

    @Override
    public Set<QName> getHeaders() {
        // 此处理器不处理特定的 SOAP 头,只处理 HTTP 头,因此返回 null
        return null;
    }
}

3.2 配置 SOAPHandler 到 JAX-WS 客户端

在使用 jaxws-spring 配置 SOAP 客户端时,可以通过 JaxWsPortProxyFactoryBean 的 handlers 属性来注册自定义的 SOAPHandler。

Java 配置示例:

import com.example.MyWebService; // 替换为你的 WebService 接口
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.remoting.jaxws.JaxWsPortProxyFactoryBean;
import org.springframework.cloud.sleuth.Tracer;

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

@Configuration
public class SoapClientConfig {

    @Autowired
    private Tracer tracer; // Spring Boot 会自动注入 Sleuth 的 Tracer 实例

    @Bean
    public MyWebService myWebService() {
        JaxWsPortProxyFactoryBean factory = new JaxWsPortProxyFactoryBean();

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

161

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

89

2026.01.26

PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

179

2025.11.26

什么是分布式
什么是分布式

分布式是一种计算和数据处理的方式,将计算任务或数据分散到多个计算机或节点中进行处理。本专题为大家提供分布式相关的文章、下载、课程内容,供大家免费下载体验。

411

2023.08.11

分布式和微服务的区别
分布式和微服务的区别

分布式和微服务的区别在定义和概念、设计思想、粒度和复杂性、服务边界和自治性、技术栈和部署方式等。本专题为大家提供分布式和微服务相关的文章、下载、课程内容,供大家免费下载体验。

251

2023.10.07

Java 微服务与 Spring Cloud 实战
Java 微服务与 Spring Cloud 实战

本专题讲解 Java 微服务架构的开发与实践,重点使用 Spring Cloud 实现服务注册与发现、负载均衡、熔断与限流、分布式配置管理、API Gateway 和消息队列。通过实际项目案例,帮助开发者理解 如何将传统单体应用拆分为高可用、可扩展的微服务架构,并有效管理和调度分布式系统中的各个组件。

51

2026.02.05

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1949

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2119

2024.08.01

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.4万人学习

Java 教程
Java 教程

共578课时 | 82.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号