hibernate泛化模版DAO

標籤：http   java   使用   os   檔案   資料   

編寫Spring+Hibernate架構下的應用，總是離不了編寫一個通用的泛型GenericHibernateDao。查閱了網上不少的GenericHibernateDao實現，歸納整理為如下實現，供後續編碼參考。

首先定義介面泛型DAO介面 GenericDao

package com.th.huz;import java.io.Serializable;import java.util.Collection;import java.util.Iterator;import java.util.List;import org.hibernate.Criteria;import org.hibernate.LockMode;import org.hibernate.criterion.DetachedCriteria;/** *  * @author lny */public interface GenericDao<T extends Serializable, PK extends Serializable> {    // -------------------- 基本檢索、增加、修改、刪除操作 --------------------    // 根據主鍵擷取實體。如果沒有相應的實體，返回 null。    public T get(PK id);    // 根據主鍵擷取實體並加鎖。如果沒有相應的實體，返回 null。    public T getWithLock(PK id, LockMode lock);    // 根據主鍵擷取實體。如果沒有相應的實體，拋出異常。    public T load(PK id);    // 根據主鍵擷取實體並加鎖。如果沒有相應的實體，拋出異常。    public T loadWithLock(PK id, LockMode lock);    // 擷取全部實體。    public List<T> loadAll();    // loadAllWithLock() ?    // 更新實體    public void update(T entity);    // 更新實體並加鎖    public void updateWithLock(T entity, LockMode lock);    // 儲存實體到資料庫    public void save(T entity);    // saveWithLock()    // 增加或更新實體    public void saveOrUpdate(T entity);    // 增加或更新集合中的全部實體    public void saveOrUpdateAll(Collection<T> entities);    // 刪除指定的實體    public void delete(T entity);    // 加鎖並刪除指定的實體    public void deleteWithLock(T entity, LockMode lock);    // 根據主鍵刪除指定實體    public void deleteByKey(PK id);    // 根據主鍵加鎖並刪除指定的實體    public void deleteByKeyWithLock(PK id, LockMode lock);    // 刪除集合中的全部實體    public void deleteAll(Collection<T> entities);    // -------------------- HSQL ----------------------------------------------    // 使用HSQL語句直接增加、更新、刪除實體    public int bulkUpdate(String queryString);    // 使用帶參數的HSQL語句增加、更新、刪除實體    public int bulkUpdate(String queryString, Object[] values);    // 使用HSQL語句檢索資料    public List find(String queryString);    // 使用帶參數的HSQL語句檢索資料    public List find(String queryString, Object[] values);    // 使用帶命名的參數的HSQL語句檢索資料    public List findByNamedParam(String queryString, String[] paramNames,            Object[] values);    // 使用命名的HSQL語句檢索資料    public List findByNamedQuery(String queryName);    // 使用帶參數的命名HSQL語句檢索資料    public List findByNamedQuery(String queryName, Object[] values);    // 使用帶具名引數的命名HSQL語句檢索資料    public List findByNamedQueryAndNamedParam(String queryName,            String[] paramNames, Object[] values);    // 使用HSQL語句檢索資料，返回 Iterator    public Iterator iterate(String queryString);    // 使用帶參數HSQL語句檢索資料，返回 Iterator    public Iterator iterate(String queryString, Object[] values);    // 關閉檢索返回的 Iterator    public void closeIterator(Iterator it);    // -------------------------------- Criteria ------------------------------    // 建立與會話無關的檢索標準對象    public DetachedCriteria createDetachedCriteria();    // 建立與會話綁定的檢索標準對象    public Criteria createCriteria();    // 使用指定的檢索標準檢索資料    public List findByCriteria(DetachedCriteria criteria);    // 使用指定的檢索標準檢索資料，返回部分記錄    public List findByCriteria(DetachedCriteria criteria, int firstResult,            int maxResults);    // 使用指定的實體及屬性檢索（滿足除主鍵外屬性＝實體值）資料    public List<T> findEqualByEntity(T entity, String[] propertyNames);    // 使用指定的實體及屬性(非主鍵)檢索（滿足屬性 like 串實體值）資料    public List<T> findLikeByEntity(T entity, String[] propertyNames);    // 使用指定的檢索標準檢索資料，返回指定範圍的記錄    public Integer getRowCount(DetachedCriteria criteria);    // 使用指定的檢索標準檢索資料，返回指定統計值    public Object getStatValue(DetachedCriteria criteria, String propertyName,            String StatName);    // -------------------------------- Others --------------------------------    // 加鎖指定的實體    public void lock(T entity, LockMode lockMode);    // 強制初始化指定的實體    public void initialize(Object proxy);    // 強制立即更新緩衝資料到資料庫（否則僅在事務提交時才更新）    public void flush();}

實現GenericDao介面的Hibernate的實作類別 GenericHibernateDao

import java.lang.reflect.ParameterizedType;import java.io.Serializable;import java.lang.reflect.ParameterizedType;import java.lang.reflect.Type;import java.util.Collection;import java.util.Iterator;import java.util.List;import org.apache.commons.beanutils.PropertyUtils;import org.hibernate.Criteria;import org.hibernate.LockMode;import org.hibernate.criterion.DetachedCriteria;import org.hibernate.criterion.Example;import org.hibernate.criterion.MatchMode;import org.hibernate.criterion.Order;import org.hibernate.criterion.Projections;import org.hibernate.criterion.Restrictions;import org.springframework.orm.hibernate3.support.HibernateDaoSupport;/** * GenericHibernateDao 繼承 HibernateDao，簡單封裝 HibernateTemplate 各項功能， * 簡化基於Hibernate Dao 的編寫。 *  * @author lny */@SuppressWarnings("unchecked")public class GenericHibernateDao<T extends Serializable, PK extends Serializable>        extends HibernateDaoSupport implements GenericDao<T, PK> {    // 實體類類型(由構造方法自動賦值)    private Class<T> entityClass;    // 構造方法，根據執行個體類自動擷取實體類類型    public GenericHibernateDao() {        this.entityClass = null;        Class c = getClass();        Type t = c.getGenericSuperclass();        if (t instanceof ParameterizedType) {            Type[] p = ((ParameterizedType) t).getActualTypeArguments();            this.entityClass = (Class<T>) p[0];        }    }    // -------------------- 基本檢索、增加、修改、刪除操作 --------------------    // 根據主鍵擷取實體。如果沒有相應的實體，返回 null。    public T get(PK id) {        return (T) getHibernateTemplate().get(entityClass, id);    }    // 根據主鍵擷取實體並加鎖。如果沒有相應的實體，返回 null。    public T getWithLock(PK id, LockMode lock) {        T t = (T) getHibernateTemplate().get(entityClass, id, lock);        if (t != null) {            this.flush(); // 立即重新整理，否則鎖不會生效。        }        return t;    }    // 根據主鍵擷取實體。如果沒有相應的實體，拋出異常。    public T load(PK id) {        return (T) getHibernateTemplate().load(entityClass, id);    }    // 根據主鍵擷取實體並加鎖。如果沒有相應的實體，拋出異常。    public T loadWithLock(PK id, LockMode lock) {        T t = (T) getHibernateTemplate().load(entityClass, id, lock);        if (t != null) {            this.flush(); // 立即重新整理，否則鎖不會生效。        }        return t;    }    // 擷取全部實體。    public List<T> loadAll() {        return (List<T>) getHibernateTemplate().loadAll(entityClass);    }    // loadAllWithLock() ?    // 更新實體    public void update(T entity) {        getHibernateTemplate().update(entity);    }    // 更新實體並加鎖    public void updateWithLock(T entity, LockMode lock) {        getHibernateTemplate().update(entity, lock);        this.flush(); // 立即重新整理，否則鎖不會生效。    }    // 儲存實體到資料庫    public void save(T entity) {        getHibernateTemplate().save(entity);    }    // saveWithLock()？    // 增加或更新實體    public void saveOrUpdate(T entity) {        getHibernateTemplate().saveOrUpdate(entity);    }    // 增加或更新集合中的全部實體    public void saveOrUpdateAll(Collection<T> entities) {        getHibernateTemplate().saveOrUpdateAll(entities);    }    // 刪除指定的實體    public void delete(T entity) {        getHibernateTemplate().delete(entity);    }    // 加鎖並刪除指定的實體    public void deleteWithLock(T entity, LockMode lock) {        getHibernateTemplate().delete(entity, lock);        this.flush(); // 立即重新整理，否則鎖不會生效。    }    // 根據主鍵刪除指定實體    public void deleteByKey(PK id) {        this.delete(this.load(id));    }    // 根據主鍵加鎖並刪除指定的實體    public void deleteByKeyWithLock(PK id, LockMode lock) {        this.deleteWithLock(this.load(id), lock);    }    // 刪除集合中的全部實體    public void deleteAll(Collection<T> entities) {        getHibernateTemplate().deleteAll(entities);    }    // -------------------- HSQL ----------------------------------------------    // 使用HSQL語句直接增加、更新、刪除實體    public int bulkUpdate(String queryString) {        return getHibernateTemplate().bulkUpdate(queryString);    }    // 使用帶參數的HSQL語句增加、更新、刪除實體    public int bulkUpdate(String queryString, Object[] values) {        return getHibernateTemplate().bulkUpdate(queryString, values);    }    // 使用HSQL語句檢索資料    public List find(String queryString) {        return getHibernateTemplate().find(queryString);    }    // 使用帶參數的HSQL語句檢索資料    public List find(String queryString, Object[] values) {        return getHibernateTemplate().find(queryString, values);    }    // 使用帶命名的參數的HSQL語句檢索資料    public List findByNamedParam(String queryString, String[] paramNames,            Object[] values) {        return getHibernateTemplate().findByNamedParam(queryString, paramNames,                values);    }    // 使用命名的HSQL語句檢索資料    public List findByNamedQuery(String queryName) {        return getHibernateTemplate().findByNamedQuery(queryName);    }    // 使用帶參數的命名HSQL語句檢索資料    public List findByNamedQuery(String queryName, Object[] values) {        return getHibernateTemplate().findByNamedQuery(queryName, values);    }    // 使用帶具名引數的命名HSQL語句檢索資料    public List findByNamedQueryAndNamedParam(String queryName,            String[] paramNames, Object[] values) {        return getHibernateTemplate().findByNamedQueryAndNamedParam(queryName,                paramNames, values);    }    // 使用HSQL語句檢索資料，返回 Iterator    public Iterator iterate(String queryString) {        return getHibernateTemplate().iterate(queryString);    }    // 使用帶參數HSQL語句檢索資料，返回 Iterator    public Iterator iterate(String queryString, Object[] values) {        return getHibernateTemplate().iterate(queryString, values);    }    // 關閉檢索返回的 Iterator    public void closeIterator(Iterator it) {        getHibernateTemplate().closeIterator(it);    }    // -------------------------------- Criteria ------------------------------    // 建立與會話無關的檢索標準    public DetachedCriteria createDetachedCriteria() {        return DetachedCriteria.forClass(this.entityClass);    }    // 建立與會話綁定的檢索標準    public Criteria createCriteria() {        return this.createDetachedCriteria().getExecutableCriteria(                this.getSession());    }    // 檢索滿足標準的資料    public List findByCriteria(DetachedCriteria criteria) {        return getHibernateTemplate().findByCriteria(criteria);    }    // 檢索滿足標準的資料，返回指定範圍的記錄    public List findByCriteria(DetachedCriteria criteria, int firstResult,            int maxResults) {        return getHibernateTemplate().findByCriteria(criteria, firstResult,                maxResults);    }    // 使用指定的實體及屬性檢索（滿足除主鍵外屬性＝實體值）資料    public List<T> findEqualByEntity(T entity, String[] propertyNames) {        Criteria criteria = this.createCriteria();        Example exam = Example.create(entity);        exam.excludeZeroes();        String[] defPropertys = getSessionFactory().getClassMetadata(                entityClass).getPropertyNames();        for (String defProperty : defPropertys) {            int ii = 0;            for (ii = 0; ii < propertyNames.length; ++ii) {                if (defProperty.equals(propertyNames[ii])) {                    criteria.addOrder(Order.asc(defProperty));                    break;                }            }            if (ii == propertyNames.length) {                exam.excludeProperty(defProperty);            }        }        criteria.add(exam);        return (List<T>) criteria.list();    }    // 使用指定的實體及屬性檢索（滿足屬性 like 串實體值）資料    public List<T> findLikeByEntity(T entity, String[] propertyNames) {        Criteria criteria = this.createCriteria();        for (String property : propertyNames) {            try {                Object value = PropertyUtils.getProperty(entity, property);                if (value instanceof String) {                    criteria.add(Restrictions.like(property, (String) value,                            MatchMode.ANYWHERE));                    criteria.addOrder(Order.asc(property));                } else {                    criteria.add(Restrictions.eq(property, value));                    criteria.addOrder(Order.asc(property));                }            } catch (Exception ex) {                // 忽略無效的檢索參考資料。            }        }        return (List<T>) criteria.list();    }    // 使用指定的檢索標準擷取滿足標準的記錄數    public Integer getRowCount(DetachedCriteria criteria) {        criteria.setProjection(Projections.rowCount());        List list = this.findByCriteria(criteria, 0, 1);        return (Integer) list.get(0);    }    // 使用指定的檢索標準檢索資料，返回指定統計值(max,min,avg,sum)    public Object getStatValue(DetachedCriteria criteria, String propertyName,            String StatName) {        if (StatName.toLowerCase().equals("max"))            criteria.setProjection(Projections.max(propertyName));        else if (StatName.toLowerCase().equals("min"))            criteria.setProjection(Projections.min(propertyName));        else if (StatName.toLowerCase().equals("avg"))            criteria.setProjection(Projections.avg(propertyName));        else if (StatName.toLowerCase().equals("sum"))            criteria.setProjection(Projections.sum(propertyName));        else            return null;        List list = this.findByCriteria(criteria, 0, 1);        return list.get(0);    }    // -------------------------------- Others --------------------------------    // 加鎖指定的實體    public void lock(T entity, LockMode lock) {        getHibernateTemplate().lock(entity, lock);    }    // 強制初始化指定的實體    public void initialize(Object proxy) {        getHibernateTemplate().initialize(proxy);    }    // 強制立即更新緩衝資料到資料庫（否則僅在事務提交時才更新）    public void flush() {        getHibernateTemplate().flush();    }}

//以上代碼來自網上收集

以上就實現了泛型的 Hibernate Dao 了，下面的例子就是業務對象對 GenericHibernateDao的使用

業務對象 Article 對應文章表的 aticle 表

package com.th.huz.model;import java.io.Serializable;import java.util.Date;public class Article implements Serializable {    private static final long serialVersionUID = 1072812006693587010L;    private long id;    private String title;    private String author;    private Date pubDate;    private String content;    public long getId() {        return id;    }    public void setId(long id) {        this.id = id;    }    public String getTitle() {        return title;    }    public void setTitle(String title) {        this.title = title;    }    public String getAuthor() {        return author;    }    public void setAuthor(String author) {        this.author = author;    }    public Date getPubDate() {        return pubDate;    }    public void setPubDate(Date pubDate) {        this.pubDate = pubDate;    }    public String getContent() {        return content;    }    public void setContent(String content) {        this.content = content;    }}

定義 Article 業務對象的Dao 介面 IArticleDao ，它繼承自 GenericDao 介面，以獲得其中的方法

你可以在 IArticleDao 中添加 Article 業務對象特有的方法，也可以直接使用 GenericDao 中提供的所有方法IArticleDao介面指定業務對象的類型和主鍵的類型

package com.th.huz.model;import com.th.huz.dao.GenericDao;import com.th.huz.model.Article;public interface IArticleDAO extends GenericDao <Article,Long> {//    public void findById(Long id);}

然後就可以定義 ArticleHibernateDao 類了，它只要實現 IArticleDao 介面並繼承 GenericHibernateDao 類 就可以使用所有的 Generic 介面和 IArticleDao 介面中的定義的方法。如果你在 IArticleDao 介面裡指定了Article業務對象特有的方法，就在ArticleHibernateDao實現這些方法。而Generic 介面中的方法，在ArticleHibernateDao 的父類 GenericHibernateDao 中已經全部實現了，直接調用就可以方便的訪問資料庫。

package com.th.huz.model;import com.th.huz.dao.GenericHibernateDao;public class ArticleHibernateDao extends GenericHibernateDao<Article,Long> implements        IArticleDAO {}

其他的業務對象也可以參照 Article 和 ArticleHibernateDao 類來定義 ， GenericDao 介面中有的通用方法就直接調用，不足的以後補充，其他業務對象特有的方法就 在其他業務對象的 Dao介面(繼承GenericDao介面) 中定義並通過 GenericHibernateDao 子類來實現。 節省很多重複代碼，簡單幾步就可以使用GenericDao介面的實作類別 GenericHibernateDao 方便地訪問資料庫。

最後提供一個 Article 業務對象的 Hibernate 對應檔 和 建表SQL指令碼 和 一個 ArticleHibernateDao 類的測試類別

Article的對應檔

<id name="id" type="java.lang.Long"><!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN""http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"><!-- Article.hbm.xml --><hibernate-mapping>    <class name="com.th.huz.model.Article" table="article">        <id name="id" type="java.lang.Long">            <column name="id" />            <generator class="native" />        </id>        <property name="title" type="java.lang.String">            <column name="title" length="100" />        </property>        <property name="author">            <column name="author" length="32" />        </property>        <property name="pubDate" type="java.util.Date">            <column name="pubDate" />        </property>        <property name="content" type="java.lang.String">            <column name="content" />        </property>    </class></hibernate-mapping>

Article對應的article表的建表指令碼

if exists (select * from dbo.sysobjects where id = object_id(N‘[dbo].[article]‘) and OBJECTPROPERTY(id, N‘IsUserTable‘) = 1)drop table [dbo].[article]GOCREATE TABLE [dbo].[article] (    [id] [int] IDENTITY (1, 1) NOT NULL ,    [title] [varchar] (100) COLLATE Chinese_PRC_CI_AS NOT NULL ,    [author] [varchar] (32) COLLATE Chinese_PRC_CI_AS NULL ,    [pubDate] [datetime] NULL ,    [content] [text] COLLATE Chinese_PRC_CI_AS NULL ) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]GO

ArticleHibernateDao的測試類別，只提供了seve(article) 方法的測試代碼

package com.th.huz.test;import junit.framework.TestCase;import org.springframework.context.ApplicationContext;import org.springframework.context.support.ClassPathXmlApplicationContext;import com.th.huz.model.Article;import com.th.huz.model.ArticleHibernateDao;public class ArticleHibernateDaoTest extends TestCase {    ApplicationContext ctx = new ClassPathXmlApplicationContext(            "applicationContext.xml");    ArticleHibernateDao adh = (ArticleHibernateDao) ctx            .getBean("articleHibernateDao");    public void testSave() {        Article art = (Article) ctx.getBean("article");        art.setId(1);        art.setTitle("標題1");        art.setAuthor("作者1");        adh.save(art);    }}

以上代碼在整合了 Hibernate 的 Spring 架構下調試通過，僅供學習參考，請自行搭配你的環境來調試，本人也是自己初學，有沒說清楚的地方敬請指教。