链路追踪 SkyWalking 源码分析 —— Agent 插件体系

Skywalking系列学习之agent收集trace数据 在上篇文章《SkyWalking系列学习之环境搭建以及分析如何类增强》中已经知道业务系统通过-javaagent引入代理,通过ByteBuddy对指定的类做增强处理。下面介绍Skywalking-Java怎样收集trace数据 在执行业务方法前, 1.1 创建TracingContext,并初始化segment属性 1.2 创建EntrySpan,放入activeSpanStack有序队列中。 业务方法内执行http远程请求前,创建ExitSpan,放入activeSpanStack有序队列中。执行完后从 阅读详情

点击上方“芋道源码”,选择“设为星标”

做积极的人,而不是积极废人!

源码精品专栏

 

摘要: 原创出处 http://www.iocoder.cn/SkyWalking/agent-plugin-system/ 「芋道源码」欢迎转载,保留摘要,谢谢!

本文主要基于 SkyWalking 3.2.6 正式版

  • 1. 概述

  • 2. 插件的加载

  • 3. 插件的匹配

  • 4. 插件的拦截


1. 概述

本文主要分享 SkyWalking Agent 插件体系。主要涉及三个流程 :

  • 插件的加载

  • 插件的匹配

  • 插件的拦截

可能看起来有点抽象,不太容易理解。淡定,我们每个小章节进行解析。

本文涉及到的类主要在 org.skywalking.apm.agent.core.plugin 包里,如下图所示 :

每个流程会涉及到较多的类,我们会贯穿着解析代码实现。

2. 插件的加载

在 《SkyWalking 源码分析 —— Agent 初始化》 一文中,Agent 初始化时,调用 PluginBootstrap#loadPlugins() 方法,加载所有的插件。整体流程如下图 :

PluginBootstrap#loadPlugins() 方法,代码如下 :

  • 第 47 行 :调用 AgentClassLoader#initDefaultLoader() 方法,初始化 AgentClassLoader 。在本文 「2.1 AgentClassLoader」 详细解析。

  • 第 50 至 56 行 :获得插件定义路径数组。在本文 「2.2 PluginResourcesResolver」 详细解析。

  • 第 59 至 66 行 :获得插件定义( `org.skywalking.apm.agent.core.plugin.PluginDefine` )数组。在本文 「2.3 PluginCfg」 详细解析。

  • 第 69 至 82 行 :创建类增强插件定义( `org.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine` )对象数组。不同插件通过实现 AbstractClassEnhancePluginDefine 抽象类,定义不同框架的切面,记录调用链路。在本文 「2.4 AbstractClassEnhancePluginDefine」 简单解析。

2.1 AgentClassLoader

org.skywalking.apm.agent.core.plugin.loader.AgentClassLoader ,继承 java.lang.ClassLoader ,Agent 类加载器。

为什么实现自定义的 ClassLoader ?应用透明接入 SkyWalking ,不会显示导入 SkyWalking 的插件依赖。通过实现自定义的 ClassLoader ,从插件 Jar 中查找相关类。例如说,从 apm-dubbo-plugin-3.2.6-2017.jar 查找 org.skywalking.apm.plugin.dubbo.DubboInstrumentation 。


AgentClassLoader 构造方法,代码如下 :

public class AgentClassLoader extends ClassLoader {

    /**
     * The default class loader for the agent.
     */
    private static AgentClassLoader DEFAULT_LOADER;

    /**
     * classpath
     */
    private List<File> classpath;
    /**
     * Jar 数组
     */
    private List<Jar> allJars;
    /**
     * Jar 读取时的锁
     */
    private ReentrantLock jarScanLock = new ReentrantLock();

    public AgentClassLoader(ClassLoader parent) throws AgentPackageNotFoundException {
        super(parent);
        File agentDictionary = AgentPackagePath.getPath();
        classpath = new LinkedList<File>();
        classpath.add(new File(agentDictionary, "plugins"));
        classpath.add(new File(agentDictionary, "activations"));
    }
}
  • DEFAULT_LOADER 静态属性,默认单例。通过 `#getDefault()` 方法,可以获取到它。

  • classpath 属性,Java 类所在的目录。在构造方法中,我们可以看到 ${AGENT_PACKAGE_PATH}/plugins / ${AGENT_PACKAGE_PATH}/activations 添加到 classpath 。在 `#getAllJars()` 方法中,加载该目录下的 Jar 中的 Class 文件。

  • allJars 属性,Jar 数组。

  • jarScanLock 属性,Jar 读取时的锁。


#initDefaultLoader() 静态方法,初始化默认的 AgentClassLoader ,代码如下 :

public static AgentClassLoader initDefaultLoader() throws AgentPackageNotFoundException {
    DEFAULT_LOADER = new AgentClassLoader(PluginBootstrap.class.getClassLoader());
    return getDefault();
}
  • 使用 org.skywalking.apm.agent.core.plugin.PluginBootstrap 的类加载器作为 AgentClassLoader 的父类加载器。


如下方法已经添加相关中文注释,胖友请自行阅读理解 :

  • `#findResource(name)`

  • `#findResources(String name)`

  • `#getAllJars()`

在 ClassLoader 加载资源( 例如,类 ),会调用 #findResource(name) / #findResources(name) 方法。

2.2 PluginResourcesResolver

org.skywalking.apm.agent.core.plugin.PluginResourcesResolver ,插件资源解析器,读取所有插件的定义文件。插件定义文件必须以 skywalking-plugin.def 命名,例如 :

