使用Java继承与泛型特性创建高效与安全的DAO对象

   现在无论做什么应用，基本上都会有涉及对象持久化这方面的操作。通常创建大量的DAO对象是我们开发过程中最常见的操作了。创建DAO对象的优点主要体现在提高代码复用和降低业务逻辑操作与业务实体持久化之间的耦合。

DAO对象一般都包括CRUD动作，如果在一个应用中,大量的重复定义这些CRUD方法,会占用大量的开发时间及测试时间,那在这一方面,有没有改进的方法呢？

其实，利用Java面向对象的基本特性及JDK5新引入的泛型语法，我们可以创建通用的DAO对象的CRUD方法，同时又可保证类型的安全性。下面DAO的实现以Hibernate为基础加以演示。

1. 我们可以定义一个包含通用的CRUD的DAO接口，如下：

package com.brady.common.dao.hibernate; import java.io.Serializable; import java.util.List; /** * 定义所有DAO接口的父接口，用以提供一些通用的方法，并通过泛型实现一些DAO的通用功能 * @author: 张国敬 * Created time: 2010-7-20 * QQ: 15945144 * Email: brady.zh@gmail.com * CopyRights: www.brady.com */ public interface BaseDAO<T> { /** * 保存实体对象到数据库中 * @param entity */ public void save(T entity); /** * 更新实体对象到数据库中 * @param entity */ public void update(T entity); /** * 从数据库中删除实体对象 * @param entity */ public void delete(T entity); /** * 合并实体对象到数据库中 * @param entity * @return */ public T merge(T entity); /** * 根据实体对象的标识ID去get一个实例 * @param entityClass * @param id * @return */ public T findById(Class entityClass, java.io.Serializable id); /** * 返回库中指定的实体类的所有对象 * @param entityClass * @return */ public List<T> findAll(Class entityClass); /** * 根据指定的属性名及属性值返回一个对象列表 * @param entityClass * @param name * @param value * @return */ public List<T> findByProperty(Class entityClass, String name, Object value); /** * 根据指定的属性名及属性值取返回一个对象 * @param entityClass * @param name * @param value * @return */ public T findUniqueResultByProperty(Class entityClass, String name, Object value); /** * 根据HQL语句返回包含实体的List * @param hql 查询的HQL语句 * @return 返回包含查询所得实体的List */ public List findByHql(String hql); /** * 根据HQL语句返回包含实体的List * @param hql 查询的HQL语句，含查询参数 * @param params hql语句中对应的一个参数 * @return 返回包含查询所得实体的List */ public List findByHql(String hql, Object param); /** * 根据HQL语句返回包含实体的List * @param hql 查询的HQL语句，含查询参数 * @param params hql语句中对应的参数数组 * @return 返回包含查询所得实体的List */ public List findByHql(String hql, Object[] params); }  

2. 下面给出该接口的参考实现

package com.brady.common.dao.hibernate; import java.io.Serializable; import java.sql.SQLException; import java.util.List; import org.springframework.orm.hibernate3.HibernateTemplate; import org.springframework.orm.hibernate3.support.HibernateDaoSupport; /** * 扩展自HibernateDaoSupport类的DAO基础类 * 因为利用的java的泛型机制，所以使用时要指定一个明确的类 * 该类实现了BaseDAO<T>接口、对通过的CURD操作提供了默认实现， * 派生类类不需要再一一来实现，从而提高了开发效率 * 使用示例: * UserDAOImpl extends BaseDAOImpl<User> { * ... * } * @author: 张国敬 * Created time: 2010-7-20 * QQ: 15945144 * Email: brady.zh@gmail.com * CopyRights: www.brady.com */ public abstract class BaseDAOImpl<T> extends HibernateDaoSupport implements BaseDAO<T> { @Override public void delete(T entity) { this.getHibernateTemplate().delete(entity); } @Override public T merge(T entity) { return (T)this.getHibernateTemplate().merge(entity); } @Override public void save(T entity) { this.getHibernateTemplate().save(entity); } @Override public void update(T entity) { this.getHibernateTemplate().update(entity); } @Override public List<T> findAll(Class entityClass) { String className = entityClass.getName(); return this.getHibernateTemplate().find("from " + className); } @Override public T findById(Class entityClass, Serializable id) { return (T)this.getHibernateTemplate().get(entityClass, id); } @Override public List<T> findByProperty(Class entityClass, String name, Object value) { String className = entityClass.getName(); StringBuffer sb = new StringBuffer(100); sb.append("from "); sb.append(className); sb.append(" as e where e."); sb.append(name); sb.append("=?"); return this.getHibernateTemplate().find(sb.toString(), value); } @Override public T findUniqueResultByProperty(Class entityClass, String name, Object value) { String className = entityClass.getName(); StringBuffer sb = new StringBuffer(100); sb.append("from "); sb.append(className); sb.append(" as e where e."); sb.append(name); sb.append("=?"); final String hql = sb.toString(); HibernateTemplate htemp = this.getHibernateTemplate(); htemp.setMaxResults(1); List<T> list = htemp.find(hql, value); return list.size() > 0 ? list.get(0) : null; } public List findByHql(final String hql) { return this.getHibernateTemplate().find(hql); } public List findByHql(String hql, Object[] params) { return this.getHibernateTemplate().find(hql, params); } public List findByHql(String hql, Object param) { return this.getHibernateTemplate().find(hql, new Object[] {param}); } }  

 

