您现在的位置：程式碼之家 >> 編程語言 > >> Java 程式設計 >> Java 相關知識

Classworking工具箱：結合Annotation與ASM實現運行時類轉換

編輯：Java 相關知識

J2SE 5.0 引入了眾多新特性，其中最具影響力的莫過於Annotation（注釋）機制。它允許開發者將元數據直接附加在 Java 代碼上，極大地簡化了框架配置，逐漸取代了傳統的 XML 配置文件。本文將深入探討如何結合 ASM 字節碼操作框架與 J2SE 5.0 新增的 java.lang.instrument 包，在類加載進 JVM 的瞬間，根據注釋指令動態轉換類結構。

Annotation 基礎概念回顧

Annotation 本質上是一種針對 Java 代碼的元數據。其功能類似於 XDoclet 風格的元數據，但實現機制更接近 C# 的屬性。語法上使用 @interface 關鍵字定義，內部聲明的「方法」實際上代表名值對，返回類型限於基本類型、String、Class、enum、Annotation 及其陣列。

Annotation 作為修飾符使用，以 @ 符號開頭。若需賦值，則在括號中以名值對形式指定。例如下方定義的 @LogMe 注釋，用於標記需納入日誌記錄的方法，包含級別與名稱兩個屬性：

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
public @interface LogMe {
    int level() default 0;
    String name() default "";
}

public class StringArray {
    @LogMe
    private String[] merge(String[] list1, String[] list2) { ... }

    @LogMe(level=1, name="lookup")
    public int indexOf(String value) { ... }
}

實戰案例：自動生成 toString() 方法

開發者常因維護成本而省略覆寫 toString()，導致輸出缺乏實用性。若能在字段聲明處以 Annotation 標記所需輸出字段，再由工具自動生成 toString()，便能將配置與實現合二為一，消除維護負擔。

定義 ToString 注釋

為靈活控制輸出格式，定義包含順序與前導文本兩個屬性的注釋：

package com.sosnoski.asm;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.FIELD})
public @interface ToString {
    int order() default 0;
    String text() default "";
}

Instrumentation 代理攔截類加載

J2SE 5.0 的 java.lang.instrument 包允許在 JVM 啟動時指定代理類，透過 premain 方法註冊 ClassFileTransformer。轉換器的 transform() 方法會在每個類被加載前調用，獲得其二進制字節碼並可進行修改。

public class ToStringAgent implements ClassFileTransformer {
    public byte[] transform(ClassLoader loader, String cname, Class clazz,
                            ProtectionDomain domain, byte[] bytes) throws IllegalClassFormatException {
        try {
            ClassReader creader = new ClassReader(bytes);
            FieldCollector visitor = new FieldCollector();
            creader.accept(visitor, true);
            FieldInfo[] fields = visitor.getFields();
            if (fields.length > 0) {
                ClassWriter writer = new ClassWriter(false);
                ToStringGenerator gen = new ToStringGenerator(writer, cname.replace('.', '/'), fields);
                creader.accept(gen, false);
                return writer.toByteArray();
            }
        } catch (IllegalStateException e) {
            throw new IllegalClassFormatException("Error: " + e.getMessage() + " on class " + cname);
        }
        return null;
    }

    public static void premain(String arglist, Instrumentation inst) {
        inst.addTransformer(new ToStringAgent());
    }
}

ASM 訪問器收集字段元數據

繼承 ASM 的 EmptyVisitor，重寫 visitField、visitAnnotation、visit 方法，掃描類結構，提取帶有 @ToString 的非靜態字段資訊（名稱、類型、順序、文本），並按順序排序：

public class FieldCollector extends EmptyVisitor {
    private final List fields = new ArrayList<>();
    // ... 省略字段變量聲明

    public FieldVisitor visitField(int access, String name, String desc, String sig, Object init) {
        finishField();
        // 初始化字段資訊、設定預設文本（去除 m_ 前綴）等
        return super.visitField(access, name, desc, sig, init);
    }

    public AnnotationVisitor visitAnnotation(String sig, boolean visible) {
        if (sig.equals("Lcom/sosnoski/asm/ToString;")) {
            if ((access & Opcodes.ACC_STATIC) == 0) isIncluded = true;
            else throw new IllegalStateException("靜態字段不支援 ToString 注釋");
        }
        return super.visitAnnotation(sig, visible);
    }

    public void visit(String name, Object value) {
        if ("order".equals(name)) fieldOrder = (Integer) value;
        else if ("text".equals(name)) fieldText = value.toString();
    }

    public FieldInfo[] getFields() { /* 返回排序後的字段陣列 */ }
}

ClassAdapter 動態生成 toString() 字節碼

繼承 ClassAdapter，在 visitEnd() 階段向類中注入 toString() 方法。邏輯遍歷字段陣列，構建 StringBuffer，依序追加類名、字段前導文本與值（物件類型自動調用其 toString()），最後返回字串：

public class ToStringGenerator extends ClassAdapter {
    public void visitEnd() {
        MethodVisitor mv = cv.visitMethod(ACC_PUBLIC, "toString", "()Ljava/lang/String;", null, null);
        mv.visitCode();
        // 新建 StringBuffer、追加類名
        for (FieldInfo prop : fields) {
            // 根據類型生成追加字段值的字節碼指令
            // 基本類型直接 append，物件類型先調用 toString() 再 append
        }
        mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuffer", "toString", "()Ljava/lang/String;");
        mv.visitInsn(ARETURN);
        mv.visitMaxs(3, 1);
        mv.visitEnd();
        super.visitEnd();
    }
}

測試驗證

定義測試類 Customer、Address、Name，字段標註 @ToString 並指定順序與文本。啟動時加入 -javaagent:tostring-agent.jar，控制台輸出顯示類被修改，最終 toString() 輸出格式化完整：

Customer: #=12345
Name: Dennis Michael Sosnoski
Address: street=1234 5th St. city=Redmond state=WA zip=98052
homePhone=425 555-1212 dayPhone=425 555-1213