Hibernate 代碼生成工具鏈：hbm2java、hbm2ddl、XDoclet、Middlegen 完整指南

四大生成方向總覽

核心配置元素詳解

<class> 類別層級屬性

<class name="com.myapp.Customer" 
       table="CUSTOMER"
       discriminator-value="CUST"
       dynamic-insert="true"
       dynamic-update="true"
       select-before-update="false"
       polymorphism="implicit"
       batch-size="10"
       optimistic-lock="version"
       lazy="true">
    <!-- 類別描述 (生成 JavaDoc) -->
    <meta attribute="class-description">客戶領域模型</meta>
    <!-- 繼承父類 -->
    <meta attribute="extends">com.myapp.BaseEntity</meta>
    <!-- 實作介面 -->
    <meta attribute="implements">java.io.Serializable, com.myapp.Auditable</meta>
    <!-- 生成類別修飾符 -->
    <meta attribute="scope-class">public</meta>
    <!-- toString() 包含屬性 -->
    <meta attribute="use-in-tostring">true</meta>
</class>

<id> 識別符生成策略

<id name="id" type="long" column="CUST_ID">
    <meta attribute="scope-field">protected</meta>  <!-- 欄位修飾符 -->
    <meta attribute="scope-get">public</meta>      <!-- getter 修飾符 -->
    <meta attribute="scope-set">protected</meta>   <!-- setter 修飾符 -->
    <generator class="native"></generator>  <!-- identity/sequence/hilo/uuid 等 -->
</id>

<property> 一般屬性完整配置

<property name="email" type="string" column="EMAIL" 
          not-null="true" unique="true" length="100">
    <meta attribute="field-description">客戶電子郵件，唯一索引</meta>
    <meta attribute="use-in-tostring">true</meta>
    <meta attribute="gen-property">true</meta>  <!-- 是否生成欄位/存取器 -->
    <column name="EMAIL" 
            sql-type="varchar(100)" 
            not-null="true" 
            unique="true" 
            index="idx_customer_email"
            check="email LIKE '%@%'">
    </column>
</property>

集合映射與索引

<set name="orders" table="ORDERS" lazy="true" inverse="true" cascade="all-delete-orphan">
    <key column="CUST_ID" not-null="true"></key>
    <one-to-many class="com.myapp.Order"/>
    <meta attribute="use-in-tostring">false</meta>  <!-- 避免遞迴 toString -->
</set>

Ant 整合建構腳本範例

<project name="hibernate-codegen" default="generate" xmlns:artifact="antlib:org.apache.maven.artifact.ant">
    <property name="hbm.dir" value="src/main/resources/hbm"/>
    <property name="gen.src" value="target/generated-sources/java"/>
    <property name="gen.sql" value="target/generated-sources/sql"/>

    <target name="generate" depends="hbm2java, hbm2ddl"/>

    <!-- hbm2java -->
    <target name="hbm2java">
        <taskdef name="hbm2java" classname="net.sf.hibernate.tool.hbm2java.Hbm2JavaTask" classpathref="hibernate.classpath"/>
        <hbm2java output="${gen.src}">
            <fileset dir="${hbm.dir}" includes="**/*.hbm.xml"/>
        </hbm2java>
    </target>

    <!-- hbm2ddl (產出 schema.sql) -->
    <target name="hbm2ddl">
        <taskdef name="schemaexport" classname="net.sf.hibernate.tool.hbm2ddl.SchemaExportTask" classpathref="hibernate.classpath"/>
        <schemaexport 
            properties="hibernate.properties" 
            quiet="no" 
            text="yes" 
            drop="no" 
            create="yes" 
            output="${gen.sql}/schema.sql" 
            delimiter=";" 
            format="yes">
            <fileset dir="${hbm.dir}" includes="**/*.hbm.xml"/>
        </schemaexport>
    </target>
</project>

現代替代方案（強烈建議）

• JPA + Hibernate：@Entity 註解取代 .hbm.xml，hibernate.hbm2ddl.auto=update/validate 替代 hbm2ddl
• Spring Boot DevTools：開發期熱重載，實體變更自動同步 Schema
• Flyway / Liquibase：版本化遷移腳本管理資料庫演進，取代一次性 DDL 生成
• MapStruct / Lombok：編譯期生成 Getter/Setter/Builder/Mapper，減少樣板碼
• Hibernate Tools (IDE 外掛/CLI)：仍支援逆向工程，但建議僅用於遷移專案初始化

遷移建議

1. 現有專案：保留 Ant 腳本維護舊模組，新模組採用 JPA 註解
2. 新專案：直接 Spring Boot + JPA + Flyway，零 XML 配置
3. 團隊技能：投資註解式開發與遷移工具，而非精通 XDoclet/Middlegen 等過時技術

總結

hbm2java/hbm2ddl/XDoclet/Middlegen 曾是 Hibernate 生態的「代碼生成四大金剛」，解決了早期大量樣板碼痛點。隨著註解驅動、遷移工具、編譯期生成技術成熟，現代架構已轉向源碼即真理、版本化遷移、編譯期驗證。理解工具鏈演進脈絡，有助於在遷移舊專案時做出合理技術決策。