MyBatis-Flex 是什么

MyBatis-Flex 是一个优雅的 MyBatis 增强框架，它非常轻量、同时拥有极高的性能与灵活性。我们可以轻松的使用 Mybaits-Flex 链接任何数据库，其内置的 QueryWrapper^亮点 帮助我们极大的减少了 SQL 编写的工作的同时，减少出错的可能性。

总而言之，MyBatis-Flex 能够极大地提高我们的开发效率和开发体验，让我们有更多的时间专注于自己的事情。

特征

1、轻量：除了 MyBatis，没有任何第三方依赖轻依赖、没有任何拦截器，其原理是通过 SqlProvider 的方式实现的轻实现。同时，在执行的过程中，没有任何的 Sql 解析（Parse）轻运行。 这带来了几个好处：1、极高的性能；2、极易对代码进行跟踪和调试； 3、把控性更高。

2、灵活：支持 Entity 的增删改查、以及分页查询的同时，MyBatis-Flex 提供了 Db + Row^灵活 工具，可以无需实体类对数据库进行增删改查以及分页查询。 与此同时，MyBatis-Flex 内置的 QueryWrapper^灵活 可以轻易的帮助我们实现 多表查询、链接查询、子查询 等等常见的 SQL 场景。

3、强大：支持任意关系型数据库，还可以通过方言持续扩展，同时支持 多（复合）主键、逻辑删除、乐观锁配置、数据脱敏、数据审计、 数据填充 等等功能。

MyBatis-Flex 和同类框架「功能」对比

MyBatis-Flex 主要是和 MyBatis-Plus 与 Fluent-MyBatis 对比，内容来源其官网、git 或者 网络文章，若有错误欢迎纠正。

  • • MyBatis-Plus：老牌的 MyBatis 增强框架，开源于 2016 年。
  • • Fluent-MyBatis：阿里云开发的 MyBatis 增强框架（来自于阿里云·云效产品团队）

功能对比

功能或特点

MyBatis-Flex

MyBatis-Plus

Fluent-MyBatis

对 entity 的基本增删改查

✅

✅

✅

分页查询

✅

✅

✅

分页查询之总量缓存

✅

✅

❌

分页查询无 SQL 解析设计（更轻量，及更高性能）

✅

❌

✅

多表查询： from 多张表

✅

❌

❌

多表查询： left join、inner join 等等

✅

❌

✅

多表查询： union，union all

✅

❌

✅

单主键配置

✅

✅

✅

多种 id 生成策略

✅

✅

✅

支持多主键、复合主键

✅

❌

❌

字段的 typeHandler 配置

✅

✅

✅

除了 MyBatis，无其他第三方依赖（更轻量）

✅

❌

❌

QueryWrapper 是否支持在微服务项目下进行 RPC 传输

✅

❌

未知

逻辑删除

✅

✅

✅

乐观锁

✅

✅

✅

SQL 审计

✅

❌

❌

数据填充

✅

✅

✅

数据脱敏

✅

✔️ （收费）

❌

字段权限

✅

✔️ （收费）

❌

字段加密

✅

✔️ （收费）

❌

字典回写

✅

✔️ （收费）

❌

Db + Row

✅

❌

❌

Entity 监听

✅

❌

❌

多数据源支持

✅

借助其他框架或收费

❌

多数据源是否支持 Spring 的事务管理，比如 @Transactional 和 TransactionTemplate 等

✅

❌

❌

多数据源是否支持 "非Spring" 项目

✅

❌

❌

多租户

✅

✅

❌

动态表名

✅

✅

❌

动态 Schema

✅

❌

❌

快速开始

Hello World

第 1 步：创建数据库表

CREATE TABLE IF NOT EXISTS `tb_account`
(
    `id`        INTEGER PRIMARY KEY auto_increment,
    `user_name` VARCHAR(100),
    `age`       INTEGER,
    `birthday`  DATETIME
);

INSERT INTO tb_account(id, user_name, age, birthday)
VALUES (1, '张三', 18, '2020-01-11'),
       (2, '李四', 19, '2021-03-21');

第 2 步：创建 Spring Boot 项目，并添加 Maven 依赖

需要添加的 Maven 主要依赖示例:

<dependencies>
    <dependency>
        <groupId>com.mybatis-flex</groupId>
        <artifactId>mybatis-flex-spring-boot-starter</artifactId>
        <version>1.5.4</version>
    </dependency>
    <dependency>
        <groupId>com.mysql</groupId>
        <artifactId>mysql-connector-j</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
    </dependency>
    <!-- for test only -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

第 3 步：对 Spring Boot 项目进行配置

在 application.yml 中配置数据源：

# DataSource Config
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/flex_test
    username: root
    password: 12345678

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication
@MapperScan("com.mybatisflex.test.mapper")
public class MybatisFlexTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisFlexTestApplication.class, args);
    }

}

第 4 步：编写实体类和 Mapper 接口

这里使用了 Lombok[1] 来简化代码。

@Data
@Table("tb_account")
public class Account {

    @Id(keyType = KeyType.Auto)
    private Long id;
    private String userName;
    private Integer age;
    private Date birthday;

}
  • • 使用 @Table("tb_account") 设置实体类与表名的映射关系
  • • 使用 @Id(keyType = KeyType.Auto) 标识主键为自增Mapper 接口继承 BaseMapper 接口：
public interface AccountMapper extends BaseMapper<Account> {

}

第 5 步：开始使用

添加测试类，进行功能测试：

import static com.mybatisflex.test.entity.table.AccountTableDef.ACCOUNT;

@SpringBootTest
class MybatisFlexTestApplicationTests {

    @Autowired
    private AccountMapper accountMapper;

    @Test
    void contextLoads() {
        QueryWrapper queryWrapper = QueryWrapper.create()
                .select()
                .where(ACCOUNT.AGE.eq(18));
        Account account = accountMapper.selectOneByQuery(queryWrapper);
        System.out.println(account);
    }

}

控制台输出：

Account(id=1, userName=张三, age=18, birthday=Sat Jan 11 00:00:00 CST 2020)

更多示例

请参考MyBatis-Flex官网[2]

欢迎关注我的公众号“码农十八讲”，原创技术文章第一时间推送。

引用链接

[1] Lombok: https://www.projectlombok.org/