摘要：此的功能是從應(yīng)用程序中隱藏在底層存儲(chǔ)機(jī)制中執(zhí)行操作所涉及的所有復(fù)雜性。這正是模式試圖解決的問題。將模式與一起使用開發(fā)人員普遍認(rèn)為的發(fā)布將模式的功能降級(jí)為零，因?yàn)樵撃Ｊ街皇菍?shí)體經(jīng)理提供的另一層抽象和復(fù)雜性。在這種情況下，模式有其自己的位置。

案例概述

數(shù)據(jù)訪問對(duì)象（DAO）模式是一種結(jié)構(gòu)模式，它允許我們使用抽象API將應(yīng)用程序/業(yè)務(wù)層與持久層（通常是關(guān)系數(shù)據(jù)庫(kù)，但它可以是任何其他持久性機(jī)制）隔離開來。
此API的功能是從應(yīng)用程序中隱藏在底層存儲(chǔ)機(jī)制中執(zhí)行CRUD操作所涉及的所有復(fù)雜性。這允許兩個(gè)層分別進(jìn)化而不知道彼此之間的任何事情。
在本文中，我們將深入研究模式的實(shí)現(xiàn)，并且我們將學(xué)習(xí)如何使用它來抽象調(diào)用JPA實(shí)體管理器。

簡(jiǎn)單實(shí)施

要了解DAO模式的工作原理，讓我們創(chuàng)建一個(gè)基本示例。
假設(shè)我們想要開發(fā)一個(gè)管理用戶的應(yīng)用程序。為了使應(yīng)用程序的域模型完全不受數(shù)據(jù)庫(kù)的影響，我們將創(chuàng)建一個(gè)簡(jiǎn)單的DAO類，它將保持這些組件彼此完美地分離。

由于我們的應(yīng)用程序?qū)⑴c用戶一起工作，我們需要定義一個(gè)類來實(shí)現(xiàn)其模型：

public class User {
?????
????private String name;
????private String email;
?????
????// constructors / standard setters / getters
}

User類只是用戶數(shù)據(jù)的普通容器，因此它不實(shí)現(xiàn)任何其他值得強(qiáng)調(diào)的行為。

當(dāng)然，我們?cè)谶@里需要做的最相關(guān)的設(shè)計(jì)選擇是如何使使用這個(gè)類的應(yīng)用程序與任何可以在某個(gè)時(shí)候?qū)崿F(xiàn)的持久性機(jī)制隔離開來。

這正是DAO模式試圖解決的問題。

DAO API

讓我們定義一個(gè)基本的DAO層，這樣我們就可以看到它如何使域模型與持久層完全分離。

這是DAO API：

public interface Dao {
?????
????Optional get(long id);
?????
????List getAll();
?????
????void save(T t);
?????
????void update(T t, String[] params);
?????
????void delete(T t);
}

從鳥瞰的角度來看，很明顯Dao接口定義了一個(gè)抽象API，它對(duì)類型為T的對(duì)象執(zhí)行CRUD操作。

由于接口提供的抽象級(jí)別很高，因此很容易創(chuàng)建與用戶對(duì)象一起工作的具體的、細(xì)粒度的實(shí)現(xiàn)。

UserDao類

讓我們定義Dao接口的特定于用戶的實(shí)現(xiàn):

public class UserDao implements Dao {
?????
????private List users = new ArrayList<>();
?????
????public UserDao() {
????????users.add(new User("John", "john@domain.com"));
????????users.add(new User("Susan", "susan@domain.com"));
????}
?????
????@Override
????public Optional get(long id) {
????????return Optional.ofNullable(users.get((int) id));
????}
?????
????@Override
????public List getAll() {
????????return users;
????}
?????
????@Override
????public void save(User user) {
????????users.add(user);
????}
?????
????@Override
????public void update(User user, String[] params) {
????????user.setName(Objects.requireNonNull(
??????????params[0], "Name cannot be null"));
????????user.setEmail(Objects.requireNonNull(
??????????params[1], "Email cannot be null"));
?????????
????????users.add(user);
????}
?????
????@Override
????public void delete(User user) {
????????users.remove(user);
????}
}

