使用Spring和Java泛型简化DAO

public abstract class AbstractHibernateDao<T extends Serializable> {
    private Class<T> clazz;

    @Autowired
    protected SessionFactory sessionFactory;

    public void setClazz(final Class<T> clazzToSet) {
        clazz = Preconditions.checkNotNull(clazzToSet);
    }

    public T findOne(final long id) {
        return (T) getCurrentSession().get(clazz, id);
    }

    public List<T> findAll() {
        return getCurrentSession().createQuery("from " + clazz.getName()).list();
    }

    public T create(final T entity) {
        Preconditions.checkNotNull(entity);
        getCurrentSession().saveOrUpdate(entity);
        return entity;
    }

    public T update(final T entity) {
        Preconditions.checkNotNull(entity);
        return (T) getCurrentSession().merge(entity);
    }

    public void delete(final T entity) {
        Preconditions.checkNotNull(entity);
        getCurrentSession().delete(entity);
    }

    public void deleteById(final long entityId) {
        final T entity = findOne(entityId);
        Preconditions.checkState(entity != null);
        delete(entity);
    }

    protected Session getCurrentSession() {
        return sessionFactory.getCurrentSession();
    }
}

这是一个具有多种数据访问方法的抽象类，它使用SessionFactory来操作实体。

我们在这里使用 Google Guava 的先决条件来确保使用有效的参数值调用方法或构造函数。如果先决条件失败，则会抛出定制的异常。

2.2. 通用 Hibernate DAO

现在我们有了抽象 DAO 类，我们可以只扩展它一次。通用 DAO 实现将成为我们唯一需要的实现：

@Repository
@Scope(BeanDefinition.SCOPE_PROTOTYPE)
public class GenericHibernateDao<T extends Serializable>
  extends AbstractHibernateDao<T> implements IGenericDao<T>{
   //
}

首先，请注意通用实现本身是参数化的，允许客户根据具体情况选择正确的参数。这将意味着客户无需为每个实体创建多个工件即可获得类型安全的所有好处。

其次，注意这个通用 DAO 实现的原型范围。使用此作用域意味着 Spring 容器将在每次请求时创建一个新的 DAO 实例(包括自动装配)。这将允许服务根据需要为不同的实体使用具有不同参数的多个 DAO。

这个作用域之所以如此重要，是因为 Spring 在容器中初始化 beans 的方式。让通用 DAO 没有范围意味着使用默认的单例范围，这将导致 DAO 的单个实例存在于容器中。对于任何一种更复杂的场景，这显然都是主要的限制。

IGenericDao只是所有 DAO 方法的一个接口，因此我们可以注入我们需要的实现：

public interface IGenericDao<T extends Serializable> {
    void setClazz(Class< T > clazzToSet);

    T findOne(final long id);

    List<T> findAll();

    T create(final T entity);

    T update(final T entity);

    void delete(final T entity);

    void deleteById(final long entityId);
}

2.3. 抽象 JPA DAO

AbstractJpaDao与AbstractHibernateDao非常相似：

public abstract class AbstractJpaDAO<T extends Serializable> {
    private Class<T> clazz;

    @PersistenceContext(unitName = "entityManagerFactory")
    private EntityManager entityManager;

    public final void setClazz(final Class<T> clazzToSet) {
        this.clazz = clazzToSet;
    }

    public T findOne(final long id) {
        return entityManager.find(clazz, id);
    }

    @SuppressWarnings("unchecked")
    public List<T> findAll() {
        return entityManager.createQuery("from " + clazz.getName()).getResultList();
    }

    public T create(final T entity) {
        entityManager.persist(entity);
        return entity;
    }

    public T update(final T entity) {
        return entityManager.merge(entity);
    }

    public void delete(final T entity) {
        entityManager.remove(entity);
    }

    public void deleteById(final long entityId) {
        final T entity = findOne(entityId);
        delete(entity);
    }
}

与 Hibernate DAO 实现类似，我们直接使用JavaPersistence API，而不依赖于现已弃用的 Spring JpaTemplate。

2.4. 通用 JPA DAO

与 Hibernate 实现类似，JPA 数据访问对象也很简单：

@Repository
@Scope( BeanDefinition.SCOPE_PROTOTYPE )
public class GenericJpaDao< T extends Serializable >
 extends AbstractJpaDao< T > implements IGenericDao< T >{
   //
}

3.注入这个DAO

我们现在有一个可以注入的 DAO 接口。我们还需要指定类：

@Service
class FooService implements IFooService{

   IGenericDao<Foo> dao;

   @Autowired
   public void setDao(IGenericDao<Foo> daoToSet) {
      dao = daoToSet;
      dao.setClazz(Foo.class);
   }

   // ...
}

Spring使用 setter 注入自动装配新的 DAO 实例，以便可以使用Class对象自定义实现。在此之后，DAO 已完全参数化并准备好供服务使用。

当然还有其他方法可以为 DAO 指定类——通过反射，甚至在 XML 中。我更喜欢这种更简单的解决方案，因为与使用反射相比，它提高了可读性和透明度。

4. 总结

本文讨论了通过提供通用 DAO 的单一、可重用实现来简化数据访问层。我们展示了在基于 Hibernate 和 JPA 的环境中的实现。结果是一个流线型的持久层，没有不必要的混乱。

有关使用基于Java的配置和项目的基本 Maven pom 设置 Spring 上下文的逐步介绍，请参阅本文。

与往常一样，本教程的完整源代码可在GitHub上获得。

Show Disqus Comments

使用Spring和Java泛型简化DAO

1. 概述

延伸阅读：

Spring Data JPA 简介

使用 Spring 的 JPA 指南

使用 JPA、Hibernate 和 Spring Data JPA 进行审计

2. Hibernate 和 JPA DAO

2.1. 抽象 Hibernate DAO

2.2. 通用 Hibernate DAO

2.3. 抽象 JPA DAO

2.4. 通用 JPA DAO

3.注入这个DAO

4. 总结

Post Directory