【过时】Skywalking Java 插件开发注意点

本文刚写就已经过时，不删只是留作记录，建议直接看 Skywalking Java 插件开发太简单了

官方文档：Java Plugin Development Guide
官方插件： https://github.com/apache/skywalking-java

正常按照官方文档 *** 作后，测试时，可以参考官方 SkyWalking的远程调试。

我直接把插件引入到项目中后增加断点即可调试（需要注意和 agent plugins目录中的 jar 一致）。

测试过程中一直没有效果，debug才发现在执行过程中抛出了异常，异常没有输出到项目日志中，通过 debug 或者查看 agent 下面的 logs 目录中的 skywalking-api.log 可以看到。第一次遇到的错误是 net.bytebuddy 相关的错

ERROR 2022-05-07 13:06:10:701 main SkyWalkingAgent : Enhance class com.example.xxx.action.AcctAdjustAction error. 
java.lang.AbstractMethodError: com.example.xxx.skywalking.action.ActionClassInstanceMethodsEnhancePluginDefine$1.getMethodsMatcher()Lorg/apache/skywalking/apm/dependencies/net/bytebuddy/matcher/ElementMatcher;
	at org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassEnhancePluginDefine.enhanceInstance(ClassEnhancePluginDefine.java:137)
	at org.apache.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine.enhance(AbstractClassEnhancePluginDefine.java:116)

这是因为在代码中使用的 net/bytebuddy/matcher/ElementMatcher，但是 skywalking 通过 shade 把名字改成了 org/apache/skywalking/apm/dependencies/net/bytebuddy/matcher/ElementMatcher，导致不匹配出错，配置 maven-shade-plugin 插件即可解决。

第二次是 gson 找不到的错，主要原因是我插件中用到了 gson 但是我自己的项目中没有依赖 gson，导致找不到，解决办法有两种，一个是自己项目添加 gson 依赖，一个是用 skywalking 中内置的 gson，和上面的 bytebuddy 一样配置即可。

综上所述，在官方文档基础上增加下面的配置后，即可使用：

<properties>
    <shade.package>org.apache.skywalking.apm.dependenciesshade.package>
    <shade.net.bytebuddy.source>net.bytebuddyshade.net.bytebuddy.source>
    <shade.net.bytebuddy.target>${shade.package}.${shade.net.bytebuddy.source}shade.net.bytebuddy.target>
    <shade.gson.source>com.google.gsonshade.gson.source>
    <shade.gson.target>${shade.package}.${shade.gson.source}shade.gson.target>
properties>
<build>
    <plugins>
        <plugin>
            <artifactId>maven-shade-pluginartifactId>
            <executions>
                <execution>
                    <phase>packagephase>
                    <goals>
                        <goal>shadegoal>
                    goals>
                    <configuration>
                        <shadedArtifactAttached>falseshadedArtifactAttached>
                        <createDependencyReducedPom>truecreateDependencyReducedPom>
                        <createSourcesJar>truecreateSourcesJar>
                        <shadeSourcesContent>trueshadeSourcesContent>
                        <relocations>
                            <relocation>
                                <pattern>${shade.net.bytebuddy.source}pattern>
                                <shadedPattern>${shade.net.bytebuddy.target}shadedPattern>
                            relocation>
                            <relocation>
                                <pattern>${shade.gson.source}pattern>
                                <shadedPattern>${shade.gson.target}shadedPattern>
                            relocation>
                        relocations>
                    configuration>
                execution>
            executions>
        plugin>
    plugins>
build>

在 skywalking-agent.jar 里面可以看到下面包含的第三方依赖：

完整的初始 pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>
    <groupId>com.examplegroupId>
    <artifactId>skywalking-plugin-xxxartifactId>
    <version>1.0version>

    <properties>
        <skywalking.version>8.10.0skywalking.version>
        <shade.package>org.apache.skywalking.apm.dependenciesshade.package>
        <shade.net.bytebuddy.source>net.bytebuddyshade.net.bytebuddy.source>
        <shade.net.bytebuddy.target>${shade.package}.${shade.net.bytebuddy.source}shade.net.bytebuddy.target>
        <shade.gson.source>com.google.gsonshade.gson.source>
        <shade.gson.target>${shade.package}.${shade.gson.source}shade.gson.target>
    properties>

    <dependencies>
        

        <dependency>
            <groupId>org.apache.skywalkinggroupId>
            <artifactId>apm-agent-coreartifactId>
            <version>${skywalking.version}version>
            <scope>providedscope>
        dependency>
        <dependency>
            <groupId>org.apache.skywalkinggroupId>
            <artifactId>java-agent-utilartifactId>
            <version>${skywalking.version}version>
            <scope>providedscope>
        dependency>
        <dependency>
            <groupId>org.apache.skywalkinggroupId>
            <artifactId>apm-test-toolsartifactId>
            <version>${skywalking.version}version>
            <scope>testscope>
        dependency>
    dependencies>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-shade-pluginartifactId>
                <executions>
                    <execution>
                        <phase>packagephase>
                        <goals>
                            <goal>shadegoal>
                        goals>
                        <configuration>
                            <shadedArtifactAttached>falseshadedArtifactAttached>
                            <createDependencyReducedPom>truecreateDependencyReducedPom>
                            <createSourcesJar>truecreateSourcesJar>
                            <shadeSourcesContent>trueshadeSourcesContent>
                            <relocations>
                                <relocation>
                                    <pattern>${shade.net.bytebuddy.source}pattern>
                                    <shadedPattern>${shade.net.bytebuddy.target}shadedPattern>
                                relocation>
                                
                                <relocation>
                                    <pattern>${shade.gson.source}pattern>
                                    <shadedPattern>${shade.gson.target}shadedPattern>
                                relocation>
                            relocations>
                        configuration>
                    execution>
                executions>
            plugin>
        plugins>
    build>
project>

skywalking 插件开发最容易出问题的就是上面的 pom.xml，有了这个之后，剩下的就是写一个 ClassInstanceMethodsEnhancePluginDefine 定义何时启用插件，处理哪些类和方法。写一个 InstanceMethodsAroundInterceptor 实现在方法执行前后和异常时的处理即可。