Ver el código de bytes de un archivo de clase en Java

1. Información general

El análisis de código de bytes es una práctica común entre los desarrolladores de Java por muchas razones, como encontrar problemas con el código, crear perfiles de código y buscar clases con anotaciones específicas.

En este artículo, exploraremos formas de ver el código de bytes de un archivo de clase en Java.

2. ¿Qué es el código de bytes?

Bytecode es la representación intermedia de un programa Java, lo que permite que una JVM traduzca un programa en instrucciones de ensamblaje a nivel de máquina.

Cuando se compila un programa Java, el código de bytes se genera en forma de archivo .class . Este archivo .class contiene instrucciones no ejecutables y depende de una JVM para ser interpretado.

3. Usando javap

La línea de comandos de Java viene con la herramienta javap que muestra información sobre los campos, constructores y métodos de un archivo de clase.

Según las opciones utilizadas, puede desensamblar una clase y mostrar las instrucciones que componen el código de bytes de Java.

3.1. javap

Vamos a usar la javap comando para ver el código de bytes de la más común de objetos de la clase:

$ javap java.lang.Object

La salida del comando mostrará la construcción mínima de la clase Object :

public class java.lang.Object { public java.lang.Object(); public final native java.lang.Class getClass(); public native int hashCode(); public boolean equals(java.lang.Object); protected native java.lang.Object clone() throws java.lang.CloneNotSupportedException; public java.lang.String toString(); public final native void notify(); public final native void notifyAll(); public final native void wait(long) throws java.lang.InterruptedException; public final void wait(long, int) throws java.lang.InterruptedException; public final void wait() throws java.lang.InterruptedException; protected void finalize() throws java.lang.Throwable; static {}; }

De forma predeterminada, la salida del código de bytes no contendrá campos / métodos con un modificador de acceso privado .

3.2. javap -p

Para ver todas las clases y miembros, podemos usar el argumento -p :