#getResources() 方法,获得插件定义路径数组,代码如下 :

  • 第 50 行 :使用 AgentClassLoader 获得所有 skywalking-plugin.def 的路径。

2.3 PluginCfg

org.skywalking.apm.agent.core.plugin.PluginCfg ,插件定义配置,读取 skywalking-plugin.def 文件,生成插件定义( org.skywalking.apm.agent.core.plugin.PluginDefinie )数组。

#load(InputStream) 方法,读取 skywalking-plugin.def 文件,添加到 pluginClassList 。如下是 apm-springmvc-annotation-4.x-plugin-3.2.6-2017.jar 插件的定义文件 :

spring-mvc-annotation-4.x=org.skywalking.apm.plugin.spring.mvc.v4.define.ControllerInstrumentation
spring-mvc-annotation-4.x=org.skywalking.apm.plugin.spring.mvc.v4.define.RestControllerInstrumentation
spring-mvc-annotation-4.x=org.skywalking.apm.plugin.spring.mvc.v4.define.HandlerMethodInstrumentation
spring-mvc-annotation-4.x=org.skywalking.apm.plugin.spring.mvc.v4.define.InvocableHandlerInstrumentation

2.4 AbstractClassEnhancePluginDefine

org.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine ,类增强插件定义抽象基类。不同插件通过实现 AbstractClassEnhancePluginDefine 抽象类,定义不同框架的切面,记录调用链路。以 Spring 插件为例子,如下是相关类图 :

PluginDefine 对象的 defineClass 属性,即对应不同插件对AbstractClassEnhancePluginDefine 的实现类。所以在 PluginBootstrap#loadPlugins() 方法的【第 74 行】,我们看到通过该属性,创建创建类增强插件定义对象。

2.5 小结

胖友,回过头,在看一下流程图,理解理解。

3. 插件的匹配

在 《SkyWalking 源码分析 —— Agent 初始化》 一文,我们提到,SkyWalking Agent 基于 JavaAgent 机制,实现应用透明接入 SkyWalking 。下面笔者默认胖友已经对 JavaAgent 机制已经有一定的了解。如果胖友暂时不了解,建议先阅读如下文章 :

  • 《Instrumentation 新功能》

  • 《JVM源码分析之javaagent原理完全解读》

友情提示 :建议自己手撸一个简单的 JavaAgent ,更容易理解 SkyWalking Agent 。

笔者练手的 JavaAgent 项目地址 :https://github.com/YunaiV/learning/tree/master/javaagent01

通过 JavaAgent 机制,我们可以在 #premain(String, Instrumentation) 方法里,调用 Instrumentation#addTransformer(ClassFileTransformer) 方法,向 Instrumentation 注册 java.lang.instrument.ClassFileTransformer 对象,可以修改 Java 类的二进制,从而动态修改 Java 类的代码实现。

如果胖友使用过 AOP 实现切面记录日志,那么就很容易理解,SkyWalking 通过这样的方式,使用不同框架定义方法切面,从而在在切面记录调用链路。


直接修改 Java 类的二进制,是非常繁杂的。因此,SkyWalking 引入了 byte-buddy 。

byte-buddy 是一个代码生成和操作库,用于在 Java 应用程序
运行时创建和修改 Java 类,而徐无需编译器的帮助。

除了参与 Java 类库一起提供代码生成工具外,byte-buddy 允许创建任意类,并不限于实现用于创建运行时代理的接口。

此外,byte-buddy 提供了一个方便的 API ,用于 Java Agent 或在构建过程中更改类。

下面笔者默认胖友已经对 byte-buddy 有一定的了解。如果胖友暂不了解,建议先阅读如下文章 :

  • 《Java字节码3-使用ByteBuddy实现一个Java-Agent》

  • 《Byte Buddy 教程》

  • 《Easily Create Java Agents with Byte Buddy》

  • 《skywalking源码分析之javaAgent工具ByteBuddy的应用》 搜索 "BYTE BUDDY应用" 部分

友情提示 :建议自己简单使用下 byte-buddy ,更容易理解 SkyWalking Agent 。

笔者练手的 byte-buddy 项目地址 :https://github.com/YunaiV/learning/tree/master/bytebuddy


