Spring Boot WebFlux 增刪改查完整實戰 demo

03：WebFlux Web CRUD 實踐

前言

上一篇基於功能性端點去創建一個簡單服務，實現了 Hello 。這一篇用 Spring Boot WebFlux 的註解控制層技術創建一個 CRUD WebFlux 應用，讓開發更方便。這裡我們不對數據庫儲存進行訪問，因為後續會講到，而且這裡主要是講一個完整的 WebFlux CRUD。

結構

這個工程會對城市（City）進行管理實現 CRUD 操作。該工程創建編寫後，得到下面的結構，其目錄結構如下：

├── pom.xml
├── src
│ └── main
│ ├── java
│ │ └── org
│ │ └── spring
│ │ └── springboot
│ │ ├── Application.java
│ │ ├── dao
│ │ │ └── CityRepository.java
│ │ ├── domain
│ │ │ └── City.java
│ │ ├── handler
│ │ │ └── CityHandler.java
│ │ └── webflux
│ │ └── controller
│ │ └── CityWebFluxController.java
│ └── resources
│ └── application.properties
└── target

如目錄結構，我們需要編寫的內容按順序有：

• 對象
• 數據訪問層類 Repository
• 處理器類 Handler
• 控制器類 Controller

對象

新建包 org.spring.springboot.domain ，作為編寫城市實體對象類。新建城市（City）對象 City，代碼如下：

/**
 * 城市實體類
 *
 */
public class City {
 /**
 * 城市編號
 */
 private Long id;
 /**
 * 省份編號
 */
 private Long provinceId;
 /**
 * 城市名稱
 */
 private String cityName;
 /**
 * 描述
 */
 private String description;
 public Long getId() {
 return id;
 }
 public void setId(Long id) {
 this.id = id;
 }
 public Long getProvinceId() {
 return provinceId;
 }
 public void setProvinceId(Long provinceId) {
 this.provinceId = provinceId;
 }
 public String getCityName() {
 return cityName; 

 }
 public void setCityName(String cityName) {
 this.cityName = cityName;
 }
 public String getDescription() {
 return description;
 }
 public void setDescription(String description) {
 this.description = description;
 }
}

城市包含了城市編號、省份編號、城市名稱和描述。具體開發中，會使用 Lombok 工具來消除冗長的 Java 代碼，尤其是 POJO 的 getter / setter 方法。具體查看 Lombok 官網地址：projectlombok.org。

數據訪問層 CityRepository

新建包 org.spring.springboot.dao ，作為編寫城市數據訪問層類 Repository。新建 CityRepository，代碼如下：

import org.spring.springboot.domain.City;
import org.springframework.stereotype.Repository;
import java.util.Collection;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.atomic.AtomicLong;
@Repository
public class CityRepository {
 private ConcurrentMap<long> repository = new ConcurrentHashMap<>();
 private static final AtomicLong idGenerator = new AtomicLong(0);
 public Long save(City city) {
 Long id = idGenerator.incrementAndGet();
 city.setId(id);
 repository.put(id, city);
 return id;
 }
 public Collection<city> findAll() {
 return repository.values();
 }
 public City findCityById(Long id) {
 return repository.get(id);
 } 

 public Long updateCity(City city) {
 repository.put(city.getId(), city);
 return city.getId();
 }
 public Long deleteCity(Long id) {
 repository.remove(id);
 return id;
 }
}
/<city>/<long>

@Repository 用於標註數據訪問組件，即 DAO 組件。實現代碼中使用名為 repository 的 Map 對象作為內存數據存儲，並對對象具體實現了具體業務邏輯。CityRepository 負責將 Book 持久層（數據操作）相關的封裝組織，完成新增、查詢、刪除等操作。

這裡不會涉及到數據存儲這塊，具體數據存儲會在後續介紹。

處理器類 Handler

新建包 org.spring.springboot.handler ，作為編寫城市處理器類 CityHandler。新建 CityHandler，代碼如下：

import org.spring.springboot.dao.CityRepository;
import org.spring.springboot.domain.City;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
@Component
public class CityHandler {
 private final CityRepository cityRepository;
 @Autowired
 public CityHandler(CityRepository cityRepository) {
 this.cityRepository = cityRepository;
 }
 public Mono<long> save(City city) {
 return Mono.create(cityMonoSink -> cityMonoSink.success(cityRepository.save(city)));
 }
 public Mono<city> findCityById(Long id) { 

 return Mono.justOrEmpty(cityRepository.findCityById(id));
 }
 public Flux<city> findAllCity() {
 return Flux.fromIterable(cityRepository.findAll());
 }
 public Mono<long> modifyCity(City city) {
 return Mono.create(cityMonoSink -> cityMonoSink.success(cityRepository.updateCity(city)));
 }
 public Mono<long> deleteCity(Long id) {
 return Mono.create(cityMonoSink -> cityMonoSink.success(cityRepository.deleteCity(id)));
 }
}
/<long>/<long>/<city>/<city>/<long>

@Component 泛指組件，當組件不好歸類的時候，使用該註解進行標註。然後用 final 和 @Autowired 標註在構造器注入 CityRepository Bean，代碼如下：

 private final CityRepository cityRepository;
 @Autowired
 public CityHandler(CityRepository cityRepository) {
 this.cityRepository = cityRepository;
 }

從返回值可以看出，Mono 和 Flux 適用於兩個場景，即：

• Mono：實現發佈者，並返回 0 或 1 個元素，即單對象
• Flux：實現發佈者，並返回 N 個元素，即 List 列表對象

有人會問，這為啥不直接返回對象，比如返回 City/Long/List。原因是，直接使用 Flux 和 Mono 是非阻塞寫法，相當於回調方式。利用函數式可以減少了回調，因此會看不到相關接口。這恰恰是 WebFlux 的好處：集合了非阻塞 + 異步。