所述的UserDAO類實(shí)現(xiàn)所有用于獲取，更新和刪除所需要的功能的用戶的對(duì)象。

為簡(jiǎn)單起見,User List的作用類似于內(nèi)存數(shù)據(jù)庫(kù)，在構(gòu)造函數(shù)中填充了幾個(gè)User對(duì)象。

當(dāng)然，重構(gòu)其他方法很容易，因此它們可以用于關(guān)系數(shù)據(jù)庫(kù)。

雖然User和UserDao類在同一個(gè)應(yīng)用程序中獨(dú)立共存，但我們?nèi)匀恍枰纯春笳呷绾斡糜诒３殖志脤訉?duì)應(yīng)用程序邏輯的隱藏：

public class UserApplication {
?
????private static Dao userDao;
?
????public static void main(String[] args) {
????????userDao = new UserDao();
?????????
????????User user1 = getUser(0);
????????System.out.println(user1);
????????userDao.update(user1, new String[]{"Jake", "jake@domain.com"});
?????????
????????User user2 = getUser(1);
????????userDao.delete(user2);
????????userDao.save(new User("Julie", "julie@domain.com"));
?????????
????????userDao.getAll().forEach(user -> System.out.println(user.getName()));
????}
?
????private static User getUser(long id) {
????????Optional user = userDao.get(id);
?????????
????????return user.orElseGet(
??????????() -> new User("non-existing user", "no-email"));
????}
}

這個(gè)例子是人為的，但簡(jiǎn)而言之，它顯示了DAO模式背后的動(dòng)機(jī)。在這種情況下，main方法只使用UserDao實(shí)例對(duì)幾個(gè)User對(duì)象執(zhí)行CRUD操作。

此過程最相關(guān)的方面是UserDao如何從應(yīng)用程序中隱藏有關(guān)如何持久，更新和刪除對(duì)象的所有低級(jí)詳細(xì)信息。

將模式與JPA一起使用

開發(fā)人員普遍認(rèn)為JPA的發(fā)布將DAO模式的功能降級(jí)為零，因?yàn)樵撃Ｊ街皇荍PA實(shí)體經(jīng)理提供的另一層抽象和復(fù)雜性。

毫無(wú)疑問，在某些情況下這是事實(shí)。即便如此，有時(shí)我們只想向我們的應(yīng)用程序公開實(shí)體管理器API的一些特定于域的方法。在這種情況下，DAO模式有其自己的位置。

JpaUserDao類

話雖如此，讓我們創(chuàng)建一個(gè)Dao接口的新實(shí)現(xiàn)，這樣我們就可以看到它如何封裝JPA實(shí)體管理器提供的開箱即用功能：

public class JpaUserDao implements Dao {
?????
????private EntityManager entityManager;
?????
????// standard constructors
?????
????@Override
????public Optional get(long id) {
????????return Optional.ofNullable(entityManager.find(User.class, id));
????}
?????
????@Override
????public List getAll() {
????????Query query = entityManager.createQuery("SELECT e FROM User e");
????????return query.getResultList();
????}
?????
????@Override
????public void save(User user) {
????????executeInsideTransaction(entityManager -> entityManager.persist(user));
????}
?????
????@Override
????public void update(User user, String[] params) {
????????user.setName(Objects.requireNonNull(params[0], "Name cannot be null"));
????????user.setEmail(Objects.requireNonNull(params[1], "Email cannot be null"));
????????executeInsideTransaction(entityManager -> entityManager.merge(user));
????}
?????
????@Override
????public void delete(User user) {
????????executeInsideTransaction(entityManager -> entityManager.remove(user));
????}
?????
????private void executeInsideTransaction(Consumer action) {
????????EntityTransaction tx = entityManager.getTransaction();
????????try {
????????????tx.begin();
????????????action.accept(entityManager);
????????????tx.commit(); 
????????}
????????catch (RuntimeException e) {
????????????tx.rollback();
????????????throw e;
????????}
????}
}

該JpaUserDao類是能夠與由JPA實(shí)現(xiàn)所支持的任何關(guān)系數(shù)據(jù)庫(kù)的工作。