下面,让我们打开 SkyWalkingAgent#premain(String, Instrumentation) 方法,从【第 79 行】代码开始看 :

  • 第 79 至 104 行 :创建 `net.bytebuddy.agent.builder.AgentBuilder` 对象,并设置相关属性。

    • 第 84 行 :调用 `PluginFinder#find(TypeDescription, ClassLoader)` 方法,获得匹配的 AbstractClassEnhancePluginDefine 数组。因为在【第 79 行】的代码,设置了所有插件需要拦截的类,所以此处需要匹配该类对应的 AbstractClassEnhancePluginDefine 数组。`PluginFinder#find(TypeDescription, ClassLoader)` 方法,在本文 「3.3 PluginFinder」 详细解析。

    • 第 85 行 :判断匹配的 AbstractClassEnhancePluginDefine 数组大于零。从目前的代码看下来,此处属于防御性编程,在【第 79 行】的代码保证一定能匹配到 AbstractClassEnhancePluginDefine 。

    • 第 86 至 100 行 :循环匹配到 AbstractClassEnhancePluginDefine 数组,调用 `AbstractClassEnhancePluginDefine#define(…)` 方法,设置 `net.bytebuddy.dynamic.DynamicType.Builder` 对象。通过该对象,定义如何拦截需要修改的 Java 类。在 `AbstractClassEnhancePluginDefine#define(…)` 方法的内部,会调用 `net.bytebuddy.dynamic.DynamicType.ImplementationDefinition#intercept(Implementation)`方法,本文 「4. 插件的拦截」 也会详细解析。

    • 第 91 行 :为什么会出现返回为空的情况呢?同一个框架在不同的大版本,使用的方式相同,但是实现的代码却不尽相同。举个例子,SpringMVC 3 和 SpringMVC 4 ,都有 `@RequestMapping` 注解定义 URL ,所以【第 84 行】会匹配到 `AbstractSpring3Instrumentation` / `AbstractSpring4Instrumentation` 两个。当应用使用的是 Spring MVC 4 时,调用 `AbstractSpring3Instrumentation#define(…)` 方法会返回空,而调用 `AbstractSpring4Instrumentation#define(…)` 方法会有返回值。这是如何实现的呢?本文 「4. 插件的拦截」 也会详细解析。

    • AgentBuilder ,提供便利的 API ,创建 Java Agent 。

    • 第 79 行 :调用 `AgentBuilder#type(ElementMatcher)` 方法,实现 `net.bytebuddy.matcher.ElementMatcher` 接口,设置需要拦截的类。`PluginFinder#buildMatch()` 方法,在本文 「3.3 PluginFinder」 详细解析。

    • 第 79 至 104 行 :调用 `AgentBuilder#transform(Transformer)` 方法,设置 Java 类的修改逻辑。

  • 第 105 至 134 行 :调用 `AgentBuilder#with(Listener)` 方法,添加监听器。

    • `#onTransformation(…)` 方法,当 Java 类的修改成功,进行调用。

    • `#onError(…)` 方法,当 Java 类的修改失败,进行调用。InstrumentDebuggingClass 在本文 「3.1 InstrumentDebuggingClass」 详细解析。

  • 第 135 行 :调用 `AgentBuilder#installOn(Instrumentation)` 方法,根据上面 AgentBuilder 设置的属性,创建 `net.bytebuddy.agent.builder.ResettableClassFileTransformer` 对象,配置到 Instrumentation 对象上。在 AgentBuilder#installOn(Instrumentation) 方法的内部,会调用 Instrumentation#addTransformer(ClassFileTransformer) 方法。


???? 这个方法信息量比较大,笔者对 byte-buddy 不是很熟悉,花费了较多时间梳理与理解。建议,如果胖友此处不是理解的很清晰,可以阅读完全文,在回过头再捋一捋这块的代码实现。

3.1 InstrumentDebuggingClass

org.skywalking.apm.agent.InstrumentDebuggingClass ,Instrument 调试类,用于将被 JavaAgent 修改的所有类存储到 ${JAVA_AGENT_PACKAGE}/debugger 目录下。需要配置 agent.is_open_debugging_class = true ,效果如下图 :

代码比较简单,胖友点击 InstrumentDebuggingClass 理解。

3.2 ClassMatch

在分享本节相关内容之前,我们先来看下 bytebuddy 的 net.bytebuddy.matcher 模块。该模块提供了各种灵活的匹配方法。那么 SkyWalking 为什么实现自己的 org.skywalking.apm.agent.core.plugin.match 模块?笔者认为,仅定位于类级别的匹配,更常用而又精简的 API 。


org.skywalking.apm.agent.core.plugin.match.ClassMatch ,类匹配接口。目前子类如下 :

  • NameMatch :基于完整的类名进行匹配,例如:"com.alibaba.dubbo.monitor.support.MonitorFilter" 。

  • IndirectMatch :间接匹配接口。相比 NameMatch 来说,确实比较 "委婉" ???? 。

    • ClassAnnotationMatch :基于类注解进行匹配,可设置同时匹配多个。例如:`"@RequestMapping"`。

    • HierarchyMatch :基于父类 / 接口进行匹配,可设置同时匹配多个。

    • MethodAnnotationMatch :基于方法注解进行匹配,可设置同时匹配多个。目前项目里主要用于匹配方法上的 `org.skywalking.apm.toolkit.trace.@Trace` 注解。

每个类已经添加详细的代码注释,胖友喜欢哪个点哪个哟。

3.3 PluginFinder

org.skywalking.apm.agent.core.plugin.PluginFinder ,插件发现者。其提供 #find(...) 方法,获得类增强插件定义( org.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine )对象。

PluginFinder 构造方法,代码如下 :

  • 第 57 至 77 行 :循环 AbstractClassEnhancePluginDefine 对象数组,添加到 nameMatchDefine / signatureMatchDefine 属性,方便 #find(…) 方法查找 AbstractClassEnhancePluginDefine 对象。

    • 第 65 至 72 行 :处理 NameMatch 为匹配的 AbstractClassEnhancePluginDefine 对象,添加到 `nameMatchDefine` 属性。

    • 第 74 至 76 行 :处理非 NameMatch 为匹配的 AbstractClassEnhancePluginDefine 对象,添加到 `signatureMatchDefine` 属性。


#find(...) 方法,获得类增强插件定义( org.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine )对象,代码如下 :

  • 第 92 至 96 行 :以 nameMatchDefine 属性来匹配 AbstractClassEnhancePluginDefine 对象。

  • 第 98 至 104 行 :以 signatureMatchDefine 属性来匹配 AbstractClassEnhancePluginDefine 对象。在这个过程中,会调用 IndirectMatch#isMatch(TypeDescription) 方法,进行匹配。


#buildMatch() 方法,获得全部插件的类匹配,多个插件的类匹配条件以 or 分隔,代码如下 :

  • 第 117 至 123 行 :以 nameMatchDefine 属性来匹配。

  • 第 124 至 132 行 :以 signatureMatchDefine 属性来匹配。

  • 实际上,该方法和 `#find(…)` 方法逻辑是一致的。

