Spring Data JPA系列2:SpringBoot集成JPA詳細教程,快速在項目中熟練使用JPA

語言: CN / TW / HK

大家好,又見面了。

這是Spring Data JPA系列的第2篇,在上一篇《Spring Data JPA系列1:JDBC、ORM、JPA、Spring Data JPA,傻傻分不清楚?給你個選擇SpringDataJPA的理由!》中,我們對JPA的基本概念有了一個整體的瞭解,也對JAVA中進行DB操作的一些周邊框架、概念等有了初步的感知。同時也給出了SpringData JPA與MyBatis的選擇判斷依據。

那麼,如果你已經決定使用SpringData JPA來作為項目中DB操作的框架,具體應該如何去做呢?

作為SpringData JPA系列內容的第二篇,此處以SpringBoot項目為基準,講一下集成SpringData JPA的相關要點,帶你快速的上手SpringData JPA,並用實例演示常見的DB操作場景,讓你分分鐘輕鬆玩轉JPA。

SpringBoot集成SpringData JPA

依賴引入

SpringBoot項目工程,在pom.xml中引入相關依賴包即可:

```xml

org.springframework.boot spring-boot-starter-data-jpa mysql mysql-connector-java runtime

```

入口註解

SpringData JPA提供了部分註解,可以添加在Application入口程序類上方,來滿足相關訴求。當然如果沒有額外的特殊訴求,則可以什麼都不需要加。

```java

@SpringBootApplication // 可選,指定掃描的表映射實體Entity的目錄,如果不指定,會掃描全部目錄 //@EntityScan("com.veezean.demo.entity") // 可選,指定掃描的表repository目錄,如果不指定,會掃描全部目錄 //@EnableJpaRepositories(basePackages = {"com.veezean.demo.repository"}) // 可選,開啟JPA auditing能力,可以自動賦值一些字段,比如創建時間、最後一次修改時間等等 @EnableJpaAuditing public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }

```

這裏@EntityScan@EnableJpaRepositories被註釋掉了,且默認的情況下是不需要添加這個配置的,JPA會自動掃描程序所在包內的所有定義的Entity和Repository對象並加載。但是,某些比較大型的項目裏面,我們可能會封裝一個common jar作為項目公共依賴,然後再分出若干子項目,每個子項目裏面依賴common jar,這個時候如果想要加載common jar裏面定義的Entity和Repository,就需要用到這兩個註解。

參數配置

在application.properties中配置一些數據庫連接信息,如下:

```properties

spring.datasource.url=jdbc:mysql://:/vzn-demo?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai spring.datasource.username=vzn-demo spring.datasource.password=

Java代碼實體字段命名與數據庫表結構字段之間的名稱映射策略

spring.jpa.hibernate.naming.implicit-strategy=org.hibernate.boot.model.naming.ImplicitNamingStrategyLegacyJpaImpl

下面配置開啟後,會禁止將駝峯轉為下劃線

spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl

spring.jpa.open-in-view=false spring.jpa.properties.hibernate.enable_lazy_load_no_trans=true

控制是否可以基於程序中Entity的定義自動創建或者修改DB中表結構

spring.jpa.properties.hibernate.hbm2ddl.auto=update

控制是否打印運行時的SQL語句與參數信息

spring.jpa.show-sql=true

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver spring.datasource.type=com.zaxxer.hikari.HikariDataSource spring.datasource.hikari.minimum-idle=10 spring.datasource.hikari.maximum-pool-size=20 spring.datasource.hikari.idle-timeout=600000 spring.datasource.hikari.max-life-time=1800000

```

基礎編碼實操

通過前面的幾個步驟的操作,便完成了SpringData JPA與項目的集成對接。本章節介紹下在業務代碼裏面應該如何使用SpringData JPA來完成一些DB交互操作。

Table對應Entity編寫

編寫數據庫中Table對應的JAVA實體映射類,並通過相關注解,來描述字段的一些附加約束信息。

  • 用户表實體

```java

@Data @Entity @Table(name = "user") @EntityListeners(value = AuditingEntityListener.class) public class UserEntity { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String workId; private String userName; @ManyToOne(optional = false) @JoinColumn(name = "department") private DepartmentEntity department; @CreatedDate private Date createTime; @LastModifiedDate private Date updateTime;

}

```

  • 部門表實體

```java

@Data @Entity @Table(name = "department") @EntityListeners(value = AuditingEntityListener.class) public class DepartmentEntity { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String deptName; @CreatedDate private Date createTime; @LastModifiedDate private Date updateTime; }

```

這裏可以看到,所謂的Entity,其實也就是一個普通的JAVA數據類,只是與普通的JAVA數據類相比,多了一些註解。沒錯!SpringData JPA正式通過各種註解,來完成對各個字段的定義與行為約束,以及完成表間關聯關係(比如外鍵)。

常見的一些註解以及含義功能説明,在本文的末尾表格裏面進行了梳理,此處不贅述。

自定義Repository編寫

