Spring Boot WebFlux 集成 Mongodb 數據源操作

WebFlux 整合 Mongodb

前言

上一講用 Map 數據結構內存式存儲了數據。這樣數據就不會持久化，本文我們用 MongoDB 來實現 WebFlux 對數據源的操作。

什麼是 MongoDB ?

官網：https://www.mongodb.com/

MongoDB 是一個基於分佈式文件存儲的數據庫，由 C++ 語言編寫，旨在為 WEB 應用提供可擴展的高性能數據存儲解決方案。

MongoDB 是一個介於關係數據庫和非關係數據庫之間的產品，是非關係數據庫當中功能最豐富，最像關係數據庫的。

由於操作方便，本文用 Docker 啟動一個 MognoDB 服務。如果 Docker 不會安裝的，請參考此文：Docker 安裝與基本操作 https://www.jianshu.com/p/f272726db9c5

Docker 安裝 MognoDB 並啟動如下：

1、創建掛載目錄

docker volume create mongo_data_db
docker volume create mongo_data_configdb

2、啟動 MognoDB

docker run -d \\
 --name mongo \\
 -v mongo_data_configdb:/data/configdb \\
 -v mongo_data_db:/data/db \\
 -p 27017:27017 \\
 mongo \\
 --auth
 

3、初始化管理員賬號

docker exec -it mongo mongo admin
 // 容器名 // mongo命令 數據庫名
# 創建最高權限用戶
db.createUser({ user: 'admin', pwd: 'admin', roles: [ { role: "root", db: "admin" } ] });

4、測試連通性

docker run -it --rm --link mongo:mongo mongo mongo -u admin -p admin --authenticationDatabase admin mongo/admin

MognoDB 基本操作：

類似 MySQL 命令，顯示庫列表：

show dbs

使用某數據庫

use admin

顯示錶列表

show collections

如果存在 city 表，格式化顯示 city 表內容

db.city.find().pretty()

結構

類似上面講的工程搭建，新建一個工程編寫此案例。工程如圖：

目錄核心如下

• pom.xml maven 配置
• application.properties 配置文件
• dao 數據訪問層，本文要點

新增 POM 依賴與配置

在 pom.xml 配置新的依賴：

 
 <dependency>
 <groupid>org.springframework.boot/<groupid>
 <artifactid>spring-boot-starter-data-mongodb-reactive/<artifactid>
 /<dependency>

類似配了 MySQL 和 JDBC 驅動，肯定得去配置數據庫。在 application.properties 配置下上面啟動的 MongoDB 配置：

數據庫名為 admin、賬號密碼也為 admin。

spring.data.mongodb.host=localhost
spring.data.mongodb.database=admin
spring.data.mongodb.port=27017
spring.data.mongodb.username=admin
spring.data.mongodb.password=admin

這就一個巨大的問題了，為啥不用我們常用的 MySQL 數據庫呢？

答案是 Spring Data Reactive Repositories 目前支持 Mongo、Cassandra、Redis、Couchbase。不支持 MySQL ，那究竟為啥呢？那就說明下 JDBC 和 Spring Data 的關係。

Spring Data Reactive Repositories 突出點是 Reactive，即非阻塞的。區別如下：

• 基於 JDBC 實現的 Spring Data ，比如 Spring Data JPA 是阻塞的。原理是基於阻塞 IO 模型
• 消耗每個調用數據庫的線程（Connection）
• 事務只能在一個 java.sql.Connection 使用，即一個事務一個操作。

那如何異步非阻塞封裝下 JDBC 的思想也不新鮮，Scala 庫 Slick 3 就實現了。簡單的實現原理如下：

• 一個事務多個操作，那麼共享一個 java.sql.Connection 。可以使用透明事務管理，利用回調編程模型去傳遞
• 保持有限的空閒連接

最後，我堅信非阻塞 JDBC 很快就會出現的。這樣我們就開心的調用 MySQL 了。

對象

修改 org.spring.springboot.domain 包裡面的城市實體對象類。修改城市（City）對象 City，代碼如下：

import org.springframework.data.annotation.Id;
/**
 * 城市實體類
 * 

 */
public class City {
 /**
 * 城市編號
 */
 @Id
 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;
 }
}

@Id 註解標記對應庫表的主鍵或者唯一標識符。因為這個是我們的 DO ，數據訪問對象一一映射到數據存儲。