4. 插件的拦截

在上文中,我们已经提到,SkyWalking 通过 JavaAgent 机制,对需要拦截的类的方法,使用 byte-buddy 动态修改 Java 类的二进制,从而进行方法切面拦截,记录调用链路。

看具体的代码实现之前,想一下拦截会涉及到哪些元素 :

  • 拦截切面 InterceptPoint

  • 拦截器 Interceptor

  • 拦截类的定义 Define :一个类有哪些拦截切面及对应的拦截器

下面,我们来看看本小节会涉及到的类。如图所示:

看起来类比想象的多?梳理之,结果如图 :

  • 根据方法类型的不同,使用不同 ClassEnhancePluginDefine 的实现类。其中,构造方法和静态方法使用相同的实现类。

  • 相比上面提到拦截会涉及到的元素,多了一个 Inter ?如下是官方的说明 :

    In this class, it provide a bridge between byte-buddy and sky-walking plugin.

4.1 ClassEnhancePluginDefine

整体类图如下:

  • AbstractClassEnhancePluginDefine :SkyWalking 类增强插件定义抽象基类。

  • ClassEnhancePluginDefine :SkyWalking 类增强插件定义抽象类。

  • 从 UML 图中的方法,我们可以看出,AbstractClassEnhancePluginDefine 注重在定义( Define ),ClassEnhancePluginDefine 注重在增强( Enhance )。

整体流程如下 :

OK ,下面我们开始看看代码是如何实现的。

4.1.1 AbstractClassEnhancePluginDefine

org.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine ,SkyWalking 类增强插件定义抽象基类。它注重在定义( Define )的抽象与实现。

#enhanceClass() 抽象方法,定义了类匹配( ClassMatch ) 。

#witnessClasses() 方法,见证类列表。当且仅当应用存在见证类列表,插件才生效。什么意思?让我们看看这种情况:一个类库存在两个发布的版本( 如 1.0 和 2.0 ),其中包括相同的目标类,但不同的方法或不同的方法参数列表。所以我们需要根据库的不同版本使用插件的不同版本。然而版本显然不是一个选项,这时需要使用见证类列表,判断出当前引用类库的发布版本。

  • 举个实际的例子,SpringMVC 3 和 SpringMVC 4 ,都有 @RequestMapping 注解定义 URL 。

    • 通过判断存在 `org.springframework.web.servlet.view.xslt.AbstractXsltView` 类,应用使用 SpringMVC 3 ,使用 `apm-springmvc-annotation-3.x-plugin.jar` 。

    • 通过判断存在 `org.springframework.web.servlet.tags.ArgumentTag` 类,应用使用 SpringMVC 4 ,使用 `apm-springmvc-annotation-4.x-plugin.jar` 。

  • 另外,该方法返回空数组。即默认情况,插件生效,无需见证类列表。


#define(...) 方法,设置 net.bytebuddy.dynamic.DynamicType.Builder 对象。通过该对象,定义如何拦截需要修改的目标 Java 类(方法的 transformClassName 参数)。代码如下 :

  • 第 57 至 70 行 :判断见证类列表是否都存在。若不存在,则插件不生效。

    • `org.skywalking.apm.agent.core.plugin.WitnessClassFinder` ,已经添加完整注释,胖友点击查看。

  • 第 72 至 76 行 :调用 #enhance(…) 抽象方法,使用拦截器增强目标类。

4.1.2 ClassEnhancePluginDefine

org.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassEnhancePluginDefine,SkyWalking 类增强插件定义抽象类。它注重在增强( Enhance )的抽象与实现。包括如下 :

  • 静态方法、构造方法、实例方法的增强

  • 静态方法、构造方法、实例方法的拦截切面


拦截切面,在 「4.2 InterceptPoint」 有相关解析。

#getStaticMethodsInterceptPoints() 抽象方法,获得 StaticMethodsInterceptPoint 数组。 
#getConstructorsInterceptPoints() 抽象方法,获得 ConstructorInterceptPoint 数组。 
#getInstanceMethodsInterceptPoints() 抽象方法,获得 InstanceMethodsInterceptPoint 数组。


#enhance(...) 方法,增强静态方法、构造方法、实例方法。

4.1.2.1 增强静态方法

调用 #enhanceClass(...) 方法,增强静态方法,代码如下 :

  • 第 206 至 210 行 :调用 #getStaticMethodsInterceptPoints() 方法,获得 StaticMethodsInterceptPoint 数组。若为空,不进行增强。

  • 第 212 至 238 行 :遍历 StaticMethodsInterceptPoint 数组,逐个增强StaticMethodsInterceptPoint 对应的静态方法。

    • 第 214 至 218 行 :获得拦截器的类名。拦截器的实例,在 Inter 类里获取。

    • 第 221 至 229 行 :当 `StaticMethodsInterceptPoint#isOverrideArgs()` 方法返回 `true` 时,使用 StaticMethodsInterWithOverrideArgs 处理拦截逻辑。在 「4.4.3 静态方法 Inter」 详细解析。

    • 第 230 至 236 行 :当 `StaticMethodsInterceptPoint#isOverrideArgs()` 方法返回 `false` 时,使用 StaticMethodsInter 处理拦截逻辑,在 「4.4.3 静态方法 Inter」 详细解析。

4.1.2.2 增强构造方法和实例方法

