javaagent简单demo

本来想学习java字节码相关操作,找了本书由下至上的学习,书本知识从基础开始讲起,但实在太枯燥很没成就感也记不住。书本中的demo也与实际操作有出入,就很绝望。
本着“实践出真知”的信条,就换种方式,由上至下的去学习,最后再花时间去做系统的充实。

JDK1.5引入了java.lang.instrument包,开发者可以很方便的实现字节码增强。其核心功能由java.lang.instrument.Instrumentation接口提供。

Instrumentation 有两种使用方式:
1、JVM启动的时候添加一个Agent的jar包
2、在JVM运行以后在任意时刻通过Attach API远程家在Agent的jar包

以下是javaagent的例子:

TestAgent

package com.jenson;

import java.lang.instrument.Instrumentation;

/**
 * @author Jenson
 */
public class TestAgent {

    /**
     * 在main方法运行前,与main方法运行于同一JVM中
     *
     * @param agentArgs agentArgs是premain函数得到的程序参数,随同"-javaagent"一同传入,
     *                  与main函数不同的是,该参数是一个字符串而不是一个字符串数组,
     *                  如果程序参数有多个,程序将自行解析这个字符串
     * @param inst      一个java.lang.instrument.Instrumentation实例,由JVM自动传入,
     *                  java.lang.instrument.Instrumentation是instrument包中的一个接口,
     *                  也是核心部分,集中了其中几乎所有的功能方法,例如类定义的转换和操作
     */
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("==============premain1 执行===================");
        System.out.println("agentArgs : " + agentArgs);
        // 添加Transformer
        inst.addTransformer(new TestTransformer());
    }
}

TestTransformer

/**
 * @author Jenson
 */
public class TestTransformer implements ClassFileTransformer {

    public final String TEST_CLASS_NAME = "com.jenson.controller.v1.HelloFoolController";

    public final String METHOD_NAME = "hello";


    public byte[] transform(ClassLoader loader,
                            String className,
                            Class classBeingRedefined,
                            ProtectionDomain protectionDomain,
                            byte[] classfileBuffer) throws IllegalClassFormatException {

//      System.out.println("className : " + className);

        String finalClassName = className.replace("/", ".");

        if (TEST_CLASS_NAME.equals(finalClassName)) {
            System.out.println("class name 匹配上了 !");

            CtClass ctClass;

            try {
                ctClass = ClassPool.getDefault().get(finalClassName);
                System.out.println("ctClass is OK !");
                CtMethod ctMethod = ctClass.getDeclaredMethod(METHOD_NAME);
                System.out.println("CtMethod is OK !");
                ctMethod.insertBefore("System.out.println(\"字节码添加成功,打印日志 !\");");
                return ctClass.toBytecode();
            } catch (Exception e) {
                e.printStackTrace();
                System.out.println(e.getMessage());
            }
        }

        return null;
    }
}

这里使用了javassist,需要引入依赖

pom.xml

        
            org.javassist
            javassist
            3.27.0-GA
        

为了能让JVM识别到Agent的入口类,需要在jar包的MANIFEST.MF文件中指定Premain-Class等信息,一个典型的生成好的MANIFEST.MF内容如下

Premain-Class: com.jenson.TestAgent
Agent-Class: com.jenson.TestAgent
Can-Redefine-Classes: true
Can-Retransform-Classes: true

但是没有用这个,maven有插件可以生成

pom.xml

......


        test-agent
        
            
            
                org.apache.maven.plugins
                maven-shade-plugin
                3.0.0
                
                    
                        package
                        
                            shade
                        
                        
                            
                                
                                    
                                        com.jenson.TestAgent
                                        
                                        
                                    
                                
                            
                        
                    
                
            
        
    
......

mvn package

图片.png

下面是使用该javaagent的应用,就是个普通的简单springboot应用,如下:

SimpleSpringBootDemoApplication

package com.jenson;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author Jenson
 */
@SpringBootApplication
public class SimpleSpringBootDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SimpleSpringBootDemoApplication.class, args);
    }
}

HelloFoolController

package com.jenson.controller.v1;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Jenson
 */
@RestController
@RequestMapping("/fool")
@Slf4j
public class HelloFoolController {

    @GetMapping("/hello")
    public String hello() {

        return "hello fool";
    }
}

application.yml

server:
  port: 8010
management:
  server:
    port: 8011
  endpoint:
    health:
      enabled: true

spring:
  application:
    name: simple-spring-boot-demo

添加javaagent启动参数,可以用命令行启动,这里用IDEA配置


图片.png

启动,打印出日志

图片.png

调用接口http://localhost:8010/fool/hello,打印出日志,说明字节码写入成功

图片.png

参考视频教程:https://www.bilibili.com/video/BV1pU4y1W74V?share_source=copy_web

你可能感兴趣的:(javaagent简单demo)