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

image.png

大家好，又見面了。

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

那么，如果你已經(jīng)決定使用SpringData JPA來作為項目中DB操作的框架，具體應(yīng)該如何去做呢？

作為SpringData JPA系列內(nèi)容的第二篇，此處以SpringBoot項目為基準，講一下集成SpringData JPA的相關(guān)要點，帶你快速的上手SpringData JPA，并用實例演示常見的DB操作場景，讓你分分鐘輕松玩轉(zhuǎn)JPA。

SpringBoot集成SpringData JPA

依賴引入

SpringBoot項目工程，在pom.xml中引入相關(guān)依賴包即可：


<!-- 數(shù)據(jù)庫相關(guān)操作 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

入口注解

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


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

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

參數(shù)配置

在application.properties中配置一些數(shù)據(jù)庫連接信息,如下：


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

#Java代碼實體字段命名與數(shù)據(jù)庫表結(jié)構(gòu)字段之間的名稱映射策略
spring.jpa.hibernate.naming.implicit-strategy=org.hibernate.boot.model.naming.ImplicitNamingStrategyLegacyJpaImpl
#下面配置開啟后，會禁止將駝峰轉(zhuǎn)為下劃線
#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的定義自動創(chuàng)建或者修改DB中表結(jié)構(gòu)
spring.jpa.properties.hibernate.hbm2ddl.auto=update
# 控制是否打印運行時的SQL語句與參數(shù)信息
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

基礎(chǔ)編碼實操

通過前面的幾個步驟的操作，便完成了SpringData JPA與項目的集成對接。本章節(jié)介紹下在業(yè)務(wù)代碼里面應(yīng)該如何使用SpringData JPA來完成一些DB交互操作。

Table對應(yīng)Entity編寫

編寫數(shù)據(jù)庫中Table對應(yīng)的JAVA實體映射類，并通過相關(guān)注解，來描述字段的一些附加約束信息。

  • 用戶表實體

@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;

}
  • 部門表實體

@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數(shù)據(jù)類，只是與普通的JAVA數(shù)據(jù)類相比，多了一些注解。沒錯！SpringData JPA正式通過各種注解，來完成對各個字段的定義與行為約束，以及完成表間關(guān)聯(lián)關(guān)系（比如外鍵）。

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

自定義Repository編寫

繼承JpaRepository接口提供自定義Repository接口類，在自定義接口類中，添加業(yè)務(wù)需要的定制化的DB操作接口。這里定制的時候，可以基于SpringData JPA的命名規(guī)范進行接口方法的命名即可，無需關(guān)注其具體實現(xiàn)，也不需要提供實現(xiàn)類。

  • 用戶repository

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

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

上述代碼里面，演示了2種自定義接口的策略：

  • 基于SpringData JPA的命名規(guī)范，直接定義接口
  • 使用自定義的SQL語句進行個性化定制，這種適用于一些需要高度定制化處理的場景

JPA中支持的一些命名關(guān)鍵字與命名示例，參見本文后面梳理的表格。

業(yè)務(wù)層執(zhí)行DB操作

寫入數(shù)據(jù)

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

  • 會判斷ID，如果唯一ID已存在，則按照update邏輯執(zhí)行；
  • 如果唯一ID記錄不存在，則按照insert邏輯執(zhí)行。

public void testUser() {
    DepartmentEntity deptEntity1 = new DepartmentEntity();
    deptEntity1.setDeptName("研發(fā)部門");
    deptEntity1.setId(1L);
    DepartmentEntity deptEntity2 = new DepartmentEntity();
    deptEntity2.setDeptName("產(chǎn)品部門");
    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();
}

執(zhí)行調(diào)用后，查看數(shù)據(jù)庫，可見數(shù)據(jù)已經(jīng)寫入DB中：

  • Department表
image.png
  • User表
image.png