调用 #enhanceInstance() 方法,增强构造方法和实例方法,代码如下 :

  • 第 92 至 110 行 :调用 #getConstructorsInterceptPoints() / #getInstanceMethodsInterceptPoints() 方法,获得 ConstructorInterceptPoint / InstanceMethodsInterceptPoint 数组。若都为空,不进行增强。

  • 第 112 至 128 行 :使用 byte-buddy ,为目标 Java 类"自动"实现 `org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance` 接口。这样,目标 Java 类就有一个私有变量,拦截器在执行过程中,可以存储状态到该私有变量。这里如果暂时不理解没关系,后面分享每个插件的实现时,会有实际的例子,更易懂。

  • ---------- 构造方法 ----------

  • 第 130 至 143 行 :遍历 ConstructorInterceptPoint 数组,逐个增强 ConstructorInterceptPoint 对应的构造方法。使用 ConstructorInter 处理拦截逻辑,在 「4.4.1 构造方法 Inter」 详细解析。

  • ---------- 实例方法 ----------

  • 第 145 至 175 行 :遍历 InstanceMethodsInterceptPoint 数组,逐个增强 InstanceMethodsInterceptPoint 对应的静态方法。

    • 第 151 至 154 行 :获得拦截器的类名。拦截器的实例,在 Inter 类里获取。

    • 第 156 至 165 行 :当 `InstanceMethodsInterceptPoint#isOverrideArgs()` 方法返回 `true` 时,使用 InstMethodsInterWithOverrideArgs 处理拦截逻辑。在 「4.4.2 实例方法 Inter」 详细解析。

    • 第 166 至 173 行 :当 `InstanceMethodsInterceptPoint#isOverrideArgs()` 方法返回 `false` 时,使用 InstMethodsInter 处理拦截逻辑,在 「4.4.2 实例方法 Inter」 详细解析。

4.1.3 ClassStaticMethodsEnhancePluginDefine

org.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassStaticMethodsEnhancePluginDefine,类增强静态方法的插件定义抽象类,和本文 「4.1.2.1 增强静态方法」 对应。

实现 #getConstructorsInterceptPoints() / #getInstanceMethodsInterceptPoints() 抽象方法,返回空,表示不增强构造方法和实例方法。即只增强静态方法。

4.1.4 ClassInstanceMethodsEnhancePluginDefine

org.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine,类增强构造方法和实例方法的插件定义抽象类,和本文 「4.1.2.2 增强构造方法和实例方法」 对应。

实现 #getStaticMethodsInterceptPoints() 抽象方法,返回空,表示不增强静态方法。即只增强构造方法和实例方法。

4.2 InterceptPoint

InterceptPoint方法类型方法匹配拦截器#isOverrideArgs()
StaticMethodsInterceptPoint静态方法#getMethodsMatcher()#getMethodsInterceptor()有
ConstructorInterceptPoint构造方法#getConstructorMatcher()#getConstructorInterceptor()无
InstanceMethodsInterceptPoint实例方法#getMethodsMatcher()#getMethodsInterceptor()有

XXXInterceptPoint 接口,对应一个 net.bytebuddy.matcher.ElementMatcher 和一个拦截器。

代码比较简单,胖友自己查看。

4.3 Interceptor

在开始分享 Inter 之前,我们先来看看 Interceptor 相关接口。如下图所见:

  • InstanceConstructorInterceptor ,构造方法拦截器接口。

  • AroundInterceptor

    • StaticMethodsAroundInterceptor ,静态方法拦截器接口。

    • InstanceMethodsAroundInterceptor ,实例方法拦截器接口。

    • 接口方法基本一致,下面 Inter 逻辑也基本一致。

在 「4. 2 InterceptPoint」 里,我们看到 #getXXXInterceptor() 方法返回的拦截器类名,需要通过 org.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoader 加载与创建拦截器实例。

4.4 Inter

我们先来看 Inter 的定义 :

In this class, it provide a bridge between byte-buddy and sky-walking plugin.

根据方法类型,将 Inter 整理如下 :

方法类型

构造方法ConstructorInter
实例方法InstMethodsInterInstMethodsInterWithOverrideArgs
静态方法StaticMethodsInterStaticMethodsInterWithOverrideArgs

4.4.1 构造方法 Inter

org.skywalking.apm.agent.core.plugin.interceptor.enhance.ConstructorInter ,构造方法 Inter 。

ConstructorInter 构造方法,调用 InterceptorInstanceLoader#load(String, classLoader) 方法,加载构造方法拦截器。

#intercept(Object) 方法,在构造方法执行完成后进行拦截,调用 InstanceConstructorInterceptor#onConstruct(...) 方法。

为什么没有 ConstructorInterWithOverrideArgs?InstanceConstructorInterceptor#onConstruct(...) 方法,是在构造方法执行完成后进行调用拦截,OverrideArgs 用于在调用方法之前,改变传入方法的参数。所以,在此处暂时没这块需要,因而没有 ConstructorInterWithOverrideArgs 。

4.4.2 实例方法 Inter

org.skywalking.apm.agent.core.plugin.interceptor.enhance.InstMethodsInter ,实例方法 Inter 。

ConstructorInter 构造方法,调用 InterceptorInstanceLoader#load(String, classLoader) 方法,加载实例方法拦截器。