繼承JpaRepository接口提供自定義Repository接口類,在自定義接口類中,添加業務需要的定製化的DB操作接口。這裏定製的時候,可以基於SpringData JPA的命名規範進行接口方法的命名即可,無需關注其具體實現,也不需要提供實現類。

  • 用户repository

```java

@Repository public interface UserRepository extends JpaRepository { List findAllByDepartment(DepartmentEntity department); UserEntity findFirstByWorkId(String workId); List findAllByDepartmentInAndUserNameLike(List departmentIds, String userName);

@Query(value = "select * from user where user_name like ?1", nativeQuery = true)
List<UserEntity> fuzzyQueryByName(String userName);

}

```

上述代碼裏面,演示了2種自定義接口的策略: - 基於SpringData JPA的命名規範,直接定義接口 - 使用自定義的SQL語句進行個性化定製,這種適用於一些需要高度定製化處理的場景

JPA中支持的一些命名關鍵字與命名示例,參見本文後面梳理的表格。

業務層執行DB操作

寫入數據

SpringData JPA寫操作邏輯很簡單,只有一個save方法即可,如果批量寫入操作,使用saveAll方法即可。

  • 會判斷ID,如果唯一ID已存在,則按照update邏輯執行;
  • 如果唯一ID記錄不存在,則按照insert邏輯執行。

```java

public void testUser() { DepartmentEntity deptEntity1 = new DepartmentEntity(); deptEntity1.setDeptName("研發部門"); deptEntity1.setId(1L); DepartmentEntity deptEntity2 = new DepartmentEntity(); deptEntity2.setDeptName("產品部門"); deptEntity2.setId(2L); // 寫入部門信息 departmentRepository.save(deptEntity1); departmentRepository.save(deptEntity2); departmentRepository.flush();

UserEntity entity1 = new UserEntity();
entity1.setWorkId("123456");
entity1.setDepartment(deptEntity1);
entity1.setUserName("王小二");
UserEntity entity2 = new UserEntity();
entity2.setWorkId("234567");
entity2.setDepartment(deptEntity1);
entity2.setUserName("王小五");
UserEntity entity3 = new UserEntity();
entity3.setWorkId("345678");
entity3.setDepartment(deptEntity1);
entity3.setUserName("劉大壯");
UserEntity entity4 = new UserEntity();
entity4.setWorkId("345678");
entity4.setDepartment(deptEntity2);
entity4.setUserName("張三");
 // 寫入用户信息
userRepository.saveAll(Stream.of(entity1, entity2, entity3, entity4).collect(Collectors.toList()));
userRepository.flush();

}

```

執行調用後,查看數據庫,可見數據已經寫入DB中:

  • Department表

  • User表

從上面可以看出,代碼裏面其實並沒有對create_time和update_time字段進行賦值,但是數據存儲到DB的時候,這兩個字段被自動賦值了,這個主要是因為開啟了自動Audit能力,主要2個地方的代碼有關係:

``` 1、Application啟動類上的註解,開啟允許JPA自動Audit能力 @EnableJpaAuditing

2、Entity類上添加註解 @EntityListeners(value = AuditingEntityListener.class)

3、Entity中具體字段上加上對應註解: @CreatedDate private Date createTime; @LastModifiedDate private Date updateTime;

```

查詢數據

常見的數據查詢操作,代碼層面實現調用如下:

```java

public void testUser() { DepartmentEntity deptEntity1 = new DepartmentEntity(); deptEntity1.setDeptName("研發部門"); deptEntity1.setId(1L); DepartmentEntity deptEntity2 = new DepartmentEntity(); deptEntity2.setDeptName("產品部門"); deptEntity2.setId(2L); // 獲取所有用户列表 --- JPA默認提供的方法 List userEntities = userRepository.findAll(); log.info("findAll result :{}", userEntities); // 獲取符合條件用户列表 --- 定製方法: 根據部門字段查詢符合條件列表 List userEntitiesInDept = userRepository.findAllByDepartment(deptEntity1); log.info("findAllByDepartment result count:{}", userEntitiesInDept); // 獲取符合條件用户 --- 定製方法: 根據工號查詢用户信息 UserEntity userEntity = userRepository.findFirstByWorkId("123456"); log.info("findFirstByWorkId result: {}", userEntity); // 多條件查詢符合條件用户列表 --- 定製方法: 根據部門與名稱字段複合查詢 List fuzzyQueryUsers = userRepository.findAllByDepartmentInAndUserNameLike(Stream.of(deptEntity1, deptEntity2).collect(Collectors.toList()), "王%"); log.info("findAllByDepartmentInAndUserNameLike result count: {}", fuzzyQueryUsers); }

```

從上面的演示代碼可以看出,SpringData JPA的一個很大的優勢,就是Repository層可以簡化大部分場景的代碼編碼事務,遵循一定的方法命名規範,即可實現相關的能力。

比如:

List<UserEntity> findAllByDepartmentInAndUserNameLike(List<DepartmentEntity> departmentIds, String userName);

看方法名就直接可以知道這個具體的DB操作邏輯:在給定的部門列表裏面查詢所有名稱可以模糊匹配上的人員列表!至於如何去具體實現,這個開發人員無需關注、也不需要去寫對應SQL語句!

