參考:
https://reflectoring.io/reactive-architecture-with-spring-boot/
- Reactive System
首先介紹下Reactive System。
通常情況下,在服務(wù)間數(shù)據(jù)的傳輸是阻塞的、同步的、先進先出,阻塞式的傳輸會影響效率。在這基礎(chǔ)上,開發(fā)人員發(fā)起了基于reactive的系統(tǒng)架構(gòu),具體的reactive系統(tǒng)定義可以查看:
2. Spring Reactive
在Spring官網(wǎng)https://spring.io/ 首頁,可以看到Reactive項目排名是非??壳暗模瑑H次于大熱的微服務(wù),可見Spring是很重視這個項目的:

在Spring Reactive首頁:https://spring.io/reactive,拉到底下有張圖,能很好的描述Reactive系統(tǒng)的架構(gòu):

具體來說:Spring Reactive技術(shù)棧包含了一系列的技術(shù),上述列舉了各個技術(shù)層(如sucurity方面,web方面或是持久層方面)和現(xiàn)有的框架做了對比。其中最重要的是WebFlux框架,即反應(yīng)式web框架,對標(biāo)Spring MVC,是Reactive微服務(wù)集成Spring Boot2中重要的一環(huán)。在介紹Spring WebFlux之前,先介紹下Reactive相關(guān)的技術(shù)。
關(guān)于Spring Reactive:
- 官方例子:https://spring.io/guides/gs/reactive-rest-service/
- Spring Reactive文檔:https://docs.spring.io/spring-framework/docs/current/reference/html/web-reactive.html
3. Reactive相關(guān)的技術(shù)
3.1 首先是Reactive Stream
具體看:https://www.reactive-streams.org/
JDK9提供了Reactive Streams的簡單實現(xiàn),主要是基于類Flow,java doc:https://docs.oracle.com/javase/9/docs/api/java/util/concurrent/Flow.html
主要是提供了4個接口:

使用Flow下面4個接口的demo演示,可以參考網(wǎng)友的博文:https://blog.csdn.net/qq_34285557/article/details/104569122
Publisher可以發(fā)送元素,Subscriber接收元素并做出響應(yīng)。當(dāng)執(zhí)行Publisher里的subscribe方法時,發(fā)布者會回調(diào)訂閱者的onSubscribe方法,這個方法中,通常訂閱者會借助傳入的Subscription向發(fā)布者請求n個數(shù)據(jù)。然后發(fā)布者通過不斷調(diào)用訂閱者的onNext方法向訂閱者發(fā)出最多n個數(shù)據(jù)。如果數(shù)據(jù)全部發(fā)完,則會調(diào)用onComplete告知訂閱者流已經(jīng)發(fā)完;如果有錯誤發(fā)生,則通過onError發(fā)出錯誤數(shù)據(jù),同樣也會終止流。
默認情況下,如果subscriber方拉取數(shù)據(jù)比較慢,那么默認的緩沖帶大小為256個。

