Java Web系列：Hibernate 基礎

從以下5個方面學習hibernate ORM。

（1）配置檔案：hibernate.cfg.xml XML檔案和hibernate.properties屬性檔案

（2）實體對映：1對多、多對多

（3）會話工廠與會話：SessionFactory&Session

（4）查詢：SQL原生查詢、HQL通用查詢、Criteria條件查詢

（5）事務：Transanction

Hibernate的5個核心物件Conifguration、SessionFactory、Session、Query和Transanction是必須掌握的。另外，沒有類似Linq的語言整合查詢。

1.配置檔案：hibernate.cfg.xml XML檔案和hibernate.properties屬性檔案

Hibernate使用Configuration表示配置資訊，配置檔案的資訊最終會適配到Configuration物件。雖然XML檔案一直被hibernate支援，但使用hibernate.properties屬性檔案更簡潔。

HSQLDB資料庫是一個常用的JAVA版的測試資料庫，我們通過下面兩種方式演示HSQLDB資料庫的配置。其中connection.driver_class, connection.url, connection.username 和 connection.password提供了JDBC使用的資料庫連結資訊，dialect配置SQL方言，hbm2ddl.auto配置啟用自動更新資料庫模式，show_sql和format_sql配置便於我們在控制檯檢視輸出資訊，generate_statistics配置生成統計資訊。

（1）XML方式配置Hibernate：

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

<hibernate-configuration>
    <session-factory>
        <property name="hibernate.connection.driver_class">org.h2.Driver</property>
        <property name="hibernate.connection.url">jdbc:h2:mem:db1;DB_CLOSE_DELAY=-1;MVCC=TRUE</property>
        <property name="hibernate.connection.username">sa</property>
        <property name="hibernate.dialect">org.hibernate.dialect.H2Dialect</property>
        <property name="hibernate.hbm2ddl.auto">update</property>
        <property name="hibernate.show_sql">true</property>
        <property name="hibernate.format_sql">true</property>
        <property name="hibernate.generate_statistics">true</property>
    </session-factory>
</hibernate-configuration>

 

（2）屬性檔案方式配置Hibernate：

hibernate.connection.driver_class org.h2.Driver
hibernate.connection.url jdbc:h2:mem:db1;DB_CLOSE_DELAY=-1;MVCC=TRUE
hibernate.connection.username sa
hibernate.dialect org.hibernate.dialect.H2Dialect
hibernate.hbm2ddl.auto update
hibernate.show_sql true
hibernate.format_sql true
hibernate.generate_statistics true

2.實體對映：1對多、多對多

Hibernate的實體對映可以採取XML和程式碼註解兩種， .NET中的EntityFramework的實體對映也有對應的註解（特性）方式，但提供了讓實體類更加乾淨的程式碼配置方式。無論是依賴注入還是實體對映，Spring和Hibernate在這方面始終相對落後和繁瑣。

各種JAVA框架的核心從來不是xml，框架的核心功能和核心物件才是最重要的。註解配置的核心註解如下：

（1）@Entity：標註類為實體。

（2）@Id和@GeneratedValue：前者標註POJO欄位為主鍵，後者標註欄位為資料庫自動生成。

（3）@OneToMany和@ManyToOne：在關聯欄位上標註1對多和多對1。

（4）@ManyToMany：在關聯欄位上標註多對多，cascade引數指定級聯處理規則。

（5）@Version：標註欄位為樂觀併發控制版本欄位。

下面分別演示常見的1對多、多對多的對映配置。

（1）1對多：Category-Post

Category程式碼：

@Entity
public class Category {

    @Id
    @GeneratedValue
    private int id;

    private String Name;

    @OneToMany
    private List<Post> posts = new ArrayList<Post>();

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return Name;
    }

    public void setName(String name) {
        Name = name;
    }

    public List<Post> getPosts() {
        return posts;
    }

    public void setPosts(List<Post> posts) {
        this.posts = posts;
    }
}

Post程式碼：

@Entity
public class Post {
    @Id
    @GeneratedValue
    private int id;

    private String Name;

    private String Text;

    @ManyToOne
    private Category category;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return Name;
    }

    public void setName(String name) {
        Name = name;
    }

    public String getText() {
        return Text;
    }

    public void setText(String text) {
        Text = text;
    }

    public Category getCategory() {
        return category;
    }

    public void setCategory(Category category) {
        this.category = category;
    }
}

 

（2）多對多+樂觀鎖：User-Role

User程式碼：

@Entity
public class User {
    @Id
    @GeneratedValue
    private int id;

    private String userName;

    private String password;

    @Version
    private long version;

    @ManyToMany(cascade = CascadeType.ALL)
    private List<Role> roles = new ArrayList<Role>();

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public long getVersion() {
        return version;
    }

    public void setVersion(long version) {
        this.version = version;
    }

    public List<Role> getRoles() {
        return roles;
    }

    public void setRoles(List<Role> roles) {
        this.roles = roles;
    }

}

Role程式碼：

@Entity
public class Role {
    @Id
    @GeneratedValue
    private int id;

    private String roleName;

    @ManyToMany(cascade = CascadeType.ALL)
    private List<User> users = new ArrayList<User>();

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getRoleName() {
        return roleName;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }

