bytebuddy動態(tài)加載原理解析

前言

bytebuddy是一個提供了一個API用于生成任意的Java類工具包,給需要編寫javaagent的代碼用戶提供了一個很方便的工具。

一般來說,如果要編寫agent代碼一般都是從premain函數(shù)開始,然后在啟動的時候通過-javaagent命令進(jìn)行啟動,bytebuddy提供了一個動態(tài)加載agent方式的api,本文主要分析這個api的工作原理,本文使用的bytebuddy版本是1.4.21

開始

動態(tài)加載javaagent主要是在程序運(yùn)行過程中通過 ByteBuddyAgent.install(); 獲得 Instrumentation inst 對象,而不是在啟動的時候通過加入-javaagent來獲得 Instrumentation inst 對象。

ByteBuddyAgent.install(); 源碼里面剛開始就是設(shè)置一些默認(rèn)的配置,接下來就是最關(guān)鍵的代碼

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,然后進(jìn)入到函數(shù) 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 對象里面就是剛才上面加入的一些默認(rèn)的設(shè)置,里面主要是設(shè)置了一個類型為 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方法,然后傳入當(dāng)前進(jìn)程號,來attach到當(dāng)前進(jìn)程的vm上面,然后通過loadAgent方法,把bytebuddyAgent.jar 加載到進(jìn)程中

那么 bytebuddyAgent.jar是從哪里來的呢? 就是 agentProvider.resolve().getAbsolutePath() 來得到的,他是在代碼運(yùn)行時產(chǎn)生的一個臨時文件,產(chǎn)生的代碼是

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文件,為什么要產(chǎn)生這2個文件?

Manifest文件是loadAgent方法加載agent.jar的時候,需要去讀的一個配置文件,里面有一個屬性Agent-Class: net.bytebuddy.agent.Installer 指定了一個類,就是表示要執(zhí)行這個類的agentmain方法,這個時候loadAgent會傳入Instrumentation inst對象,這樣在當(dāng)前的ClassLoader里面就會得到并且保存這個對象了,用于以后class類文件的改造。

Installer.class文件就是Manifest文件里面指定的class,用于啟動agentmain方法的入口類文件,里面就一個Instrumentation inst成員和一個agentmain方法

生成了上面的2個文件以后,通過zip方法壓縮成一個jar包,保存到臨時目錄,然后把這個臨時目錄的絕對地址傳入到loadAgent方法,就算完成了agent的啟動。

最后再通過attachmentAccessor.getVirtualMachineType().getDeclaredMethod(DETACH_METHOD_NAME).invoke(virtualMachineInstance); 把a(bǔ)ttach上的jvm進(jìn)行detach

所以通過上面的一系列步驟,就把inst對象加入到了當(dāng)前的classloader里面,以后再通過這個inst對象,就可以對ClassFileTransformer對象進(jìn)行操作,完成class文件的修改工作了。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容