Java 6 編譯器 API 深度實戰：構建靜態代碼分析工具

Java SE 6 引入三大標準 API——Java Compiler API (JSR 199)、可插拔注解處理 API (JSR 269)、Compiler Tree API，使開發者能以標準化方式編程訪問編譯器、解析源碼、構建抽象語法樹（AST），實現代碼分析、自動修復、規則檢查等 IDE 級功能。本文通過構建一個驗證 equals/hashCode 契約的演示工具，全面講解三大 API 協作原理與代碼實現。

一、三大 API 角色定位

二、演示目標：驗證 equals/hashCode 契約

規則：覆寫 equals() 的類必須覆寫 hashCode()。待分析類：

public class TestClass implements Serializable {
    int num;
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null || getClass() != obj.getClass()) return false;
        TestClass test = (TestClass) obj;
        return num == test.num;
    }
    // 缺少 hashCode() 實現
}

三、核心實現步驟

1. 程序化調用編譯器

JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
StandardJavaFileManager fileManager = compiler.getStandardFileManager(null, null, null);
Iterable units = fileManager.getJavaFileObjectsFromFiles("TestClass.java");

CompilationTask task = compiler.getTask(null, fileManager, null, null, null, units);
task.call(); // 執行編譯，生成 TestClass.class

2. 編寫自定義注解處理器

繼承 AbstractProcessor，覆寫 process()，聲明支持所有注解（@SupportedAnnotationTypes("*")）以觸發通用源碼分析：

@SupportedSourceVersion(SourceVersion.RELEASE_6)
@SupportedAnnotationTypes("*")
public class CodeAnalyzerProcessor extends AbstractProcessor {
    private CodeAnalyzerTreeVisitor visitor = new CodeAnalyzerTreeVisitor();

    @Override
    public void init(ProcessingEnvironment pe) {
        super.init(pe);
        visitor.trees = Trees.instance(pe); // 獲取 Trees 實例，橋接 JSR 269 與 Tree API
    }

    @Override
    public boolean process(Set annotations, RoundEnvironment roundEnv) {
        for (Element e : roundEnv.getRootElements()) {
            TreePath path = visitor.trees.getPath(e);
            visitor.scan(path, visitor.trees); // 掃描 AST
        }
        return true; // 聲明已處理，阻止後續處理器處理同類注解
    }
}

3. 將處理器插入編譯任務

CompilationTask task = compiler.getTask(null, fileManager, null, null, null, units);
List processors = new ArrayList<>();
processors.add(new CodeAnalyzerProcessor());
task.setProcessors(processors); // 必須在 call() 前設置
task.call();

4. 實現 TreeVisitor 遍歷 AST 提取信息

public class CodeAnalyzerTreeVisitor extends TreePathScanner {
    @Override
    public Object visitClass(ClassTree node, Trees trees) {
        TreePath path = getCurrentPath();
        TypeElement elem = (TypeElement) trees.getElement(path);
        // 提取類名、父類、實現接口等存入自定義模型 JavaClassInfo
        return super.visitClass(node, trees);
    }

    @Override
    public Object visitMethod(MethodTree node, Trees trees) {
        // 提取方法名、參數、註解等存入模型
        return super.visitMethod(node, trees);
    }
    // 同理實現 visitVariable 等
}

5. 精確定位源碼位置（行號、偏移量）

利用 SourcePositions 和 LineMap 獲取節點在編譯單元中的字符偏移，再通過正則匹配令牌精確定位：

SourcePositions sp = trees.getSourcePositions();
long start = sp.getStartPosition(path.getCompilationUnit(), node);
int line = compileTree.getLineMap().getLineNumber((int) start);

6. 規則引擎驗證模型

規則配置於 XML，RuleEngine 逐條執行。OverrideEqualsHashCode 規則邏輯：

public class OverrideEqualsHashCode extends JavaClassRule {
    protected Collection apply(ClassFile clazz) {
        boolean hasEquals = false, hasHashCode = false;
        Location errorLoc = null;
        for (Method m : clazz.getMethods()) {
            if ("equals".equals(m.getName()) && m.getParameters().size() == 1
                && "java.lang.Object".equals(m.getParameters().get(0))) {
                hasEquals = true;
                errorLoc = m.getLocationInfo();
            } else if ("hashCode".equals(m.getName()) && m.getParameters().isEmpty()) {
                hasHashCode = true;
            }
        }
        if (hasEquals && !hasHashCode) {
            // 返回包含錯誤消息與位置的 ErrorDescription
        }
        return null;
    }
}

四、運行與擴展

命令行運行：

java -classpath \lib\tools.jar;. demo.codeanalyzer.main.Main

擴展方向：

• 集成到構建腳本（Ant/Maven/Gradle）實現構建時自動檢查。
• 開發更多規則：空指針檢查、資源洩漏、編碼規範等。
• 輸出標準化報告（SARIF、HTML）接入 CI/CD 流水線。
• 利用 javax.lang.model 進行更深層語義分析（類型推導、數據流）。

五、總結

Java 6 三大編譯器 API 打破了 IDE 專有解析器的壟斷，提供標準化、可重用的源碼分析基礎設施。掌握其協作模式——Compiler API 驅動編譯流程，Annotation Processing API 切入處理鉤子，Tree API 提供結構化源碼視圖**——是構建高質量靜態分析工具、代碼生成器、重構引擎的關鍵。