#intercept(...) 方法,Before-After 方式拦截实例方法,代码如下 :

  • 第 79 至 86 行 :调用 InstanceMethodsAroundInterceptor#beforeMethod(…) 方法,执行在实例方法之前的逻辑。

    • `org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult` ,方法拦截器执行结果。当调用 `MethodInterceptResult#defineReturnValue(Object)` 方法,设置执行结果,并标记不再继续执行。

  • 第 90 至 92 行 :当 MethodInterceptResult 已经有执行结果,不再执行原有方法,直接返回结果。

  • 第 94 至 96 行 :调用 Callable#call() 方法,执行原有实例方法。

  • 第 97 至 105 行 :调用 InstanceMethodsAroundInterceptor#handleMethodException(…) 方法,处理异常。

  • 第 107 至 113 行 :调用 InstanceMethodsAroundInterceptor#afterMethod(…) 方法,执行后置逻辑。


org.skywalking.apm.agent.core.plugin.interceptor.enhance.InstMethodsInterWithOverrideArgs,覆写参数的实例方法 Inter 。

不太理解覆写参数?有这样一个场景,InstanceMethodsAroundInterceptor#beforeMethod(...) 方法里,我们修改了方法参数,并且希望原有实例方法执行时,使用的是修改了的方法参数,此时,就需要使用 InstMethodsInterWithOverrideArgs 。

InstMethodsInterWithOverrideArgs#intercept(...) 方法,总体逻辑和 InstMethodsInter 是一致的,下面我们来看看差异点 :

  • 第 76 行 :方法参数类型是 `org.skywalking.apm.agent.core.plugin.interceptor.enhance.OverrideCallable`,并且带有 `net.bytebuddy.implementation.bind.annotation.@Morph` 注解。

  • 第 96 行 :调用 `OverrideCallable#call(args)` 方法,使用被前置方法修改过的参数,执行原有实例方法。

先来瞅瞅 @Morph 注解的定义 :

This annotation instructs Byte Buddy to inject a proxy class that calls a method's super method with explicit arguments.

For this, the {@link Morph.Binder} needs to be installed for an interface type that takes an argument of the array type {@link java.lang.Object} and returns a non-array type of {@link java.lang.Object}.

This is an alternative to using the {@link net.bytebuddy.implementation.bind.annotation.SuperCall} or {@link net.bytebuddy.implementation.bind.annotation.DefaultCall} annotations which call a super method using the same arguments as the intercepted method was invoked with.

简单的来说 :

  • @Morph 注解,注入一个代理对象,该对象会使用传入的参数,调用被代理的方法。例如在 InstMethodsInterWithOverrideArgs 里,调用 OverrideCallable#call(args) 方法,会调用原有实例方法。

  • 需要使用 Morph.Binder 设置一个接口,并且该接口的方法定义为 Object methodName(Object[])。在 InstMethodsInterWithOverrideArgs 使用的是org.skywalking.apm.agent.core.plugin.interceptor.enhance.OverrideCallable 接口。另外,调用 Morph.Binder#install(Class<?>) 方法的代码如下 :

    // ClassEnhancePluginDefine.java
    // #enhanceInstance(...) 方法
    newClassBuilder =
        newClassBuilder.method(not(isStatic()).and(instanceMethodsInterceptPoint.getMethodsMatcher())) // 匹配
            .intercept( // 拦截
                MethodDelegation.withDefaultConfiguration()
                    .withBinders(
                        Morph.Binder.install(OverrideCallable.class) // 覆写参数
                    )
                    .to(new InstMethodsInterWithOverrideArgs(interceptor, classLoader))
            );

4.4.3 静态方法 Inter

org.skywalking.apm.agent.core.plugin.interceptor.enhance.StaticMethodsInter 和 org.skywalking.apm.agent.core.plugin.interceptor.enhance.StaticMethodsInterWithOverrideArgs和实例方法 Inter基本一致,胖友可以自己捋一捋,笔者就不瞎比比了。

4.5 小结

总的来说,涉及到的组件,如下图 :

胖友再梳理梳理。



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:

已在知识星球更新源码解析如下:

如果你喜欢这篇文章,喜欢,转发。

生活很美好,明天见(。・ω・。)ノ♡

抄表程序员的DLMS/COSEM协议实战:从抓包到解析,手把手教你读懂IEC62056报文 本文深入解析DLMS/COSEM协议在智能电表通信中的应用,从报文捕获到数据解析的全流程实战指南。涵盖HDLC帧解析、应用层连接建立、数据请求/响应解码等核心内容,并提供Wireshark配置、OBIS代码速查表等实用工具,帮助开发者快速掌握IEC62056标准下的电能表通信技术。 阅读详情

相关推荐

STM32cube HAL库两条命令实现i2c通信---Nucleo L476RG用I2C实现tmp117模块温度读取并串口打印

Getting Started with STM32 - I2C Example

m0_54706625的博客 1835

skywalkling~插件定义体系

插件

TCLAY 875

FPGA矩阵键盘计算器Verilog实现与Quartus仿真全流程解析

本文详细解析了基于FPGA和Verilog的矩阵键盘计算器实现全流程,包括矩阵键盘扫描、状态机设计、算术运算逻辑及数码管显示驱动。通过Quartus仿真与Testbench测试,确保设计稳定性与准确性,适合数字逻辑设计初学者学习FPGA开发与硬件描述语言应用。

chair的专栏 743

全链路跟踪——skywalking自定义插件开发(五)

支持定义构造方法和实例方法的拦截点。:支持定义静态方法的拦截点。当然还可以直接扩展,这个类是上面两个类的父类。这种方式较为麻烦,一般不推荐使用。这里以拦截实例方法为例,继承类。:实例方法拦截器:静态方法拦截器:构造方法拦截器要拦截对应的方法,必须要实现对应的接口。这里以实现接口,拦截实例方法为例。在自定义插件模块的resources目录下定义配置文件,该文件用于帮助探针启动时加载插件时,寻找插件拦截点。

