超越 MyBatis-Plus，来领略一下 MyBatis-Flex 的优雅魅力吧！

一时失言乱红尘 2023-10-14 11:32 8阅读 0赞

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

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

> 官网文档：https://mybatis-flex.com/

### Mybatis-Flex有什么特点？ ###

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

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

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

### Mybatis-Flex和同类框架对比 ###

#### 1）功能对比： ####

<table> 
 <thead> 
  <tr> 
   <th>功能或特点</th> 
   <th>MyBatis-Flex</th> 
   <th>MyBatis-Plus</th> 
   <th>Fluent-MyBatis</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>对 entity 的基本增删改查</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>分页查询</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>分页查询之总量缓存</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>分页查询无 SQL 解析设计（更轻量，及更高性能）</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>多表查询：from 多张表</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>多表查询：left join、inner join 等等</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>多表查询：union，union all</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>单主键配置</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>多种 id 生成策略</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>支持多主键、复合主键</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>字段的 typeHandler 配置</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>除了 MyBatis，无其他第三方依赖（更轻量）</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>QueryWrapper 是否支持在微服务项目下进行 RPC 传输</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>未知</td> 
  </tr> 
  <tr> 
   <td>逻辑删除</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>乐观锁</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>SQL 审计</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>数据填充</td> 
   <td>✅</td> 
   <td>✔️&nbsp;<strong>（收费）</strong></td> 
   <td>✅</td> 
  </tr> 
  <tr> 
   <td>数据脱敏</td> 
   <td>✅</td> 
   <td>✔️&nbsp;<strong>（收费）</strong></td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>字段权限</td> 
   <td>✅</td> 
   <td>✔️&nbsp;<strong>（收费）</strong></td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>字段加密</td> 
   <td>✅</td> 
   <td>✔️&nbsp;<strong>（收费）</strong></td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>字典回写</td> 
   <td>✅</td> 
   <td>✔️&nbsp;<strong>（收费）</strong></td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>Db + Row</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>Entity 监听</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>多数据源支持</td> 
   <td>✅</td> 
   <td>借助其他框架或收费</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>多数据源是否支持 Spring 的事务管理，比如 @Transactional 和 TransactionTemplate 等</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>多数据源是否支持 "非Spring" 项目</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>多租户</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>动态表名</td> 
   <td>✅</td> 
   <td>✅</td> 
   <td>❌</td> 
  </tr> 
  <tr> 
   <td>动态 Schema</td> 
   <td>✅</td> 
   <td>❌</td> 
   <td>❌</td> 
  </tr> 
 </tbody> 
</table>

#### 2）性能对比： ####

**这里直接贴测试结果：**

*  MyBatis-Flex 的查询单条数据的速度，大概是 MyBatis-Plus 的 5 ~ 10+ 倍。
 *  MyBatis-Flex 的查询 10 条数据的速度，大概是 MyBatis-Plus 的 5~10 倍左右。
 *  Mybatis-Flex 的分页查询速度，大概是 Mybatis-Plus 的 5~10 倍左右。
 *  Mybatis-Flex 的数据更新速度，大概是 Mybatis-Plus 的 5~10+ 倍。

**具体性能对比测试，移步：**

> https://mybatis-flex.com/zh/intro/benchmark.html

### Mybatis-Flex支持的数据库类型 ###

MyBatis-Flex 支持的数据库类型，如下表格所示，我们还可以通过自定义方言的方式，持续添加更多的数据库支持。

