SkyWalking 源码分析 —— @Trace 注解想要追踪的任何方法

最新推荐文章于 2025-04-05 11:47:53 发布

weixin_42073629

最新推荐文章于 2025-04-05 11:47:53 发布

阅读量4.8k

点赞数

分类专栏： SkyWalking 链路追踪

本文链接：https://blog.csdn.net/weixin_42073629/article/details/119703770

版权

链路追踪同时被 2 个专栏收录

40 篇文章

订阅专栏

SkyWalking

32 篇文章

订阅专栏

本文深入探讨了SkyWalking的@Trace注解，用于追踪方法的执行。通过引入SkyWalking APM工具包，可以在SpringMVC中轻松添加注解以创建LocalSpan，并设置标签和获取全局追踪ID。实现部分涉及TraceAnnotationActivation、ActiveSpanTagActivation和TraceContextActivation三个激活类，分别处理方法切面、添加标签和获取全局追踪ID的操作。这些激活类通过拦截器实现方法的增强，确保SkyWalking能够捕获和展示详细的追踪信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. 概述

本文主要分享 @Trace 注解想要追踪的任何方法。

我们首先看看 @Trace 的使用例子，再看看 @Trace 的实现代码。涉及代码如下：

2. 使用例子

本节参考官方文档：Application-toolkit-trace-CN.md

1、使用 Maven 引入相应的工具包

<dependency>
    <groupId>org.skywalking</groupId>
    <artifactId>apm-toolkit-trace</artifactId>
    <version>${skywalking.version}</version>
</dependency>

2、在任何想要追踪的方法上添加 @Trace 注解，以 SpringMVC 为例子：

@Trace
@GetMapping("/log")
public String log() {
    ActiveSpan.tag("mp", "芋道源码");
    System.out.println("traceId：" + TraceContext.traceId());
    return "log";
}

@Trace 注解的方法，会创建一个 LocalSpan 。
ActiveSpan#tag(key, value) 方法，在 LocalSpan 上添加标签键值对。
TraceContext.traceId#traceId 方法，获得全局链路追踪编号。

3、执行后，我们看来看看 SkyWalking WEBUI 的展示。

3. 实现代码

友情提示：本小节需要胖友阅读过《SkyWalking 源码分析 —— Agent 插件体系》。

3.1 TraceAnnotationActivation

org.skywalking.apm.toolkit.activation.trace.TraceAnnotationActivation ，实现 ClassInstanceMethodsEnhancePluginDefine 抽象类，定义了方法切面，代码如下：

org.skywalking.apm.toolkit.activation.trace.TraceAnnotationMethodInterceptor ，实现 InstanceMethodsAroundInterceptor 接口，TraceAnnotationActivation 的拦截器。代码如下：

#beforeMethod(...) 方法，创建 LocalSpan 对象。代码如下：
- 第 42 至 46 行：获得操作名。若 @Trace#operationName() 非空，作为操作名。否则，调用 #generateOperationName(Method) 方法，使用方法签名。
- 第 49 行：调用 ContextManager#createLocalSpan(operationName) 方法，创建 LocalSpan 对象。
#afterMethod(...) 方法，调用 ContextManager#stopSpan() 方法，完成 LocalSpan 对象。
#handleMethodException(...) 方法，发生异常时，打印错误日志。