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

        <dependency>
            <groupId>org.javassist</groupId>
            <artifactId>javassist</artifactId>
            <version>3.27.0-GA</version>
        </dependency>

为了能让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

......

<build>
        <finalName>test-agent</finalName>
        <plugins>
            <!--
            META-INF 下 MANIFEST.MF 文件 内容
            Manifest-Version: 1.0
            Premain-Class: com.jenson.TestAgent
            下面Maven插件可以自动实现
            -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.0.0</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer
                                        implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"
                                >
                                    <manifestEntries>
                                        <Premain-Class>com.jenson.TestAgent</Premain-Class>
                                        <!--<Can-Redefine-Classes>${can.redefine.classes}</Can-Redefine-Classes>-->
                                        <!--<Can-Retransform-Classes>${can.retransform.classes}</Can-Retransform-Classes>-->
                                    </manifestEntries>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
......

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

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

推荐阅读更多精彩内容