3.2 Project Reactor
- 官網(wǎng):https://projectreactor.io/
- 最新Release文檔:https://projectreactor.io/docs/core/3.5.2/reference/index.html
- baeldung網(wǎng)站上的hello world例子:https://www.baeldung.com/reactor-core
基于上述的Reactive Stream,可與Java的functional API, CompletableFuture, Stream以及Duration結(jié)合使用。Spring很多項目中都用到了該庫,如Spring WebFlux, Spring Data以及Spring Cloud Gateway。
Reactor提供了兩類Publisher:
Flux的例子:其中l(wèi)ogs()是為了打印日志:
Flux.range(1,3).log().subscribe(s -> log.info("received: {}", s));
運行后打印,可以看到和Reactive Stream一樣,也有個subscribe的過程,request以及onNext的過程:
14:39:04.339 [main] DEBUG reactor.util.Loggers - Using Slf4j logging framework
14:39:04.351 [main] INFO reactor.Flux.Range.1 - | onSubscribe([Synchronous Fuseable] FluxRange.RangeSubscription)
14:39:04.353 [main] INFO reactor.Flux.Range.1 - | request(unbounded)
14:39:04.354 [main] INFO reactor.Flux.Range.1 - | onNext(1)
14:39:04.354 [main] INFO com.reactor.FluxDemo - received: 1
14:39:04.354 [main] INFO reactor.Flux.Range.1 - | onNext(2)
14:39:04.354 [main] INFO com.reactor.FluxDemo - received: 2
14:39:04.354 [main] INFO reactor.Flux.Range.1 - | onNext(3)
14:39:04.354 [main] INFO com.reactor.FluxDemo - received: 3
14:39:04.354 [main] INFO reactor.Flux.Range.1 - | onComplete()
Mono的例子:
Mono.just("John").log().subscribe(System.out::println);
運行后日志:
15:36:56.824 [main] DEBUG reactor.util.Loggers - Using Slf4j logging framework
15:36:56.844 [main] INFO reactor.Mono.Just.1 - | onSubscribe([Synchronous Fuseable] Operators.ScalarSubscription)
15:36:56.847 [main] INFO reactor.Mono.Just.1 - | request(unbounded)
15:36:56.848 [main] INFO reactor.Mono.Just.1 - | onNext(John)
John
15:36:56.849 [main] INFO reactor.Mono.Just.1 - | onComplete()
4. Spring WebFlux
從Spring 5開始,Spring增加了reactive的web框架:Spring WebFlux。從官方文檔上看,Spring WebMvc和Spring WebFlux可以單獨分開使用,也可一起使用。通過Spring WebFlux可以構(gòu)建異步式的web項目,使用reactive stream以及functional的API來來更好的支持并發(fā)。
Spring WebFlux官方文檔:https://docs.spring.io/spring-framework/docs/current/reference/html/web-reactive.html#webflux
Spring WebFlux支持兩種編程模式,所謂的兩種編程模式是在Controller這層的變化:
-
Annotated Controllers:和Spring MVC的編程風(fēng)格保持一致,也可使用類似
@GetMapping,@PostMapping這樣的注解。 - Functional Endpoints: lambda風(fēng)格的,使用functional的編程方式??梢钥醋鍪窃赼pp中有一系列的工具類,我們需要給它們加上路由以使可以支持requests。
4.1 Spring WebFlux demo
【baeldung網(wǎng)站上的hello world的例子】
- 基地Annotated Controllers的例子:https://www.baeldung.com/spring-webflux
- 基于Functional Endpoints的例子:https://www.baeldung.com/spring-5-functional-web
【此外還有一些學(xué)習(xí)的例子也很不錯】
- https://reflectoring.io/reactive-architecture-with-spring-boot/
-
Getting Started with Spring WebFlux
-->【本文參照的是這篇文章搭建的demo?!?/strong>
4.2 安裝mongodb
持久層我們選擇mongodb,所以需要先安裝mongodb,使用的是docker安裝。
- 參考:https://www.linode.com/docs/guides/set-up-mongodb-on-docker/
- 官網(wǎng)鏡像地址:https://hub.docker.com/_/mongo
拉取鏡像:
docker pull mongo
啟動:
docker run --name mongo_example -d -p 27017:27017 --name mongo_example -e MONGO_INITDB_ROOT_USERNAME=mongoadmin -e MONGO_INITDB_ROOT_PASSWORD=mypass mongo
怎樣進入mongo bash:
docker exec -it mongo_example bash
進入后再次輸入,需要按提示輸入密碼:mypass:
mongosh -u mongoadmin