3. 在开发应用中，如果需要实现DAO，则可以直接使用该接口以及继承自该默认实现类，从而省去了重复定义那些类似的重复CRUD动作，只需把精力放在其他特定查询功能的实现上即可。下以给出一个自定义UserDAO的例子以说明其使用方法。

    0). User对象的定义

package com.brady.common.dao.hibernate.test; import java.util.HashSet; import java.util.Set; /** * User entity. @author MyEclipse Persistence Tools */ public class User implements java.io.Serializable { // Fields private Integer id; private String code; private String name; private String password; private Integer type = 3; private String email; private String qq; private String msn; private String officephone; private String cellphone; // Constructors /** default constructor */ public User() { } /** minimal constructor */ public User(String code, String password, Integer type) { this.code = code; this.password = password; this.type = type; } // Property accessors public Integer getId() { return this.id; } public void setId(Integer id) { this.id = id; } public String getCode() { return this.code; } public void setCode(String code) { this.code = code; } public String getName() { return this.name; } public void setName(String name) { this.name = name; } public String getPassword() { return this.password; } public void setPassword(String password) { this.password = password; } public Integer getType() { return this.type; } public void setType(Integer type) { this.type = type; } public String getEmail() { return this.email; } public void setEmail(String email) { this.email = email; } public String getQq() { return this.qq; } public void setQq(String qq) { this.qq = qq; } public String getMsn() { return this.msn; } public void setMsn(String msn) { this.msn = msn; } public String getOfficephone() { return this.officephone; } public void setOfficephone(String officephone) { this.officephone = officephone; } public String getCellphone() { return this.cellphone; } public void setCellphone(String cellphone) { this.cellphone = cellphone; } } 

 

A). UserDAO接口的定义：

package com.brady.common.dao.hibernate.test; import java.util.List; import com.brady.common.dao.hibernate.BaseDAO; public interface UserDAO extends BaseDAO<User> { public User findByCode(String code); }

B). UserDAOImpl的定义：

package com.brady.common.dao.hibernate.test; import java.io.Serializable; import java.util.List; import java.util.Set; import com.brady.common.dao.hibernate.BaseDAOImpl; public class UserDAOImpl extends BaseDAOImpl<User> implements UserDAO { @Override public User findByCode(String code) { return this.findUniqueResultByProperty(User.class, "code", code); } }

5. UserDAO及UserDAOImpl的测试代码 UserMaanger：

package com.brady.common.dao.hibernate.test; import java.util.List; public class UserManager { private UserDAO userDao; public User findById(Integer id) { return userDao.findById(User.class, id); } public User findByCode(String code) { return userDao.findByCode(code); } public boolean isValidUser(String code, String password) { User u = this.findByCode(code); return u != null && u.getPassword().equals(password); } public UserDAO getUserDao() { return userDao; } public void setUserDao(UserDAO userDao) { this.userDao = userDao; } public User merge(User user) { return this.userDao.merge(user); } public void delete(User user) { this.userDao.delete(user); } public List<User> findAll() { return userDao.findAll(User.class); } public List<User> findAllManager() { return this.userDao.findByProperty(User.class, "type", 1); } public List<User> findAllQA() { return this.userDao.findByProperty(User.class, "type", 2); } public List<User> findAllDev() { return this.userDao.findByProperty(User.class, "type", 3); } }  

以上代码，简单演示了如何利用继承及泛型的机制来定义通用的DAO以提高开发效率的方法，如有其他问题，请直接与我联系。

QQ: 15945144

Email: brady.zh@gmail.com