Spring Boot 2.x基礎教程：使用Spring Data JPA訪問MySQL
在資料訪問這章的第一篇文章《Spring中使用JdbcTemplate訪問資料庫》 中，我們已經介紹瞭如何使用Spring Boot中最基本的jdbc模組來實現關係型資料庫的資料讀寫操作。那麼結合Web開發一章的內容，我們就可以利用JDBC模組與Web模組的功能，綜合著使用來完成一個適用於很多簡單應用場景的後端應用了。
然而當我們有一定的開發經驗之後，不難發現，在實際開發過程中，對資料庫的操作大多可以歸結為：“增刪改查”。就最為普遍的單表操作而言，除了表和欄位不同外，語句幾乎都是類似的，開發人員需要寫大量類似而枯燥的語句來完成業務邏輯。
為了解決這些大量枯燥的資料操作語句，誕生了非常多的優秀框架，比如：Hibernate。通過整合Hibernate，我們能夠以操作Java實體的方式來完成對資料的操作，通過框架的幫助，對Java實體的變更最終將自動地對映到資料庫表中。
在Hibernate的幫助下，Java實體對映到資料庫表資料完成之後，再進一步解決抽象各個Java實體基本的“增刪改查”操作，我們通常會以泛型的方式封裝一個模板Dao來進行抽象簡化，但是這樣依然不是很方便，我們需要針對每個實體編寫一個繼承自泛型模板Dao的介面，再編寫該介面的實現。雖然一些基礎的資料訪問已經可以得到很好的複用，但是在程式碼結構上針對每個實體都會有一堆Dao的介面和實現。
由於模板Dao的實現，使得這些具體實體的Dao層已經變的非常“薄”，有一些具體實體的Dao實現可能完全就是對模板Dao的簡單代理，並且往往這樣的實現類可能會出現在很多實體上。Spring Data JPA的出現正可以讓這樣一個已經很“薄”的資料訪問層變成只是一層介面的編寫方式。比如，下面的例子：
public interface UserRepository extends JpaRepository<User, Long> {
User findByName(String name);
@Query("from User u where u.name=:name")
User findUser(@Param("name") String name);
}我們只需要通過編寫一個繼承自JpaRepository的介面就能完成資料訪問，下面以一個具體例項來體驗Spring Data JPA給我們帶來的強大功能。
使用步驟
由於Spring Data JPA依賴於Hibernate。如果您對Hibernate有一定了解，下面內容可以毫不費力的看懂並上手使用它。如果您還是Hibernate新手，您可以先按如下方式入門，再建議回頭學習一下Hibernate以幫助這部分的理解和進一步使用。
工程配置
在pom.xml中新增相關依賴，加入以下內容：
<dependency
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>在application.xml中配置：資料庫連線資訊（如使用嵌入式資料庫則不需要）、自動建立表結構的設定，例如使用mysql的情況如下：
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.properties.hibernate.hbm2ddl.auto=create-dropspring.jpa.properties.hibernate.hbm2ddl.auto是hibernate的配置屬性，其主要作用是：自動建立、更新、驗證資料庫表結構。該引數的幾種配置如下：
create：每次載入hibernate時都會刪除上一次的生成的表，然後根據你的model類再重新來生成新表，哪怕兩次沒有任何改變也要這樣執行，這就是導致資料庫表資料丟失的一個重要原因。create-drop：每次載入hibernate時根據model類生成表，但是sessionFactory一關閉,表就自動刪除。update：最常用的屬性，第一次載入hibernate時根據model類會自動建立起表的結構（前提是先建立好資料庫），以後載入hibernate時根據model類自動更新表結構，即使表結構改變了但表中的行仍然存在不會刪除以前的行。要注意的是當部署到伺服器後，表結構是不會被馬上建立起來的，是要等應用第一次執行起來後才會。validate：每次載入hibernate時，驗證建立資料庫表結構，只會和資料庫中的表進行比較，不會建立新表，但是會插入新值。
至此已經完成基礎配置，如果您有在Spring下整合使用過它的話，相信你已經感受到Spring Boot的便利之處：JPA的傳統配置在persistence.xml檔案中，但是這裡我們不需要。當然，最好在構建專案時候按照之前提過的最佳實踐的工程結構來組織，這樣以確保各種配置都能被框架掃描到。
建立實體
建立一個User實體，包含id（主鍵）、name（姓名）、age（年齡）屬性，通過ORM框架其會被對映到資料庫表中，由於配置了hibernate.hbm2ddl.auto，在應用啟動的時候框架會自動去資料庫中建立對應的表。
@Entity
@Data
@NoArgsConstructor
public class User {
@Id
@GeneratedValue
private Long id;
private String name;
private Integer age;
public User(String name, Integer age) {
this.name = name;
this.age = age;
}
}@Entity註解標識了User類是一個持久化的實體@Data和@NoArgsConstructor是Lombok中的註解。用來自動生成各引數的Set、Get函式以及不帶引數的建構函式。如果您對Lombok還不瞭解，可以看看這篇文章：Java開發神器Lombok的使用與原理@Id和@GeneratedValue用來標識User對應對應資料庫表中的主鍵
注意：除了這些註解之外，還有很多用來精細化配置對映關係的註解，這裡不做具體介紹。後續會出專門一篇來介紹常用註解。讀者也可以自行閱讀Hibernate的文件來學習這些註解的詳細使用方法。
建立資料訪問介面
下面針對User實體建立對應的Repository介面實現對該實體的資料訪問，如下程式碼：
public interface UserRepository extends JpaRepository<User, Long> {
User findByName(String name);
User findByNameAndAge(String name, Integer age);
@Query("from User u where u.name=:name")
User findUser(@Param("name") String name);
}在Spring Data JPA中，只需要編寫類似上面這樣的介面就可實現資料訪問。不再像我們以往編寫了介面時候還需要自己編寫介面實現類，直接減少了我們的檔案清單。
下面對上面的UserRepository做一些解釋，該介面繼承自JpaRepository，通過檢視JpaRepository介面的API文件，可以看到該介面本身已經實現了建立（save）、更新（save）、刪除（delete）、查詢（findAll、findOne）等基本操作的函式，因此對於這些基礎操作的資料訪問就不需要開發者再自己定義。
在我們實際開發中，JpaRepository介面定義的介面往往還不夠或者效能不夠優化，我們需要進一步實現更復雜一些的查詢或操作。由於本文重點在Spring Boot中整合spring-data-jpa，在這裡先拋磚引玉簡單介紹一下spring-data-jpa中讓我們興奮的功能，後續再單獨開篇講一下spring-data-jpa中的常見使用。
在上例中，我們可以看到下面兩個函式：
User findByName(String name)User findByNameAndAge(String name, Integer age)
它們分別實現了按name查詢User實體和按name和age查詢User實體，可以看到我們這裡沒有任何類SQL語句就完成了兩個條件查詢方法。這就是Spring-data-jpa的一大特性：通過解析方法名建立查詢。
除了通過解析方法名來建立查詢外，它也提供通過使用@Query 註解來建立查詢，您只需要編寫JPQL語句，並通過類似“:name”來對映@Param指定的引數，就像例子中的第三個findUser函式一樣。
Spring Data JPA的能力遠不止本文提到的這些，由於本文主要以整合介紹為主，對於Spring Data JPA的使用只是介紹了常見的使用方式。諸如@Modifying操作、分頁排序、原生SQL支援以及與Spring MVC的結合使用等等內容就不在本文中詳細展開，這裡先挖個坑，後續再補文章填坑，如您對這些感興趣可以關注我部落格或簡書，同樣歡迎大家留言交流想法。
單元測試
在完成了上面的資料訪問介面之後，按照慣例就是編寫對應的單元測試來驗證編寫的內容是否正確。這裡就不多做介紹，主要通過資料操作和查詢來反覆驗證操作的正確性。
@RunWith(SpringRunner.class)
@SpringBootTest
public class ApplicationTests {
@Autowired
private UserRepository userRepository;
@Test
public void test() throws Exception {
// 建立10條記錄
userRepository.save(new User("AAA", 10));
userRepository.save(new User("BBB", 20));
userRepository.save(new User("CCC", 30));
userRepository.save(new User("DDD", 40));
userRepository.save(new User("EEE", 50));
userRepository.save(new User("FFF", 60));
userRepository.save(new User("GGG", 70));
userRepository.save(new User("HHH", 80));
userRepository.save(new User("III", 90));
userRepository.save(new User("JJJ", 100));
// 測試findAll, 查詢所有記錄
Assert.assertEquals(10, userRepository.findAll().size());
// 測試findByName, 查詢姓名為FFF的User
Assert.assertEquals(60, userRepository.findByName("FFF").getAge().longValue());
// 測試findUser, 查詢姓名為FFF的User
Assert.assertEquals(60, userRepository.findUser("FFF").getAge().longValue());
// 測試findByNameAndAge, 查詢姓名為FFF並且年齡為60的User
Assert.assertEquals("FFF", userRepository.findByNameAndAge("FFF", 60).getName());
// 測試刪除姓名為AAA的User
userRepository.delete(userRepository.findByName("AAA"));
// 測試findAll, 查詢所有記錄, 驗證上面的刪除是否成功
Assert.assertEquals(9, userRepository.findAll().size());
}
}拓展閱讀：關於Spring Data
Spring Data JPA在Spring家族中實際上是一個二級專案，它隸屬於Spring Data這個頂級專案。讀者可以看一下關於這個專案的介紹，它除了涵蓋對關係型資料庫的抽象之外，其實還有很多對其他資料儲存中介軟體的實現，比如我們常用的Redis、MongoDB、Elasticsearch等。
如果再找幾個專案看一下它們的簡單示例，你會發現：不論你是要訪問什麼資料儲存產品，它們的編碼方式幾乎都是一樣的！這就是Spring Data這個專案充滿魅力的地方！通過對資料訪問操作的抽象來遮蔽細節，用不同子專案的方式去實現細節。讓開發者只需要學會使用Spring Data，就能方便快捷的學會對各種資料儲存的操作。所以，對於Spring Data，我是強烈推薦Java開發者們可以學、甚至讀一下原始碼的重要框架。雖然，目前來說很多大型網際網路公司並不會選擇它（效能考量居多，能真正用好它的人不多）作為主要的開發框架，但是其背後的抽象思想是非常值得我們學習的。並且，在做一些非高併發專案的時候，這簡直就是一個快捷開發神器，它可以幫助我們少寫非常多的程式碼！
更多本系列免費教程連載「點選進入彙總目錄」
程式碼示例
本文的相關例子可以檢視下面倉庫中的chapter3-4目錄：
- Github：https://github.com/dyc87112/SpringBoot-Learning/
- Gitee：https://gitee.com/didispace/SpringBoot-Learning/
如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！
歡迎關注我的公眾號：程式猿DD，獲得獨家整理的學習資源和日常乾貨推送。
如果您對我的專題內容感興趣，也可以關注我的部落格：didispace.com