4.3 引入依賴
-
spring-boot-starter-webflux是Spring WebFlux的主要依賴 -
spring-boot-starter-data-mongodb-reactive是持久化層mongodb基于reactive實現(xiàn)的依賴 -
springdoc-openapi-webflux-ui是Spring Doc基于webflux的依賴,主要是為了swagger-ui頁面,可以更好的測試代碼。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb-reactive</artifactId>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId>
<version>1.6.4</version>
</dependency>
4.4 application.yaml配置
首先是mongodb的配置,這里的username/password需要跟上面docker安裝的一致。
其次是Netty相關(guān)的配置,使用的是9000端口:
spring:
data:
mongodb:
host: 127.0.0.1
port: 27017
username: mongoadmin
password: mypass
database: test
authenticationDatabase: admin
server:
port: 9000
http2:
enabled: true
4.5 首先是POJO層
新建User類,其中@Document(value = "users")是聲明使用的是Mongodb:
@ToString
@EqualsAndHashCode(of = {"id","name","department"})
@AllArgsConstructor
@NoArgsConstructor
@Data
@Document(value = "users")
public class User {
@Id
private String id;
private String name;
private int age;
private double salary;
private String department;
}
Repository:
@Repository
public interface UserRepository extends ReactiveMongoRepository<User, String> {
}
4.6 新建Service層:
@Service
@Slf4j
@RequiredArgsConstructor
@Transactional
public class UserService {
private final ReactiveMongoTemplate reactiveMongoTemplate;
private final UserRepository userRepository;
public Mono<User> createUser(User user){
return userRepository.save(user);
}
public Flux<User> getAllUsers(){
return userRepository.findAll();
}
public Mono<User> findById(String userId){
return userRepository.findById(userId);
}
public Mono<User> updateUser(String userId, User user){
return userRepository.findById(userId)
.flatMap(dbUser -> {
dbUser.setAge(user.getAge());
dbUser.setSalary(user.getSalary());
return userRepository.save(dbUser);
});
}
public Mono<User> deleteUser(String userId){
return userRepository.findById(userId)
.flatMap(existingUser -> userRepository.delete(existingUser)
.then(Mono.just(existingUser)));
}
public Flux<User> fetchUsers(String name) {
Query query = new Query().with(Sort.by(Collections.singletonList(Sort.Order.asc("age"))));
query.addCriteria(Criteria.where("name").regex(name));
return reactiveMongoTemplate.find(query, User.class);
}
}
4.7 Controller層
@RequiredArgsConstructor
@RestController
@RequestMapping("/users")
public class UserController {
private final UserService userService;
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public Mono<User> create(@RequestBody User user){
return userService.createUser(user);
}
@GetMapping
public Flux<User> getAllUsers(){
return userService.getAllUsers();
}
@GetMapping("/{userId}")
public Mono<ResponseEntity<User>> getUserById(@PathVariable String userId){
Mono<User> user = userService.findById(userId);
return user.map(ResponseEntity::ok)
.defaultIfEmpty(ResponseEntity.notFound().build());
}
@PutMapping("/{userId}")
public Mono<ResponseEntity<User>> updateUserById(@PathVariable String userId, @RequestBody User user){
return userService.updateUser(userId,user)
.map(ResponseEntity::ok)
.defaultIfEmpty(ResponseEntity.badRequest().build());
}
@DeleteMapping("/{userId}")
public Mono<ResponseEntity<Void>> deleteUserById(@PathVariable String userId){
return userService.deleteUser(userId)
.map( r -> ResponseEntity.ok().<Void>build())
.defaultIfEmpty(ResponseEntity.notFound().build());
}
@GetMapping("/search")
public Flux<User> searchUsers(@RequestParam("name") String name) {
return userService.fetchUsers(name);
}
@GetMapping(value = "/stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
public Flux<User> streamAllUsers() {
return userService
.getAllUsers()
.flatMap(user -> Flux.zip(Flux.interval(Duration.ofSeconds(2)),
Flux.fromStream(Stream.generate(() -> user))).map(Tuple2::getT2));
}
}
4.8 新建Spring Boot啟動類
@EnableMongoAuditing
@EnableReactiveMongoRepositories
@SpringBootApplication
public class WebFluxApplication {
public static void main(String[] args) {
SpringApplication.run(WebFluxApplication.class, args);
}
}
4.9 測試
在沒有插入任何數(shù)據(jù)前,mongodb中的數(shù)據(jù)為空:
打開swagger-ui:http://localhost:9000/swagger-ui.html
試圖插入user.id="1"的數(shù)據(jù):



也可通過單元測試來測試UserRepository:
參考:https://github.com/eugenp/tutorials/tree/master/persistence-modules/spring-data-mongodb-reactive/src/test/java/com/baeldung/reactive/repository
@SpringBootTest
public class UserRepositoryTest {
@Autowired
private UserRepository userRepository;
@Test
public void tes() {
Mono<User> userMono = userRepository.findById("1");
StepVerifier.create(userMono)
.assertNext(u -> {
Assertions.assertEquals("bill", u.getName());
})
.expectComplete()
.verify();
}
}
也可以用WebClient測試:
參考:https://github.com/eugenp/tutorials/blob/master/spring-reactive-modules/spring-reactive/src/main/java/com/baeldung/reactive/webclient/WebController.java
@Slf4j
@SpringBootTest(classes = WebFluxApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class EmployeeWebClientTest {
@LocalServerPort
private int port;
@Test
public void whenBindToController_thenRequestProcessed() throws InterruptedException {
Flux<User> userFlux = WebClient.create()
.get()
.uri("http://localhost:" + port + "/users")
.retrieve()
.bodyToFlux(User.class);
userFlux.log().subscribe(user -> log.info(user.toString()));
Thread.sleep(100000L);
}
}
日志:
2023-01-26 23:20:53.789 INFO 38308 --- [ main] reactor.Flux.MonoFlatMapMany.1 : onSubscribe(MonoFlatMapMany.FlatMapManyMain)
2023-01-26 23:20:53.791 INFO 38308 --- [ main] reactor.Flux.MonoFlatMapMany.1 : request(unbounded)
2023-01-26 23:20:55.051 INFO 38308 --- [ntLoopGroup-3-3] org.mongodb.driver.connection : Opened connection [connectionId{localValue:3, serverValue:112}] to 127.0.0.1:27017
2023-01-26 23:20:55.175 INFO 38308 --- [ctor-http-nio-3] reactor.Flux.MonoFlatMapMany.1 : onNext(User(id=1, name=bill, age=18, salary=1000.0, department=dept-a))
2023-01-26 23:20:55.182 INFO 38308 --- [ctor-http-nio-3] com.webflux.EmployeeWebClientTest : User(id=1, name=bill, age=18, salary=1000.0, department=dept-a)
2023-01-26 23:20:55.182 INFO 38308 --- [ctor-http-nio-3] reactor.Flux.MonoFlatMapMany.1 : onComplete()