使用 Javassist 记录方法调用和参数值，如何使记录器 class 在每个检测的 class 中可见？
Using Javassist to log method calls and argument values, how to make a logger class visible in every instrumented class?
该工具（在 this repo 中）包含 3 个 classes（如下所示）。问题是如何使我的 ParaTracer.Logger class 在每个 class I 仪器中可见（例如下面显示的 java.util.Random）。语句 cp.importPackage( "ParaTracer.Logger"); 似乎不起作用，我收到此错误：
java.lang.NoClassDefFoundError: ParaTracer/Logger
at java.util.Random.nextLong(Random.java)
我尝试在每个已检测的 class 中动态加载 Logger class。但似乎我使用 Class.getMethod() 不正确，或者 Javassist 编译器太原始无法编译动态 class-loading 代码。我收到此错误：
javassist.CannotCompileException: [source error] getMethod(java.lang.String,java.lang.Class,java.lang.Class) not found in java.lang.Class
以下 3 classes 被导出到一个 JAR 文件中，其中 MANIFEST.MF 文件定义了 Premain-Class 并在 运行 任何检测程序使用时传递给 JVM开关：
-javaagent:/Path/To/ParaTracerAgent.jar
这是 3 个 classes.
package ParaTracer;
import java.lang.instrument.Instrumentation;
import javassist.CannotCompileException;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtField;
import javassist.CtNewConstructor;
import javassist.CtNewMethod;
public class ParaTracer {
private static volatile Instrumentation instr;
public static void premain(String agentArgs, Instrumentation inst) {
instr = inst;
SimpleClassTransformer transformer = new SimpleClassTransformer();
inst.addTransformer( transformer, false );
}
}
变压器class:
package ParaTracer;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;
import java.util.HashMap;
import java.util.HashSet;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
public class SimpleClassTransformer implements ClassFileTransformer {
public HashMap< String, HashSet< String > > mInstrumentedMethods;
public SimpleClassTransformer() {
mInstrumentedMethods = new HashMap< String, HashSet< String > >();
mInstrumentedMethods.put( "java.util.Random", new HashSet< String >() );
mInstrumentedMethods.get( "java.util.Random").add( "nextLong" );
}
@Override
public byte[] transform(
ClassLoader loader,
String className,
Class<?> classBeingRedefined,
ProtectionDomain protectionDomain,
byte[] classfileBuffer) throws IllegalClassFormatException {
System.err.println( "---- Instrumenting: " + className );
byte[] byteCode = classfileBuffer;
String normalizedClassName = className.replaceAll("/", ".");
if ( mInstrumentedMethods.containsKey( normalizedClassName ) ) {
try {
ClassPool cp = ClassPool.getDefault();
cp.importPackage( "ParaTracer.Logger");
CtClass cc = cp.get( normalizedClassName );
for( String method : mInstrumentedMethods.get( normalizedClassName ) ) {
CtMethod m = cc.getDeclaredMethod( method );
StringBuilder sbs = new StringBuilder();
sbs.append( "long tid = Thread.currentThread().getId();" );
sbs.append( "StringBuilder sbArgs = new StringBuilder();" );
sbs.append( "sbArgs.append( System.identityHashCode( [=13=] ) );" );
CtClass[] pTypes = m.getParameterTypes();
for( int i=0; i < pTypes.length; ++i ) {
CtClass pType = pTypes[i];
if ( pType.isPrimitive() ) {
sbs.append( "sbArgs.append( \", \" + $args[" + i + "] );" );
} else {
sbs.append( "sbArgs.append( \", \" + System.identityHashCode( $args[" + i + "] ) );" );
}
}
sbs.append( "ParaTracer.Logger.pushArgs( tid, sbArgs.toString() );" );
sbs.append( "StringBuilder sb = new StringBuilder();" );
sbs.append( "sb.append( tid + \" : " + m.getLongName() + ".<START>(\" );" );
sbs.append( "sb.append( sbArgs.toString() );" );
sbs.append( "sb.append( \")\" );" );
sbs.append( "ParaTracer.Logger.print( sb.toString() );" );
m.insertBefore("{" + sbs.toString() + "}");
StringBuilder sbe = new StringBuilder();
sbe.append( "long tid = Thread.currentThread().getId();" );
sbe.append( "String args = ParaTracer.Logger.popArgs( tid );" );
sbe.append( "StringBuilder sb = new StringBuilder();" );
sbe.append( "sb.append( tid + \" : " + m.getLongName() + ".<END>(\" );" );
sbe.append( "sb.append( args );" );
sbe.append( "sb.append( \")\" );" );
sbe.append( "ParaTracer.Logger.print( sb.toString() );" );
m.insertAfter("{" + sbe.toString() + "}");
}
byteCode = cc.toBytecode();
cc.detach();
} catch (Exception ex) {
ex.printStackTrace();
}
}
return byteCode;
}
}
线程安全记录器 class 由：
package ParaTracer;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Stack;
public class Logger {
private static String loggerFilePath = "\"/some/fixed/path\"";
private static FileWriter fw;
private static PrintWriter out;
private static HashMap< Long, Stack<String> > callStacks;
public static synchronized void pushArgs( long tid, String args ) {
try {
init();
} catch (IOException e) {
e.printStackTrace();
}
if ( ! callStacks.containsKey( tid ) ) {
callStacks.put( tid, new Stack<String>() );
}
callStacks.get( tid ).push( args );
}
public static synchronized String popArgs( long tid ) {
assert( callStacks.containsKey( tid ) );
assert( ! callStacks.get( tid ).empty() );
return callStacks.get( tid ).pop();
}
public static synchronized void shutdown() {
if ( fw == null ) return;
try {
fw.close();
} catch (IOException e) {
e.printStackTrace();
}
}
public static synchronized void print( String str ) {
try {
init();
} catch (IOException e) {
e.printStackTrace();
}
out.print( str );
}
private static void init() throws IOException {
if ( fw != null ) return;
fw = new FileWriter( loggerFilePath );
out = new PrintWriter( fw );
callStacks = new HashMap< Long, Stack<String> >();
}
}
我最终得到 ClassFileTransformer.tranform 方法如下：
基本上，Javassist 插入的代码在每次有消息要写出时都会重新打开同一个日志文件，并且 appends消息到输出文件。拥有一个单独的日志文件很重要，因为如果这些流已被检测应用程序使用（通常是这种情况），则重定向标准 output/error 将导致日志文件被污染。
@Override
public byte[] transform(
ClassLoader loader,
String className,
Class<?> classBeingRedefined,
ProtectionDomain protectionDomain,
byte[] classfileBuffer)
throws IllegalClassFormatException {
byte[] byteCode = classfileBuffer;
String normalizedClassName = className.replaceAll("/", ".");
System.out.println( "\tNormalized: " + normalizedClassName );
ClassMonitorSet classMonitorSet = monitorClass( normalizedClassName );
if ( classMonitorSet != null ) {
System.out.println( "\tMonitoring: " + normalizedClassName );
try {
ClassPool cp = ClassPool.getDefault();
CtClass cc = cp.get( normalizedClassName );
for( String methodName : classMonitorSet.monitorSet ) {
CtMethod[] methods = cc.getDeclaredMethods( methodName );
for( CtMethod method : methods ) {
StringBuilder sbs = new StringBuilder();
sbs.append( "long tid = Thread.currentThread().getId();" );
sbs.append( "StringBuilder sbArgs = new StringBuilder();" );
sbs.append( "sbArgs.append( System.identityHashCode( [=10=] ) );" );
CtClass[] pTypes = method.getParameterTypes();
for( int i=0; i < pTypes.length; ++i ) {
CtClass pType = pTypes[i];
if ( pType.isPrimitive() ) {
sbs.append( "sbArgs.append( \", \" + $args[" + i + "] );" );
} else {
sbs.append( "sbArgs.append( \", \" + System.identityHashCode( $args[" + i + "] ) );" );
}
}
sbs.append( "StringBuilder sb = new StringBuilder();" );
sbs.append( "sb.append( tid + \" : " + method.getLongName() + ".<START>(\" );" );
sbs.append( "sb.append( sbArgs.toString() );" );
sbs.append( "sb.append( \")\" );" );
sbs.append( "String fPath = \"/path/to/log.out\";" );
sbs.append( "try {" );
sbs.append( " java.io.FileWriter fw = new java.io.FileWriter( fPath, true );" );
sbs.append( " java.io.PrintWriter out = new java.io.PrintWriter( fw, true );" );
sbs.append( " out.println( sb.toString() );" );
sbs.append( " fw.close();" );
sbs.append( "} catch (java.io.IOException e) {" );
sbs.append( " e.printStackTrace();" );
sbs.append( "}" );
method.insertBefore("{" + sbs.toString() + "}");
StringBuilder sbe = new StringBuilder();
sbe.append( "long tid = Thread.currentThread().getId();" );
sbe.append( "StringBuilder sb = new StringBuilder();" );
sbe.append( "sb.append( tid + \" : " + method.getLongName() + ".<END>(*)\" );" );
sbe.append( "String fPath = \"/path/to/log.out\";" );
sbe.append( "try {" );
sbe.append( " java.io.FileWriter fw = new java.io.FileWriter( fPath, true );" );
sbe.append( " java.io.PrintWriter out = new java.io.PrintWriter( fw, true );" );
sbe.append( " out.println( sb.toString() );" );
sbe.append( " fw.close();" );
sbe.append( "} catch (java.io.IOException e) {" );
sbe.append( " e.printStackTrace();" );
sbe.append( "}" );
method.insertAfter("{" + sbe.toString() + "}");
}
}
byteCode = cc.toBytecode();
cc.detach();
} catch (Exception ex) {
ex.printStackTrace();
}
}
return byteCode;
}
根据 the documentation for Java agents，代理 class 由 系统 class 加载程序加载。但是如果你想检测核心 Java classes 并从中引用你自己的自定义 class 那么 class 需要对 [=21] 可用=]bootstrap class加载程序而不是系统加载程序。
将您的 Logger class 移动到一个单独的 JAR 文件中，并在代理 JAR 清单的 Boot-Class-Path 属性中列出该文件：
Boot-Class-Path: ParaTracerLogger.jar
现在记录器 class 在 bootstrap 加载器上可见，并且可以被检测 java.lang classes.
看到
该工具（在 this repo 中）包含 3 个 classes（如下所示）。问题是如何使我的 ParaTracer.Logger class 在每个 class I 仪器中可见（例如下面显示的 java.util.Random）。语句 cp.importPackage( "ParaTracer.Logger"); 似乎不起作用，我收到此错误：
java.lang.NoClassDefFoundError: ParaTracer/Logger
at java.util.Random.nextLong(Random.java)
我尝试在每个已检测的 class 中动态加载 Logger class。但似乎我使用 Class.getMethod() 不正确，或者 Javassist 编译器太原始无法编译动态 class-loading 代码。我收到此错误：
javassist.CannotCompileException: [source error] getMethod(java.lang.String,java.lang.Class,java.lang.Class) not found in java.lang.Class
以下 3 classes 被导出到一个 JAR 文件中，其中 MANIFEST.MF 文件定义了 Premain-Class 并在 运行 任何检测程序使用时传递给 JVM开关：
-javaagent:/Path/To/ParaTracerAgent.jar
这是 3 个 classes.
package ParaTracer;
import java.lang.instrument.Instrumentation;
import javassist.CannotCompileException;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtField;
import javassist.CtNewConstructor;
import javassist.CtNewMethod;
public class ParaTracer {
private static volatile Instrumentation instr;
public static void premain(String agentArgs, Instrumentation inst) {
instr = inst;
SimpleClassTransformer transformer = new SimpleClassTransformer();
inst.addTransformer( transformer, false );
}
}
变压器class:
package ParaTracer;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;
import java.util.HashMap;
import java.util.HashSet;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
public class SimpleClassTransformer implements ClassFileTransformer {
public HashMap< String, HashSet< String > > mInstrumentedMethods;
public SimpleClassTransformer() {
mInstrumentedMethods = new HashMap< String, HashSet< String > >();
mInstrumentedMethods.put( "java.util.Random", new HashSet< String >() );
mInstrumentedMethods.get( "java.util.Random").add( "nextLong" );
}
@Override
public byte[] transform(
ClassLoader loader,
String className,
Class<?> classBeingRedefined,
ProtectionDomain protectionDomain,
byte[] classfileBuffer) throws IllegalClassFormatException {
System.err.println( "---- Instrumenting: " + className );
byte[] byteCode = classfileBuffer;
String normalizedClassName = className.replaceAll("/", ".");
if ( mInstrumentedMethods.containsKey( normalizedClassName ) ) {
try {
ClassPool cp = ClassPool.getDefault();
cp.importPackage( "ParaTracer.Logger");
CtClass cc = cp.get( normalizedClassName );
for( String method : mInstrumentedMethods.get( normalizedClassName ) ) {
CtMethod m = cc.getDeclaredMethod( method );
StringBuilder sbs = new StringBuilder();
sbs.append( "long tid = Thread.currentThread().getId();" );
sbs.append( "StringBuilder sbArgs = new StringBuilder();" );
sbs.append( "sbArgs.append( System.identityHashCode( [=13=] ) );" );
CtClass[] pTypes = m.getParameterTypes();
for( int i=0; i < pTypes.length; ++i ) {
CtClass pType = pTypes[i];
if ( pType.isPrimitive() ) {
sbs.append( "sbArgs.append( \", \" + $args[" + i + "] );" );
} else {
sbs.append( "sbArgs.append( \", \" + System.identityHashCode( $args[" + i + "] ) );" );
}
}
sbs.append( "ParaTracer.Logger.pushArgs( tid, sbArgs.toString() );" );
sbs.append( "StringBuilder sb = new StringBuilder();" );
sbs.append( "sb.append( tid + \" : " + m.getLongName() + ".<START>(\" );" );
sbs.append( "sb.append( sbArgs.toString() );" );
sbs.append( "sb.append( \")\" );" );
sbs.append( "ParaTracer.Logger.print( sb.toString() );" );
m.insertBefore("{" + sbs.toString() + "}");
StringBuilder sbe = new StringBuilder();
sbe.append( "long tid = Thread.currentThread().getId();" );
sbe.append( "String args = ParaTracer.Logger.popArgs( tid );" );
sbe.append( "StringBuilder sb = new StringBuilder();" );
sbe.append( "sb.append( tid + \" : " + m.getLongName() + ".<END>(\" );" );
sbe.append( "sb.append( args );" );
sbe.append( "sb.append( \")\" );" );
sbe.append( "ParaTracer.Logger.print( sb.toString() );" );
m.insertAfter("{" + sbe.toString() + "}");
}
byteCode = cc.toBytecode();
cc.detach();
} catch (Exception ex) {
ex.printStackTrace();
}
}
return byteCode;
}
}
线程安全记录器 class 由：
package ParaTracer;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Stack;
public class Logger {
private static String loggerFilePath = "\"/some/fixed/path\"";
private static FileWriter fw;
private static PrintWriter out;
private static HashMap< Long, Stack<String> > callStacks;
public static synchronized void pushArgs( long tid, String args ) {
try {
init();
} catch (IOException e) {
e.printStackTrace();
}
if ( ! callStacks.containsKey( tid ) ) {
callStacks.put( tid, new Stack<String>() );
}
callStacks.get( tid ).push( args );
}
public static synchronized String popArgs( long tid ) {
assert( callStacks.containsKey( tid ) );
assert( ! callStacks.get( tid ).empty() );
return callStacks.get( tid ).pop();
}
public static synchronized void shutdown() {
if ( fw == null ) return;
try {
fw.close();
} catch (IOException e) {
e.printStackTrace();
}
}
public static synchronized void print( String str ) {
try {
init();
} catch (IOException e) {
e.printStackTrace();
}
out.print( str );
}
private static void init() throws IOException {
if ( fw != null ) return;
fw = new FileWriter( loggerFilePath );
out = new PrintWriter( fw );
callStacks = new HashMap< Long, Stack<String> >();
}
}
我最终得到 ClassFileTransformer.tranform 方法如下：
基本上，Javassist 插入的代码在每次有消息要写出时都会重新打开同一个日志文件，并且 appends消息到输出文件。拥有一个单独的日志文件很重要，因为如果这些流已被检测应用程序使用（通常是这种情况），则重定向标准 output/error 将导致日志文件被污染。
@Override
public byte[] transform(
ClassLoader loader,
String className,
Class<?> classBeingRedefined,
ProtectionDomain protectionDomain,
byte[] classfileBuffer)
throws IllegalClassFormatException {
byte[] byteCode = classfileBuffer;
String normalizedClassName = className.replaceAll("/", ".");
System.out.println( "\tNormalized: " + normalizedClassName );
ClassMonitorSet classMonitorSet = monitorClass( normalizedClassName );
if ( classMonitorSet != null ) {
System.out.println( "\tMonitoring: " + normalizedClassName );
try {
ClassPool cp = ClassPool.getDefault();
CtClass cc = cp.get( normalizedClassName );
for( String methodName : classMonitorSet.monitorSet ) {
CtMethod[] methods = cc.getDeclaredMethods( methodName );
for( CtMethod method : methods ) {
StringBuilder sbs = new StringBuilder();
sbs.append( "long tid = Thread.currentThread().getId();" );
sbs.append( "StringBuilder sbArgs = new StringBuilder();" );
sbs.append( "sbArgs.append( System.identityHashCode( [=10=] ) );" );
CtClass[] pTypes = method.getParameterTypes();
for( int i=0; i < pTypes.length; ++i ) {
CtClass pType = pTypes[i];
if ( pType.isPrimitive() ) {
sbs.append( "sbArgs.append( \", \" + $args[" + i + "] );" );
} else {
sbs.append( "sbArgs.append( \", \" + System.identityHashCode( $args[" + i + "] ) );" );
}
}
sbs.append( "StringBuilder sb = new StringBuilder();" );
sbs.append( "sb.append( tid + \" : " + method.getLongName() + ".<START>(\" );" );
sbs.append( "sb.append( sbArgs.toString() );" );
sbs.append( "sb.append( \")\" );" );
sbs.append( "String fPath = \"/path/to/log.out\";" );
sbs.append( "try {" );
sbs.append( " java.io.FileWriter fw = new java.io.FileWriter( fPath, true );" );
sbs.append( " java.io.PrintWriter out = new java.io.PrintWriter( fw, true );" );
sbs.append( " out.println( sb.toString() );" );
sbs.append( " fw.close();" );
sbs.append( "} catch (java.io.IOException e) {" );
sbs.append( " e.printStackTrace();" );
sbs.append( "}" );
method.insertBefore("{" + sbs.toString() + "}");
StringBuilder sbe = new StringBuilder();
sbe.append( "long tid = Thread.currentThread().getId();" );
sbe.append( "StringBuilder sb = new StringBuilder();" );
sbe.append( "sb.append( tid + \" : " + method.getLongName() + ".<END>(*)\" );" );
sbe.append( "String fPath = \"/path/to/log.out\";" );
sbe.append( "try {" );
sbe.append( " java.io.FileWriter fw = new java.io.FileWriter( fPath, true );" );
sbe.append( " java.io.PrintWriter out = new java.io.PrintWriter( fw, true );" );
sbe.append( " out.println( sb.toString() );" );
sbe.append( " fw.close();" );
sbe.append( "} catch (java.io.IOException e) {" );
sbe.append( " e.printStackTrace();" );
sbe.append( "}" );
method.insertAfter("{" + sbe.toString() + "}");
}
}
byteCode = cc.toBytecode();
cc.detach();
} catch (Exception ex) {
ex.printStackTrace();
}
}
return byteCode;
}
根据 the documentation for Java agents，代理 class 由 系统 class 加载程序加载。但是如果你想检测核心 Java classes 并从中引用你自己的自定义 class 那么 class 需要对 [=21] 可用=]bootstrap class加载程序而不是系统加载程序。
将您的 Logger class 移动到一个单独的 JAR 文件中，并在代理 JAR 清单的 Boot-Class-Path 属性中列出该文件：
Boot-Class-Path: ParaTracerLogger.jar
现在记录器 class 在 bootstrap 加载器上可见，并且可以被检测 java.lang classes.