bytebuddy 进阶

• 一、ByteBuddyAgent
• • 示例
  • 1.1 Attacher 负责启动agent.jar
  • 1.2 Intaller Instrumention对象的载体
  • • 很简单的getInstrumention
    • premain agentmain
  • 1.3 VirtualMachine jvm平台的支持
  • • Resover获取 jvm平台信息
    • OPENJ9
    • HotSpot
  • 1.4 ByteBuddyAgent(核心)
  • • Provider
    • • 1. ProceessProvider
      • 2. AttachmentProvider
      • 3. AgentProvider
      • 4.AttachmentTypeEvaluator
    • install()方法
    • 其他 attach（）方法
  • 二、类型的描述
  • • 2.1 NamedElement.java
    • • 2.1.1 PackageDescription.java
      • 2.1.3 修饰符ModifierReviewable.java
      • 2.1.3 类型描述 TypeDescription
      • • 1. 非泛型
        • • 变量类型 7种
          • 方法
        • 2 泛型Generic
        • • 变量。
        • 2.1.4 注解的封装
        • 2.1.5 EnumerationDescription
        • 2.1.6 FieldDescription
        • 2.1.7 方法和参数列表
        • 2.1.7 修饰符
        • • asm的编码
        • 2.2 ASM相关
        • • 2.2.1 Advice.OnMethodEnter
          • • Advice.Argument
            • Advice.This
          • 2.2.2 Advice.OnMethodExit
          • • Advice.Argument
            • Advice.This
            • Advice.Return
            • Advice.Thrown
          • 2.2.3 AsmVisitorWrapper
        • 2.3 ElementMatcher 匹配
        • • Junction extends ElementMatcher
        • 2.4 Implementation 自定义实现
        • • 2.4.1 fixedValue.java
          • 2.4.2 FieldAccessor.java
          • 2.4.3 MethodCall
          • • Specific
          • 2.4.4 DefaultMethodCall
          • 2.4.5 MethodDelegation
          • 2.4.6 SuperMethodCall
          • 2.4.7 Annotations 注解修改
        • 2.5 DynamicType 动态类型
        • • 类型的加载策略
        • 三、字节码的修改
        • • 示例
          • 属性
          • 3.1 classFileVersion
          • 3.2 命名策略
          • 3.3 注解过滤器
          • 3.4 注解策略
          • 3.5 implement内容上下文
          • 3.6 方法视图编译器 MethodGraph
          • 3.7 字节码生成器类型InstrumentedType
          • 3.8 类型校验 TypeValidation
          • 3.9 继承关系的Bridge
          • 3.10 class写入策略
          • 3.11 ignoredMethods
          • 3.12 重要的方法
          • • subclass
            • • 构造器策略
            • redifine
            • rebase
          • 三、compose agent.jar
          • • 示例

            博客
            不同于使用-agent-jar参数的方式。bytebuddy自己实现了对Attach API的封装，可以直接将agent.jar加载。就是启动后主动attach到目标进程。

            bytebuddy如何将类替换进内存。核心的函数是 net.bytebuddy.agent.install 方法。
            可以先看 VirtualMachine 和 Instrument 完成扫盲。

            1.1 Attacher 负责启动agent.jar

            负责启动agent.jar包

            只有一个方法install()，

            • 接受一个jvm的pid，和jvm建立连接，执行attach，返回一个 VirtualMachine 。
            • 执行loadagentpath或者loadagent加载agent.jar并触发premain或者domain方法
            • detach

            1.2 Intaller Instrumention对象的载体

            
            只要有有一个内部变量instrumention，用来包含对类的修改设定

            很简单的getInstrumention

            多了个权限策略的控制
            

            premain agentmain

            简单的赋值
            

            1.3 VirtualMachine jvm平台的支持

            支持的JVM，对JDK VirtualMachine的增强版
            这里不需要细看

            Resover获取 jvm平台信息

            Resolver
            

            OPENJ9

            HotSpot

            平台具体的attach处理，bytebuddy自己写的attach逻辑
            

            1.4 ByteBuddyAgent(核心)

            Provider

            1. ProceessProvider

            当前JVM pi的获取
            

            2. AttachmentProvider

            得到VirtulMachine用来attch的API

            返回用来支持attach的Provider集合
            
            内部实现了ACCESSOR，是对不同jvm的封装
            

            用来attach的jvm的具体实现
            

            3. AgentProvider

            用来处理提供的jar文件或者agent.jar。

            比如Agent-jar包中的 Manifest 文件有 PreMain-class 属性。
            这个provider会
            1 解析Manifest属性，设置到 ByteBuddyAgent 的属性去
            2 读取agent的jar包
            

            4.AttachmentTypeEvaluator

            install()方法

            其他 attach（）方法

            底层也是调用了install方法
            

            二、类型的描述

            2.1 NamedElement.java

            net.bytebuddy.description 用来承载和操作类型
            

            • getActualName() sourcecode中的名称，没有就返回空""
            • getName() 运行中，byte code中变量的名称，例如 int i=0 的 i
            • getInternalName() 运行中，byte code中变量的名称，以classfile变量方式，比如 常量池的序号 #1=int 中的 #1
            • isNamed() 是已经有设置的名称，而不是用默认
            • toGenericString() 返回泛型名称,如 List<>

            2.1.1 PackageDescription.java

            包名 的载体
            

            2.1.3 修饰符ModifierReviewable.java

            2.1.3 类型描述 TypeDescription

            java type的藐视，要么是一个class要么是interface。

            1. 非泛型

            变量类型 7种

            0	FieldList<FieldDescription.InDefinedShape getDeclaredFields()	不管private还是public只要是生命过的filed。
            1	MethodList<MethodDescription.InDefinedShape> getDeclaredMethods()	针对方法
            2	boolean isInstance(Object value);	判读是否是某个类的实例
            3	boolean isAssignableFrom(Class<?> type);	class Bar extends Foo —Foo.class.isAssignableFrom(Bar.class) 判读继承关系
            4	isAssignableTo	Bar.class.isAssignableTo(Foo.class)刚好相反
            5	boolean isInHierarchyWith(Class<?> type);	范围更大是否继承于
            6	MethodDescription.InDefinedShape getEnclosingMethod()	返回当前方法
            7	getEnclosingType()	返回当前类型
            8	PackageDescription getPackage()	返回包的类型
            9	getInheritedAnnotations()	返回继承的注解
            10	isNestedClass()	是否是嵌套类型

            2 泛型Generic

            非泛型被认为是，泛型的儿子。非泛型是一个更具体的泛型。

            无法了解更细了，需要了解泛型的原理。

            2.1.4 注解的封装

            
            AnnotationDescription

