Spring Boot中使用Spring-data-jpa的配置方法詳解

2024-07-14 08:43:49

字體：大中小

來源：轉載

供稿：網友

為了解決這些大量枯燥的數據操作語句，我們第一個想到的是使用ORM框架，比如：hibernate。通過整合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有一定了解，下面內容可以毫不費力的看懂并上手使用Spring-data-jpa。如果您還是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=root spring.datasource.driver-class-name=com.mysql.jdbc.Driverspring.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，在應用啟動的時候框架會自動去數據庫中創建對應的表。

@Entitypublic class User {  @Id  @GeneratedValue  private Long id;  @Column(nullable = false)  private String name;  @Column(nullable = false)  private Integer age;  // 省略構造函數  // 省略getter和setter}

創建數據訪問接口

下面針對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中的常見使用。

在上例中，我們可以看到下面兩個函數：