Spring WebFlux 整合 r2dbc 的增删改查案例

无障碍阅读方法

微信公众号关注：张家的小伙子
回复：10205

说明

本文主要讲述使用Spring Boot3 结合Spring WebFlux 和 r2dbc 访问 mysql数据库做增删改查的基础案例。
与常见的阻塞式Spring MVC 不一样，Spring WebFlux为非阻塞响应式的解决方案，底层支持高并发，效率比Spring MVC 更快，资源占用更少。

准备

1. 有java8以上的流式编程基础
2. 有java9以上flow api 以及 Reactor相关知识
3. idea 编程工具
4. jdk17
5. mysql 8
6. maven
7. postman

创建mysql数据库和数据表

 -- 创建数据库
drop database if exists threeCloud;
create database threeCloud charset=utf8mb4 collate=utf8mb4_general_ci;

-- 使用此创建的数据库
use threeCloud;

-- 创建用户表
CREATE TABLE `t_user` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT 'id',
  `username` varchar(255) NOT NULL COMMENT '用户名称',
  `passwd` varchar(255) NOT NULL COMMENT '密码',
  
  PRIMARY KEY (`id`),
  UNIQUE KEY `username` (`username`),
  UNIQUE KEY `phone` (`phone`),
  UNIQUE KEY `idcard` (`idcard`),
  UNIQUE KEY `email` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='用户表';

创建一个maven项目

创建一个maven项目，并创建一个属于本项目的java包存放源码。如下图：

添加项目依赖包

在pom.xml 中加入以下依赖，完整pom.xml 内容如下:

<?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>
    
    <!-- 此处用于定义需要的依赖版本号，方便管理 -->
    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring-boot-maven-plugin.version>3.3.2</spring-boot-maven-plugin.version>
        <spring-boot-starter-webflux.version>3.3.2</spring-boot-starter-webflux.version>
        <spring-boot-starter-data-r2dbc.version>3.3.2</spring-boot-starter-data-r2dbc.version>
        <spring-boot-starter-data-jdbc.version>3.3.2</spring-boot-starter-data-jdbc.version>
        <lombok.version>1.18.22</lombok.version>
        <r2dbc-mysql.version>1.1.3</r2dbc-mysql.version>
        <fastjson2.version>2.0.47</fastjson2.version>
    </properties>

    <groupId>com.three.test.webflux</groupId>
    <artifactId>three-test-webflux</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 新增。r2dbc对于mysql的连接驱动  -->
        <dependency>
            <groupId>io.asyncer</groupId>
            <artifactId>r2dbc-mysql</artifactId>
            <version>${r2dbc-mysql.version}</version>
        </dependency>

		 <!-- 新增。spring webflux 的依赖  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
            <version>${spring-boot-starter-webflux.version}</version>
        </dependency>
		
		<!-- 新增。spring data 对 r2dbc 的依赖  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-r2dbc</artifactId>
            <version>${spring-boot-starter-data-r2dbc.version}</version>
        </dependency>
		
		<!-- 新增。lombok 快速构建工具  -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
        </dependency>

		<!-- 新增。处理json的依赖包  -->
        <dependency>
            <groupId>com.alibaba.fastjson2</groupId>
            <artifactId>fastjson2</artifactId>
            <version>${fastjson2.version}</version>
        </dependency>
    </dependencies>
</project>

创建项目基本目录接口

把项目用到的基础目录结构创建出来，

• 在包下创建目录：config、controller、dao、model、service 以及 WebFluxApplication.java 启动类
• service 下创建impl 和 interfaces 目录
• 在resources下创建 application.yml 配置文件

如下图：

启动类编写

WebFluxApplication.java

package www.zhang.test;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 说明：
 *
 * @author 张小三
 * @create 2024-08-01 9:39
 * @verson 1.0.0
 */
@SpringBootApplication
public class WebFluxApplication {
    public static void main(String[] args) {
        SpringApplication.run(WebFluxApplication.class, args);
    }
}

编写application配置

# 项目运行的端口号
server:
  port: 8080
 