qq_34434565的博客 2192

浅谈IC测试向量(pattern)及其转换

随着集成电路的飞速发展,其规模越来越大,对电路的质量与可靠性要求进一步提高,集成电路的测试方法也变得越来越困难,为了实现芯片的快速测试和筛选,ATE设备为其提供了强有力的支撑。ATE运用芯片设计仿真文件,将其作为芯片输入激励,通过ATE测试平台提供芯片测试环境,将芯片的输出和测试结果进行比较,以此来判定芯片的好坏。 说起IC测试,不得不说一下Pattern这个词,它中文的意思是模式。在图像处理中,这个词意思为图像的纹理特征,而在IC也即芯片测试行业,这个词实际上代表了需要测试芯片的时序特征。简单的说,在测

flomingo1的专栏 1万+

家庭宽带IPv6避坑指南:如何通过DHCPv6-PD获取公网地址(附OpenWRT配置)

本文详细解析了家庭宽带IPv6的地址分配机制,重点介绍了通过DHCPv6-PD获取公网地址的方法,并提供了OpenWRT路由器的具体配置步骤。从路由器通告(RA)标记位到前缀委派(PD)流程,帮助用户解决IPv6部署中的常见问题,实现稳定高效的IPv6网络连接。

backprop5master的博客 1265

Skywalking的增强与拦截机制

字节增强条件匹配 在 skywalking 中实现很多基于 byte-buddy 的关于链式匹配查询的实现, 代码如下所示: public abstract class AbstractJunction<V> implements ElementMatcher.Junction<V> 其对应的类的类图关系如下所示: 除此之外, 为了便于更好的执...

bajiaoyan5785的博客 2740

采用离散模型搭建永磁同步电机控制系统

永磁同步电机发电系统分为控制器和发电机,通过simulink仿真软件进行发电系统的离散系统仿真。离散搭建仿真,可以更方便的自动代码生成。通过实践经验离散模块搭建,更能加深对整个控制系统的理解。离散系统在矢量控制中经常涉及到上个开关周期的角度,电压,或者预测下个周期的角度,电流,一般都是通过延时模块实现。PWM比较值寄存器被改写后都是使能了预装载,采样后触发计算到比较值生效可以延时0.5个开关周期Ts,也可以延时1个开关周期Ts,可以通过离散系统进行仿真,大大缩短开发周期。

f1072239934的博客 2865

SkyWalking 源码分析 —— Agent 插件体系

SkyWalking Agent插件体系采用模块化设计,通过字节码增强技术实现无侵入式应用监控。核心架构包括插件加载机制、拦截器系统和上下文传播模块,支持Tomcat、JDBC等组件的自动监控。系统使用ByteBuddy进行代码注入,通过自定义类加载器实现插件隔离,并采用异步处理优化性能。开发者可基于抽象类快速扩展新插件,配置文件支持细粒度定制。该体系具有低性能损耗、高扩展性特点,为分布式系统提供完整的链路追踪能力,是APM领域的高效解决方案。

油墨香^-^的博客 996

Agentic AI应用架构师如何提升AI应用的灵活性

可扩展性(Scalability):快速添加新功能或扩展任务范围(如Agent从“客服”扩展到“供应链管理”);可修改性(Modifiability):调整Agent的决策逻辑或动作策略,无需重构整个系统;鲁棒性(Robustness):在环境异常或数据噪声下保持性能稳定;自适应(Self-Adaptation):自主学习新场景,无需人工干预。状态空间(S):Agent能感知的所有内部/外部状态(如用户需求、环境数据);动作空间(A):Agent能执行的所有动作(如调用工具、发送消息);

项目管理的博客 607

蓝鸟四轴飞控系统C程序V3.0(基础版本)深度解读

2. 解析遥控通道数据(油门 / 横滚 / 俯仰 / 偏航),转换为标准化值(-1000~+1000);3. 封装PID初始化(PID_Init,配置KP/KI/KD、输出限幅、积分限幅);,包含姿态角(Attitude_Data.Roll/Pitch/Yaw)、角速度(Gyro_Data.X/Y/Z)、遥控值(RC_Data[0~5])、电池电压(Bat_Volt)、电机PWM值(Motor_PWM[0~3])、系统状态(Sys_State),校验和通过Check_Sum()函数计算;

搏博的专栏 344

SkyWalking 源码分析 —— Agent 插件(三)之 SpringMVC

本文深入分析了SkyWalking的SpringMVC插件实现原理,重点阐述了其架构设计、增强机制和追踪逻辑。该插件通过字节码增强技术实现对SpringMVC框架的无侵入监控,包含Controller增强点和请求处理增强点两大核心组件。文章详细解析了URL路径解析策略、上下文传播机制以及性能优化手段,包括缓存机制和懒加载策略。同时介绍了完善的异常处理与容错机制,确保插件稳定性。测试验证部分展示了路径解析和注解解析的单元测试案例。该插件体现了SkyWalking插件体系的高扩展性、高性能和稳定性特点,为应用性

油墨香^-^的博客 1069

lammps多晶正弦粗糙界面建模

其中,30可以理解为正弦曲线的幅度,150为正弦曲线的基准坐标值,80控制周期,改变参数多试试就能找到规律。很久之前介绍过lammps粗糙界面建模,主要是在lammps中进行一维和二维的正弦粗糙面建模。运行完成后,会生成final.data,这个模型即为上表面为正弦波动的粗糙界面。新建1.py文件,粘贴下面内容后,运行:python 1.py。多晶需要在atomsk中进行,因此上述的方法就不再适用。最近有学员咨询多晶模型的正弦粗糙界面建模应该如何实现。在cmd窗口按顺序运行以下命令创建多晶模型。

