web-dev-qa-db-ja.com

Hibernate：CRUD Generic DAO

私のWebアプリケーションには、payment_methods、tax_codes、province_codesなど、多くのサービステーブル/エンティティがあります。

新しいエンティティを追加するたびに、DAOを作成する必要があります。基本的に、これらはすべて同じですが、唯一の違いはエンティティクラス自体です。

Hibernateツールが自動的にコードを生成できることは知っていますが、今は使用できません（理由を聞かないでください）。したがって、Generic DAOを考えています。それについては多くの文献がありますが、私は作品をまとめてSpringで動作させることはできません。

それはすべてジェネリックに関するもので、4つの基本的な方法があります：

  • listAll
  • saveOrUpdate
  • deleteById
  • getById

それだけです。

質問：

車輪を再発明しないためのベストプラクティスは何ですか？まだ使用できるものはありませんか？

javaspringhibernategenericsdao
36
Fabio B.

これは私の

@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);
    }
42
NimChimpsky

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（Namelike）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 > ...

そして、ページングが適用されます。

唯一の欠点は、プロジェクトがかなり新しく、ヒットするのが比較的簡単なことです（ただし、非常に積極的に開発されています）。

25
Tomasz Nurkiewicz

他のドメイン固有のDAOクラスのレバレッジとして汎用DAOを使用できます。次のような従業員ドメインクラスがあるとします。

  @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クラスは、一般的に一般的ではない操作のために別のインターフェイスを実装することもあります。そして、コンストラクタを使用して型情報を送信することを好みます。

4
Shahid Yousuf

各エンティティに特定のdaoを書き込まないでください。必要なすべてのエンティティに対して90％の作業を行う1つの汎用DAOを実装できます。特定のエンティティの特定の処理が必要な場合に拡張できます。

現在取り組んでいるプロジェクトでは、HibernateセッションをラップするDAOを使用して、説明した方法と同様の方法を提供しています。さらに、GoogleコードでホストされているオープンソースプロジェクトであるISearch APIを使用しており、HibernateとJPAのインターフェースを構築する非常に便利な基準を提供しています。

4
AlexR

baseDAOインターフェイスとbaseDAO実装クラスを作成できます。そして、異なるクラスタイプで特定のユースケースが必要な場合、baseDAOクラスを継承するクラスのDAOを作成し、このクラスの特定のニーズで追加のインターフェイスを実装することができます。

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();
    }

}
1
Mandar Kawtakwar