詳細介紹 Hibernate 泛型 DAO 及其使用方法
編寫Spring+Hibernate框架下的應(yīng)用，總是離不了編寫一個通用的泛型GenericHibernateDao。查閱了網(wǎng)上不少的GenericHibernateDao實現(xiàn)，歸納整理為如下實現(xiàn)，供后續(xù)編碼參考。
首先定義接口泛型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;
public interface GenericDao<T extends Serializable, PK extends Serializable> {
// -------------------- 基本檢索、增加、修改、刪除操作 --------------------
// 根據(jù)主鍵獲取實體。如果沒有相應(yīng)的實體，返回 null。
public T get(PK id);
// 根據(jù)主鍵獲取實體并加鎖。如果沒有相應(yīng)的實體，返回 null。
public T getWithLock(PK id, LockMode lock);
// 根據(jù)主鍵獲取實體。如果沒有相應(yīng)的實體，拋出異常。
public T load(PK id);
// 根據(jù)主鍵獲取實體并加鎖。如果沒有相應(yīng)的實體，拋出異常。
public T loadWithLock(PK id, LockMode lock);
// 獲取全部實體。
public List<T> loadAll();
// loadAllWithLock() ?
// 更新實體
public void update(T entity);
// 更新實體并加鎖
public void updateWithLock(T entity, LockMode lock);
// 存儲實體到數(shù)據(jù)庫
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);
// 根據(jù)主鍵刪除指定實體
public void deleteByKey(PK id);
// 根據(jù)主鍵加鎖并刪除指定的實體
public void deleteByKeyWithLock(PK id, LockMode lock);
// 刪除集合中的全部實體
public void deleteAll(Collection<T> entities);
// -------------------- HSQL ----------------------------------------------
// 使用HSQL語句直接增加、更新、刪除實體
public int bulkUpdate(String queryString);
// 使用帶參數(shù)的HSQL語句增加、更新、刪除實體
public int bulkUpdate(String queryString, Object[] values);
// 使用HSQL語句檢索數(shù)據(jù)
public List find(String queryString);
// 使用帶參數(shù)的HSQL語句檢索數(shù)據(jù)
public List find(String queryString, Object[] values);
// 使用帶命名的參數(shù)的HSQL語句檢索數(shù)據(jù)
public List findByNamedParam(String queryString, String[] paramNames,
Object[] values);
// 使用命名的HSQL語句檢索數(shù)據(jù)
public List findByNamedQuery(String queryName);
// 使用帶參數(shù)的命名HSQL語句檢索數(shù)據(jù)
public List findByNamedQuery(String queryName, Object[] values);
// 使用帶命名參數(shù)的命名HSQL語句檢索數(shù)據(jù)
public List findByNamedQueryAndNamedParam(String queryName,
String[] paramNames, Object[] values);
// 使用HSQL語句檢索數(shù)據(jù)，返回 Iterator
public Iterator iterate(String queryString);
// 使用帶參數(shù)HSQL語句檢索數(shù)據(jù)，返回 Iterator
public Iterator iterate(String queryString, Object[] values);
// 關(guān)閉檢索返回的 Iterator
public void closeIterator(Iterator it);
// -------------------------------- Criteria ------------------------------
// 創(chuàng)建與會話無關(guān)的檢索標準對象
public DetachedCriteria createDetachedCriteria();
// 創(chuàng)建與會話綁定的檢索標準對象
public Criteria createCriteria();
// 使用指定的檢索標準檢索數(shù)據(jù)
public List findByCriteria(DetachedCriteria criteria);
// 使用指定的檢索標準檢索數(shù)據(jù)，返回部分記錄
public List findByCriteria(DetachedCriteria criteria, int firstResult,
int maxResults);
// 使用指定的實體及屬性檢索（滿足除主鍵外屬性＝實體值）數(shù)據(jù)
public List<T> findEqualByEntity(T entity, String[] propertyNames);
// 使用指定的實體及屬性(非主鍵)檢索（滿足屬性 like 串實體值）數(shù)據(jù)
public List<T> findLikeByEntity(T entity, String[] propertyNames);
// 使用指定的檢索標準檢索數(shù)據(jù)，返回指定范圍的記錄
public Integer getRowCount(DetachedCriteria criteria);
// 使用指定的檢索標準檢索數(shù)據(jù)，返回指定統(tǒng)計值
public Object getStatValue(DetachedCriteria criteria, String propertyName,
String StatName);
// -------------------------------- Others --------------------------------
// 加鎖指定的實體
public void lock(T entity, LockMode lockMode);
// 強制初始化指定的實體
public void initialize(Object proxy);
// 強制立即更新緩沖數(shù)據(jù)到數(shù)據(jù)庫（否則僅在事務(wù)提交時才更新）
public void flush();
}
實現(xiàn)GenericDao接口的Hibernate的實現(xiàn)類 GenericHibernateDao
package com.th.huz;
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;
@SuppressWarnings("unchecked")
public class GenericHibernateDao<T extends Serializable, PK extends Serializable>
extends HibernateDaoSupport implements GenericDao<T, PK> {
// 實體類類型(由構(gòu)造方法自動賦值)
private Class<T> entityClass;
// 構(gòu)造方法，根據(jù)實例類自動獲取實體類類型
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];
}
}
// -------------------- 基本檢索、增加、修改、刪除操作 --------------------
// 根據(jù)主鍵獲取實體。如果沒有相應(yīng)的實體，返回 null。
public T get(PK id) {
return (T) getHibernateTemplate().get(entityClass, id);
}
// 根據(jù)主鍵獲取實體并加鎖。如果沒有相應(yīng)的實體，返回 null。
public T getWithLock(PK id, LockMode lock) {
T t = (T) getHibernateTemplate().get(entityClass, id, lock);
if (t != null) {
this.flush(); // 立即刷新，否則鎖不會生效。
}
return t;
}
// 根據(jù)主鍵獲取實體。如果沒有相應(yīng)的實體，拋出異常。
public T load(PK id) {
return (T) getHibernateTemplate().load(entityClass, id);
}
// 根據(jù)主鍵獲取實體并加鎖。如果沒有相應(yīng)的實體，拋出異常。
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(); // 立即刷新，否則鎖不會生效。
}
// 存儲實體到數(shù)據(jù)庫
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(); // 立即刷新，否則鎖不會生效。
}
// 根據(jù)主鍵刪除指定實體
public void deleteByKey(PK id) {
this.delete(this.load(id));
}
// 根據(jù)主鍵加鎖并刪除指定的實體
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);
}
// 使用帶參數(shù)的HSQL語句增加、更新、刪除實體
public int bulkUpdate(String queryString, Object[] values) {
return getHibernateTemplate().bulkUpdate(queryString, values);
}
// 使用HSQL語句檢索數(shù)據(jù)
public List find(String queryString) {
return getHibernateTemplate().find(queryString);
}
// 使用帶參數(shù)的HSQL語句檢索數(shù)據(jù)
public List find(String queryString, Object[] values) {
return getHibernateTemplate().find(queryString, values);
}
// 使用帶命名的參數(shù)的HSQL語句檢索數(shù)據(jù)
public List findByNamedParam(String queryString, String[] paramNames,
Object[] values) {
return getHibernateTemplate().findByNamedParam(queryString, paramNames,
values);
}
// 使用命名的HSQL語句檢索數(shù)據(jù)
public List findByNamedQuery(String queryName) {
return getHibernateTemplate().findByNamedQuery(queryName);
}
// 使用帶參數(shù)的命名HSQL語句檢索數(shù)據(jù)
public List findByNamedQuery(String queryName, Object[] values) {
return getHibernateTemplate().findByNamedQuery(queryName, values);
}
// 使用帶命名參數(shù)的命名HSQL語句檢索數(shù)據(jù)
public List findByNamedQueryAndNamedParam(String queryName,
String[] paramNames, Object[] values) {
return getHibernateTemplate().findByNamedQueryAndNamedParam(queryName,
paramNames, values);
}
// 使用HSQL語句檢索數(shù)據(jù)，返回 Iterator
public Iterator iterate(String queryString) {
return getHibernateTemplate().iterate(queryString);
}
// 使用帶參數(shù)HSQL語句檢索數(shù)據(jù)，返回 Iterator
public Iterator iterate(String queryString, Object[] values) {
return getHibernateTemplate().iterate(queryString, values);
}
// 關(guān)閉檢索返回的 Iterator
public void closeIterator(Iterator it) {
getHibernateTemplate().closeIterator(it);
}
// -------------------------------- Criteria ------------------------------
// 創(chuàng)建與會話無關(guān)的檢索標準
public DetachedCriteria createDetachedCriteria() {
return DetachedCriteria.forClass(this.entityClass);
}
// 創(chuàng)建與會話綁定的檢索標準
public Criteria createCriteria() {
return this.createDetachedCriteria().getExecutableCriteria(
this.getSession());
}
// 檢索滿足標準的數(shù)據(jù)
public List findByCriteria(DetachedCriteria criteria) {
return getHibernateTemplate().findByCriteria(criteria);
}
// 檢索滿足標準的數(shù)據(jù)，返回指定范圍的記錄
public List findByCriteria(DetachedCriteria criteria, int firstResult,
int maxResults) {
return getHibernateTemplate().findByCriteria(criteria, firstResult,
maxResults);
}
// 使用指定的實體及屬性檢索（滿足除主鍵外屬性＝實體值）數(shù)據(jù)
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 串實體值）數(shù)據(jù)
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) {
// 忽略無效的檢索參考數(shù)據(jù)。
}
}
return (List<T>) criteria.list();
}
// 使用指定的檢索標準獲取滿足標準的記錄數(shù)
public Integer getRowCount(DetachedCriteria criteria) {
criteria.setProjection(Projections.rowCount());
List list = this.findByCriteria(criteria, 0, 1);
return (Integer) list.get(0);
}
// 使用指定的檢索標準檢索數(shù)據(jù)，返回指定統(tǒng)計值(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);
}
// 強制立即更新緩沖數(shù)據(jù)到數(shù)據(jù)庫（否則僅在事務(wù)提交時才更新）
public void flush() {
getHibernateTemplate().flush();
}
}
//以上代碼來自網(wǎng)上收集
以上就實現(xiàn)了泛型的 Hibernate Dao 了，下面的例子就是業(yè)務(wù)對象對 GenericHibernateDao的使用
業(yè)務(wù)對象 Article 對應(yīng)文章表的 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 業(yè)務(wù)對象的Dao 接口 IArticleDao ，它繼承自 GenericDao 接口，以獲得其中的方法
你可以在 IArticleDao 中添加 Article 業(yè)務(wù)對象特有的方法，也可以直接使用 GenericDao 中提供的所有方法IArticleDao接口指定業(yè)務(wù)對象的類型和主鍵的類型 <Article,Long>
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 類了，它只要實現(xiàn) IArticleDao 接口并繼承 GenericHibernateDao 類 就可以使用所有的 Generic 接口和 IArticleDao 接口中的定義的方法。如果你在 IArticleDao 接口里指定了Article業(yè)務(wù)對象特有的方法，就在ArticleHibernateDao實現(xiàn)這些方法。而Generic 接口中的方法，在ArticleHibernateDao 的父類 GenericHibernateDao 中已經(jīng)全部實現(xiàn)了，直接調(diào)用就可以方便的訪問數(shù)據(jù)庫。
package com.th.huz.model;
import com.th.huz.dao.GenericHibernateDao;
public class ArticleHibernateDao extends GenericHibernateDao<Article,Long> implements
IArticleDAO {
}
其他的業(yè)務(wù)對象也可以參照 Article 和 ArticleHibernateDao 類來定義 ， GenericDao 接口中有的通用方法就直接調(diào)用，不足的以后補充，其他業(yè)務(wù)對象特有的方法就 在其他業(yè)務(wù)對象的 Dao接口(繼承GenericDao接口) 中定義并通過 GenericHibernateDao 子類來實現(xiàn)。 節(jié)省很多重復(fù)代碼，簡單幾步就可以使用GenericDao接口的實現(xiàn)類 GenericHibernateDao 方便地訪問數(shù)據(jù)庫。
最后提供一個 Article 業(yè)務(wù)對象的 Hibernate 映射文件 和 建表SQL腳本 和 一個 ArticleHibernateDao 類的測試類
Article的映射文件
<?xml version="1.0"?>
<!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對應(yīng)的article表的建表腳本
if exists (select * from dbo.sysobjects where id = object_id(N'[dbo].[article]') and OBJECTPROPERTY(id, N'IsUserTable') = 1)
drop table [dbo].[article]
GO
CREATE 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);
}
}