使用 WebFlux 开发一个 CURD 应用

WebFlux 最为人所诟病的是数据库的支持问题,毕竟数据是一个应用的生命,我们接触的大部分应用程序都是有数据库的,而 WebFlux 在这一方面的支持行一直比较弱,这也是大家总是吐槽它的原因。

不过从 Spring 5 开始,这一问题得到了一定程度的缓解。

Spring 官方在 Spring5 发布了响应式 Web 框架 Spring WebFlux 之后急需能够满足异步响应的数据库交互 API,不过由于缺乏标准和驱动,Pivotal 团队开始自己研究响应式关系型数据库连接 Reactive Relational Database Connectivity,并提出了 R2DBC 规范 API 用来评估可行性并讨论数据库厂商是否有兴趣支持响应式的异步非阻塞驱动程序。最早只有 PostgreSQL 、H2、MSSQL 三家数据库厂商,不过现在 MySQL 也加入进来了,这是一个极大的利好。目前 R2DBC 的最新版本是 0.9.0.RELEASE。

本系列接下来的文章中将会和大家演示 R2DBC 的用法,但是今天我们还是先来看看 WebFlux + MongoDB 的用法,毕竟这是 WebFlux 较早支持的数据库之一,各种 API 都比较成熟,我们一步一步来。

1、项目创建

方便起见,我们这里就直接创建 Spring Boot 项目,首先创建一个 Spring Boot 项目,引入 MongoDB 依赖和 WebFlux 依赖,如下:

Spring Data Reactive MongoDB 依赖

注意我们这里选择的 MongoDB 依赖是 Spring Data Reactive MongoDB,千万别选错了。

项目创建完成后,我们先在 application.properties 中对 MongoDB 进行简单配置,如下:

spring.data.mongodb.port=27017
spring.data.mongodb.host=127.0.0.1
spring.data.mongodb.username=madmin
spring.data.mongodb.password=m123
spring.data.mongodb.database=test
spring.data.mongodb.authentication-database=admin

配置完 MongoDB 后,我们的准备工作就算完成了。

2、实体类与 DAO

接下来我们需要准备一个操作的实体类,这些都是 JPA 的基本操作,这里不再赘述。

实体类如下:

@Document
public class User {
    @Id
    private String id;
    private String username;
    private String address;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}

接下来我们再提供一个实体类操作的接口,如下:

@EnableMongoRepositories
public interface UserDao extends ReactiveMongoRepository<User,String> {
}

自定义一个空的接口继承自 ReactiveMongoRepository,里边什么都不用写,这和 JPA 的用法如出一辙(毕竟都是 Spring Data 家族),所以这块就没啥好说的,不赘述。

3、测试接口

接下来我们来看看测试接口。

3.1、添加

首先我们来看看添加数据。

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    UserDao userDao;

    @PostMapping("/")
    public Mono<User> addUser(@RequestBody User user) {
        return userDao.save(user);
    }
}

添加完成后,返回刚刚添加成功的对象。save 方法的返回值就是 Mono

我们来看看测试效果:

save 方法的测试结果

3.2、查询

再来看看查询效果:

@GetMapping("/")
public Flux<User> getAll() {
    return userDao.findAll();
}
@GetMapping(value = "/stream/all", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
public Flux<User> streamGetAll() {
    return userDao.findAll();
}

我们提供了两个查询接口,一个就是返回 Flux,里边包含多个对象,还有一个我设置了响应的 Content-Typetext/event-stream,通过响应式流返回数据。

我们来看看查询效果:

Postman 请求端点

Postman 中的响应

可以看到两种不同的查询方式返回的数据格式也有差异。前者是以数组形式一次性返回数据,后者是以 SSE 的形式多次返回数据。

3.3、删除

再来看看删除。

按照 RESTful 规范,如果删除成功请求响应码就是 200,如果删除失败请求响应码就是 404,因此,我们开发出来的接口如下:

@DeleteMapping("/{id}")
public Mono<ResponseEntity<Void>> deleteUser(@PathVariable String id) {
    return userDao.findById(id)
            .flatMap(user -> userDao.delete(user).then(Mono.just(new ResponseEntity<Void>(HttpStatus.OK))))
            .defaultIfEmpty(new ResponseEntity(HttpStatus.NOT_FOUND));
}

首先从数据库中查询出相关的数据,然后调用 flatMap,在 flatMap 中对数据进行删除处理,删除完成后,给出一个 200 的响应码,如果查询的时候没有查询到数据,就给一个 404 响应码。

可以看到,删除成功后,响应码为 200:

Postman 删除请求,响应 200

删除失败后,响应码为 404:

Postman 删除请求,响应 404

3.4、修改

再来看看修改,和前面的删除类似,先查询,再修改:

@PutMapping("/")
public Mono<ResponseEntity<User>> updateUser(@RequestBody User user) {
    return userDao.findById(user.getId())
            .flatMap(u -> userDao.save(user))
            .map(u->new ResponseEntity<User>(u,HttpStatus.OK))
            .defaultIfEmpty(new ResponseEntity(HttpStatus.NOT_FOUND));
}

Postman 修改请求

如果修改的数据不存在的话,就会给出一个 404 响应:

Postman 修改请求响应 404

3.5、自定义查询方法

Spring Data Jpa 中的一些查询 API,同样是适用于这里。

例如我们可以在 UserDao 中自定义一个查询方法:

@EnableMongoRepositories
public interface UserDao extends ReactiveMongoRepository<User,String> {
    Flux<User> findUserByUsernameContaining(String name);
}

然后添加一个接口调用该方法:

@GetMapping("/byname")
public Flux<User> getUserByName(String name) {
    return userDao.findUserByUsernameContaining(name);
}

这样该接口就可以查询名字中包含某关键字的所有用户了。

其他关于 JPA 的用法这里都是适用的,这里就不再赘述了。你可以参阅 其中文文档

4、小结

本文介绍了如何使用 WebFlux 开发一个简单的 CURD 应用,旨在让大家初步体验 WebFlux 的基本用法。


参考:https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247505813&idx=2&sn=ab62b24ccdd965c45b757697dd7f5781