AnnotationList 也定义了一系列注解实例
            

            2.1.5 EnumerationDescription

            2.1.6 FieldDescription

            2.1.7 方法和参数列表

            
            和前面一样，带list的在筛选时提供遍历的筛选接口。

            2.1.7 修饰符

            这里不细讲，只是说明做什么的

            asm的编码

            2.2 ASM相关

            和ASM API交互的包，这里简单看一下Advice是干什么的。
            

            Advice 包含了 OnMethodEnter 和 OnMethodExit 注解。这两个类是在方法的执行前和后加入织入代码。使用可以用自己的实现，然后标注这两个注解，来达到将自己的代码嵌入目标类的前后，实现增强。
            示例
            官网
            

            2.2.1 Advice.OnMethodEnter

            方法执行前

            Advice.Argument

            用来获取 被执行对象的 field 或者参数

            Advice.This

            是当前advice对象的载体，标注之后，方法内部可以获取目前advice对象。

            2.2.2 Advice.OnMethodExit

            Advice.Argument

            Advice.This

            Advice.Return

            给一个参数标识Advice.Return 后可以接收返回结果。

            Advice.Thrown

            给一个参数标识Advice. Thrown 后可以接收抛出的异常。

            如果方法引发异常，则该方法将提前终止。如果由Advice.OnMethodEnter注释的方法引发异常，则不会调用由Advice.OnMethodExit方法注释的方法。如果检测的方法引发异常，则仅当Advice.OnMethodExit.onThrowable（）属性设置为true（默认值）时，才调用由Advice.OnMethodExit注释的方法。

            2.2.3 AsmVisitorWrapper

            可以对已经增强的方法，继续增强。可以理解为基于asm对已有的增强的处理。至于怎么增强等待后面研究。

            2.3 ElementMatcher 匹配

            内置了很多匹配类可以直接使用，也可以自定义。这里描述的少，但是很重要。使用也很简单。

            • boolean matches(T target);匹配目标方法

            Junction extends ElementMatcher

            • and | or matcher之前的匹配关系

            2.4 Implementation 自定义实现

            都继承 Implementation 接口， DynamicType.intercet(Implementation) 方法使用他去构造动态类的实现。
            

            将定义好的类转为字节码

            2.4.1 fixedValue.java

            为method构造一个返回值。其他构造返回值得方法在 net.bytebuddy.implementation.StubMethod
            打桩，即允许根据参数预设要返回的值

            2.4.2 FieldAccessor.java

            为一个field,构造setter和getter方法。

            2.4.3 MethodCall

            构造方法的调用字节码

            Specific

            调用具体的方法，就是指无需知道类名称，直接动态获取就行。
            

            2.4.4 DefaultMethodCall

            java8的interface可以指定default实现，这个类就是用来，给interface添加defalut的实现的。

            2.4.5 MethodDelegation

            不错的参考

            委托调用，移花接木。将类的某个方法，指定成调用另外一个类的方法。
            
            

            它会匹配Target.hello(String)方法，但是这不够精确，比如 target 有三个hello方法呢，默认采用和编译一致的算法，需要 target 中方法签名为 hello(String) 。除此之外可以配合注解使用，来设置匹配的优先级。

            • @Argument 主要使用的注解
              
              判断是不是用来代理的方法。如果被判断的方法，没有两个以上(如图)，或者类型不匹配，就判断不是，继续下一个
              

            • @AllArguments
              被修饰的参数意味值必须为一个数组

            • @This and @Super
              

            注解	说明
            @Argument	绑定单个参数
            @AllArguments	绑定所有参数的数组
            @This	当前被拦截的、动态生成的那个对象
            @Super	当前被拦截的、动态生成的那个对象的父类对象
            @Origin	可以绑定到以下类型的参数：Method 被调用的原始方法；Constructor 被调用的原始构造器；Class 当前动态创建的类；MethodHandle；MethodType；String 动态类的toString()的返回值；int 动态方法的修饰符
            @DefaultCall	调用默认方法而非super的方法
            @SuperCall	用于调用父类版本的方法
            @Super	注入父类型对象，可以是接口，从而调用它的任何方法
            @RuntimeType	可以用在返回值、参数上，提示ByteBuddy禁用严格的类型检查
            @Empty	注入参数的类型的默认值
            @StubValue	注入一个存根值。对于返回引用、void的方法，注入null；对于返回原始类型的方法，注入0
            @FieldValue	注入被拦截对象的一个字段的值
            @Morph	类似于@SuperCall，但是允许指定调用参数

            2.4.6 SuperMethodCall

            调用父方法

            2.4.7 Annotations 注解修改

            • bytebuddy可修改类的注解（添加删除，修改）
            • bytebuddy也可以修改注解的属性，比如 value 值,或者注解本身的属性
              

            2.5 DynamicType 动态类型

            
            类型的载体

            • Loaded 对于加载进jvm的修改

            • Unloaded 未加载进jvm的修改

            类型的加载策略

            ClassLoadingStrategy

            • WRAPPER（默认）
              新建classloader,去加载缺点是和其他类不再一个namespace下。
            • CHILD_FIRST
              和WRAPPER类似，但是有classloader直接加载，不去请求上层classloader加载。好处是避免加载了同名的类，缺点是破坏了双亲委派模型
            • INJECTION
              使用反射调用当前的classloader的方法去加载。缺点是程序再次加载时找不到当前的修改。就是一次性的。

            三、字节码的修改

            ByteBuddyAgent

            可以看出一个字节吗的修改都是围绕着 new ByteBuddy() 。

            1. 设定类的创建类型 subclass，redefine, rebase。
            2. 添加方法或者类的匹配规则， matchaer
            3. 添加最后的修改行为 intercept
            4. 类的加载器
            5. with等方法来设定命名规则等。

            沿着类的构造器往下分析
            

            3.1 classFileVersion

            jDK语言的等级，现在已经到15了。 new ByteBuddy ，默认会设置为 jdk 6
            

            3.2 命名策略

            bytebuddy命名中有讲过，用 byteBuudy 对于新生成类，命名规则的设定

            3.3 注解过滤器

            AnnotationValueFilter，目的给一个类写注解的时候，决定让那些类跳过。

            3.4 注解策略

            注释保留策略决定是否在重新定义（redefine）时保留包含在类文件中的注释
            或rebase方法。 当保留注释时，不重复已经存在的注释很重要。
            保留注释时，它们将保留其原始格式。

            3.5 implement内容上下文

            implementation。前面提到过，是要依赖implementation来完成字节码生成。但是使用new ByteBuddy()时，需要设置一些列的内容。靠这些内容最后生成implementation。

            3.6 方法视图编译器 MethodGraph

            代表了一个方法集合的关系视图。
            Compiler用来生成一个MethodGraph。不同Compiler生成不同的，有默认的。

            3.7 字节码生成器类型InstrumentedType

            代表了最后生成Suject对象，包含了字节码的结构等。
            
            具体说明，如下是一个类的的字节码（class文件）。
            
            字节码本身一个table的结构。
            这个InstrumentedType就是代表这个table的结构。
            也包含了设置这个table得方法。
            比如withField（XXX），那么最后这个InstrumentedType就会被用来生成这样一个class文件。

            3.8 类型校验 TypeValidation

            TypeValidation
            如果启用类型验证，则Byte Buddy会执行多项检查以确保生成的
            类文件是以有效方式指定的。 这涉及检查生成的检测
            类型并检查生成的字节码。 Byte Buddy的
            实例独立于任何类型验证执行自己的检查。
            JVM的验证程序执行自己的检查； 永远不会加载非法的类文件。

            3.9 继承关系的Bridge

            VisibilityBridgeStrategy
            如果一个pubilc 类型，从一个package-private的type，继承了一个public method。那么使用反射invoke的时候,获取package-private的方法会是一个问题。

            这个Bridge可以让使用者看到package-private的方法，在使用反射时仅仅考虑该类的属性是什么，而不用担心其他权限。
            

            • ALWAYS 总是
            • ON_NON_GENERIC_METHOD java 11只为非泛型方法，可见
            • 都不可见

            3.10 class写入策略

            ClassWriterStrategy
            默认

            • CONSTANT_POOL_RETAINING 保留原有常量池
            • CONSTANT_POOL_DISCARDING 覆盖原先的常量池

            3.11 ignoredMethods

            指明要忽略的方法。

            3.12 重要的方法

            subclass

            构造器的策略是用来明确，创建子类使用的构造器类型
            

            构造器策略

            ConstructorStrategy负责为任何给定的类创建一组预定义的构造函数。

            • 除了上述复制动态类型的直接超类的每个可见构造函数的策略之外，
            • 还存在其他三种预定义策略：一种根本不创建任何构造函数，
            • 一种创建缺省构造函数，该默认构造函数调用直接超类的缺省构造函数，
            • 以及如果不存在这样的构造函数，并且仅模仿超级类型的公共构造函数，则抛出异常。

            redifine

            不保留原有的方式实现直接覆盖

            rebase

            保留原有的方法实现，将原先的方法重命名。

            三、compose agent.jar

            使用Agent.build替代直接使用instrumentation
            

            bytebuddy 进阶一、ByteBuddyAgent示例1.1 Attacher 负责启动agent.jar1.2 Intaller Instrumention对象的载体很简单的getInstrumentionpremain agentmain1.3 VirtualMachine jvm平台的支持Resover获取 jvm平台信息OPENJ9HotSpot1.4 ByteBuddyAgent(核心)Provider1. ProceessProvider2. AttachmentProvider3. Ag
            字节码增强技术- Byte Buddy 目录简介性能使用installHello World创建动态类加载类拦截方法通过匹配模式拦截方法委托参数绑定AgentElementMatcherTransformerEND Byte Buddy 是一个字节码生成和操作库，用于在Java应用程序运行时创建和修改Java类，而无需编译器的帮助。除了Java类库附带的代码生成实用程序外， Byte Buddy 还允许创建任意类，并且不限于实现用于创建运行时代理的接口。此外， Byte Buddy 提供了一种方便的API，可以使
            为了把一个物联网管理平台部署到Linux上，折腾了好半天，多亏有百度还有各位开发的朋友分享的踩坑经历和解决办法。现在终于部署好了，本着继承互联网分享精神的原则，把踩坑经历分享出来，给大家一份帮助 1.通过docker创建的容器，其对外暴露的端口号一般就是localhost端口号，应用中使用localhost去连接就可以了 2.shell终端对于系统环境变量的变化并不总是能即时响应，例如Java环境变量。这可能和shell上下文有关。因此检测环境变量是否修改可以多打开几个终端试试 3.标题中的错误，原因是使用
            @OnMethodEnter 表示这个方法会在，进入目标方法时调用，这个注解声明的方法必须是static。当目标的方法是constructor构造器时，@This只能写field，不能读field，或者调用方法 skipOn() 跳过一些方法 截至到本章节关于字节码框架 Byte - buddy 的大部分常用 API 的使用已经通过案例介绍比较全面了，接下来介绍关于如何去实现一个抽象类以及创建出相应注解(包括类的注解和方法的注解)的知识点。而注解的这部分内容在一些监控或者拦截处理的场景下还是比较常用的，所以在这章节我们会通过一个例子来创建出含有自定义注解的类和方法。 如果你已经阅读了之前的系列文章，这部分学习. <groupId>net. byte buddy </groupId> <artifactId> byte - buddy -agent</artifactId> <version>1.4.32</version> </dependency>
            为什么需要运行时代码生成 我们知道，Java 是一种强类型的编程语言，即要求所有变量和对象都有一个确定的类型，如果在赋值操作中出现类型不兼容的情况，就会抛出异常。强类型检查在大多数情况下是可行的，然而在某些特殊场景下，强类型检查则成了巨大的障碍。 例如，在对外提供一个通用 jar 包时，我们通常不能引用用户应用中定义的任何类型，因为当这个通用 jar 包被编译时，我们还不知道这些用户的自定义类型。为了调用用户自定义的类，访问其属性或方法，Java 类库提供了一套反射 API 帮助我们查找未知类型，以及调
            第03讲：掌握 Java Agent 真的可以为所欲为？ 我们在上一课时中，将 demo-provider 和 demo-webapp 接入 SkyWalking Agent 的时候，只需要在 VM options 中添加下面这一行配置即可： -javaagent:/path/to/skywalking-agent.jar \ -Dskywalking_config=/path/to/agent.config 并没有修改任何一行 Java 代码。这里便使用到了 Java Agent 技术，本课时