摘要: 原創(chuàng)出處 https://www.bysocket.com 「公眾號(hào)：泥瓦匠BYSocket 」歡迎關(guān)注和轉(zhuǎn)載辆苔，保留摘要充岛，謝謝懈玻！
這是泥瓦匠的第102篇原創(chuàng)
03：WebFlux Web CRUD 實(shí)踐
文章工程：
- JDK 1.8
- Maven 3.5.2
- Spring Boot 2.1.3.RELEASE
- 工程名：springboot-webflux-2-restful
- 工程地址：見(jiàn)文末
一泽示、前言
上一篇基于功能性端點(diǎn)去創(chuàng)建一個(gè)簡(jiǎn)單服務(wù)钳幅，實(shí)現(xiàn)了 Hello 付鹿。這一篇用 Spring Boot WebFlux 的注解控制層技術(shù)創(chuàng)建一個(gè) CRUD WebFlux 應(yīng)用澜汤，讓開(kāi)發(fā)更方便。這里我們不對(duì)數(shù)據(jù)庫(kù)儲(chǔ)存進(jìn)行訪問(wèn)舵匾，因?yàn)楹罄m(xù)會(huì)講到俊抵，而且這里主要是講一個(gè)完整的 WebFlux CRUD。
二坐梯、結(jié)構(gòu)
這個(gè)工程會(huì)對(duì)城市（City）進(jìn)行管理實(shí)現(xiàn) CRUD 操作徽诲。該工程創(chuàng)建編寫(xiě)后，得到下面的結(jié)構(gòu)吵血，其目錄結(jié)構(gòu)如下：
├── 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
如目錄結(jié)構(gòu)谎替，我們需要編寫(xiě)的內(nèi)容按順序有：
- 對(duì)象
- 數(shù)據(jù)訪問(wèn)層類(lèi) Repository
- 處理器類(lèi) Handler
- 控制器類(lèi) Controller
三、對(duì)象
新建包 org.spring.springboot.domain 蹋辅，作為編寫(xiě)城市實(shí)體對(duì)象類(lèi)钱贯。新建城市（City）對(duì)象 City，代碼如下：
/**
* 城市實(shí)體類(lèi)
*
*/
public class City {
/**
* 城市編號(hào)
*/
private Long id;
/**
* 省份編號(hào)
*/
private Long provinceId;
/**
* 城市名稱(chēng)
*/
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;
}
}
城市包含了城市編號(hào)侦另、省份編號(hào)秩命、城市名稱(chēng)和描述。具體開(kāi)發(fā)中淋肾，會(huì)使用 Lombok 工具來(lái)消除冗長(zhǎng)的 Java 代碼硫麻，尤其是 POJO 的 getter / setter 方法。具體查看 Lombok 官網(wǎng)地址：projectlombok.org樊卓。
四拿愧、數(shù)據(jù)訪問(wèn)層 CityRepository
新建包 org.spring.springboot.dao ，作為編寫(xiě)城市數(shù)據(jù)訪問(wèn)層類(lèi) 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, City> 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;
}
}
@Repository 用于標(biāo)注數(shù)據(jù)訪問(wèn)組件，即 DAO 組件唾戚。實(shí)現(xiàn)代碼中使用名為 repository 的 Map 對(duì)象作為內(nèi)存數(shù)據(jù)存儲(chǔ)柳洋，并對(duì)對(duì)象具體實(shí)現(xiàn)了具體業(yè)務(wù)邏輯。CityRepository 負(fù)責(zé)將 Book 持久層（數(shù)據(jù)操作）相關(guān)的封裝組織叹坦，完成新增熊镣、查詢(xún)、刪除等操作。
這里不會(huì)涉及到數(shù)據(jù)存儲(chǔ)這塊绪囱，具體數(shù)據(jù)存儲(chǔ)會(huì)在后續(xù)介紹测蹲。
五、處理器類(lèi) Handler
新建包 org.spring.springboot.handler 鬼吵，作為編寫(xiě)城市處理器類(lèi) 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)));
}
}
@Component 泛指組件齿椅，當(dāng)組件不好歸類(lèi)的時(shí)候琉挖，使用該注解進(jìn)行標(biāo)注。然后用 final 和 @Autowired 標(biāo)注在構(gòu)造器注入 CityRepository Bean涣脚，代碼如下：
private final CityRepository cityRepository;
@Autowired
public CityHandler(CityRepository cityRepository) {
this.cityRepository = cityRepository;
}
從返回值可以看出示辈，Mono 和 Flux 適用于兩個(gè)場(chǎng)景，即：
- Mono：實(shí)現(xiàn)發(fā)布者涩澡，并返回 0 或 1 個(gè)元素顽耳，即單對(duì)象
- Flux：實(shí)現(xiàn)發(fā)布者，并返回 N 個(gè)元素妙同，即 List 列表對(duì)象
有人會(huì)問(wèn)射富，這為啥不直接返回對(duì)象，比如返回 City/Long/List粥帚。原因是胰耗，直接使用 Flux 和 Mono 是非阻塞寫(xiě)法，相當(dāng)于回調(diào)方式芒涡。利用函數(shù)式可以減少了回調(diào)柴灯，因此會(huì)看不到相關(guān)接口。反應(yīng)了是 WebFlux 的好處：集合了非阻塞 + 異步费尽。
5.1 Mono
Mono 是什么赠群？ 官方描述如下：A Reactive Streams Publisher with basic rx operators that completes successfully by emitting an element, or with an error.
Mono 是響應(yīng)流 Publisher ，即要么成功發(fā)布元素旱幼，要么錯(cuò)誤查描。如圖所示：
Mono 常用的方法有：
- Mono.create()：使用 MonoSink 來(lái)創(chuàng)建 Mono
- Mono.justOrEmpty()：從一個(gè) Optional 對(duì)象或 null 對(duì)象中創(chuàng)建 Mono。
- Mono.error()：創(chuàng)建一個(gè)只包含錯(cuò)誤消息的 Mono
- Mono.never()：創(chuàng)建一個(gè)不包含任何消息通知的 Mono
- Mono.delay()：在指定的延遲時(shí)間之后柏卤，創(chuàng)建一個(gè) Mono冬三，產(chǎn)生數(shù)字 0 作為唯一值
5.2 Flux
Flux 是什么？ 官方描述如下：A Reactive Streams Publisher with rx operators that emits 0 to N elements, and then completes (successfully or with an error).
Flux 是響應(yīng)流 Publisher 缘缚，即要么成功發(fā)布 0 到 N 個(gè)元素勾笆，要么錯(cuò)誤。Flux 其實(shí)是 Mono 的一個(gè)補(bǔ)充桥滨。如圖所示：
所以要注意：如果知道 Publisher 是 0 或 1 個(gè)窝爪，則用 Mono弛车。
Flux 最值得一提的是 fromIterable 方法。fromIterable(Iterable<? extends T> it) 可以發(fā)布 Iterable 類(lèi)型的元素蒲每。當(dāng)然帅韧，F(xiàn)lux 也包含了基礎(chǔ)的操作：map、merge啃勉、concat、flatMap双妨、take淮阐，這里就不展開(kāi)介紹了。
六刁品、控制器類(lèi) Controller
Spring Boot WebFlux 也可以使用自動(dòng)配置加注解驅(qū)動(dòng)的模式來(lái)進(jìn)行開(kāi)發(fā)泣特。
新建包目錄 org.spring.springboot.webflux.controller ，并在目錄中創(chuàng)建名為 CityWebFluxController 來(lái)處理不同的 HTTP Restful 業(yè)務(wù)請(qǐng)求挑随。代碼如下：
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);
}
}
這里按照 REST 風(fēng)格實(shí)現(xiàn)接口状您。那具體什么是 REST?
REST 是屬于 WEB 自身的一種架構(gòu)風(fēng)格，是在 HTTP 1.1 規(guī)范下實(shí)現(xiàn)的兜挨。Representational State Transfer 全稱(chēng)翻譯為表現(xiàn)層狀態(tài)轉(zhuǎn)化膏孟。Resource：資源。比如 newsfeed拌汇；Representational：表現(xiàn)形式柒桑，比如用JSON，富文本等噪舀；State Transfer：狀態(tài)變化魁淳。通過(guò)HTTP 動(dòng)作實(shí)現(xiàn)。
理解 REST ,要明白五個(gè)關(guān)鍵要素：
- 資源（Resource）
- 資源的表述（Representation）
- 狀態(tài)轉(zhuǎn)移（State Transfer）
- 統(tǒng)一接口（Uniform Interface）
- 超文本驅(qū)動(dòng)（Hypertext Driven）
6 個(gè)主要特性：
- 面向資源（Resource Oriented）
- 可尋址（Addressability）
- 連通性（Connectedness）
- 無(wú)狀態(tài)（Statelessness）
- 統(tǒng)一接口（Uniform Interface）
- 超文本驅(qū)動(dòng)（Hypertext Driven）
具體這里就不一一展開(kāi)与倡，詳見(jiàn) http://www.infoq.com/cn/articles/understanding-restful-style界逛。
請(qǐng)求入?yún)ⅰilters纺座、重定向息拜、Conversion、formatting 等知識(shí)會(huì)和以前 MVC 的知識(shí)一樣比驻，詳情見(jiàn)文檔：
https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html
七该溯、運(yùn)行工程
一個(gè) CRUD 的 Spring Boot Webflux 工程就開(kāi)發(fā)完畢了，下面運(yùn)行工程驗(yàn)證下别惦。使用 IDEA 右側(cè)工具欄狈茉，點(diǎn)擊 Maven Project Tab ，點(diǎn)擊使用下 Maven 插件的 install 命令掸掸÷惹欤或者使用命令行的形式蹭秋，在工程根目錄下，執(zhí)行 Maven 清理和安裝工程的指令：
cd springboot-webflux-2-restful
mvn clean install
在控制臺(tái)中看到成功的輸出：
... 省略
[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 中執(zhí)行 Application 類(lèi)啟動(dòng)堤撵，任意正常模式或者 Debug 模式仁讨。可以在控制臺(tái)看到成功運(yùn)行的輸出：
... 省略
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)
打開(kāi) POST MAN 工具实昨，開(kāi)發(fā)必備洞豁。進(jìn)行下面操作：
新增城市信息 POST http://127.0.0.1:8080/city
獲取城市信息列表 GET http://127.0.0.1:8080/city
其他接口就不演示了。
八荒给、總結(jié)
這里丈挟，探討了 Spring WebFlux 的一些功能，構(gòu)建沒(méi)有底層數(shù)據(jù)庫(kù)的基本 CRUD 工程志电。為了更好的展示了如何創(chuàng)建 Flux 流曙咽，以及如何對(duì)其進(jìn)行操作。下面會(huì)講到如何操作數(shù)據(jù)存儲(chǔ)挑辆。
系列教程目錄
- 《01：WebFlux 系列教程大綱》
- 《02：WebFlux 快速入門(mén)實(shí)踐》
- 《03：WebFlux Web CRUD 實(shí)踐》
- 《04：WebFlux 整合 Mongodb》
- 《05：WebFlux 整合 Thymeleaf》
- 《06：WebFlux 中 Thymeleaf 和 Mongodb 實(shí)踐》
- 《07：WebFlux 整合 Redis》
- 《08：WebFlux 中 Redis 實(shí)現(xiàn)緩存》
- 《09：WebFlux 中 WebSocket 實(shí)現(xiàn)通信》
- 《10：WebFlux 集成測(cè)試及部署》
- 《11：WebFlux 實(shí)戰(zhàn)圖書(shū)管理系統(tǒng)》
代碼示例
本文示例讀者可以通過(guò)查看下面?zhèn)}庫(kù)的中的模塊工程名: 2-x-spring-boot-webflux-handling-errors：
- Github：https://github.com/JeffLi1993/springboot-learning-example
- Gitee：https://gitee.com/jeff1993/springboot-learning-example
如果您對(duì)這些感興趣例朱，歡迎 star、follow鱼蝉、收藏洒嗤、轉(zhuǎn)發(fā)給予支持！
參考資料
- Spring Boot 2.x WebFlux 系列：https://www.bysocket.com/archives/2290
- spring.io 官方文檔