# r2dbc 链接MySQL的配置 
spring:
  r2dbc:
    url: r2dbc:mysql://localhost:3306/threeCloud?SSL=false&sslMode=DISABLED
    username: root
    password: 123456

添加跨域请求配置

在config文件夹下创建配置文件CorsConfig.java 编写跨域配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;

/**
 * 跨域配置
 */
@Configuration
public class CorsConfig {
    @Bean
    public CorsWebFilter corsWebFilter() {
        CorsConfiguration corsConfig = new CorsConfiguration();
        corsConfig.addAllowedOrigin("*"); // 允许所有来源
        corsConfig.addAllowedMethod("*"); // 允许所有请求方法 (GET, POST, PUT, DELETE, ...)
        corsConfig.addAllowedHeader("*"); // 允许所有请求头
        corsConfig.addAllowedOriginPattern("*");
        // 如果需要设置额外的配置项，可以在这里添加，例如：
         corsConfig.setMaxAge(3600L); // 预检请求的有效期，单位秒

        // 创建 CorsConfiguration 对象后，将其应用于所有路径
        return new CorsWebFilter(source -> corsConfig);
    }
}

创建实体-数据表映射类

在model 文件夹下创建java 实体类，用于与数据表t_user 进行关联映射。

package www.zhang.test.model;

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

import java.io.Serializable;

/**
 * 说明：
 *
 * @author 张小三
 * @create 2024-08-02 11:49
 * @verson 1.0.0
 */
@Data
@Table(name = "t_user")
public class TUser implements Serializable {
    @Id
    private Long id;
    
    private String username;
    
    private String passwd;
}

创建Dao操作类

在 dao文件夹中创建 TUserDao.java接口文件.并继承ReactiveCrudRepository、R2dbcRepository、ReactiveSortingRepository。
这三个方法中封装了基础的增删改查操作方法。

import org.springframework.data.r2dbc.repository.R2dbcRepository;
import org.springframework.data.repository.reactive.ReactiveCrudRepository;
import org.springframework.data.repository.reactive.ReactiveSortingRepository;
import www.zhang.test.model.TUser;

/**
* ReactiveCrudRepository<实体类，主键类型>
* R2dbcRepository<实体类，主键类型>
* ReactiveSortingRepository<实体类，主键类型>
* */
public interface TUserDao extends  ReactiveCrudRepository<TUser, Long>,R2dbcRepository<TUser, Long>,ReactiveSortingRepository<TUser, Long>{
}

编写自己的增删改查接口和实现方法

接口方法定义

在service\interfaces下创建TUserService.java接口文件,
定义好增删改查接口

package www.zhang.test.service.intefaces;

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import www.zhang.test.model.TUser;

import java.util.List;

public interface TUserService {
    /**
    * 说明: 增
    * @author   zhangxiaosan
    * @create   2024/8/2
    * @param
    * @return
    */
    Mono<TUser> add(TUser tUser) throws RuntimeException;

    /**
    * 说明: 删
    * @author   zhangxiaosan
    * @create   2024/8/2
    * @param
    * @return
    */
    Mono<Long> delete(TUser tUser) throws RuntimeException;

    /**
    * 说明: 改
    * @author   zhangxiaosan
    * @create   2024/8/2
    * @param
    * @return
    */
    Mono<TUser> update(TUser tUser) throws RuntimeException;

    /**
    * 说明: 查 ，多个
    * @author   zhangxiaosan
    * @create   2024/8/2
    * @param
    * @return
    */
    Flux<TUser> list(TUser tUser) throws RuntimeException;

    /**
    * 说明: 查，单个
    * @author   zhangxiaosan
    * @create   2024/8/2
    * @param
    * @return
    */
    Mono<TUser> get(TUser tUser) throws RuntimeException;
}

接口实现

在service\impl下创建TUserServiceImpl.java类文件,
实现TUserService.java定义好增删改查接口

package www.zhang.test.service.impl;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.r2dbc.core.R2dbcEntityTemplate;
import org.springframework.data.relational.core.query.Criteria;
import org.springframework.data.relational.core.query.Query;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import www.zhang.test.model.TUser;
import www.zhang.test.service.intefaces.TUserService;

import java.util.Objects;

