使用 Java 編譯器 API 編譯 Java 程式碼
1. 簡介
在 Java 開發中，編譯是防止語法錯誤、類型不匹配和其他可能導致專案脫軌的問題的第一道防線。雖然傳統的工作流程依賴手動編譯，但現代應用程式需要動態編譯檢查。例如：
- 即時驗證學生程式碼提交的教育平台
- 在部署之前編譯產生的程式碼片段的 CI/CD 管道
- 動態編譯使用者定義邏輯的低程式碼工具
- 熱代碼重載系統可立即重新載入開發人員的更改
- 創建 Java 插件
Java 編譯器 API透過在 Java 應用程式內以程式設計方式編譯程式碼來實作這些場景。 LeetCode或Codecademy等平台可以立即驗證使用者提交的程式碼。當使用者點擊「執行」時，後端會使用編譯器 API 等工具編譯程式碼片段，檢查錯誤，並在沙盒環境中執行。程序化編譯為這個即時回饋循環提供動力。
在本教程中，我們將探討如何利用這個強大的工具。
2. Java編譯器API概述
Java 編譯器 API 位於javax.tools套件中，並提供對 Java 編譯器的程式存取。此 API 對於需要在執行時間驗證或執行程式碼的動態編譯任務至關重要。
編譯器 API 的關鍵元件包括：
-
JavaCompiler：啟動編譯任務的主編譯器實例 -
JavaFileObject：表示 Java 原始檔或類別文件，位於記憶體或基於文件 -
StandardJavaFileManager：管理編譯過程中的輸入與輸出文件 -
DiagnosticCollector：捕獲編譯診斷訊息，例如錯誤和警告
這些元件協同工作，實現 Java 應用程式內靈活、高效的動態編譯。
讓我們檢查一下編譯過程是如何進行的。
3. 逐步實現編譯檢查
編譯器 API 在 JDK 環境中預設可用，無需任何外部相依性。現在，讓我們看看如何從.java檔案編譯記憶體中的 Java 程式碼。
3.1.建立記憶體 Java 來源
要編譯以字串形式儲存的程式碼，我們首先需要建立原始檔案的記憶體表示。我們透過擴展SimpleJavaFileObject類別來實現這一點：
public class InMemoryJavaFile extends SimpleJavaFileObject {
private final String code;
protected InMemoryJavaFile(String name, String code) {
super(URI.create("string:///" + name.replace('.', '/') + Kind.SOURCE.extension),
Kind.SOURCE);
this.code = code;
}
@Override
public CharSequence getCharContent(boolean ignoreEncodingErrors) {
return code;
}
}此類別將 Java 程式碼表示為記憶體中的JavaFileObject ，使我們能夠將原始程式碼直接傳遞給編譯器，而無需實體檔案。
3.2. Compile API 的工作原理
接下來，讓我們建立一個實用方法來編譯 Java 程式碼並擷取診斷：
private boolean compile(Iterable<? extends JavaFileObject> compilationUnits) {
DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<>();
JavaCompiler.CompilationTask task = compiler.getTask(
null,
standardFileManager,
diagnostics,
null,
null,
compilationUnits
);
boolean success = task.call();
for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics()) {
System.out.println(diagnostic.getMessage(null));
}
return success;
}compile()方法透過 Compiler API 處理 Java 原始碼編譯，首先使用DiagnosticCollector擷取編譯訊息。
中央的compiler.getTask()呼叫接受六個參數： null用於寫入器（預設為System.err ），用於處理原始檔案的標準檔案管理器，用於編譯訊息的診斷收集器， null用於編譯器選項（使用預設值而不是自訂標誌）， null用於註解處理類別（因為沒有特定類型需要處理），以及提供的編譯要處理的原始碼。執行task.call()後，此方法會記錄所有診斷訊息並傳回一個布林值，指示編譯成功。
3.3.從記憶體字串編譯
為了讓編譯更容易在客戶端程式碼或測試案例中使用，讓我們引入一個直接從String編譯 Java 程式碼的包裝方法：
public boolean compileFromString(String className, String sourceCode) {
JavaFileObject sourceObject = new InMemoryJavaFile(className, sourceCode);
return compile(Collections.singletonList(sourceObject));
}在這裡，我們建立先前的InMemoryJavaFile類別的實例，並將其包裝在單例清單中以傳遞給實際的compile()方法。
3.4.測試編譯器
現在我們已經實作了一種動態編譯 Java 程式碼的方法，讓我們使用有效且無效的程式碼片段對其進行測試。這證實了 API 正確識別了語法錯誤並傳回了適當的診斷：
@Test
void givenSimpleHelloWorldClass_whenCompiledFromString_thenCompilationSucceeds() {
String className = "HelloWorld";
String sourceCode = "public class HelloWorld {\n" +
" public static void main(String[] args) {\n" +
" System.out.println(\"Hello, World!\");\n" +
" }\n" +
"}";
boolean result = compilerUtil.compileFromString(className, sourceCode);
assertTrue(result, "Compilation should succeed");
// Check if the class file was created
Path classFile = compilerUtil.getOutputDirectory().resolve(className + ".class");
assertTrue(Files.exists(classFile), "Class file should be created");
}
此測試確認編譯器處理並將有效的 Java 原始程式碼編譯為在預期輸出目錄中產生的可執行類別檔。
接下來，我們透過測試帶有語法錯誤的程式碼來驗證錯誤捕獲：
@Test
void givenClassWithSyntaxError_whenCompiledFromString_thenCompilationFails() {
String className = "ErrorClass";
String sourceCode = "public class ErrorClass {\n" +
" public static void main(String[] args) {\n" +
" System.out.println(\"This has an error\")\n" +
" }\n" +
"}";
boolean result = compilerUtil.compileFromString(className, sourceCode);
assertFalse(result, "Compilation should fail due to syntax error");
Path classFile = compilerUtil.getOutputDirectory().resolve(className + ".class");
assertFalse(Files.exists(classFile), "No class file should be created for failed compilation");
}
由於編譯失敗，因此沒有建立.class文件，確認錯誤已被正確捕獲。
4. 結論
在本文中，我們探討了 Java 編譯器 API 及其在程式碼編譯中的作用。我們學習如何編譯記憶體原始碼、捕獲診斷以及動態執行編譯。
透過利用編譯器 API，我們可以：
- 在 CI/CD 管道、教育平台和低程式碼環境中自動化編譯工作流程
- 在應用程式內動態驗證並執行使用者定義的程式碼
- 透過捕獲詳細的診斷來改進調試和錯誤處理
無論我們建立的是自動評分系統、外掛系統或動態 Java 執行工具，Java 編譯器 API 都提供了強大且靈活的解決方案。
與往常一樣，本文的完整原始碼位於 GitHub 上。