Шаблоны реализации JPA: объекты доступа к данным

Класс сущности

Допустим, мы хотим сохранить следующий класс Order:

@Entity@Table(name = "ORDERS")public class Order {@Id@GeneratedValueprivate int id;private String customerName;private Date date; public int getId() { return id; }public void setId(int id) { this.id = id; } public String getCustomerName() { return customerName; }public void setCustomerName(String customerName) { this.customerName = customerName; } public Date getDate() { return date; }public void setDate(Date date) { this.date = date;}}

Не беспокойтесь о деталях этого класса. Мы вернемся к специфике в других шаблонах реализации JPA. Аннотация @Table существует потому, что ORDER является зарезервированным ключевым словом в SQL.

Интерфейсы DAO

Сначала мы определяем общий интерфейс DAO с методами, которые мы хотели бы, чтобы все DAO разделяли:

public interface Dao<K, E> {      void persist(E entity);      void remove(E entity);      E findById(K id);}

Параметр первого типа, K, является типом для использования в качестве ключа, а параметр второго типа, E, является типом сущности. Помимо базовых методов persist, remove и findById, вы также можете добавить метод List findAll (). Но, как и сам класс сущности, мы вернемся к методам DAO в более поздних шаблонах реализации JPA.

Затем мы определяем один подинтерфейс для каждого типа сущности, который мы хотим сохранить, добавляя любые методы, специфичные для сущности, которые мы хотим. Например, если мы хотим иметь возможность запрашивать все заказы, которые были добавлены с определенной даты, мы можем добавить такой метод:

public interface OrderDao extends Dao<Integer, Order> {List<Order> findOrdersSubmittedSince(Date date);}

Базовая реализация DAO

Третий шаг — создание базовой реализации JPA DAO. Он будет иметь базовую реализацию всех методов в стандартном интерфейсе Dao, который мы создали на шаге 1:

public abstract class JpaDao<K, E> implements Dao<K, E> {protected Class<E> entityClass; @PersistenceContextprotected EntityManager entityManager; public JpaDao() {ParameterizedType genericSuperclass = (ParameterizedType) getClass().getGenericSuperclass();this.entityClass = (Class<E>) genericSuperclass.getActualTypeArguments()[1];} public void persist(E entity) { entityManager.persist(entity); } public void remove(E entity) { entityManager.remove(entity); } public E findById(K id) { return entityManager.find(entityClass, id); }}

Большая часть реализации довольно проста. Некоторые моменты, чтобы отметить, хотя:

• Конструктор JpaDao включает в себя метод, предложенный моим коллегой Арджаном Блокзейлом для использования отражения для получения класса сущностей.
• Аннотация @PersistenceContext приводит к тому, что контейнер EJB 3.0 или Spring внедряет менеджер сущностей.
• Поля entityManager и entityClass защищены, чтобы подклассы, то есть конкретные реализации DAO, могли получить к ним доступ.

Конкретная реализация DAO

И, наконец, мы создаем такую ​​конкретную реализацию DAO. Он расширяет базовый класс JPA DAO и реализует специальный интерфейс DAO:

public class JpaOrderDao extends JpaDao<Integer, Order> implements OrderDao {public List<Order> findOrdersSubmittedSince(Date date) {Query q = entityManager.createQuery("SELECT e FROM " + entityClass.getName() + " e WHERE date >= :date_since");q.setParameter("date_since", date);return (List<Order>) q.getResultList();}}

Использование DAO

То, как вы получите ссылку на экземпляр вашего OrderDao, зависит от того, используем ли мы EJB 3.0 или Spring. В EJB 3.0 мы использовали бы аннотацию, подобную этой:

@EJB(name="orderDao")private OrderDao orderDao;

в то время как в Spring мы можем использовать файлы XML bean-компонентов или использовать автоматическую разводку следующим образом:

@Autowiredpublic OrderDao orderDao;

В любом случае, если у нас есть ссылка на DAO, мы можем использовать ее следующим образом:

Order o = new Order();o.setCustomerName("Peter Johnson");o.setDate(new Date());orderDao.persist(o); 

Но мы также можем использовать специфический для сущности запрос, который мы добавили в интерфейс OrderDao:

List<Order> orders = orderDao.findOrdersSubmittedSince(date);for (Order each : orders) {System.out.println("order id = " + each.getId());}

С этим типобезопасным шаблоном DAO мы получаем следующие преимущества:

• Нет прямой зависимости от API JPA от клиентского кода.
• Безопасность типов за счет использования дженериков. Любые приведения, которые еще должны быть выполнены, обрабатываются в реализации DAO.
• Одно логическое место для группировки всего кода объекта JPA.
• Одно место для добавления маркеров транзакций, отладки, профилирования и т. Д. Хотя, как мы увидим позже, нам потребуется добавить маркеры транзакций и в других частях наших приложений.
• Один класс для тестирования при тестировании кода доступа к базе данных. Мы вернемся к этому вопросу в более поздней схеме реализации JPA.

Я надеюсь , что вы это убеждает , что вы делаете потребность DAO с JPA.

И это завершает первый шаблон реализации JPA. В следующем блоге этой серии мы будем использовать этот пример для обсуждения следующего паттерна. В то же время я хотел бы услышать от вас, как вы пишете свои DAO!

С http://blog.xebia.com