Spring WebFlux整合R2DBC實現數據庫操作（反應式編程系列）

作者：Springboot實戰案例錦集 2023-09-21 08:01:27

Spring Data R2DBC的目標是在概念上變得簡單。為了實現這一點，它不提供緩存、延遲加載、寫后處理或ORM框架的許多其他特性。這使得Spring Data R2DBC成為一個簡單、有限、固執己見的對象映射器。

環境：Springboot2.4.12

R2DBC簡介

Spring data R2DBC是更大的Spring data 系列的一部分，它使得實現基于R2DBC的存儲庫變得容易。R2DBC代表反應式關系數據庫連接，這是一種使用反應式驅動程序集成SQL數據庫的規范。Spring Data R2DBC使用屬性的Spring抽象和Repository支持應用于R2DBC。它使得在反應式應用程序堆棧中使用關系數據訪問技術構建Spring驅動的應用程序變得更加容易。

Spring Data R2DBC允許一種 functional 方法與數據庫交互，提供R2dbcEntityTemplate作為應用程序的入口點。

首先選擇數據庫驅動程序并創建R2dbcEntityTemplate實例：

H2 (io.r2dbc:r2dbc-h2)
MariaDB (org.mariadb:r2dbc-mariadb)
Microsoft SQL Server (io.r2dbc:r2dbc-mssql)
MySQL (dev.miku:r2dbc-mysql)
jasync-sql MySQL (com.github.jasync-sql:jasync-r2dbc-mysql)
Postgres (io.r2dbc:r2dbc-postgresql)
Oracle (com.oracle.database.r2dbc:oracle-r2dbc)

WebFlux介紹

Spring框架中包含原始web框架Spring Web MVC是專門為ServletAPI和Servlet容器構建的。反應式堆棧web框架Spring Web Flux是后來在5.0版中添加。它是完全非阻塞的，支持反應流背壓（由消費者控制生產者的速度），并在Netty、Undertow和Servlet 3.1+容器等服務器上運行。

這兩個web框架都反映了它們的源模塊（Spring Web MVC和Spring Web Flux）的名稱，并在Spring框架中共存。每個模塊都是可選的。應用程序可以使用一個或另一個模塊，在某些情況下，可以同時使用這兩個模塊?—?例如，帶有反應式WebClient的Spring MVC控制器。

依賴管理

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-r2dbc</artifactId>
  </dependency>
  <dependency>
    <groupId>dev.miku</groupId>
    <artifactId>r2dbc-mysql</artifactId>
  </dependency>
</dependencies>

應用配置

spring:
  r2dbc:
    url: r2dbc:mysql://localhost:3306/reactive_db
    username: root
    password: 123123
    pool:
      initialSize: 100
      maxSize: 100
---
logging:
  level:
    org.springframework.r2dbc: DEBUG  #輸出執行的sql

關于MySQL的R2DBC詳細配置查看：

https://github.com/mirromutth/r2dbc-mysql

實體&Service 基本的CURD操作

@Table("T_USERS")
public class Users {
  @Id
  private Long id ;
  private String name ;
  private String sex ;
  private Integer age ;
}
Service
@Resource
private R2dbcEntityTemplate template ;
  
@Transactional
public Mono<Users> insertByTemplate(Users users) {
  return template.insert(users) ;
}
public Mono<Integer> removeByTemplate(Long id) {
  Query query = Query.query(Criteria.where("id").is(id)) ;
  return template.delete(query, Users.class) ;
}
public Mono<Integer> updateByTemplate(Users users) {
  CriteriaDefinition criteria = Criteria.where("id").is(users.getId()) ;
  Query query = Query.query(criteria) ;
  Update update = Update.update("name", users.getName()) ;
  return template.update(query, update, Users.class) ;
}
public Mono<Users> selectByTemplate(Long id) {
  Query query = Query.query(Criteria.where("id").is(id)) ;
  return template.select(query, Users.class).single() ;
}
public Flux<Users> selectByTemplate(Integer page, Integer size) {
  Query query =  Query.empty().offset((page - 1) * size).limit(size) ;
  return template.select(query, Users.class) ;
}
public Mono<Long> selecyByTemplateCount() {
  return template.select(Users.class).count() ;
}
public Mono<ResponseEntity<List<Users>>> selectByTemplatePager(Integer page, Integer size) {
  Mono<List<Users>> datas = this.selectByTemplate(page, size).collectList() ;
  Mono<Long> count = this.selecyByTemplateCount() ;
  return datas.zipWith(count, (list, c) -> {
    return ResponseEntity.ok().header("count", c + "").header("page", page + "").header("size", size + "").body(list) ;
  }) ;
}

Controller

@Resource
private UsersService us ;
@PostMapping("/insert")
public Mono<Users> insertByTemplate(@RequestBody Users users) {
  return us.insertByTemplate(users) ;
}
@GetMapping("/remove/{id}")
public Mono<Integer> removeByTemplate(@PathVariable("id")Long id) {
  return us.removeByTemplate(id) ;
}
@PostMapping("/update")
public Mono<Integer> updateByTemplate(@RequestBody Users users) {
  return us.updateByTemplate(users) ;
}
@GetMapping("/query/{id}")
public Mono<Users> selectByTemplate(@PathVariable("id") Long id) {
  return us.selectByTemplate(id).single() ;
}
@GetMapping("/pager")
public Mono<ResponseEntity<List<Users>>> selectByTemplate(Integer page, Integer size) {
  return us.selectByTemplatePager(page, size) ;
}
@GetMapping("/count")
public Mono<Long> selecyByTemplateCount() {
  return us.selecyByTemplateCount() ;
}

R2DBC Repository

通過繼承ReactiveCrudRepository或者是ReactiveSortingRepository。Repository支持的方法查詢如下表所示：

圖片

Repository修改操作：

interface ReactivePersonRepository extends ReactiveSortingRepository<Person, String> {
  Mono<Integer> deleteByLastname(String lastname);            
  Mono<Void> deletePersonByLastname(String lastname);         
  Mono<Boolean> deletePersonByLastname(String lastname);      
}

自定義修改操作：

@Modifying
@Query("UPDATE person SET firstname = :firstname where lastname = :lastname")
Mono<Integer> setFixedFirstnameFor(String firstname, String lastname);

支持樂觀鎖：

@Version注釋提供了與R2DBC上下文中JPA類似的語法，并確保更新僅應用于具有匹配版本的行。因此，version屬性的實際值被添加到update查詢中，如果另一個操作同時更改了行，則更新不會產生任何影響。在這種情況下，將拋出OptimisticLockingFailureException。以下示例顯示了這些功能：

@Table
public class Person {
  @Id Long id;
  String firstname;
  String lastname;
  @Version 
  Long version;
}

如下示例演示了樂觀鎖異常的觸發：

R2dbcEntityTemplate template = …;


// 1. 初始插入數據 此時version = 0
Mono<Person> daenerys = template.insert(new Person("Daenerys"));            


// 2. 加載剛剛插入的數據，此時加載的version = 0
Person other = template.select(Person.class) .matching(query(where("id").is(daenerys.getId()))).first().block();                                                    


// 3. 更新數據，此處更新后該條數據的version = 1
daenerys.setLastname("Targaryen");
template.update(daenerys);                                                            


// 4. 更新數據，由于other中的version = 0 ；而數據庫已經是1了，所以這里會觸發OptimisticLockingFailureException異常
template.update(other).subscribe();

責任編輯：武曉燕來源： Spring全家桶實戰案例源碼