Fluent-Mybatis 技术文档

Fluent-Mybatis 技术文档

【免费下载链接】fluent-mybatis 项目地址: https://gitcode.com/gh_mirrors/fl/fluent-mybatis

Fluent-Mybatis 是一个高度灵活的 Mybatis 插件，它通过流畅的 API 设计来简化 SQL 的编写过程，使开发人员能够更加专注于业务逻辑而无需过多关注 SQL 语句的拼接细节。本文档旨在提供一套全面的指南，帮助您快速上手并熟练运用 Fluent-Mybatis。

安装指南

Maven 工程

在您的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.github.atool</groupId>
    <artifactId>fluent-mybatis</artifactId>
    <version>最新版本号</version>
</dependency>

确保替换“最新版本号”为实际的最新稳定版本。

Gradle 工程

在 build.gradle 文件中加入：

dependencies {
    implementation 'com.github.atool:fluent-mybatis:最新版本'
}

同样需要确认使用最新的版本号。

项目使用说明

Fluent-Mybatis 核心在于通过领域对象直接构建 SQL，减少硬编码的 SQL 字符串，提升代码的可读性和可维护性。首先，创建实体类，并使用 Fluent-Mybatis 的注解来标注字段与表列的映射关系。

快速入门示例

假设有一个简单的 User 实体类，您可以这样使用 Fluent-Mybatis 进行 CRUD 操作：

// 示例实体类（略去注解，实际使用时应正确注解）
public class User {
    private Long id;
    private String name;
}

// 创建Mapper接口
public interface UserMapper extends BaseMapper<User> {}

// 使用示例
User user = new User();
user.setName("TestUser");
UserMapper mapper = ...; // 获取Mapper实例
mapper.insert(user);

项目API使用文档

Fluent-Mybatis 提供了丰富的 API 来支持各种数据库操作，例如插入、更新、删除和查询等。

查询示例

List<User> users = mapper.selectList(User.where().eq("name", "TestUser"));

插入示例

mapper.insert(user);

更新示例

user.setName("UpdatedName");
mapper.updateById(user);

删除示例

mapper.deleteById(user.getId());

代码生成

Fluent-Mybatis 支持通过配置文件自动生成 Mapper 接口以及对应的实现。配置文件通常包含实体类信息、表名映射、以及是否启用某些特性（如逻辑删除）。具体步骤可以参考 Gitee 上的相关wiki页面指导进行配置和执行代码生成命令。

环境部署与支持

Fluent-Mybatis 支持多种环境部署，包括但不限于Maven和Gradle管理的项目。对于不同的数据库支持，通过简单的配置即可适配MySQL、Oracle等主流数据库，并且提供了分页以及特定数据库下的SQL差异化处理。

---

以上就是对Fluent-Mybatis的基本介绍和技术文档概览。为了更深入地理解和应用，强烈推荐访问其官方Gitee仓库中的详细文档和示例代码，那里包含了每个特性的详尽说明和实战案例。

【免费下载链接】fluent-mybatis 项目地址: https://gitcode.com/gh_mirrors/fl/fluent-mybatis