Eclipse Hibernate Synchronizer 外掛開發 Hibernate 應用完整指南

前言

Hibernate Synchronizer 是 Eclipse 上知名的 Hibernate 程式碼產生外掛，能從資料庫 Schema 反向產生 *.hbm.xml 對應檔、持久化實體類別與 DAO 介面/實作，並支援雙向同步與客製化模板。本文詳述安裝配置、核心功能、產出架構分析與實際使用範例。

一、核心功能總覽

• Hibernate Configuration Wizard：圖形化產生 hibernate.cfg.xml
• Reverse Engineering Wizard：從資料庫表格同步產生 *.hbm.xml
• Code Generation：從 *.hbm.xml 產生持久化類別（Value Object）與 DAO
• HBM Editor：視覺化編輯對應檔，支援屬性、關聯、ID 產生策略設定
• Velocity Template Customization：進階使用者可自訂產生程式碼模板（通常無需修改）

二、安裝與配置步驟

1. 安裝：Help > Software Updates 加入更新站點 https://www.binamics.com/hibernatesync（Eclipse 3.x 適用）。
2. 偏好設定（Workspace 或 Project 層級）：
   • HBM 儲存時是否自動更新 Value Object
   • 是否自動產生 DAO/Value Object
   • 產生類別的預設套件名稱
3. 建立 Hibernate Configuration：Wizard 設定資料庫連線、Dialect、連線池等。
4. 產生 Mapping Files：選擇資料庫 Schema/表格 → 產生 *.hbm.xml。
5. （選擇性）編輯 HBM：微調關聯、Lazy Loading、Cascade 策略等。
6. 更新 Configuration Mapping Resource：將新增的 HBM 註冊至 hibernate.cfg.xml。
7. 同步產生 DAO/VO：從 HBM 產生程式碼至指定套件。

三、產出程式碼架構深度解析

以範例資料庫兩張表 T_Order、T_User（一對多關聯）為例，預設產出結構：

3.1 套件架構

• base：抽象基類，每次重新同步會覆蓋，嚴禁放入客製代碼。包含 _BaseRootDAO、_BaseTUserDAO、_BaseTOrderDAO 等。
• dao：具體實作類別，繼承 base 對應抽象類，完全空白供開發者填入自訂邏輯。重新同步不覆蓋。
• vo / model：持久化實體分兩層：
  • 抽象基類（BaseTUser、BaseTOrder）：含 Hibernate 欄位對應、getter/setter，同步時覆蓋。
  • 具體實作類（TUser、TOrder）：繼承基類，供客製商務邏輯，同步不覆蓋。

3.2 類別繼承關係圖解

_BaseRootDAO (abstract)          ← 封裝通用 Hibernate 操作
    ↑
_RootDAO (abstract)              ← 專案層級通用擴展點
    ↑
BaseTUserDAO / BaseTOrderDAO     ← 實體專用 DAO 抽象類
    ↑
TUserDAO / TOrderDAO             ← 開發者實作類（空實作）

BaseTUser (abstract)             ← 欄位對應、getter/setter
    ↑
TUser                            ← 客製邏輯擴展

3.3 設計優勢

「基類/實作類分離」模式完美解決程式碼產生器覆蓋客製代碼的經典難題，實現生成代碼與業務代碼零耦合。

四、實際使用範例

// 1. 初始化 RootDAO（必須，建立 SessionFactory）
_RootDAO.initialize();

// 2. 取得 DAO 實例
TUserDAO dao = new TUserDAO();  // 實際型別為具體實作類

// 3. 載入實體
TUser user = dao.load("zhangyu");

// 4. 修改持久化物件（自動 dirty checking）
user.setMail("e-zhangyu@vip.sina.com");

// 5. 更新回資料庫
dao.update(user);  // 內部處理 Session/Transaction

關鍵點說明

• _RootDAO.initialize()：啟動時呼叫一次，建立單例 SessionFactory。
• DAO 封裝 Session 開關、交易控制、查詢、儲存/更新/刪除，業務代碼極度精簡。
• 產生的 VO 為標準 Hibernate POJO，可直接用於 HQL/Criteria 查詢。

五、進階技巧與注意事項

• 雙向同步：修改 HBM 後儲存，勾選偏好設定可自動同步更新 VO/DAO 基類。
• 自訂模板：專案層級建立 templates/ 目錄覆蓋預設 Velocity 模板，可統一加入 Lombok 註解、Builder 模式等。
• 版本控制：僅將 dao/、vo/（具體類）、hbm/ 納入版控；base/ 由建置腳本重新產生。
• 效能調校：於 HBM Editor 設定 lazy="true"、batch-size、cache usage="read-write" 等。

六、總結

Hibernate Synchronizer 以「基類/實作類分離」架構，優雅解決代碼產生器最大痛點，配合視覺化 HBM 編輯器與雙向同步，使 Hibernate 專案從 Schema 到程式碼的開發週期大幅縮短。適合採用 Database-First 或 Model-First 流程的中小型專案；大型專案建議搭配 Maven + Hibernate Tools 進行建置整合。