WebFlux写CURD详细步骤教程

在现代的异步、响应式应用中，WebFlux是Spring框架提供的一种强大的响应式编程模型，允许你构建非阻塞的、事件驱动的应用程序。

结合MySQL数据库，使用R2DBC（Reactive Relational Database Connectivity）来实现响应式的数据库访问。

本文将介绍如何使用WebFlux来操作MySQL数据库。

1.项目创建

我们这里就直接创建 Spring Boot 项目，首先创建一个 Spring Boot 项目，添加 依赖，完整项目结构如下

1.1.在pom.xml中添加依赖

首先，在你的Spring Boot项目中，确保添加了WebFlux和R2DBC MySQL的依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.7.15</version>
    </parent>

    <groupId>com.zbbmeta</groupId>
    <artifactId>zbbmeta-webflux-curd-mysql</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.23</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-r2dbc</artifactId>
        </dependency>


        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>dev.miku</groupId>
            <artifactId>r2dbc-mysql</artifactId>
            <version>0.8.2.RELEASE</version>
        </dependency>

    </dependencies>

</project>

1.2.配置数据库连接信息

在application.properties或application.yml中配置MySQL数据库的连接信息。

server:
  port: 8800


spring:
  r2dbc:
    url:  r2dbc:mysql://localhost:3306/backend_db?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT
    username: root
    password: root

注意:这里url开头是r2dbc

3.创建实体类

create table backend_db.tb_tutorial
(
    id          bigint auto_increment comment '主键ID'
        primary key,
    title       varchar(40) null comment '标题',
    description varchar(30) null comment '描述',
    published   tinyint     null comment '1 表示发布 0 表示未发布'
);

创建与数据库表对应的实体类。例如，如果有一个tb_tutorial表，可以创建一个Tutorial类。

package com.zbbmeta.entity;

import lombok.Data;
import org.springframework.data.annotation.Id;
import org.springframework.data.relational.core.mapping.Table;

/**
 * @author springboot
 * @description: TODO
 */
@Data
@Table("tb_tutorial")
public class Tutorial {
    @Id
    private Long id;

    private String title;

    private String description;
    private Integer published;
}

4.创建Repository接口

使用Spring Data R2DBC创建一个Repository接口，继承自ReactiveCrudRepository，用于操作数据库。

package com.zbbmeta.repositpry;

import com.zbbmeta.entity.Tutorial;
import org.springframework.data.repository.reactive.ReactiveCrudRepository;
import reactor.core.publisher.Mono;

/**
 * @author springboot
 * @description: TODO
 */
public interface TutorialRepository extends ReactiveCrudRepository<Tutorial, Long> {

}

5. 创建WebFlux Controller

创建一个WebFlux Controller来处理HTTP请求，并调用Repository进行数据库操作。

package com.zbbmeta.controller;

import com.zbbmeta.entity.Tutorial;
import com.zbbmeta.service.TutorialService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

/**
 * @author springboot
 * @description: TODO
 */
@RestController
@RequestMapping("/tutorial")
public class TutorialController {

    @Autowired
    private TutorialService tutorialService;

    @PostMapping
    public Mono<Tutorial> addTutorial(@RequestBody Tutorial tutorial) {
        return tutorialService.addTutorial(tutorial);
    }

    @DeleteMapping("/{id}")
    public Mono<ResponseEntity<Void>> delTutorial(@PathVariable Long id) {
        return tutorialService.delTutorial(id);
    }

    @PutMapping
    public Mono<ResponseEntity< Tutorial>> updateTutorial(@RequestBody Tutorial tutorial) {
        return tutorialService.updateTutorial(tutorial);
    }

    @GetMapping
    public Flux< Tutorial> getAllUser() {
        return tutorialService.getAllTutorial();
    }
}

6.测试

6.1. 查询

GET请求 http://localhost:8800/tutorial进行测试

6.2. 添加

POST请求 http://localhost:8800/tutorial进行测试

{

    "title": "K8S从入门到精通6666",
    "description": "K8S从入门到精通44664",
    "published": 1
}

6.3. 删除

DELETE请求 http://localhost:8800/tutorial/{id}进行测试

删除成功后，响应码为 200

删除失败后，响应码为 404

7.自定义查询方法

在步骤4中，创建Repository接口是为了使用Spring Data R2DBC来简化与数据库的交互。Repository接口继承自ReactiveCrudRepository，它提供了一组基本的CRUD（Create、Read、Update、Delete）操作方法，同时支持响应式编程模型。

除了继承的标准CRUD方法外，还可以在Repository接口中定义自己的查询方法。Spring Data R2DBC会根据方法的命名规则自动生成查询语句。

在这个例子中，findByTitle是自定义查询方法，分别用于根据Title条件查询tutorial信息。

通过创建这样的Repository接口，可以在Controller中注入并使用它的方法来进行数据库操作，而无需编写复杂的SQL语句。

Spring Data R2DBC会根据你的Repository接口定义自动生成SQL查询语句，并提供响应式的方式执行这些查询。

这使得数据库操作变得简单、易于维护，并且符合Spring框架的约定优于配置的思想。