在數據訪問這章的第一篇文章《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-drop
spring.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