一步一步实现简单安卓性能监控SDK之回顾JavaAgent

该篇文章是系列<一步一步实现简单安卓性能监控SDK>第二篇文章,欢迎关注!其他文章,请看作者主页!

什么是javaagent

代理 (javaagent) 是在你的java程序的main方法前的一个拦截器 (interceptor),也就是在main方法执行之前,执行agent的代码。javaagent的运行依赖于一个特殊的JVMTIAgent。

javaagent的代码要执行的main方法在同一个JVM中运行,并被同一个system classloader装载,被同一的安全策略 (security policy) 和上下文 (context) 所管理。

Javaagent jar包结构

jar包结构和普通的jar包没啥区别,唯一值得注意的是多了几个配置:Premain-calss和Agent-Class两个配置项,如下图,我圈起来的部分


premain-class,顾名思义,就是在正式程序的main方法执行之前,需要执行哪些方法。下面会说到,这个方法会在使用命令行参数配置-javaagent的时候才会用到。

agent-class,这个配置会在java虚拟机加载了之后,如果再通过attach方式加载javaagent,就会调用这个配置的类中的名为agentmain 方法!

JVMTIAgent

说到javaagent,必须要讲的是一个叫做instrument的JVMTIAgent(Linux下对应的动态库是libinstrument.so),因为javaagent功能就是它来实现的,另外instrument agent还有个别名叫JPLISAgent(Java Programming Language Instrumentation Services Agent),这个名字也完全体现了其最本质的功能:就是专门为Java语言编写的插桩服务提供支持的。

JavaAgent的功能

1、可以在加载class文件之前做拦截,对字节码做修改
2、可以在运行期对已加载类的字节码做变更,但是这种情况下会有很多的限制,后面会详细说
3、还有其他一些小众的功能
4、获取所有已经加载过的类
5、获取所有已经初始化过的类(执行过clinit方法,是上面的一个子集)
6、获取某个对象的大小
7、将某个jar加入到bootstrap classpath里作为高优先级被bootstrapClassloader加载
8、将某个jar加入到classpath里供AppClassloard去加载
9、设置某些native方法的前缀,主要在查找native方法的时候做规则匹配

javaagent 启动

随jvm的启动而启动

这个情况也就是我们常见的在命令行参数后面加上-javaagent参数而启动的。通过这个方式启动的,需在它的manifest文件中指定Premain-Class属性,它的值是javaagent的实现类,这个实现类需要实现一个premain方法。
<pre>
public static void premain(String agentArgs, Instrumentation instrumentation) {
//TODO
}
</pre>

总结,这个方式启动
1、manifest中需要指定Premain-Class属性
2、agent 需要实现premain方法
3、premain方法会在程序的main方法之前执行
4、agentmain在这个方式下不会被调用
5、通过命令行加载javaagent的形式如下:
<pre>-javaagent:jarpath[=options]</pre>
一个示例如下:
<pre>java -javaagent:/pathToAgent/newagent.jar -jar test.jar</pre>

运行时加载javaagent

这个是jvm启动之后,通过attach方式加载的javaagent,需要在它的manifest文件中指定Agent-Class属性,它的值是javaagent的实现类,这个实现类需要实现一个agentmain方法。
<pre>
public static void agentmain(String agentArgs, Instrumentation instrumentation) {
//TODO
}
</pre>

总结
1、manifest中需要指定Agent-Class属性
2、agent必须实现agentmain方法
3、agentmain方法会在javaagent被加载时执行
4、一般的attach方式
<pre>
String nameOfRunningVM = ManagementFactory.getRuntimeMXBean().getName();
int p = nameOfRunningVM.indexOf('@');
String pid = nameOfRunningVM.substring(0, p); //获取进程号
String jarFilePath = "/pathToAgent/newagent.jar";
try {
VirtualMachine vm = VirtualMachine.attach(pid);
vm.loadAgent(jarFilePath);
vm.detach();
} catch (Exception e) {
//catch exception .
}
</pre>

