EMF 元建模實戰：擴展 Ecore 定義程式行為，動態 JET 模板生成可重用 Java 代碼片段

Eclipse Modeling Framework (EMF) 是模型驅動開發 (MDA) 基石，核心元模型 Ecore 定義模型結構。本文展示如何擴展 Ecore 元模型，將「程式碼實作邏輯」納入模型層，配合動態 JET 模板生成具體、可重用的 Java 方法實作，實現真正的模型驅動程式碼生成。

為什麼要擴展 Ecore？

預設 EMF 僅對 EOperation 生成方法簽名（拋出 `UnsupportedOperationException`），實作邏輯需手工填寫且難以重用。若將「變數宣告、賦值、方法調用、返回」等程式行為建模為模型元素，即可跨專案重用實作邏輯。

擴展元模型 EcoreX 設計

核心擴展元素：

• EPackageX / EClassX：標記介面，允許編輯器接受子類元素
• EOperationImpl：核心實體，擴展 EOperation，包含區域變數與語句序列
• LocalVariable：區域變數（名稱 + Java 類型）
• Statement 抽象超類及子類：
  • LiteralAssignment：字面值賦值（如 str = "hello"）
  • FieldReferenceAssignment：欄位引用賦值（var1 = var2.name）
  • Invoke：方法調用，可指派結果給變數（myVar = obj.toString()）

六步驟構建流程

1. 擴展 Ecore 元模型（新增語義）
2. 為擴展元模型建立 genmodel
3. 生成 EMF 編輯器並安裝為外掛
4. 使用新編輯器建構具體模型（描述程式行為）
5. 為具體模型建立並配置 genmodel（啟用動態模板）
6. 基於具體模型生成 Java 代碼

具體建模範例：兩個方法實作

方法 1：printTimestampMessage(String message)

void printTimestampMessage(String message) {
    System.out.print(message);
    System.out.print("; Timestamp= ");
    System.out.println(System.currentTimeMillis());
}

建模要素：

• 區域變數：timestampStr (EString)、timestamp (ELong)
• 語句序列：
  1. LiteralAssignment：timestampStr = "; Timestamp = "
  2. Invoke（靜態）：timestamp = System.currentTimeMillis()
  3. Invoke：System.out.print(message)
  4. Invoke：System.out.print(timestampStr)
  5. Invoke：System.out.println(timestamp)

方法 2：getDayOfWeek(int year, int month, int date)

int getDayOfWeek(int year, int month, int date) {
    int result;
    Calendar calendar = Calendar.getInstance();
    calendar.set(year, month, date);
    result = calendar.get(Calendar.DAY_OF_WEEK);
    return result;
}

建模要素：

• 區域變數：result (EInt)、DAY (EInt)、calendar (CalendarType)
• Return Ref 指向 result
• 語句序列：
  1. Invoke（靜態）：calendar = Calendar.getInstance()
  2. Invoke：calendar.set(year, month, date)（參數對應方法參數）
  3. FieldReferenceAssignment：DAY = Calendar.DAY_OF_WEEK
  4. Invoke：result = calendar.get(DAY)

動態 JET 模板實作

關鍵模板檔：implementedGenOperation.TODO.override.javajetinc。邏輯偽代碼：

If genOperation 非 EOperationImpl → 產生預設拋出異常
Else
  宣告所有 LocalVariable 初始化為 null
  遍歷 Statements：
    依子類型產生 Java 代碼
  若有 Return Ref → 產生 return 語句

模板中區分靜態/非靜態調用、處理參數列表、生成變數宣告與賦值語句。

GenModel 關鍵配置

• Dynamic Templates = true
• Template Directory 指向專案中的 templates 資料夾
• Template Plug-in Variables 加入擴展元模型外掛 ID (EMFX)
• Suppress Interfaces = true（EMF 2.5+）

生成代碼範例

public void printTimestampMessage(String message) {
    // created by implementedGenOperation.TODO.override.javajetinc
    // ** EOperationX implementation **
    java.lang.String timestampStr = null;
    long timestamp;
    timestampStr = "; Timestamp = ";
    timestamp = java.lang.System.currentTimeMillis();
    java.lang.System.out.print(message);
    java.lang.System.out.print(timestampStr);
    java.lang.System.out.println(timestamp);
}

public int getDayOfWeek(int year, int month, int date) {
    // ** EOperationX implementation **
    int result;
    int DAY;
    java.util.Calendar calendar = null;
    calendar = java.util.Calendar.getInstance();
    calendar.set(year , month , date);
    DAY = java.util.Calendar.DAY_OF_WEEK;
    result = calendar.get(DAY);
    return result;
}

已知限制與避坑指南

• EMF 2.5+ 具體模型檔名須為 `.ecore`（不可用 `.ecorex`），否則 GenModel 建立失敗
• JET Editor（現屬 M2T 專案）語法高亮、嵌套包含檔編譯支援不完善
• 匯入宣告只能在父模板（如 Class.javajet）指定，不可在包含檔中
• 缺乏模型驗證（OCL/EMF Validation），型別不匹配只會在生成代碼編譯階段暴露

結語

透過擴展 Ecore 將「實作邏輯」模型化，配合動態 JET 模板，EMF 可從單純的資料模型工具進化為完整的程式碼生成平台。雖工具鏈尚有粗糙處，但核心路徑已通，為 MDA 落地提供可行路徑。