休眠：CRUD 通用 DAO

Question

我的 Web 应用程序有很多服务表/实体，例如 payment_methods、tax_codes、province_codes 等。

每次我添加一个新实体时，我都必须编写一个 DAO。问题是，基本上，它们都是一样的，但唯一的区别是实体类本身。

我知道 Hibernate 工具可以自动为我生成代码，但我现在不能使用它们（不要问为什么），所以我正在考虑一个 通用 DAO。有很多关于这方面的文献，但我无法将其拼凑在一起并使其与 Spring 一起使用。

我认为这都是关于泛型的，它将有四种基本方法：

• listAll
• saveOrUpdate
• deleteById
• getById

仅此而已。

---

问题：

不重新发明轮子的最佳实践是什么？还没有准备好使用的东西吗？

Answer 1

这是我的

@Component
public class Dao{

    @Resource(name = "sessionFactory")
    private SessionFactory sessionFactory;

    public <T> T save(final T o){
      return (T) sessionFactory.getCurrentSession().save(o);
    }


    public void delete(final Object object){
      sessionFactory.getCurrentSession().delete(object);
    }

    /***/
    public <T> T get(final Class<T> type, final Long id){
      return (T) sessionFactory.getCurrentSession().get(type, id);
    }

    /***/
    public <T> T merge(final T o)   {
      return (T) sessionFactory.getCurrentSession().merge(o);
    }

    /***/
    public <T> void saveOrUpdate(final T o){
      sessionFactory.getCurrentSession().saveOrUpdate(o);
    }

    public <T> List<T> getAll(final Class<T> type) {
      final Session session = sessionFactory.getCurrentSession();
      final Criteria crit = session.createCriteria(type);
  return crit.list();
    }
// and so on, you shoudl get the idea

然后你就可以在服务层这样访问了：

 @Autowired
    private Dao dao;

   @Transactional(readOnly = true)
    public List<MyEntity> getAll() {
      return dao.getAll(MyEntity.class);
    }

Answer 2

Spring Data JPA 是一个很棒的项目，它可以为你生成 DAO 等等！您只需创建一个接口（无需任何实现）：

interface PaymentMethodsDao extends JpaRepository<PaymentMethods, Integer> {}

这个接口（通过继承JpaRepository）会自动给你：

PaymentMethod save(PaymentMethod entity);
Iterable<PaymentMethod> save(Iterable<? extends PaymentMethod> entities);
PaymentMethod findOne(Integer id);
boolean exists(Integer id);
Iterable<PaymentMethod> findAll();
long count();
void delete(Integer id);
void delete(PaymentMethod entity);
void delete(Iterable<? extends PaymentMethod> entities);
void deleteAll();
Iterable<PaymentMethod> findAll(Sort sort);
Page<PaymentMethod> findAll(Pageable pageable);
List<PaymentMethod> findAll();
List<PaymentMethod> findAll(Sort sort);
List<PaymentMethod> save(Iterable<? extends PaymentMethods> entities);
void flush();
PaymentMethod saveAndFlush(PaymentMethods entity);
void deleteInBatch(Iterable<PaymentMethods> entities);

接口是强类型（泛型）并自动为您实现。对于每个实体，您所要做的就是创建一个扩展 JpaRepository<T,Integer extends Serializable> 的接口。

但是等等，还有更多！假设您的 PaymentMethod 具有 name 和 validSince 持久字段。如果你在你的界面中添加以下方法：

interface PaymentMethodsDao extends JpaRepository<PaymentMethods, Integer> {

