JUG.ua 20170225 - Java bytecode instrumentation

Как и зачем инструментировать
байткод в Java приложениях?
Специально для JUG.ua, 25 мая 2017
@antonarhipov

Антон Архипов
@antonarhipov
Javassist & ASM inside!
Привет!

@Entity 
@Table(name = "owners") 
public class Owner extends Person { 
@Column(name = "address") 
@NotEmpty 
private String address; 
 
@Column(name = "city") 
@NotEmpty 
private String city; 
 
@Column(name = "telephone") 
@NotEmpty 
@Digits(fraction = 0, integer = 10) 
private String telephone; 
 
@OneToMany(cascade = CascadeType.ALL,
mappedBy = "owner") 
private Set<Pet> pets;

public class JavassistLazyInitializer
extends BasicLazyInitializer
implements MethodHandler {
final JavassistLazyInitializer instance
= new JavassistLazyInitializer(…);
 
ProxyFactory factory = new ProxyFactory(); 
factory.setSuperclass(interfaces.length == 1?persistentClass:null); 
factory.setInterfaces(interfaces); 
factory.setFilter(FINALIZE_FILTER);
 
Class cl = factory.createClass(); 
final HibernateProxy proxy = (HibernateProxy) cl.newInstance(); 
((ProxyObject)proxy).setHandler(instance); 
instance.constructed = true; 
return proxy;

Зачем?
Модели программирования (AOP, ORM, итд)
Специализированные отладчики
Агенты для мониторинга (NewRelic, XRebel)
Инструменты для разработки (JRebel)
Обфускация (Proguard)
итд

Починить
ошибку в
open-source
библиотеке.
Потому, что я
могу!

Как?
java.lang.instrument
-javaagent
ASM, Javassist, Byte Buddy, cglib, итд
Classloaders

public class Hello { 
public static void main(String[] args) { 
System.out.println("Hello, World!"); 
} 
}

} 
}
> javap -c Hello
Дизассемблировать Hello

} 
}
> javap -c Hello
Compiled from "Hello.java"
public class Hello extends java.lang.Object{
public Hello();
Code:
0: aload_0
1: invokespecial #1; //Method java/lang/Object."<init>":()V
4: return
public static void main(java.lang.String[]);
Code:
0: getstatic #2; //Field java/lang/System.out:Ljava/io/PrintStream;
3: ldc #3; //String Hello, World!
5: invokevirtual #4; //Method java/io/PrintStream.println:(Ljava/lang/String;)V

java -cp asm-all-3.3.1.jar:asm-util-3.3.1.jar
org.objectweb.asm.util.ASMifierClassVisitor
Items.class

ASM
“Сделаю всё как хочу”
Приходится писать много кода
Надо понимать Java-байткод

Class<?> dynamicType = new ByteBuddy()
.subclass(Object.class)
.method(ElementMatchers.named("toString"))
.intercept(FixedValue.value("Hello World!"))
.make()
.load(getClass().getClassLoader())
.getLoaded();
System.out.println(dynamicType.newInstance().toString()); //Hello World!
System.out.println(dynamicType);
//class net.bytebuddy.renamed.java.lang.Object$ByteBuddy$KUZX06bM

Byte Buddy
Модный API
Попурялный / активный проект
“Много магии”

API
ClassPool
CtClass
CtClass
CtClass
CtClass
CtField
CtMethod
CtConst
CtMethod
insertBefore
insertAfter
instrument

public static void main(String[] args) throws Exception {
ClassPool cp = ClassPool.getDefault();
CtClass ct = cp.makeClass("com.zt.A",
cp.get("com.zt.Clazz"));
CtMethod[] methods = ct.getMethods(); 
for (CtMethod method : methods) { 
//…
}
ct.writeFile("/output");
}

//…
}
}
ClassPool cp = new ClassPool(null);
cp.appendSystemPath();

//…
}
}
public class A extends Clazz {  
public A() { 
} 
}

//…
}
}
mars:output anton$ javap -c com/zt/A.class
public class com.zt.A extends com.zt.Clazz {
public com.zt.A();
Code:
0: aload_0
1: invokespecial #10
4: return

CtClass ctClass = cp.get("com.zt.A");
CtMethod foo = ctClass.getMethod("foo",
"()V");
foo.insertBefore("System.out.println();");
Class c = ctClass.toClass(); 
A a = (A) c.newInstance(); 
a.foo("Hello"); 
}

"()V");
a.foo("Hello"); 
}
public void foo() {  
}

"(Ljava/lang/String;)V");
a.foo("Hello"); 
}
public void foo(String s) {  
}

"(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lja
a.foo("Hello"); 
}
Дескрипторы бывают длинноваты ;)

foo.insertBefore("System.out.println($1)");
a.foo("Hello"); 
}
$1, $2, $3 — локальные переменные
$0 — this (для виртуальных методов)

foo.insertBefore("System.out.println($1)");
a.foo("Hello"); 
}
Exception in thread "main" javassist.CannotCompileException: [source error] ; is missing
at javassist.CtBehavior.insertBefore(CtBehavior.java:774)
at javassist.CtBehavior.insertBefore(CtBehavior.java:734)
at com.zt.basics.Ex.main(Ex.java:35)

foo.insertBefore("System.out.println($1);");
a.foo("Hello"); 
}

CtMethod foo = …
foo.insertBefore(…);
foo.insertAfter(…);
Можно реализовать
трассировку
… или добавить логирование
… или реализовать свой “AOP”

CtMethod foo = …
foo.instrument(new ExprEditor() {
@Override 
public void edit(NewExpr e)
throws CannotCompileException { 
e.replace("{" + 
"$_ = $proceed($$);" + 
"System.out.println($_);" + 
"}"); 
}
});

CtMethod foo = …
@Override 
public void edit(MethodCall m)
if(m.getMethodName().contains("println")) { 
m.replace("{}"); 
}
}
});

CtMethod foo = …
@Override 
public void edit(FieldAccess m)
if (f.isWriter()) { 
CtField field = f.getField(); 
String setterName = findSetter(field); 
f.replace("{" + "$0." + setterName + "($$);" + "}"); 
}
}
});

Javassist
“Простой как тесак”
Неприхотлив в использовании
Производительность - так себе :(

import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.Instrumentation;
public class Agent {
public static void premain(String args, Instrumentation inst)
throws Exception {
inst.addTransformer(new ClassFileTransformer {
// here be dragons
});
}
}
$> java –javaagent:agent.jar application.Main
META-INF/MANIFEST.MF
Premain-Class: Agent

https://www.youtube.com/watch?v=SY5lMgWlHAw

DEMO
https://github.com/zeroturnaround/callspy
https://github.com/bsideup/javaagent-boilerplate

anton@zeroturnaround.com
@antonarhipov

JUG.ua 20170225 - Java bytecode instrumentation

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

More from Anton Arhipov

More from Anton Arhipov (20)

JUG.ua 20170225 - Java bytecode instrumentation