public class java.lang.Object { public java.lang.Object(); private static native void registerNatives(); public final native java.lang.Class getClass(); public native int hashCode(); public boolean equals(java.lang.Object); protected native java.lang.Object clone() throws java.lang.CloneNotSupportedException; // ... }

Aquí, podemos observar un método privado registerNatives también se muestra en el bytecode de la clase Object .

3.3. javap -v

De manera similar, podemos usar el argumento -v para ver información detallada como el tamaño de la pila y los argumentos de los métodos de la clase Object :

Classfile jar:file:/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk/Contents/Home/jre/lib/rt.jar!/java/lang/Object.class Last modified Mar 15, 2017; size 1497 bytes MD5 checksum 5916745820b5eb3e5647da3b6cc6ef65 Compiled from "Object.java" public class java.lang.Object minor version: 0 major version: 52 flags: ACC_PUBLIC, ACC_SUPER Constant pool: #1 = Class #49 // java/lang/StringBuilder // ... { public java.lang.Object(); descriptor: ()V flags: ACC_PUBLIC Code: stack=0, locals=1, args_size=1 0: return LineNumberTable: line 37: 0 public final native java.lang.Class getClass(); descriptor: ()Ljava/lang/Class; flags: ACC_PUBLIC, ACC_FINAL, ACC_NATIVE Signature: #26 // ()Ljava/lang/Class; // ... } SourceFile: "Object.java"

3.4. javap -c

Además, el comando javap permite desensamblar toda la clase Java usando el argumento -c :

Compiled from "Object.java" public class java.lang.Object { public java.lang.Object(); Code: 0: return public boolean equals(java.lang.Object); Code: 0: aload_0 1: aload_1 2: if_acmpne 9 5: iconst_1 6: goto 10 9: iconst_0 10: ireturn protected native java.lang.Object clone() throws java.lang.CloneNotSupportedException; // ... }

Además, el comando javap nos permite verificar la información del sistema, las constantes y las firmas de tipo internas utilizando varios argumentos.

Podemos enumerar todos los argumentos admitidos por el comando javap usando el argumento -help .

Ahora que hemos visto una solución de línea de comandos de Java para ver el código de bytes de un archivo de clase, examinemos algunas bibliotecas de manipulación de códigos de bytes.

4. Usando ASM

ASM es un popular marco de trabajo de análisis y manipulación de código de bytes Java de bajo nivel orientado al rendimiento.

4.1. Preparar

Primero, agreguemos las últimas dependencias de asm y asm-util Maven a nuestro pom.xml :

 org.ow2.asm asm 8.0.1   org.ow2.asm asm-util 8.0.1 

4.2. Ver código de bytes

Luego, usaremos ClassReader y TraceClassVisitor para ver el bytecode de la clase Object :

try { ClassReader reader = new ClassReader("java.lang.Object"); StringWriter sw = new StringWriter(); TraceClassVisitor tcv = new TraceClassVisitor(new PrintWriter(System.out)); reader.accept(tcv, 0); } catch (IOException e) { e.printStackTrace(); }

Aquí, notaremos que el objeto TraceClassVisitor requiere que el objeto PrintWriter extraiga y produzca el código de bytes :

// class version 52.0 (52) // access flags 0x21 public class java/lang/Object { // compiled from: Object.java // access flags 0x1 public ()V L0 LINENUMBER 37 L0 RETURN MAXSTACK = 0 MAXLOCALS = 1 // access flags 0x101 public native hashCode()I // access flags 0x1 public equals(Ljava/lang/Object;)Z L0 LINENUMBER 149 L0 ALOAD 0 ALOAD 1 IF_ACMPNE L1 ICONST_1 GOTO L2 L1 // ... }

5. Usando BCEL

La Biblioteca de Ingeniería de Código Byte, conocida popularmente como Apache Commons BCEL, proporciona una forma conveniente de crear / manipular archivos de clases Java.

5.1. Dependencia de Maven

Como de costumbre, agreguemos la última dependencia de bcel Maven a nuestro pom.xml :

 org.apache.bcel bcel 6.5.0 

5.2. Desmontar clase y ver código de bytes

Luego, podemos usar la clase Repository para generar el objeto JavaClass :

try { JavaClass objectClazz = Repository.lookupClass("java.lang.Object"); System.out.println(objectClazz.toString()); } catch (ClassNotFoundException e) { e.printStackTrace(); }

Aquí, hemos utilizado el método toString en el objeto objectClazz para ver el código de bytes en un formato conciso:

public class java.lang.Object file name java.lang.Object compiled from Object.java compiler version 52.0 access flags 33 constant pool 78 entries ACC_SUPER flag true Attribute(s): SourceFile: Object.java 14 methods: public void () private static native void registerNatives() public final native Class getClass() [Signature: ()Ljava/lang/Class;] public native int hashCode() public boolean equals(Object arg1) protected native Object clone() throws Exceptions: java.lang.CloneNotSupportedException public String toString() public final native void notify() // ...

Further, the JavaClass class provides methods like getConstantPool, getFields, and getMethods to view the details of the disassembled class.

assertEquals(objectClazz.getFileName(), "java.lang.Object"); assertEquals(objectClazz.getMethods().length, 14); assertTrue(objectClazz.toString().contains("public class java.lang.Object")); 

Similarly, set* methods are available for bytecode manipulation.

6. Using Javassist

Also, we can use the Javassist (Java Programming Assistant) library that provides high-level APIs to view/manipulate Java bytecode.

6.1. Maven Dependency

First, we'll add the latest javassist Maven dependency to our pom.xml:

 org.javassist javassist 3.27.0-GA 

6.2. Generate ClassFile

Then, we can use the ClassPool and ClassFile classes to generate a Java class:

try { ClassPool cp = ClassPool.getDefault(); ClassFile cf = cp.get("java.lang.Object").getClassFile(); cf.write(new DataOutputStream(new FileOutputStream("Object.class"))); } catch (NotFoundException e) { e.printStackTrace(); }

Here, we've used the write method, which allows us to write the class file using the DataOutputStream object:

// Compiled from Object.java (version 1.8 : 52.0, super bit) public class java.lang.Object { // Method descriptor #19 ()V // Stack: 0, Locals: 1 public Object(); 0 return Line numbers: [pc: 0, line: 37] // Method descriptor #19 ()V private static native void registerNatives(); // Method descriptor #24 ()Ljava/lang/Class; // Signature: ()Ljava/lang/Class; public final native java.lang.Class getClass(); // Method descriptor #28 ()I public native int hashCode(); // ...

Also, the object of the ClassFile class provides access to the constant pool, fields, and methods:

assertEquals(cf.getName(), "java.lang.Object"); assertEquals(cf.getMethods().size(), 14);

7. Jclasslib

Additionally, we can use an IDE based plugin to view the bytecode of a class file. For instance, let's explore the jclasslib Bytecode viewer plugin available for IntelliJ IDEA.

7.1. Installation

First, we'll install the plugin using the Settings/Preferences dialog:

7.2. View Bytecode of the Object Class

Then, we can choose “Show Bytecode With Jclasslib” option under the View menu to view bytecode of the selected Object class:

Next, a dialog will open to show the bytecode of the Object class:

7.3. View Details

Also, we can see various details of the bytecode like constant pool, fields, and methods using the Jclasslib plugin dialog:

Similarly, we have the Bytecode Visualizer Plugin to view the bytecode of a class file using the Eclipse IDE.

8. Conclusion

In this tutorial, we explored ways to view the bytecode of a class file in Java.

First, we examined the javap command along with its various arguments. Then, we went through a few bytecode manipulation libraries that provide the features to view and manipulate the bytecode.

Last, we looked into an IDE based plugin Jclasslib that allows us to view bytecode in IntelliJ IDEA.

As usual, all the code implementations are available over on GitHub.