注意:
如果通过命令行参数在JVM启动时加载,agentmain方法不会被调用。而在这个时候,应用中的类还没有被加载到虚拟机,所以给我们修改字节码带来了便利,因为一个类被加载之后,修改它的字节码会比较麻烦。

手动写一个简单的javaagent

新建javaagent的maven工程并写测试代码

1、首先在idea中新建maven工程

new maven project .png

2、编写测试代码
由javaagent的介绍可知,如果支持命令行和运行时加载javaagent,需要提供两个方法。这里我们就这样做,并且测试代码的逻辑很简单,只是简单的输出一些测试内容!
<pre>
package com.zxy.test.javaagent.hello;
import java.lang.instrument.Instrumentation;
/**

  • Created by zxy on 2017/3/28.
    */
    public class TestAgent {
    public static void agentmain(String agentArgs,Instrumentation instrumentation) {
    premain(agentArgs, instrumentation);
    System.out.println(" hello java agetnt! method agentmain method executed ! ");
    }

    public static void premain(String agentArgs, Instrumentation instrumentation) {
    System.out.println(" hello java agetnt! method premain method executed ! ");
    }
    }
    </pre>

3、编辑pom文件
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.zxy.test.javaagent</groupId>
<artifactId>hello</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>

</dependencies>
<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.0.1</version>
                <configuration>
                    <archive>
                        <manifestEntries>
                            <Premain-Class>com.zxy.test.javaagent.hello.TestAgent</Premain-Class>
                            <Agent-Class>com.zxy.test.javaagent.hello.TestAgent</Agent-Class>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

</project>
</pre>

注意代码中的manifestEntries这个元素中的子节点,必须不能少!里面的含义上面,已经介绍了就不多说了!

4、maven 打包
简单的程序,单元测试就省略了。直接运行mvn clean package ,没啥好说的!
打包结束之后会得到一个


Paste_Image.png

新建一个测试程序

1、新建一个maven工程
步骤同新建javaagent工程

2、编写测试代码
<pre>
package com.zxy.test.javaagent.test;

/**

  • Created by zxy on 2017/3/28.
    */
    public class Main {

    public static void main(String args [] ) {
    System.out.println(" program main method execute ! ");
    }
    }
    </pre>

3、编辑pom文件
这里注意,需要写入main class
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.zxy.test.javaagent.test</groupId>
<artifactId>main-program</artifactId>
<version>1.0-SNAPSHOT</version>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>1.2.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.zxy.test.javaagent.test.Main</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
</pre>

4、mvn命令打包!

运行自己写的javaagent程序

通过上面的两个简单的测试工程会得到两个jar包如下

Paste_Image.png

打开命令行窗口执行
<pre>
java -javaagent:hello-1.0-SNAPSHOT.jar -jar main-program-1.0-SNAPSHOT.jar
</pre>

javaagent运行结果

测试代码:https://github.com/codewithyou/learn-android-apm/tree/master/01-javaagent

欢迎star

参考:http://www.infoq.com/cn/articles/javaagent-illustrated

<pre>
文|孔祥子
转载请注明!
欢迎留言讨论
</pre>

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • 涉及知识点:APM, java Agent, plugin, bytecode, asm, InvocationH...
    zyq_neuq阅读 17,109评论 8 83
  • ProcessBuilder的改写逻辑 private static ClassAdapter createPro...
    孔祥子看天下阅读 635评论 0 0
  • 赏析1 《归去来兮辞》是一篇脱离仕途回归田园的豪迈宣言,陶渊明以诗心慧眼来透视生活,用生花妙笔来点化景物,通过无拘...
    彭小艾阅读 343评论 8 15
  • 也许从来不知道自己确切的方向,所以把梦叫做远方。 徘徊在整天无聊枯燥的试卷里,有时候我也会怀疑,这休止的尽头究竟是...
    我好酷啊我最酷阅读 103评论 0 1