赞
踩
本系列文章索引《响应式Spring的道法术器》
前情提要 lambda与函数式 | Reactor 3快速上手
本文源码
Spring WebFlux是随Spring 5推出的响应式Web框架。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-lvETf31S-1612524681374)(https://leanote.com/api/file/getImage?fileId=5a929813ab644121e3000f8c)]
1)服务端技术栈
Spring提供了完整的支持响应式的 服务端技术栈。
如上图所示,左侧为基于spring-webmvc的技术栈,右侧为基于spring-webflux的技术栈,
@Controller
、@RequestMapping
)的开发模式;由此看来,Spring WebFlux与Vert.x有一些相通之处,都是建立在
- 非阻塞的异步I/O和
- 事件驱动的 基础之上的。
2)响应式Http客户端
此外,Spring WebFlux也提供了一个
WebClient
。它可以用函数式的方式异步非阻塞地发起Http请求并处理响应。我们可以把WebClient
看做是响应式的RestTemplate
,与后者相比,前者:
当然,与服务端对应的,Spring WebFlux也提供了响应式的Websocket客户端API。
简单介绍这些,让我们来Coding吧~
本节,我们通过以下几个例子来逐步深入地了解它的使用方法:
WebClient
与前几步做好的服务端 进行通信;Spring Boot 2是基于 Spring 5的,其中一个比较大的更新就在于支持包括
我们首先用Spring WebMVC开发一个只有Controller层的简单的Web服务,然后仅仅做一点点调整就可切换为基于Spring WebFlux的具有同样功能的Web服务。
我们使用Spring Boot 2搭建项目框架。
以下截图来自IntelliJ IDEA,不过其他IDE也都是类似的。
1)基于Spring Initializr创建项目
本节的例子很简单,不涉及Service层和Dao层,因此只选择spring-webmvc即可,也就是“Web”的starter。
也可以使用网页版的https://start.spring.io来创建项目:
创建后的项目POM中,包含下边的依赖,即表示基于Spring WebMVC:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
2)创建Controller和Endpoint
创建Controller类HelloController
,仅提供一个Endpoint:/hello
:
@RestController
public class HelloController {
@GetMapping("/hello")
public String hello() {
return "Welcome to reactive world ~";
}
}
3)启动应用
OK了,一个简单的基于Spring WebMVC的Web服务。我们新增了HelloController.java
,修改了application.properties
。
使用IDE启动应用,或使用maven命令:
mvn spring-boot:run
通过打印的log可以看到,服务运行于Tomcat的8080端口:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wuAjd6DJ-1612524681377)(https://leanote.com/api/file/getImage?fileId=5a9d391dab64417b7a0018dc)]
测试Endpoint。在浏览器中访问http://localhost:8080/hello
,或运行命令:
curl http://localhost:8080/hello
返回Welcome to reactive world ~
。
基于Spring WebFlux的项目与上边的步骤一致,仅有两点不同。我们这次偷个懒,就不从新建项目了,修改一下上边的项目:
4)依赖“Reactive Web”的starter而不是“Web”
修改项目POM,调整依赖使其基于Spring WebFlux:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-WebFlux</artifactId> <!--【改】增加“flux”四个字符-->
</dependency>
5)Controller中处理请求的返回类型采用响应式类型
@RestController
public class HelloController {
@GetMapping("/hello")
public Mono<String> hello() { // 【改】返回类型为Mono<String>
return Mono.just("Welcome to reactive world ~"); // 【改】使用Mono.just生成响应式数据
}
}
6)启动应用
仅需要上边两步就改完了,是不是很简单,同样的方法启动应用。启动后发现应用运行于Netty上:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5PSMIg7V-1612524681378)(https://leanote.com/api/file/getImage?fileId=5a9d3947ab64417d9f001bc7)]
访问http://localhost:8080/hello
,结果与Spring WebMVC的相同。
7)总结
从上边这个非常非常简单的例子中可以看出,Spring真是用心良苦,WebFlux提供了与之前WebMVC相同的一套注解来定义请求的处理,使得Spring使用者迁移到响应式开发方式的过程变得异常轻松。
虽然我们只修改了少量的代码,但是其实这个简单的项目已经脱胎换骨了。整个技术栈从命令式的、
Netty是
下边的内容了解即可,就不实战了。
在Java 7推出异步I/O库,以及Servlet3.1增加了对异步I/O的支持之后,Tomcat等Servlet容器也随后开始支持异步I/O,然后Spring WebMVC也增加了对Reactor库的支持,所以上边第4)步如果不是将spring-boot-starter-web
替换为spring-boot-starter-WebFlux
,而是增加
reactor-core
的依赖的话,仍然可以用注解的方式开发基于Tomcat的响应式应用。
既然是响应式编程了,有些朋友可能会想统一用函数式的编程风格,WebFlux满足你。WebFlux提供了一套函数式接口,可以用来实现类似MVC的效果。我们先接触两个常用的。
再回头瞧一眼上边例子中我们用Controller
定义定义对Request的处理逻辑的方式,主要有两个点:
@RequestMapping
注解定义好这个方法对什么样url进行响应。在WebFlux的函数式开发模式中,我们用HandlerFunction
和RouterFunction
来实现上边这两点。
HandlerFunction
相当于Controller
中的具体处理方法,输入为请求,输出为装在Mono
中的响应: Mono<T extends ServerResponse> handle(ServerRequest request);
RouterFunction
,顾名思义,路由,相当于@RequestMapping
,用来判断什么样的url映射到那个具体的HandlerFunction
,输入为请求,输出为装在Mono里边的Handlerfunction
: Mono<HandlerFunction<T>> route(ServerRequest request);
我们看到,在WebFlux中,请求和响应不再是WebMVC中的ServletRequest
和ServletResponse
,而是ServerRequest
和ServerResponse
。后者是在响应式编程中使用的接口,
下面我们用函数式的方式开发两个Endpoint:
/time
返回 当前的时间;/date
返回 当前的日期。对于这两个需求,HandlerFunction很容易写:
// 返回包含时间字符串的ServerResponse
//状态为ok,内容为:"text", "plain",body为 单个String为 Now is HH:mm:ss ,为string
HandlerFunction<ServerResponse> timeFunction =
request -> ServerResponse.ok().contentType(MediaType.TEXT_PLAIN).body(
Mono.just("Now is " + new SimpleDateFormat("HH:mm:ss").format(new Date())), String.class);
// 返回包含日期字符串的ServerResponse
HandlerFunction<ServerResponse> dateFunction =
request -> ServerResponse.ok().contentType(MediaType.TEXT_PLAIN).body(
Mono.just("Today is " + new SimpleDateFormat("yyyy-MM-dd").format(new Date())), String.class);
那么RouterFunction为:
RouterFunction<ServerResponse> router =
RouterFunctions.route(GET("/time"), timeFunction)
.andRoute(GET("/date"), dateFunction);
按照常见的套路,
RouterFunctions
是工具类。
不过这么写在业务逻辑复杂的时候不太好组织,我们通常采用跟MVC类似的代码组织方式,将同类业务的HandlerFunction放在一个类中,然后在Java Config中将RouterFunction配置为Spring容器的Bean。我们继续在第一个例子的代码上开发:
1)创建统一存放处理时间的Handler类
创建TimeHandler.java
:
import static org.springframework.web.reactive.function.server.ServerResponse.ok;
@Component
public class TimeHandler {
public Mono<ServerResponse> getTime(ServerRequest serverRequest) {
return ok().contentType(MediaType.TEXT_PLAIN).body(Mono.just("Now is " + new SimpleDateFormat("HH:mm:ss").format(new Date())), String.class);
}
public Mono<ServerResponse> getDate(ServerRequest serverRequest) {
return ok().contentType(MediaType.TEXT_PLAIN).body(Mono.just("Today is " + new SimpleDateFormat("yyyy-MM-dd").format(new Date())), String.class);
}
}
由于出现次数通常比较多,这里静态引入ServerResponse.ok()
方法。
2)在Spring容器配置RouterFunction
我们采用Spring现在比较推荐的Java Config的配置Bean的方式,创建用于存放Router的配置类RouterConfig.java
:
import static org.springframework.web.reactive.function.server.RequestPredicates.GET;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;
@Configuration
public class RouterConfig {
@Autowired
private TimeHandler timeHandler;
@Bean
public RouterFunction<ServerResponse> timerRouter() {
return route(GET("/time"), req -> timeHandler.getTime(req))
.andRoute(GET("/date"), timeHandler::getDate); // 这种方式相对于上一行更加简洁
}
}
3)重启服务试一试
重启服务测试一下吧:
$ curl http://localhost:8080/date
Today is 2018-02-26
$ curl http://localhost:8080/time
Now is 21:12:53
我们可能会遇到一些需要 网页与服务器端 保持连接(起码看上去是保持连接)的需求,
比如类似微信网页版的聊天类应用,
比如需要频繁更新页面数据的监控系统页面或股票看盘页面。我们通常采用如下几种技术:
既然响应式编程是一种 基于数据流 的编程范式,自然在服务器推送方面得心应手,我们基于函数式方式再增加一个Endpoint /times
,可以每秒推送一次时间。
1)增加Handler方法
TimeHandler.java
:
public Mono<ServerResponse> sendTimePerSec(ServerRequest serverRequest) {
return ServerResponse.ok().contentType(MediaType.TEXT_EVENT_STREAM).body(
// 1 每秒执行一次
Flux.interval(Duration.ofSeconds(1))
// 2 内容为 当前时间 格式化,变成string data:11:07:12
.map(l -> new SimpleDateFormat("HH:mm:ss").format(new Date())),
String.class);
}
MediaType.TEXT_EVENT_STREAM
表示Content-Type
为text/event-stream
,即SSE;2)配置router
RouterConfig.java
:
@Bean
public RouterFunction<ServerResponse> timerRouter() {
return route(GET("/time"), timeHandler::getTime)
.andRoute(GET("/date"), timeHandler::getDate)
.andRoute(GET("/times"), timeHandler::sendTimePerSec); // 增加这一行
}
3)重启服务试一下
重启服务后,测试一下:
curl http://localhost:8080/times
data:21:32:22
data:21:32:23
data:21:32:24
data:21:32:25
data:21:32:26
<Ctrl+C>
就酱,访问这个url会收到持续不断的报时数据(时间数据是在data
中的)。
那么用 注解的方式 如何进行服务端推送呢,这个演示就融到下一个例子中吧~
开发基于 响应式流的应用,就像是在 搭建数据流 流动的管道,从而异步的数据能够顺畅流过每个环节。前边的例子主要聚焦于应用层,然而绝大多数系统免不了要与数据库进行交互,所以我们也需要 响应式的持久层API和 支持异步的数据库驱动。就像从自来水厂到家里水龙头这个管道中,如果任何一个环节发生了阻塞,那就可能造成整体吞吐量的下降。
各个数据库都开始陆续推出异步驱动,目前Spring Data支持的可以进行 响应式数据访问的数据库有 MongoDB、Redis、Apache Cassandra 和 CouchDB。今天我们用MongoDB来写一个响应式demo。
我们这个例子很简单,就是关于User
的增删改查,以及基于注解的服务端推送。
1)编写User
既然是举例,我们随便定义几个属性吧~
public class User {
private String id;
private String username;
private String phone;
private String email;
private String name;
private Date birthday;
}
然后为了方便开发,我们引入lombok库,它能够通过注解的方式为我们添加必要的Getter/Setter/hashCode()/equals()/toString()/构造方法等,添加依赖(版本可自行到http://search.maven.org搜索最新):
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.20</version>
</dependency>
然后为User
添加注解:
@Data // 生成无参构造方法/getter/setter/hashCode/equals/toString
@AllArgsConstructor // 生成所有参数构造方法
@NoArgsConstructor // @AllArgsConstructor会导致@Data不生成无参构造方法,需要手动添加@NoArgsConstructor,如果没有无参构造方法,可能会导致比如com.fasterxml.jackson在序列化处理时报错
public class User {
...
我们可以利用IDE看一下生成的方法(如下图黄框所示):
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rMzsVVGF-1612524681405)(https://leanote.com/api/file/getImage?fileId=5a94c32aab64415b37000523)]
可能需要先在IDE中进行少量配置以便支持lombok的注解,比如IntelliJ IDEA:
- 安装“lombok plugin”:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EoRMdOLS-1612524681407)(https://leanote.com/api/file/getImage?fileId=5a94c412ab64415b3700054b)]- 开启对注解编译的支持:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-bsRtnwgV-1612524681408)(https://leanote.com/api/file/getImage?fileId=5a94c46aab64415b37000550)]
lombok对于Java开发者来说绝对算是个福音了,希望使用Kotlin的朋友不要笑话我们土哦~
2)增加Spring Data的依赖
在POM中增加Spring Data Reactive Mongo的依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb-reactive</artifactId>
</dependency>
MongoDB是文档型的NoSQL数据库,因此,我们使用@Document
注解User
类:
@Data
@AllArgsConstructor
@Document
public class User {
@Id
private String id; // 注解属性id为ID
@Indexed(unique = true) // 注解属性username为索引,并且不能重复
private String username;
private String name;
private String phone;
private Date birthday;
}
OK,这样我们的模型就准备好了。MongoDB会自动创建collection,默认为类名首字母小写,也就是user
。
3)配置数据源
Spring Boot为我们搞定了几乎所有的配置,太赞了,下边是MongoDB的默认配置:
# MONGODB (MongoProperties)
spring.data.mongodb.authentication-database= # Authentication database name.
spring.data.mongodb.database=test # Database name.
spring.data.mongodb.field-naming-strategy= # Fully qualified name of the FieldNamingStrategy to use.
spring.data.mongodb.grid-fs-database= # GridFS database name.
spring.data.mongodb.host=localhost # Mongo server host. Cannot be set with uri.
spring.data.mongodb.password= # Login password of the mongo server. Cannot be set with uri.
spring.data.mongodb.port=27017 # Mongo server port. Cannot be set with uri.
spring.data.mongodb.repositories.enabled=true # Enable Mongo repositories.
spring.data.mongodb.uri=mongodb://localhost/test # Mongo database URI. Cannot be set with host, port and credentials.
spring.data.mongodb.username= # Login user of the mongo server. Cannot be set with uri.
请根据需要添加自定义的配置,比如我的MongoDB是跑在IP为192.168.0.101的虚拟机的Docker中的,就可在application.properties
中增加一条:
spring.data.mongodb.host=192.168.0.101
4)增加DAO层repository
与非响应式Spring Data的CrudReposity
对应的,响应式的Spring Data也提供了相应的Repository库:ReactiveCrudReposity
,
ReactiveMongoRepository
。我们增加UserRepository
:
public interface UserRepository extends ReactiveCrudRepository<User, String> { // 1
Mono<User> findByUsername(String username); // 2
Mono<Long> deleteByUsername(String username);
}
ReactiveCrudRepository
的泛型分别是User
和ID
的类型;ReactiveCrudRepository
已经提供了基本的增删改查的方法,根据业务需要,我们增加四个方法(在此膜拜一下Spring团队的牛人们,使得我们仅需按照规则定义接口方法名即可完成DAO层逻辑的开发,牛~)5)Service层
由于业务逻辑几乎为零,只是简单调用了DAO层,直接贴代码:
@Service public class UserService { @Autowired private UserRepository userRepository; /** * 保存或更新。 * 如果传入的user没有id属性,由于username是unique的,在重复的情况下有可能报错, * 这时找到以保存的user记录用传入的user更新它。 */ public Mono<User> save(User user) { //如果插入出错,就根据name拿到ID,进行更新 return userRepository.save(user) .onErrorResume(e -> // 1 userRepository.findByUsername(user.getUsername()) // 2 .flatMap(originalUser -> { // 4 user.setId(originalUser.getId()); return userRepository.save(user); // 3 })); } public Mono<Long> deleteByUsername(String username) { return userRepository.deleteByUsername(username); } public Mono<User> findByUsername(String username) { return userRepository.findByUsername(username); } public Flux<User> findAll() { return userRepository.findAll(); } }
onErrorResume
进行错误处理;User -> Publisher
,所以用flatMap
。6)Controller层
直接贴代码:
@RestController @RequestMapping("/user") public class UserController { @Autowired private UserService userService; @PostMapping("") public Mono<User> save(User user) { return this.userService.save(user); } @DeleteMapping("/{username}") public Mono<Long> deleteByUsername(@PathVariable String username) { return this.userService.deleteByUsername(username); } @GetMapping("/{username}") public Mono<User> findByUsername(@PathVariable String username) { return this.userService.findByUsername(username); } @GetMapping("") public Flux<User> findAll() { return this.userService.findAll(); } }
7)启动应用测试一下
由于涉及到POST和DELETE方法的请求,建议用支持RESTful的client来测试,比如“Restlet client”:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-BW2v771W-1612524681408)(https://leanote.com/api/file/getImage?fileId=5a95091cab64415d3400134a)]
如图,增加操作是成功的,只要username不变,再次发送请求会更新该记录。
图中birthday的时间差8小时,不去管它。
用同样的方法增加一个李四,之后我们再来测试一下查询。
{
"id": "5a9504a167646d057051e229",
"username": "zhangsan",
"name": "张三",
"phone": "18610861861",
"birthday": "1989-12-31T16:00:00.000+0000"
}
[{"id":"5a9504a167646d057051e229","username":"zhangsan","name":"张三","phone":"18610861861","birthday":"1989-12-31T16:00:00.000+0000"},{"id":"5a9511db67646d3c782f2e7f","username":"lisi","name":"李四","phone":"18610861862","birthday":"1992-02-01T16:00:00.000+0000"}]
测试一下删除(METHOD:DELETE URL:http://localhost:8080/user/zhangsan),返回值为1,再查询全部,发现张三已经被删除了,OK。
8)stream+json
看到这里细心的朋友可能会有点嘀咕,怎么看是不是异步的呢?毕竟查询全部的时候,结果都用中括号括起来了,这和原来返回List<User>
的效果似乎没多大区别。假设一下查询100个数据,如果是异步的话,以我们对“异步响应式流”的印象似乎应该是一个一个至少是一批一批的到达客户端的嘛。我们加个延迟验证一下:
@GetMapping("")
public Flux<User> findAll() {
return this.userService.findAll().delayElements(Duration.ofSeconds(1));
}
每个元素都延迟1秒,现在我们在数据库里弄三条记录,然后请求查询全部的那个URL,发现并不是像/times
一样一秒一个地出来,而是3秒之后一块儿出来的。果然如此,这一点都不响应式啊!
与/times
类似,我们也加一个MediaType,不过由于这里返回的是JSON,因此不能使用TEXT_EVENT_STREAM
,而是使用APPLICATION_STREAM_JSON
,即application/stream+json
格式。
@GetMapping(value = "", produces = MediaType.APPLICATION_STREAM_JSON_VALUE)
public Flux<User> findAll() {
return this.userService.findAll().delayElements(Duration.ofSeconds(2));
}
produces
后边的值应该是application/stream+json
字符串,因此用APPLICATION_STREAM_JSON_VALUE
。重启服务再次请求,发现三个user是一秒一个的速度出来的,中括号也没有了,而是一个一个独立的JSON值构成的json stream:
{"id":"5a9504a167646d057051e229","username":"zhangsan","name":"张三","phone":"18610861861","birthday":"1989-12-31T16:00:00.000+0000"}
{"id":"5a9511db67646d3c782f2e7f","username":"lisi","name":"李四","phone":"18610861862","birthday":"1992-02-01T16:00:00.000+0000"}
{"id":"5a955f08fa10b93ec48df37f","username":"wangwu","name":"王五","phone":"18610861865","birthday":"1995-05-04T16:00:00.000+0000"}
9)总结
如果有Spring Data开发经验的话,切换到Spring Data Reactive的难度并不高。跟Spring WebFlux类似:原来返回User
的话,那现在就返回Mono<User>
;原来返回List<User>
的话,那现在就返回Flux<User>
。
对于稍微复杂的业务逻辑或一些必要的异常处理,比如上边的save方法,请一定采用响应式的编程方式来定义,从而一切都是异步非阻塞的。如下图所示,
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OknXRMB5-1612524681409)(https://leanote.com/api/file/getImage?fileId=5a93885bab64417fd90007c1)]
WebClient
开发响应式Http客户端下面,我们用WebClient测试一下前边几个例子的成果。
1) /hello,返回Mono
@Test
public void webClientTest1() throws InterruptedException {
WebClient webClient = WebClient.create("http://localhost:8080"); // 1
Mono<String> resp = webClient
.get().uri("/hello") // 2
.retrieve() // 3
.bodyToMono(String.class); // 4
resp.subscribe(System.out::println); // 5
TimeUnit.SECONDS.sleep(1); // 6
}
WebClient
对象并指定baseUrl;CountDownLatch
。运行效果如下:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Kdc4W2YH-1612524681410)(https://leanote.com/api/file/getImage?fileId=5a9513e7ab64415d34003abd)]
2) /user,返回Flux
为了多演示一些不同的实现方式,下边的例子我们调整几个地方,但是效果跟上边是一样的:
@Test
public void webClientTest2() throws InterruptedException {
WebClient webClient = WebClient.builder().baseUrl("http://localhost:8080").build(); // 1
webClient
.get().uri("/user")
.accept(MediaType.APPLICATION_STREAM_JSON) // 2
.exchange() // 3
.flatMapMany(response -> response.bodyToFlux(User.class)) // 4
.doOnNext(System.out::println) // 5
.blockLast(); // 6
}
这次我们使用WebClientBuilder来构建WebClient对象;
配置请求Header:Content-Type: application/stream+json;
获取response信息,返回值为ClientResponse,retrive()可以看做是exchange()方法的“快捷版”;
使用flatMap来将ClientResponse映射为Flux;
只读地peek每个元素,然后打印出来,它并不是subscribe,所以不会触发流;
上个例子中sleep的方式有点low,blockLast方法,顾名思义,在收到最后一个元素前会阻塞,响应式业务场景中慎用。
运行效果如下:
title
3) /times,服务端推送
@Test
public void webClientTest3() throws InterruptedException {
WebClient webClient = WebClient.create("http://localhost:8080");
webClient
.get().uri("/times")
.accept(MediaType.TEXT_EVENT_STREAM) // 1
.retrieve()
.bodyToFlux(String.class)
.log() // 2
.take(10) // 3
.blockLast();
}
配置请求Header:Content-Type: text/event-stream,即SSE;
这次用log()代替doOnNext(System.out::println)来查看每个元素;
由于/times是一个无限流,这里取前10个,会导致流被取消;
运行效果如下:
title
1.3.3.5 让数据在Http上双向无限流动起来
学不动了
https://blog.51cto.com/liukang/2090198
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。