/**
 * 说明：
 *
 * @author 张小三
 * @create 2024-08-02 12:02
 * @verson 1.0.0
 */
@Slf4j
@Service
public class TUserServiceImpl implements TUserService {

    @Autowired
    private R2dbcEntityTemplate r2dbcEntityTemplate;

    /**
     * 说明: 增
     *
     * @param tUser
     * @return
     * @author zhangxiaosan
     * @create 2024/8/2
     */
    @Override
    public Mono<TUser> add(TUser tUser) throws RuntimeException {
        return r2dbcEntityTemplate.insert(tUser).doOnError(throwable -> log.error("添加失败:{}", throwable.getMessage()));
    }

    /**
     * 说明: 删
     *
     * @param tUser
     * @return
     * @author zhangxiaosan
     * @create 2024/8/2
     */
    @Override
    public Mono<Long> delete(TUser tUser) throws RuntimeException {
        return r2dbcEntityTemplate.delete(query(tUser), TUser.class).doOnError(throwable -> log.error("删除失败:{}", throwable.getMessage()));
    }

    /**
     * 说明: 改
     *
     * @param tUser
     * @return
     * @author zhangxiaosan
     * @create 2024/8/2
     */
    @Override
    public Mono<TUser> update(TUser tUser) throws RuntimeException {
        return r2dbcEntityTemplate.update(tUser).doOnError(throwable -> log.error("更新失败:{}", throwable.getMessage()));
    }

    /**
     * 说明: 查 ，多个
     *
     * @param tUser
     * @return
     * @author zhangxiaosan
     * @create 2024/8/2
     */
    @Override
    public Flux<TUser> list(TUser tUser) throws RuntimeException {
        return r2dbcEntityTemplate.select(query(tUser), TUser.class).doOnError(throwable -> log.error("list查找失败:{}", throwable.getMessage()));
    }

    /**
     * 说明: 查，单个
     *
     * @param tUser
     * @return
     * @author zhangxiaosan
     * @create 2024/8/2
     */
    @Override
    public Mono<TUser> get(TUser tUser) throws RuntimeException {
       return r2dbcEntityTemplate.select(query(tUser), TUser.class).take(1).next().doOnError(throwable -> log.error("get查找失败:{}", throwable.getMessage()));
    }

    /**
    * 说明: 通用的动态查询条件
    * @author   zhangxiaosan 
    * @create   2024/8/2
    * @param    
    * @return   
    */
    private Query query(TUser param) {
        Criteria criteria = Criteria.empty();

        if (Objects.nonNull(param.getId())) {
            criteria = criteria.and(Criteria.where("id").is(param.getId()));
        }

        if (StringUtils.hasText(param.getUsername())) {
            criteria = criteria.and(Criteria.where("username").like("%" + param.getUsername() + "%"));
        }

        return Query.query(criteria);
    }
}

编写控制器api接口

在controller文件夹下创建 TUserController.java控制器类

package www.zhang.test.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import www.zhang.test.model.TUser;
import www.zhang.test.service.intefaces.TUserService;

/**
 * 说明：
 *
 * @author 张小三
 * @create 2024-08-02 14:24
 * @verson 1.0.0
 */
@RestController
@RequestMapping(value = "user")
public class TUserController {
    @Autowired
    private TUserService tUserService;

    @RequestMapping(value = "get")
    public Mono<TUser> get(@RequestBody TUser tUser) throws RuntimeException {
        return tUserService.get(tUser);
    }

    @RequestMapping(value = "add")
    public Mono<TUser> add(@RequestBody TUser tUser) throws RuntimeException {
        return tUserService.add(tUser);
    }

    @RequestMapping(value = "list")
    public Flux<TUser> list(@RequestBody TUser tUser) throws RuntimeException {
        return tUserService.list(tUser);
    }

    @RequestMapping(value = "delete")
    public Mono<Long> delete(@RequestBody TUser tUser) throws RuntimeException {
        return tUserService.delete(tUser);
    }

    @RequestMapping(value = "update")
    public Mono<TUser> update(@RequestBody TUser tUser) throws RuntimeException {
        return tUserService.update(tUser);
    }
}

接口调用测试