聲明:原創(chuàng)文章,轉(zhuǎn)載請(qǐng)注明出處。http://www.reibang.com/p/be092b1c72cb
Java字節(jié)碼系列
Java字節(jié)碼1-Agent簡(jiǎn)單上手
Java字節(jié)碼2-instrument初體驗(yàn)
Java字節(jié)碼3-使用ByteBuddy實(shí)現(xiàn)一個(gè)Java-Agent
Java字節(jié)碼4-使用Java-Agent實(shí)現(xiàn)一個(gè)JVM監(jiān)控工具
本系列代碼可見:https://github.com/hawkingfoo/demo-agent
一、概述
在上一節(jié)中Java字節(jié)碼1-Agent簡(jiǎn)單上手中惯裕,我們了解了通過一個(gè)Agent可以在main
方法前執(zhí)行。
本節(jié)中,我們將介紹java.lang.instrument
祸穷,通過instrument
可以實(shí)現(xiàn)一個(gè)Agent來修改類的字節(jié)碼。下面我們會(huì)借助javassist
實(shí)現(xiàn)一個(gè)簡(jiǎn)單的性能檢測(cè)工具勺三。目的是檢測(cè)函數(shù)的調(diào)用耗時(shí)雷滚,這里僅僅拋磚引玉,instrument
提供的更松耦合的AOP不止于此吗坚。
二祈远、實(shí)現(xiàn)一個(gè)函數(shù)檢測(cè)耗時(shí)Agent
1呆万、修改pom.xml
這里與上一節(jié)不同的是,我們需要額外引入javassist
包來增強(qiáng)Agent车份。
<dependency
<groupId>javassist</groupId
<artifactId>javassist</artifactId>
<version>3.12.1.GA</version>
<type>jar</type>
</dependency>
除此之外谋减,我們還需要將此Jar包打包到Agent中,見如下配置:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
<configuration>
<artifactSet>
<includes>
<include>javassist:javassist:jar:</include>
</includes>
</artifactSet>
</configuration>
</plugin>
2扫沼、實(shí)現(xiàn)一個(gè)Agent
public class MyAgent {
public static void premain(String agentArgs, Instrumentation inst) {
System.out.println("this is an perform monitor agent.");
// 添加 Transformer
ClassFileTransformer transformer = new PerformMonitorTransformer();
inst.addTransformer(transformer);
}
}
與上一節(jié)不同的是出爹,這里添加了一個(gè)Transformer
。
3缎除、實(shí)現(xiàn)一個(gè)Transformer類
public class PerformMonitorTransformer implements ClassFileTransformer {
private static final Set<String> classNameSet = new HashSet<>();
static {
classNameSet.add("com.example.demo.AgentTest");
}
@Override
public byte[] transform(ClassLoader loader,
String className,
Class<?> classBeingRedefined,
ProtectionDomain protectionDomain,
byte[] classfileBuffer) throws IllegalClassFormatException {
try {
String currentClassName = className.replaceAll("/", ".");
if (!classNameSet.contains(currentClassName)) { // 僅僅提升Set中含有的類
return null;
}
System.out.println("transform: [" + currentClassName + "]");
CtClass ctClass = ClassPool.getDefault().get(currentClassName);
CtBehavior[] methods = ctClass.getDeclaredBehaviors();
for (CtBehavior method : methods) {
enhanceMethod(method);
}
return ctClass.toBytecode();
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
private void enhanceMethod(CtBehavior method) throws Exception {
if (method.isEmpty()) {
return;
}
String methodName = method.getName();
if (methodName.equalsIgnoreCase("main")) { // 不提升main方法
return;
}
final StringBuilder source = new StringBuilder();
source.append("{")
.append("long start = System.nanoTime();\n") // 前置增強(qiáng): 打入時(shí)間戳
.append("$_ = $proceed($$);\n") // 保留原有的代碼處理邏輯
.append("System.out.print(\"method:[" + methodName + "]\");").append("\n")
.append("System.out.println(\" cost:[\" +(System.nanoTime() -start)+ \"ns]\");") // 后置增強(qiáng)
.append("}");
ExprEditor editor = new ExprEditor() {
@Override
public void edit(MethodCall methodCall) throws CannotCompileException {
methodCall.replace(source.toString());
}
};
method.instrument(editor);
}
}
上面的代碼中以政,我們?cè)鰪?qiáng)了Set中保存的類的方法,這里是“com.example.demo.AgentTest”伴找,如果是其他類需重新設(shè)置或?qū)⒋颂幣渲玫轿募小?/p>
通過enhanceMethod
方法盈蛮, 重新寫了其方法的字節(jié)碼,即對(duì)原有的方法體進(jìn)行了環(huán)繞增強(qiáng)技矮。
三抖誉、運(yùn)行
與上一節(jié)中的運(yùn)行方式相同,為了體現(xiàn)本節(jié)的內(nèi)容衰倦,我們修改了Test類增加了兩個(gè)方法:
public class AgentTest {
private void fun1() {
System.out.println("this is fun 1.");
}
private void fun2() {
System.out.println("this is fun 2.");
}
public static void main(String[] args) {
AgentTest test = new AgentTest();
test.fun1();
test.fun2();
}
運(yùn)行結(jié)果如下:
this is an perform monitor agent.
transform: [com.example.demo.AgentTest]
this is fun 1.
method:[fun1] cost:[79024ns]
this is fun 2.
method:[fun2] cost:[41164ns]
Process finished with exit code 0
從上面的運(yùn)行結(jié)果可以看到袒炉,我們對(duì)調(diào)用的兩個(gè)方法進(jìn)行了增強(qiáng),得到了其調(diào)用耗時(shí)樊零。