<table> 
 <thead> 
  <tr> 
   <th>数据库</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>mysql</td> 
   <td>MySQL 数据库</td> 
  </tr> 
  <tr> 
   <td>mariadb</td> 
   <td>MariaDB 数据库</td> 
  </tr> 
  <tr> 
   <td>oracle</td> 
   <td>Oracle11g 及以下数据库</td> 
  </tr> 
  <tr> 
   <td>oracle12c</td> 
   <td>Oracle12c 及以上数据库</td> 
  </tr> 
  <tr> 
   <td>db2</td> 
   <td>DB2 数据库</td> 
  </tr> 
  <tr> 
   <td>hsql</td> 
   <td>HSQL 数据库</td> 
  </tr> 
  <tr> 
   <td>sqlite</td> 
   <td>SQLite 数据库</td> 
  </tr> 
  <tr> 
   <td>postgresql</td> 
   <td>PostgreSQL 数据库</td> 
  </tr> 
  <tr> 
   <td>sqlserver2005</td> 
   <td>SQLServer2005 数据库</td> 
  </tr> 
  <tr> 
   <td>sqlserver</td> 
   <td>SQLServer 数据库</td> 
  </tr> 
  <tr> 
   <td>dm</td> 
   <td>达梦数据库</td> 
  </tr> 
  <tr> 
   <td>xugu</td> 
   <td>虚谷数据库</td> 
  </tr> 
  <tr> 
   <td>kingbasees</td> 
   <td>人大金仓数据库</td> 
  </tr> 
  <tr> 
   <td>phoenix</td> 
   <td>Phoenix HBase 数据库</td> 
  </tr> 
  <tr> 
   <td>gauss</td> 
   <td>Gauss 数据库</td> 
  </tr> 
  <tr> 
   <td>clickhouse</td> 
   <td>ClickHouse 数据库</td> 
  </tr> 
  <tr> 
   <td>gbase</td> 
   <td>南大通用(华库)数据库</td> 
  </tr> 
  <tr> 
   <td>gbase-8s</td> 
   <td>南大通用数据库 GBase 8s</td> 
  </tr> 
  <tr> 
   <td>oscar</td> 
   <td>神通数据库</td> 
  </tr> 
  <tr> 
   <td>sybase</td> 
   <td>Sybase ASE 数据库</td> 
  </tr> 
  <tr> 
   <td>OceanBase</td> 
   <td>OceanBase 数据库</td> 
  </tr> 
  <tr> 
   <td>Firebird</td> 
   <td>Firebird 数据库</td> 
  </tr> 
  <tr> 
   <td>derby</td> 
   <td>Derby 数据库</td> 
  </tr> 
  <tr> 
   <td>highgo</td> 
   <td>瀚高数据库</td> 
  </tr> 
  <tr> 
   <td>cubrid</td> 
   <td>CUBRID 数据库</td> 
  </tr> 
  <tr> 
   <td>goldilocks</td> 
   <td>GOLDILOCKS 数据库</td> 
  </tr> 
  <tr> 
   <td>csiidb</td> 
   <td>CSIIDB 数据库</td> 
  </tr> 
  <tr> 
   <td>hana</td> 
   <td>SAP_HANA 数据库</td> 
  </tr> 
  <tr> 
   <td>impala</td> 
   <td>Impala 数据库</td> 
  </tr> 
  <tr> 
   <td>vertica</td> 
   <td>Vertica 数据库</td> 
  </tr> 
  <tr> 
   <td>xcloud</td> 
   <td>行云数据库</td> 
  </tr> 
  <tr> 
   <td>redshift</td> 
   <td>亚马逊 redshift 数据库</td> 
  </tr> 
  <tr> 
   <td>openGauss</td> 
   <td>华为 openGauss 数据库</td> 
  </tr> 
  <tr> 
   <td>TDengine</td> 
   <td>TDengine 数据库</td> 
  </tr> 
  <tr> 
   <td>informix</td> 
   <td>Informix 数据库</td> 
  </tr> 
  <tr> 
   <td>greenplum</td> 
   <td>Greenplum 数据库</td> 
  </tr> 
  <tr> 
   <td>uxdb</td> 
   <td>优炫数据库</td> 
  </tr> 
 </tbody> 
</table>

### 快速开始 ###

**第 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 依赖**

> TIP：可以使用 Spring Initializer 快速初始化一个 Spring Boot 工程。

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

<dependencies>
        <dependency>
            <groupId>com.mybatis-flex</groupId>
            <artifactId>mybatis-flex-spring-boot-starter</artifactId>
            <version>1.5.3</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>
        
        <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 来简化代码。

@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> {
    
    }

这部分也可以使用 MyBatis-Flex 的代码生成器来生，功能非常强大的。详情进入：

> https://mybatis-flex.com/zh/others/codegen.html

**第 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)

以上的 示例 中， `ACCOUNT` 为 MyBatis-Flex 通过 APT 自动生成，只需通过静态导入即可，无需手动编码。

整体来讲，这个框架是Mybatis的增强版，几乎集成了mybatis plus、jooq、fluent mybatis的所有优点，大家可以探索一番，官方网站：

> https://mybatis-flex.com/