MongoDB 數據訪問層 CityRepository

修改 CityRepository 類，代碼如下：

import org.spring.springboot.domain.City;
import org.springframework.data.mongodb.repository.ReactiveMongoRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface CityRepository extends ReactiveMongoRepository<city> {
}
/<city>

CityRepository 接口只要繼承 ReactiveMongoRepository 類即可。默認會提供很多實現，比如 CRUD 和列表查詢參數相關的實現。ReactiveMongoRepository 接口默認實現瞭如下：

  Mono insert(S var1);
  Flux insert(Iterable var1);
  Flux insert(Publisher var1);
  Flux findAll(Example var1);
  Flux findAll(Example var1, Sort var2);
 

如圖，ReactiveMongoRepository 的集成類 ReactiveSortingRepository、ReactiveCrudRepository 實現了很多常用的接口：

ReactiveCrudRepository 接口如圖所示：

另外可以看出，接口的命名是遵循規範的。常用命名規則如下：

• 關鍵字 ：： 方法命名
• And ：： findByNameAndPwd
• Or ：： findByNameOrSex
• Is ：： findById
• Between ：： findByIdBetween
• Like ：： findByNameLike
• NotLike ：： findByNameNotLike
• OrderBy ：： findByIdOrderByXDesc
• Not ：： findByNameNot

常用案例，代碼如下：

 Flux<person> findByLastname(String lastname);
 @Query("{ 'firstname': ?0, 'lastname': ?1}")
 Mono<person> findByFirstnameAndLastname(String firstname, String lastname);
 // Accept parameter inside a reactive type for deferred execution
 Flux<person> findByLastname(Mono<string> lastname);
 Mono<person> findByFirstnameAndLastname(Mono<string> firstname, String lastname);
 @Tailable // Use a tailable cursor
 Flux<person> findWithTailableCursorBy();
/<person>/<string>/<person>/<string>/<person>/<person>/<person>

源碼層面

ReactiveCrudRepository 抽象在 reactive 包，如圖：

這裡我們可以看出，支持了 reactive 還支持了 RxJava。對應老的 CrudRepository 新增了 ReactiveCrudRepository 接口及各種存儲實現。

處理器類 Handler 和控制器類 Controller

修改下 Handler ，代碼如下：

@Component
public class CityHandler {
 private final CityRepository cityRepository;
 @Autowired
 public CityHandler(CityRepository cityRepository) {
 this.cityRepository = cityRepository;
 }
 public Mono<city> save(City city) {
 return cityRepository.save(city);
 }
 public Mono<city> findCityById(Long id) {
 return cityRepository.findById(id);
 }
 public Flux<city> findAllCity() {
 return cityRepository.findAll();
 }
 public Mono<city> modifyCity(City city) {
 return cityRepository.save(city);
 }
 public Mono<long> deleteCity(Long id) {
 cityRepository.deleteById(id);
 return Mono.create(cityMonoSink -> cityMonoSink.success(id));
 }
}
/<long>/<city>/<city>/<city>/<city>

不要對 Mono 、Flux 陌生，把他當成對象即可。繼續修改下控制器類 Controller ，代碼如下：

@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<city> saveCity(@RequestBody City city) {
 return cityHandler.save(city);
 }
 @PutMapping()
 public Mono<city> modifyCity(@RequestBody City city) {
 return cityHandler.modifyCity(city);
 }
 @DeleteMapping(value = "/{id}")
 public Mono<long> deleteCity(@PathVariable("id") Long id) {
 return cityHandler.deleteCity(id);
 }
}
/<long>/<city>/<city>/<city>/<city>

運行工程

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

cd springboot-webflux-3-mongodb
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

連接 MongoDB , 驗證數據

連接 MongoDB

docker run -it --rm --link mongo:mongo mongo mongo -u admin -p admin --authenticationDatabase admin mongo/admin

顯示庫列表：

show dbs

使用某數據庫

use admin

顯示錶列表

show collections 

如果存在 city 表，格式化顯示 city 表內容：

db.city.find().pretty()

總結

這裡，探討了 Spring WebFlux 的如何整合 MongoDB 。整合其他存儲 Cassandra、Redis、Couchbase，就大同小異了。下面，我們能會整合 Thymeleaf，更好的頁面展示給大家。順便讓大家學習下 Thymeleaf 的基本用法。

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