藏在配置中的小技能

在前面章節中有介紹集成SpringData JPA涉及到的一些常見配置,此處對其中部分配置的含義與功能進行一個補充介紹。

控制是否自動基於代碼Entity定義自動創建變更數據庫表結構

spring.jpa.properties.hibernate.hbm2ddl.auto=update

如果設置為update,程序運行之後,會自動在DB中將Table創建出來,並且相關約束條件(比如自增主鍵、關聯外鍵之類的)也會一併創建並設置上去,如下示意,左側的代碼自動創建出右側DB中的表結構:

補充説明

雖然這個功能比較方便,但是強烈建議在生產環境上關閉此功能。因為DB表結構改動變更,對於生產環境而言,是一個非常重大的操作,一旦出問題甚至會影響到實際數據。為了避免造成不可逆的危害,保險起見,還是人工手動操作變更下比較好。

控制是否打印相關操作的SQL語句

spring.jpa.show-sql=true

如果設置為true,則會在日誌中打印每次DB操作所執行的最終SQL語句內容,這個比較適合與開發過程中的問題定位分析,生產環境上建議關閉(影響性能)。

如果開啟後,打印的日誌示例如下:

```

2022-06-14 14:30:50.329 INFO 23380 --- [io-48080-exec-3] o.a.c.c.C.[.[localhost].[/veezean-demo] : Initializing Spring DispatcherServlet 'dispatcherServlet' 2022-06-14 14:30:50.329 INFO 23380 --- [io-48080-exec-3] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet' 2022-06-14 14:30:50.337 INFO 23380 --- [io-48080-exec-3] o.s.web.servlet.DispatcherServlet : Completed initialization in 8 ms Hibernate: insert into department (create_time, dept_name, update_time) values (?, ?, ?) Hibernate: insert into department (create_time, dept_name, update_time) values (?, ?, ?) Hibernate: insert into user (create_time, department, update_time, user_name, work_id) values (?, ?, ?, ?, ?) Hibernate: insert into user (create_time, department, update_time, user_name, work_id) values (?, ?, ?, ?, ?) Hibernate: insert into user (create_time, department, update_time, user_name, work_id) values (?, ?, ?, ?, ?) Hibernate: insert into user (create_time, department, update_time, user_name, work_id) values (?, ?, ?, ?, ?) 2022-06-14 14:30:50.544 INFO 23380 --- [io-48080-exec-3] o.h.h.i.QueryTranslatorFactoryInitiator : HHH000397: Using ASTQueryTranslatorFactory

```

瞭解幾個"常識"概念

通過前面內容的介紹以及相關示例代碼的演示,可以看出SpringData JPA中有很多情況都是藉助不同註解來約定一些屬性或者處理邏輯策略的,且在自定義接口方法的時候,需要遵循SpringData JPA固有的一套命名規範才行。

這裏對一些高頻易用的註解與常見的接口方法命名規範進行梳理介紹。

常用註解

Repository方法命名約定

DB裏面一些關鍵字對應的SpringData JPA中命名關鍵字列舉如下:

小結,承上啟下

好啦,本篇內容就介紹到這裏。

跟着本篇內容,可以讓你順利的完成SpringBoot項目與JPA的集成配置,以及對項目中如何使用JPA進行代碼開發有了個整體的感知,可以應付大部分場景的基礎業務代碼開發訴求。

本系列教程是按照由面到點、由淺入深的邏輯進行內容編排的。在本系列的下一篇內容中,我會進一步對SpringData JPA中的一些核心類型與核心方法進行剖析,讓你不僅僅停留在簡單使用層面,更能對JPA有個深度的瞭解、達到精通級別。如果感興趣的話,歡迎關注我的後續系列文檔。

如果對本文有自己的見解,或者有任何的疑問或建議,都可以留言,我們一起探討、共同進步。


補充

Spring Data JPA作為Spring Data中對於關係型數據庫支持的一種框架技術,屬於ORM的一種,通過得當的使用,可以大大簡化開發過程中對於數據操作的複雜度。

本文檔隸屬於《Spring Data JPA用法與技能探究》系列的第二篇。本系列文檔規劃對Spring Data JPA進行全方位的使用介紹,一共分為5篇文檔,如果感興趣,歡迎關注交流。

《Spring Data JPA用法與技能探究》系列涵蓋內容: - 開篇介紹 —— 《Spring Data JPA系列1:JDBC、ORM、JPA、Spring Data JPA,傻傻分不清楚?給你個選擇SpringDataJPA的理由!》 - 快速上手 —— 《Spring Data JPA系列2:SpringBoot集成JPA詳細教程,快速在項目中熟練使用JPA》 - 深度進階 —— 《JPA核心類型與用法介紹》 - 可靠保障 —— 《聊一聊數據庫的事務,以及Spring體系下對事務的使用》 - 周邊擴展 —— 《JPA開發輔助效率提升方案介紹》


我是悟道,聊技術、又不僅僅聊技術~

如果覺得有用,請點個關注,也可以關注下我的公眾號【架構悟道】,獲取更及時的更新。

期待與你一起探討,一起成長為更好的自己。