從上面可以看出，代碼里面其實并沒有對create_time和update_time字段進行賦值，但是數(shù)據(jù)存儲到DB的時候，這兩個字段被自動賦值了，這個主要是因為開啟了自動Audit能力，主要2個地方的代碼有關(guān)系：

1、Application啟動類上的注解，開啟允許JPA自動Audit能力
@EnableJpaAuditing

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

3、Entity中具體字段上加上對應(yīng)注解：
@CreatedDate
private Date createTime;
@LastModifiedDate
private Date updateTime;

查詢數(shù)據(jù)

常見的數(shù)據(jù)查詢操作，代碼層面實現(xiàn)調(diào)用如下：



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

從上面的演示代碼可以看出，SpringData JPA的一個很大的優(yōu)勢，就是Repository層可以簡化大部分場景的代碼編碼事務(wù)，遵循一定的方法命名規(guī)范，即可實現(xiàn)相關(guān)的能力。

比如：

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

看方法名就直接可以知道這個具體的DB操作邏輯：在給定的部門列表里面查詢所有名稱可以模糊匹配上的人員列表！至于如何去具體實現(xiàn)，這個開發(fā)人員無需關(guān)注、也不需要去寫對應(yīng)SQL語句！

藏在配置中的小技能

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

控制是否自動基于代碼Entity定義自動創(chuàng)建變更數(shù)據(jù)庫表結(jié)構(gòu)

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

如果設(shè)置為update，程序運行之后，會自動在DB中將Table創(chuàng)建出來，并且相關(guān)約束條件（比如自增主鍵、關(guān)聯(lián)外鍵之類的）也會一并創(chuàng)建并設(shè)置上去，如下示意，左側(cè)的代碼自動創(chuàng)建出右側(cè)DB中的表結(jié)構(gòu)：

image.png

補充說明：

雖然這個功能比較方便，但是強烈建議在生產(chǎn)環(huán)境上關(guān)閉此功能。因為DB表結(jié)構(gòu)改動變更，對于生產(chǎn)環(huán)境而言，是一個非常重大的操作，一旦出問題甚至會影響到實際數(shù)據(jù)。為了避免造成不可逆的危害，保險起見，還是人工手動操作變更下比較好。

控制是否打印相關(guān)操作的SQL語句

spring.jpa.show-sql=true

如果設(shè)置為true，則會在日志中打印每次DB操作所執(zhí)行的最終SQL語句內(nèi)容，這個比較適合與開發(fā)過程中的問題定位分析，生產(chǎn)環(huán)境上建議關(guān)閉（影響性能）。

如果開啟后，打印的日志示例如下：


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

了解幾個"常識"概念

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

這里對一些高頻易用的注解與常見的接口方法命名規(guī)范進行梳理介紹。

常用注解

image.png
image.png
image.png

Repository方法命名約定

DB里面一些關(guān)鍵字對應(yīng)的SpringData JPA中命名關(guān)鍵字列舉如下：

image.png
image.png

小結(jié)，承上啟下

好啦，本篇內(nèi)容就介紹到這里。

跟著本篇內(nèi)容，可以讓你順利的完成SpringBoot項目與JPA的集成配置，以及對項目中如何使用JPA進行代碼開發(fā)有了個整體的感知，可以應(yīng)付大部分場景的基礎(chǔ)業(yè)務(wù)代碼開發(fā)訴求。

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

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

補充

Spring Data JPA作為Spring Data中對于關(guān)系型數(shù)據(jù)庫支持的一種框架技術(shù)，屬于ORM的一種，通過得當?shù)氖褂?，可以大大簡化開發(fā)過程中對于數(shù)據(jù)操作的復(fù)雜度。

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

《Spring Data JPA用法與技能探究》系列涵蓋內(nèi)容：

我是悟道，聊技術(shù)、又不僅僅聊技術(shù)~

如果覺得有用，請點個關(guān)注，也可以關(guān)注下我的公眾號【架構(gòu)悟道】，獲取更及時的更新。

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容