此外，如果我們仔細(xì)研究這個(gè)類，我們將會(huì)意識(shí)到使用Composition和Dependency Injection如何允許我們只調(diào)用應(yīng)用程序所需的實(shí)體管理器方法。

簡(jiǎn)而言之，我們有一個(gè)特定于域的定制API，而不是整個(gè)實(shí)體管理器的API。

重構(gòu)User類

在這種情況下，我們將使用Hibernate作為JPA默認(rèn)實(shí)現(xiàn)，因此我們將相應(yīng)地重構(gòu)User類：

@Entity
@Table(name = "users")
public class User {
?????
????@Id
????@GeneratedValue(strategy = GenerationType.AUTO)
????private long id;
?????
????private String name;
????private String email;
?????
????// standard constructors / setters / getters
}

以編程方式引導(dǎo)JPA實(shí)體管理器

假設(shè)我們已經(jīng)在本地或遠(yuǎn)程運(yùn)行MySQL的工作實(shí)例，并且數(shù)據(jù)庫(kù)表“users”填充了一些用戶記錄，我們需要獲得一個(gè)JPA實(shí)體管理器，因此我們可以使用JpaUserDao類來執(zhí)行CRUD操作數(shù)據(jù)庫(kù)。

在大多數(shù)情況下，我們通過典型的“persistence.xml”文件來實(shí)現(xiàn)這一點(diǎn)，這是標(biāo)準(zhǔn)方法。

在這種情況下，我們將采用“xml-less”方法，通過Hibernate方便的EntityManagerFactoryBuilderImpl類獲取具有普通Java的實(shí)體管理器。

有關(guān)如何使用Java引導(dǎo)JPA實(shí)現(xiàn)的詳細(xì)說明，請(qǐng)查看用Java編程引導(dǎo)JPA。

UserApplication類

最后，讓我們重構(gòu)一下初始的UserApplication類，這樣它就可以使用JpaUserDao實(shí)例并在User實(shí)體上執(zhí)行CRUD操作：

public class UserApplication {
?
????private static Dao jpaUserDao;
?
????// standard constructors
?????
????public static void main(String[] args) {
????????User user1 = getUser(1);
????????System.out.println(user1);
????????updateUser(user1, new String[]{"Jake", "jake@domain.com"});
????????saveUser(new User("Monica", "monica@domain.com"));
????????deleteUser(getUser(2));
????????getAllUsers().forEach(user -> System.out.println(user.getName()));
????}
?????
????public static User getUser(long id) {
????????Optional user = jpaUserDao.get(id);
?????????
????????return user.orElseGet(
??????????() -> new User("non-existing user", "no-email"));
????}
?????
????public static List getAllUsers() {
????????return jpaUserDao.getAll();
????}
?????
????public static void updateUser(User user, String[] params) {
????????jpaUserDao.update(user, params);
????}
?????
????public static void saveUser(User user) {
????????jpaUserDao.save(user);
????}
?????
????public static void deleteUser(User user) {
????????jpaUserDao.delete(user);
????}
}

即使示例確實(shí)非常有限，它仍然有助于演示如何將DAO模式的功能與實(shí)體管理器提供的功能集成。

在大多數(shù)應(yīng)用程序中，有一個(gè)DI框架，它負(fù)責(zé)將JpaUserDao實(shí)例注入U(xiǎn)serApplication類。為簡(jiǎn)單起見，我們省略了此過程的詳細(xì)信息。

最相關(guān)的點(diǎn)這里要強(qiáng)調(diào)的是如何在JpaUserDao類有助于保持UserApplication類完全無(wú)關(guān)關(guān)于持久層如何執(zhí)行CRUD操作。

此外，由于Dao接口和實(shí)體管理器提供的抽象級(jí)別，我們可以將MySQL交換到任何其他RDBMS（甚至是平面數(shù)據(jù)庫(kù)），而且，我們的應(yīng)用程序仍將按預(yù)期繼續(xù)工作。

案例結(jié)論

在本文中，我們深入研究了DAO模式的關(guān)鍵概念，如何在Java中實(shí)現(xiàn)它，以及如何在JPA的實(shí)體管理器之上使用它。