  Page<PaymentMethod> findByNameLikeAndValidSinceGreaterThan(
    String name, Date validSince, Pageable page
  );

}

框架会解析方法名：

findBy（名字喜欢）And（ValidSince大于）

创建 JPA QL 查询，应用分页和排序 (Pageable page) 并为您运行它。无需实现：

paymentMethodsDao.findByNameLikeAndValidSinceGreaterThan(
  "abc%",
  new Date(),
  new PageRequest(0, 20, Sort.Direction.DESC, "name"
);

查询结果：

SELECT *  //or COUNT, framework also returns the total number of records
FROM PaymentMethods
WHERE name LIKE "abc%"
  AND validSince > ...

并且应用了分页。

唯一的缺点是这个项目比较新，而且比较容易上手（但它的开发非常活跃）。

Answer 3

不要为每个实体编写特定的 dao。您可以实现一个通用 DAO，为您需要的所有实体完成 90% 的工作。如果您希望对某些实体进行特定处理，可以对其进行扩展。

在我目前正在从事的项目中，我们有这样的 DAO，它包装了 Hibernate 会话，提供了与您描述的方法类似的方法。此外，我们正在使用 ISearch API - 托管在 google 代码上的开源项目，并为 Hibernate 和 JPA 提供非常方便的标准构建接口。

Answer 4

您可以使用通用 DAO 作为其他特定于域的 DAO 类的杠杆。假设您有一个 Employee Domain 类：

  @Entity
  @Table(name="employee")
  public class Employee {

    @Id
    @Column(name="id")
    @GeneratedValue(strategy=GenerationType.AUTO)
    private Long id;

    @Column(name="emp_name")
    private String empName;

    @Column(name="emp_designation")
    private String empDesignation;

    @Column(name="emp_salary")
    private Float empSalary;

    public Long getId() {
        return id;
    }

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

    public String getEmpName() {
        return empName;
    }

    public void setEmpName(String empName) {
        this.empName = empName;
    }

    public String getEmpDesignation() {
        return empDesignation;
    }

    public void setEmpDesignation(String empDesignation) {
        this.empDesignation = empDesignation;
    }

    public Float getEmpSalary() {
        return empSalary;
    }

    public void setEmpSalary(Float empSalary) {
        this.empSalary = empSalary;
    }


}

那么所需的通用 DAO 将如下所示：

通用 DAO 接口：

 public interface GenericRepositoryInterface<T> {

    public T save(T emp);
    public Boolean delete(T emp);
    public T edit(T emp);
    public T find(Long empId);
}

通用 DAO 实现：

@Repository
public class GenericRepositoryImplementation<T> implements GenericRepositoryInterface<T> {

protected EntityManager entityManager;
private Class<T> type;

public GenericRepositoryImplementation() {
    // TODO Auto-generated constructor stub

}

public GenericRepositoryImplementation(Class<T> type) {
    // TODO Auto-generated constructor stub

    this.type = type;
}

public EntityManager getEntityManager() {
    return entityManager;
}

@PersistenceContext
public void setEntityManager(EntityManager entityManager) {
    this.entityManager = entityManager;
}
@Override
public T save(T emp) {
    // TODO Auto-generated method stub
    entityManager.persist(emp);
    entityManager.flush();
    return emp;
}

@Override
public Boolean delete(T emp) {
    // TODO Auto-generated method stub
    try {
         entityManager.remove(emp);
    } catch (Exception ex) {
        return false;
    }
    return true;
}

@Override
public T edit(T emp) {
    // TODO Auto-generated method stub
    try{
       return entityManager.merge(emp);
    } catch(Exception ex) {
        return null;
    }
}

@Override
public T find(Long empId) {
    // TODO Auto-generated method stub
    return (T) entityManager.find(Employee.class, empId);
}
} 

然后，每个特定于域的 DAO 类都需要扩展这个通用 DAO 类。域特定的 DAO 类甚至可以为一般不常见的操作实现另一个接口。并且更喜欢使用构造函数发送类型信息。

Answer 5

您可以创建一个 baseDAO 接口和一个 baseDAO 实现类。 当您需要具有不同类类型的特定用例时，您可以创建该类的 DAO，它继承 baseDAO 类并根据该类的特定需求实现额外的接口，如下所示

IBaseDAO

 public interface IBaseDAO<T> {

/**
 * @Purpose :Save object of type T
 * @param transientInstance
 */
public Object persist(final T transientInstance);

/**
 * @Purpose :Delete object of type T
 * @param persistentInstance
 */
public void remove(final T persistentInstance);

/**
 * @Purpose :Update Object of type T
 * @param detachedInstance
 * @return
 */
public T merge(final T detachedInstance);

/**
 * @Purpose :Find object by 'id' of type T
 * @param identifier
 * @return
 */
public T findById(final Long identifier, Class<?> persistClass);
}

BaseDAO 类

public class BaseDAO<T> implements IBaseDAO<T> {

@Autowired
private SessionFactory sessionFactory;

public Object persist(T entity) {
    return this.getSession().save(entity);
}

@Override
public void remove(T persistentInstance) {
    this.getSession().delete(persistentInstance);
}

@SuppressWarnings("unchecked")
@Override
public T merge(T detachedInstance) {
    return (T) this.getSession().merge(detachedInstance);
}

@SuppressWarnings("unchecked")
@Override
public T findById(Long identifier, Class<?> persistClass) {
    return (T) this.getSession().get(persistClass, identifier);
}

public SessionFactory getSessionFactory() {
    return sessionFactory;
}

public Session getSession() {
    return getSessionFactory().getCurrentSession();
}

}

和具体的界面

public interface IUserDAO extends IBaseDAO<User> {

   public User getUserById(long userId);

   public User findUserByUsername(String username);

}

和这样的类

@Repository("userDAO")
public class UserDAO extends BaseDAO<User> implements IUserDAO {

public User getUserById(long userId) {
    return findById(userId, User.class);
}

@Override
    public User findUserByUsername(String username) {
        Criteria criteria = getSession().createCriteria(User.class);
        criteria.add(Restrictions.eq("username", username));
        return (User) criteria.uniqueResult();
    }

}