From Gossip@caterpillar

Hibernate Gossip: Hibernate Annotations

Hibernate Annotations為Hibernate的擴充模組之一，如果您的JDK為5.0以上的版本，即可使用它所提供的Annotation來於.java 檔案上，進行物件與表格的對映定義，在開發上，讓物件屬性的對映設定更貼近於程式碼。

Java Persistence API為Java EE 5.0平台所定義的標準資料庫物件對應及持久管理介面，為EJB 3.0規格之一，Hibernate作為JPA的實作品，Hibernate Annotations包括了標準的JPA Annotations及額外Hibernate擴充功能Annotation。

您可以使用標準的JPA以取得與JPA/EJB 3.0的最大相容性，或是使用擴充的Hibernate進階功能，或是兩者混合。

想要使用Hibernate Annotations，您必須下載Hibernate Annotations，將其中的hibernate-annotations.jar、hibernate-commons- annotations.jar與ejb3-persistence.jar加入Classpath設定之中。

使用Hibernate Annotations，不需要使用HBM映射檔案，而直接在POJO上使用Annotation設定對映關係：

User.java

package onlyfun.caterpillar;

import javax.persistence.*;

@Entity
@Table(name = "T_USER")
public class User {
    @Id @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "id") // 非必要，在欄位名稱與屬性名稱不同時使用
    private Long id;
 
    @Column(name = "name") // 非必要，在欄位名稱與屬性名稱不同時使用
    private String name;
 
    @Column(name = "age") // 非必要，在欄位名稱與屬性名稱不同時使用
    private Long age;
 
    // 必須要有一個預設的建構方法
    // 以使得Hibernate可以使用Constructor.newInstance()建立物件
    public User() {
    }
 
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Long getAge() {
        return age;
    }
    public void setAge(Long age) {
        this.age = age;
    }
}

注意到所有的Annotation都是在javax.persistence這個package之下，這是標準的 JPA Annotations，Hibernate實作了這些Annotations，其中id是個特殊的屬性，Hibernate會使用它來作為主鍵識別，您可以定義主鍵產生的方式，這邊設定為自動產生主鍵，依賴於資料庫自動增生主鍵的機制，也就是相當於在XML中設定native。可以看到，實體標識，主鍵生成，以及相關映射，都可以使用Annotation來完成。

設定檔案中，<mapping>要改用class屬性：

hibernate.cfg.xml

<?xml version="1.0" encoding="utf-8"?> 
<!DOCTYPE hibernate-configuration PUBLIC
	"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
	"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
	
<hibernate-configuration> 

    <session-factory> 

        ...

        <!-- 物件與資料庫表格映射文件 --> 
        <mapping class="onlyfun.caterpillar.User"/> 
	
    </session-factory> 

</hibernate-configuration>

使用Annotation時，需要的是AnnotationConfiguration類別，所以可以改寫一下 HibernateUtil類別：

HibernateUtil.java

package onlyfun.caterpillar;

import org.hibernate.SessionFactory;
import org.hibernate.cfg.AnnotationConfiguration;

public class HibernateUtil {
    private static SessionFactory sessionFactory;
    static {
        try {
            sessionFactory = new AnnotationConfiguration().configure()
                                   .buildSessionFactory();
        } catch (Throwable ex) {
            throw new ExceptionInInitializerError(ex);
        }
    }

    public static SessionFactory getSessionFactory() {
        return sessionFactory;
    }

    public static void shutdown() {
        getSessionFactory().close();
    }
}

如果打算以撰寫程式的方式，在取得AnnotationConfiguration實例之後，再載入類別中的 Annotation定義，則可以使用addAnnotatedClass()方法，例如：

AnnotationConfiguration config =
new AnnotationConfiguration();

      config.addAnnotationClass(onlyfun.caterpillar.Room.class);