Mono

Mono 是什麼？ 官方描述如下：A Reactive Streams Publisher with basic rx operators that completes successfully by emitting an element, or with an error.

Mono 是響應流 Publisher 具有基礎 rx 操作符。可以成功發佈元素或者錯誤。如圖所示：

Mono 常用的方法有：

• Mono.create()：使用 MonoSink 來創建 Mono
• Mono.justOrEmpty()：從一個 Optional 對象或 null 對象中創建 Mono。
• Mono.error()：創建一個只包含錯誤消息的 Mono
• Mono.never()：創建一個不包含任何消息通知的 Mono
• Mono.delay()：在指定的延遲時間之後，創建一個 Mono，產生數字 0 作為唯一值

Flux

Flux 是什麼？ 官方描述如下：A Reactive Streams Publisher with rx operators that emits 0 to N elements, and then completes (successfully or with an error).

Flux 是響應流 Publisher 具有基礎 rx 操作符。可以成功發佈 0 到 N 個元素或者錯誤。Flux 其實是 Mono 的一個補充。如圖所示：

所以要注意：如果知道 Publisher 是 0 或 1 個，則用 Mono。

Flux 最值得一提的是 fromIterable 方法。 fromIterable(Iterable it) 可以發佈 Iterable 類型的元素。當然，Flux 也包含了基礎的操作：map、merge、concat、flatMap、take，這裡就不展開介紹了。

控制器類 Controller

Spring Boot WebFlux 開發中，不需要配置。Spring Boot WebFlux 可以使用自動配置加註解驅動的模式來進行開發。

新建包目錄 org.spring.springboot.webflux.controller ，並在目錄中創建名為 CityWebFluxController 來處理不同的 HTTP Restful 業務請求。代碼如下：

import org.spring.springboot.domain.City;
import org.spring.springboot.handler.CityHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
@RestController
@RequestMapping(value = "/city")
public class CityWebFluxController {
 @Autowired
 private CityHandler cityHandler;
 @GetMapping(value = "/{id}")
 public Mono<city> findCityById(@PathVariable("id") Long id) {
 return cityHandler.findCityById(id);
 }
 @GetMapping()
 public Flux<city> findAllCity() {
 return cityHandler.findAllCity();
 }
 @PostMapping()
 public Mono<long> saveCity(@RequestBody City city) {
 return cityHandler.save(city);
 }
 @PutMapping()
 public Mono<long> modifyCity(@RequestBody City city) { 

 return cityHandler.modifyCity(city);
 }
 @DeleteMapping(value = "/{id}")
 public Mono<long> deleteCity(@PathVariable("id") Long id) {
 return cityHandler.deleteCity(id);
 }
}
/<long>/<long>/<long>/<city>/<city>

這裡按照 REST 風格實現接口。那具體什麼是 REST?

REST 是屬於 WEB 自身的一種架構風格，是在 HTTP 1.1 規範下實現的。Representational State Transfer 全稱翻譯為表現層狀態轉化。Resource：資源。比如 newsfeed；Representational：表現形式，比如用JSON，富文本等；State Transfer：狀態變化。通過HTTP 動作實現。

理解 REST ,要明白五個關鍵要素：

• 資源（Resource）
• 資源的表述（Representation）
• 狀態轉移（State Transfer）
• 統一接口（Uniform Interface）
• 超文本驅動（Hypertext Driven）

6 個主要特性：

• 面向資源（Resource Oriented）
• 可尋址（Addressability）
• 連通性（Connectedness）
• 無狀態（Statelessness）
• 統一接口（Uniform Interface）
• 超文本驅動（Hypertext Driven）

具體這裡就不一一展開，詳見 http://www.infoq.com/cn/articles/understanding-restful-style。

請求入參、Filters、重定向、Conversion、formatting 等知識會和以前 MVC 的知識一樣，詳情見文檔：https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html

運行工程

一個 CRUD 的 Spring Boot Webflux 工程就開發完畢了，下面運行工程驗證下。使用 IDEA 右側工具欄，點擊 Maven Project Tab ，點擊使用下 Maven 插件的 install 命令。或者使用命令行的形式，在工程根目錄下，執行 Maven 清理和安裝工程的指令：

cd springboot-webflux-2-restful
mvn clean install

在控制檯中看到成功的輸出：

... 省略
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:30 min
[INFO] Finished at: 2017-10-15T10:00:54+08:00
[INFO] Final Memory: 31M/174M
[INFO] ------------------------------------------------------------------------

在 IDEA 中執行 Application 類啟動，任意正常模式或者 Debug 模式。可以在控制檯看到成功運行的輸出：

... 省略
2018-04-10 08:43:39.932 INFO 2052 --- [ctor-http-nio-1] r.ipc.netty.tcp.BlockingNettyContext : Started HttpServer on /0:0:0:0:0:0:0:0:8080
2018-04-10 08:43:39.935 INFO 2052 --- [ main] o.s.b.web.embedded.netty.NettyWebServer : Netty started on port(s): 8080
2018-04-10 08:43:39.960 INFO 2052 --- [ main] org.spring.springboot.Application : Started Application in 6.547 seconds (JVM running for 9.851)

打開 POST MAN 工具，開發必備。進行下面操作：

新增城市信息 POST http://127.0.0.1:8080/city

獲取城市信息列表 GET http://127.0.0.1:8080/city

其他接口就不演示了。

總結

這裡，探討了 Spring WebFlux 的一些功能，構建沒有底層數據庫的基本 CRUD 工程。為了更好的展示瞭如何創建 Flux 流，以及如何對其進行操作。下面會講到如何操作數據存儲。

本文由博客一文多發平臺 https://openwrite.cn?from=article_bottom 發佈！