    public List<User> getUsers() {
        return users;
    }

    public void setUsers(List<User> users) {
        this.users = users;
    }
}

 

3.會話工廠與會話：SessionFactory&Session

（1）會話上下文SessionFactory

SessionFactory始終是Hibernate的核心物件.通過Configuration建立的SessionFactory是Hibernate ORM的核心物件。Hibernate 4.3.5和Hibernate 5.x可以使用一致的程式碼建立SessionFactory，但5.x需要引入jta（javax.transaction），否則建立失敗。

    public SessionFactory sessionFactory() {

        org.hibernate.cfg.Configuration configuration = new org.hibernate.cfg.Configuration();

        configuration.addAnnotatedClass(User.class);
        configuration.addAnnotatedClass(Role.class);
        configuration.addAnnotatedClass(Category.class);
        configuration.addAnnotatedClass(Post.class);

        SessionFactory sessionFactory = configuration.buildSessionFactory(new StandardServiceRegistryBuilder().build());
        return sessionFactory;

    }

（2）會話Session

Session物件類似於EntityFramework中DbContext物件。Hibernate中通過SessionFactory獲取Session，有2種方式openSession()和 getCurrentSession()。openSession方式獲取單個開啟的Session，需要自己寫程式碼關閉。getCurrentSession方式則可以獲取自動管理的Session物件，這是依賴CurrentSessionContext介面的實現類來支援的，可以通過配置hibernate.current_session_context_class來適配，取值"jta","thread"和"managed"分別對應三個實現類。使用getCurrentSession時雖然不需要手動管理Session的關閉，但是需要手動管理Transaction事務的開啟和關閉。在Spring中繼承Hibernate時，Spring提供了CurrentSessionContext的實現類SpringJtaSessionContext，避免了我們手動管理事務。在不使用Spring的Servlet環境中，我們可以選擇使用Filter+getSession方式使用Session。也可以配置成"thread"+手動管理事務方式。

Filter+getSession可以直接使用click-extras程式包中的Filter和SessionContext，最好是複用並修改其原始碼，其中SessionContext的實現核心是使用型別為ThreadLocal<Session>的靜態欄位實現執行緒級別的Session共享。

click-extras的pom如下：

<dependency>
    <groupId>org.apache.click</groupId>
    <artifactId>click-extras</artifactId>
    <version>2.3.0</version>
</dependency>

使用"thread"+手動管理事務方式需要先配置hibernate.properties屬性檔案：hibernate.current_session_context_class thread。

    private void Test(SessionFactory factory)
    {
        factory.getCurrentSession().beginTransaction();
        Query query = factory.getCurrentSession().createSQLQuery("select * from User where userName=?").addEntity(User.class);
        User user = (User) query.uniqueResult();
        factory.getCurrentSession().getTransaction().commit();
    }

4.查詢：SQL原生查詢、HQL通用查詢、Criteria條件查詢

（1）SQL原生查詢：

原生查詢使用Query介面的子介面SQLQuery。通過session可以建立該介面的例項。下面的程式碼中hsqldb的引數化查詢佔位符是"?"。為了便於使用，使用了SQLQuery的addEntity方法配置查詢對應的實體型別。

    private User SqlQuery() {
        Session session = SessionContext.getSession();
        Query query = session.createSQLQuery("select * from User where userName=?").addEntity(User.class);
        query.setString(0, "admin");
        return (User) query.uniqueResult();
    }

（2）HQL通用查詢：

Hibernate使用Query介面，通過自定義的HQL實現通用查詢，HQL提供了一箇中間語言，遮蔽了不同資料庫的語法差異。通過session可以建立Query介面的例項。

    private User SqlQuery() {
        Session session = SessionContext.getSession();
        Query query = session.createQuery("from User where userName=:userName");
        query.setString("userName", "admin");
        return (User) query.uniqueResult();
    }

（3）Criteria條件查詢：

Hibernate通過Criteria物件提供對自動化查詢的方法級別的支援，輔助類Restrictions提供了大量靜態方法建立Criteria物件，最大的作用就是防止寫錯SQL關鍵字。Java中沒有類似.NET中Linq一樣的語言整合查詢。

    private User CriteriaQuery() {
        Session session = SessionContext.getSession();
        Criteria query = session.createCriteria(User.class);
        query.add(Restrictions.eq("userName", "admin"));
        return (User) query.uniqueResult();
    }

5.事務

 Transanction介面是Hibernate中封裝事務的介面，支援JDBC資料庫事務和JTA分散式事務，可以通過Session物件使用Transanction進行事務管理。JAT事務則與JTA容器緊密相關，以後再續。

    private void Test(SessionFactory factory) {
        factory.getCurrentSession().beginTransaction();
        Query query = factory.getCurrentSession().createSQLQuery("select * from User where userName=?")
                .addEntity(User.class);
        User user = (User) query.uniqueResult();
        factory.getCurrentSession().getTransaction().commit();
    } 

參考

（1）http://docs.jboss.org/hibernate/orm/5.0/quickstart/html/

（2）https://www.ibm.com/developerworks/cn/java/j-lo-jta/

（3）https://www.ibm.com/developerworks/cn/java/j-lo-hibernate3/