MyBatis R2DBC Adapter 技术文档

MyBatis R2DBC Adapter 技术文档

mybatis-r2dbc MyBatis R2DBC Adapter 项目地址: https://gitcode.com/gh_mirrors/my/mybatis-r2dbc

安装指南

为了使用MyBatis R2DBC Adapter，确保你的开发环境已准备好Java开发工具，并且熟悉Maven或Gradle构建系统。首先，你需要添加MyBatis R2DBC库依赖到你的项目中。如果你使用的是Maven，可以在pom.xml中加入以下依赖：

<dependency>
    <groupId>linux-china</groupId>
    <artifactId>mybatis-r2dbc</artifactId>
    <version>latest_version</version> <!-- 替换为实际版本号 -->
</dependency>

请注意，替换成最新的稳定版本号或者根据项目的需要选择合适的版本。此外，还需要添加对R2DBC驱动（例如，r2dbc-mysql或r2dbc-postgresql）的支持以及Spring Boot或Spring Framework的Reactive支持。

项目的使用说明

MyBatis R2DBC Adapter使原有基于阻塞式JDBC的MyBatis能够运行在非阻塞的Reactive环境中，这要求你的应用程序是响应式编程模式。

步骤1: 配置MyBatis

创建或修改mybatis-config.xml以适应Reactive需求，包括必要的属性配置，如数据源信息和是否启用指标等。

<configuration>
    <properties>
        <property name="metrics.enabled" value="true"/>
        <property name="r2dbc.pool.initial-size" value="1"/>
        <property name="r2dbc.pool.max-size" value="10"/>
        <property name="r2dbc.pool.max-idle-time" value="5"/>
    </properties>
</configuration>

步骤2: 创建Reactive SqlSessionFactory

在你的启动类或配置类中，初始化ReactiveSqlSessionFactory：

@Configuration
public class AppConfig {
    @Bean
    public ReactiveSqlSessionFactory sqlSessionFactory() {
        XMLConfigBuilder builder = new XMLConfigBuilder.getResourceAsStream("mybatis-config.xml");
        Configuration configuration = builder.parse();
        // 假设r2dbcConnectionFactory是预先配置好的ConnectionFactory实例
        return new DefaultReactiveSqlSessionFactory(configuration, r2dbcConnectionFactory());
    }
}

步骤3: 使用Reactive Mappers

定义你的Mapper接口时，确保它们返回Mono或Flux类型，代表单个结果或结果流。

public interface UserReactiveMapper {
    Mono<User> getUserById(Integer id);
    Flux<User> getAllUsers();
}

步骤4: 数据访问

利用ReactiveSqlSession执行数据库操作：

@Service
public class UserService {
    private final UserReactiveMapper userMapper;

    public UserService(UserReactiveMapper userMapper) {
        this.userMapper = userMapper;
    }

    public Mono<User> fetchUserProfile(int userId) {
        return userMapper.getUserById(userId);
    }
}

项目API使用文档

• ReactiveSqlSession: 提供异步执行SQL操作的方法，比如insert, update, delete, 以及查询方法，所有这些都返回Mono或Flux。
• ReactiveMapper: 你定义的Mapper接口需要标记为Reactive，转换CRUD操作的返回类型为非阻塞的类型。
• TypeHandler: 通过实现R2DBCTypeHandler接口处理特定类型的映射，以支持复杂的对象转换。

项目安装方式

• 依赖管理: 直接通过Maven或Gradle添加依赖。
• 本地构建: 克隆项目到本地，使用Maven的mvn clean install或Gradle的相应命令构建项目，随后将生成的jar引入项目作为本地库。

此文档介绍了如何集成MyBatis R2DBC Adapter到响应式应用中，重点在于配置、Mapper接口的使用和TypeHandler的定制。确保遵循最佳实践，以便充分利用Reactive编程带来的性能增益。

mybatis-r2dbc MyBatis R2DBC Adapter 项目地址: https://gitcode.com/gh_mirrors/my/mybatis-r2dbc