bytebuddy动态加载原理解析

前言

bytebuddy是一个提供了一个API用于生成任意的Java类工具包,给需要编写javaagent的代码用户提供了一个很方便的工具。

一般来说,如果要编写agent代码一般都是从premain函数开始,然后在启动的时候通过-javaagent命令进行启动,bytebuddy提供了一个动态加载agent方式的api,本文主要分析这个api的工作原理,本文使用的bytebuddy版本是1.4.21

开始

动态加载javaagent主要是在程序运行过程中通过 ByteBuddyAgent.install(); 获得 Instrumentation inst 对象,而不是在启动的时候通过加入-javaagent来获得 Instrumentation inst 对象。

ByteBuddyAgent.install(); 源码里面刚开始就是设置一些默认的配置,接下来就是最关键的代码

public static synchronized Instrumentation install(AttachmentProvider attachmentProvider, ProcessProvider processProvider) {    
    Instrumentation instrumentation = doGetInstrumentation();    
    if (instrumentation != null) {        
        return instrumentation;    
    }    
    install(attachmentProvider, processProvider.resolve(),  AgentProvider.ForByteBuddyAgent.INSTANCE);   
    return doGetInstrumentation();
}

刚开始尝试获得 Instrumentation, 如果是第一次启动,就会返回null,然后进入到函数 install

private static void install(AttachmentProvider attachmentProvider, String processId, AgentProvider agentProvider) {
        AttachmentProvider.Accessor attachmentAccessor = attachmentProvider.attempt();
        if (!attachmentAccessor.isAvailable()) {
            throw new IllegalStateException();
        }
        try {
            Object virtualMachineInstance = attachmentAccessor.getVirtualMachineType()
                    .getDeclaredMethod(ATTACH_METHOD_NAME, String.class)
                    .invoke(STATIC_MEMBER, processId);
            try {
                attachmentAccessor.getVirtualMachineType()
                        .getDeclaredMethod(LOAD_AGENT_METHOD_NAME, String.class, String.class)
                        .invoke(virtualMachineInstance, agentProvider.resolve().getAbsolutePath(), WITHOUT_ARGUMENTS);
            } finally {
                attachmentAccessor.getVirtualMachineType().getDeclaredMethod(DETACH_METHOD_NAME).invoke(virtualMachineInstance);
            }
        } catch (RuntimeException exception) {
            throw exception;
        } catch (Exception exception) {
            throw new IllegalStateException("Error during attachment using: " + attachmentProvider, exception);
        }
    }

attachmentAccessor 对象里面就是刚才上面加入的一些默认的设置,里面主要是设置了一个类型为 Class<?> clazz = com.sun.tools.attach.VirtualMachine.getClass() 成员, 这个作用是什么可以参考: https://docs.oracle.com/javase/7/docs/jdk/api/attach/spec/com/sun/tools/attach/VirtualMachine.html

然后通过反射VirtualMachine类里面的attach方法,然后传入当前进程号,来attach到当前进程的vm上面,然后通过loadAgent方法,把bytebuddyAgent.jar 加载到进程中

那么 bytebuddyAgent.jar是从哪里来的呢? 就是 agentProvider.resolve().getAbsolutePath() 来得到的,他是在代码运行时产生的一个临时文件,产生的代码是

public File resolve() throws IOException {
                File agentJar;
                InputStream inputStream = Installer.class.getResourceAsStream('/' + Installer.class.getName().replace('.', '/') + CLASS_FILE_EXTENSION);
                if (inputStream == null) {
                    throw new IllegalStateException("Cannot locate class file for Byte Buddy installer");
                }
                try {
                    agentJar = File.createTempFile(AGENT_FILE_NAME, JAR_FILE_EXTENSION);
                    agentJar.deleteOnExit(); // Agent jar is required until VM shutdown due to lazy class loading.
                    Manifest manifest = new Manifest();
                    manifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, MANIFEST_VERSION_VALUE);
                    manifest.getMainAttributes().put(new Attributes.Name(AGENT_CLASS_PROPERTY), Installer.class.getName());
                    manifest.getMainAttributes().put(new Attributes.Name(CAN_REDEFINE_CLASSES_PROPERTY), Boolean.TRUE.toString());
                    manifest.getMainAttributes().put(new Attributes.Name(CAN_RETRANSFORM_CLASSES_PROPERTY), Boolean.TRUE.toString());
                    manifest.getMainAttributes().put(new Attributes.Name(CAN_SET_NATIVE_METHOD_PREFIX), Boolean.TRUE.toString());
                    JarOutputStream jarOutputStream = new JarOutputStream(new FileOutputStream(agentJar), manifest);
                    try {
                        jarOutputStream.putNextEntry(new JarEntry(Installer.class.getName().replace('.', '/') + CLASS_FILE_EXTENSION));
                        byte[] buffer = new byte[BUFFER_SIZE];
                        int index;
                        while ((index = inputStream.read(buffer)) != END_OF_FILE) {
                            jarOutputStream.write(buffer, START_INDEX, index);
                        }
                        jarOutputStream.closeEntry();
                    } finally {
                        jarOutputStream.close();
                    }
                } finally {
                    inputStream.close();
                }
                return agentJar;
            }

这份代码主要就是生成了2个文件,一个是Manifest文件,一个是Installer.class文件,为什么要产生这2个文件?

Manifest文件是loadAgent方法加载agent.jar的时候,需要去读的一个配置文件,里面有一个属性Agent-Class: net.bytebuddy.agent.Installer 指定了一个类,就是表示要执行这个类的agentmain方法,这个时候loadAgent会传入Instrumentation inst对象,这样在当前的ClassLoader里面就会得到并且保存这个对象了,用于以后class类文件的改造。

Installer.class文件就是Manifest文件里面指定的class,用于启动agentmain方法的入口类文件,里面就一个Instrumentation inst成员和一个agentmain方法

生成了上面的2个文件以后,通过zip方法压缩成一个jar包,保存到临时目录,然后把这个临时目录的绝对地址传入到loadAgent方法,就算完成了agent的启动。

最后再通过attachmentAccessor.getVirtualMachineType().getDeclaredMethod(DETACH_METHOD_NAME).invoke(virtualMachineInstance); 把attach上的jvm进行detach

所以通过上面的一系列步骤,就把inst对象加入到了当前的classloader里面,以后再通过这个inst对象,就可以对ClassFileTransformer对象进行操作,完成class文件的修改工作了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容