该篇文章是系列<一步一步实现简单安卓性能监控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方法。


 public static void premain(String agentArgs, Instrumentation instrumentation) {
 //TODO
 }

总结，这个方式启动
1、manifest中需要指定Premain-Class属性
2、agent 需要实现premain方法
3、premain方法会在程序的main方法之前执行
4、agentmain在这个方式下不会被调用
5、通过命令行加载javaagent的形式如下：

-javaagent:jarpath[=options]

一个示例如下：

java -javaagent:/pathToAgent/newagent.jar -jar test.jar

运行时加载javaagent

这个是jvm启动之后，通过attach方式加载的javaagent，需要在它的manifest文件中指定Agent-Class属性，它的值是javaagent的实现类，这个实现类需要实现一个agentmain方法。


 public static void agentmain(String agentArgs, Instrumentation instrumentation) {
 //TODO
 }

总结
1、manifest中需要指定Agent-Class属性
2、agent必须实现agentmain方法
3、agentmain方法会在javaagent被加载时执行
4、一般的attach方式


 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 .
 }

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

手动写一个简单的javaagent

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

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

new maven project .png

2、编写测试代码
由javaagent的介绍可知，如果支持命令行和运行时加载javaagent，需要提供两个方法。这里我们就这样做，并且测试代码的逻辑很简单，只是简单的输出一些测试内容！


 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 ! ");
 }
 }

3、编辑pom文件


 
  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">
 4.0.0 
 com.zxy.test.javaagent
hello
1.0-SNAPSHOT




    
        
            
                org.apache.maven.plugins
                maven-jar-plugin
                3.0.1
                
                    
                        
                            com.zxy.test.javaagent.hello.TestAgent
                            com.zxy.test.javaagent.hello.TestAgent
                            true
                            true

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

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

Paste_Image.png

新建一个测试程序

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

2、编写测试代码


 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 ! ");
 }
 }

3、编辑pom文件
这里注意，需要写入main class


 
  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">
 4.0.0
 com.zxy.test.javaagent.test
 main-program
 1.0-SNAPSHOT
 
 
 
 org.apache.maven.plugins
 maven-shade-plugin
 1.2.1
 
 
 package
 
 shade
 
 
 
 
 com.zxy.test.javaagent.test.Main

4、mvn命令打包！

运行自己写的javaagent程序

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

Paste_Image.png

打开命令行窗口执行


 java -javaagent:hello-1.0-SNAPSHOT.jar -jar main-program-1.0-SNAPSHOT.jar

javaagent运行结果

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

欢迎star

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


 文|孔祥子
 转载请注明！
 欢迎留言讨论

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