lammps_jiayou的博客 390

skywalking使用方法_分布式追踪 & APM 系统 SkyWalking源码分析 —— Agent 插件体系

1. 概述本文主要分享 SkyWalking Agent 插件体系。主要涉及三个流程 :插件的加载插件的匹配插件的拦截可能看起来有点抽象,不太容易理解。淡定,我们每个小章节进行解析。本文涉及到的类主要在 org.skywalking.apm.agent.core.plugin 包里,如下图所示 :每个流程会涉及到较多的类,我们会贯穿着解析代码实现。2. 插件的加载在 《SkyWalking 源码分...

weixin_39559804的博客 1214

android 蓝牙通讯demo

android 下蓝牙通讯demo,实现了发现蓝牙,使能蓝牙,通过蓝牙发送消息。

IDEA的使用指南

IDEA基于java的使用手册,可以最快速的上手,在使用中不断的丰富自己的使用技巧.

java包 agent_不用 Jar 包的 Agent ?几行代码实现运行时增强

提起 JavaAgent,很多人都说几句,就像古龙武侠小说里的「孔雀翎」,威力很大,江湖上都是它的传说。但真的见识过的人并没几个。JavaAgent 虽说没这么神秘,但也一直给人曲高和寡的感觉,除了一些中间件产品、大型的框架中使用外,在业务中一直很少出现。原因可能有很多,一来是可能确实不需要,再者需要开发独立的 Agent Jar 文件,在 Jar 内对类的 transform 开发也并不容易。...

weixin_29459473的博客 693

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

jvm堆栈日志里大量的WAITING (parking)怎么分析问题代码在哪里呢?

下图是阿里arms日志监控里,当时的线程情况: 以下日志是jstack打印的日志: 2021-07-13 12:58:18 Full thread dump Java HotSpot(TM) 64-Bit Server VM (25.171-b11 mixed mode): "Keep-Alive-Timer" #1660 daemon prio=8 os_prio=0 tid=0x00007fab642a6000 nid=0x6a9 sleeping[0x00007faba86db0..

qq_33543227的博客 1万+

pscad IEEE标准系统搭建说明

pscad IEEE标准系统搭建说明,包含典型的IEEE 9节点、14节点、30节点、39节点和118节点系统。内含标准测试系统的原始数据和潮流结果。

SkyWalking8.7源码解析(一):Agent启动流程、Agent配置加载流程、自定义类加载器AgentClassLoader、插件定义体系、插件加载

1、Agent启动流程 找到入口方法SkyWalkingAgent的premain()方法,源码如下: public class SkyWalkingAgent { /** * Main entrance. Use byte-buddy transform to enhance all classes, which define in plugins. * -javaagent:/path/to/agent.jar=agentArgs * -javaagent:

hxt的博客 1万+

【线上问题】Timeout waiting for connection from pool 问题排查

【线上问题】Timeout waiting for connection from pool 问题排查

Prior_SX的博客 4894

第二节:一文读懂链路追踪模型以及Skywalking Java探针实现原理

一文读懂链路追踪模型以及Skywalking Java探针实现原理,详细的阐述了 Skywalking Java Agent 的实现原理,快速帮助读者理解其设计的思想和架构。

陈家少爷的专栏 1880

第10讲:深入剖析 Agent 插件原理,无侵入性埋点

在开始之前,先简单回顾上一课时中关于 AbstractClassEnhancePluginDefine 的一个核心知识点:AbstractClassEnhancePluginDefine 是所有插件的父类,SkywalkingAgent.Transformer 会通过其 enhanceClass() 方法返回的 ClassMatch 对象,匹配到要增强的目标类。Dubbo 插件拦截的是 com.alibaba.dubbo.monitor.support.MonitorFilter 这个类;

Marion的博客 1955

skywalking~定制agent

skywalking-定制agent

TCLAY 953

手把手教你skywalking二开之扩展logback日志%tid

接下来真正的实现当然是放在agent里面去做的首先去继承/*** issue.* *//***/@Override/***/@Override/***/@Override@Override@Override@Override这里主要定义agent要增强哪个类、哪个方法。比如这里就通过定义增强类,定义增强的方法之后再配置类中添加这个类拦截class就是配置我们下面要写的也就是真正的实现类。

念念不忘,必有回响 3333

IDEA skywalking 启动报错 ClassNotFoundException InstanceConstructorInterceptor

InstanceConstructorInterceptor ClassNotFoundException classpath file会导致类加载器加载时找不到agent

no_away的博客 1432

skywalking agent插件开发过程中各种拦截点的写法

本文主要总结了自己写SkyWalking agent端插件的时候常用的匹配方法,并对每一个方法写了一个demo以供参考(所有demo均来自社区插件中的具体类),希望能给想开发SkyWalking插件的小伙伴以帮助。

Startapi的博客 2118

SkyWalking 源码分析—— Agent 插件体系

SkyWalking 源码分析 —— Agent 插件体系 总阅读量:14541次 《Dubbo 实现原理与源码解析 —— 精品合集》 《Netty 实现原理与源码解析 —— 精品合集》 《Spring 实现原理与源码解析 —— 精品合集》 《MyBatis 实现原理与源码解析 —— 精品合集》 《Spring MVC 实现原理与源码解析 —— 精品合集》 《...

snail_bi的博客 1095
上一篇: 我是如何拿到蚂蚁金服 offer ?
下一篇: 华为 Java 编程军规
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值