Mybatis-Flex初体验
本篇文章内容主要包括：
MyBatis-Flex 介绍
MyBatis-Flex 是一个优雅的 MyBatis 增强框架，它非常轻量、同时拥有极高的性能与灵活性。我们可以轻松的使用 Mybaits-Flex 链接任何数据库，其内置的 QueryWrapper^亮点 帮助我们极大的减少了 SQL 编写的工作的同时，减少出错的可能性。
总而言之，MyBatis-Flex 能够极大地提高我们的开发效率和开发体验，让我们有更多的时间专注于自己的事情。
主要特点
- 轻量
除了 MyBatis，没有任何第三方依赖轻依赖、没有任何拦截器，其原理是通过 SqlProvider 的方式实现的轻实现。同时，在执行的过程中，没有任何的 Sql 解析（Parse）轻运行。 这带来了几个好处：1、极高的性能；2、极易对代码进行跟踪和调试； 3、更高的把控性。
- 灵活
支持 Entity 的增删改查、以及分页查询的同时，MyBatis-Flex 提供了 Db + Row^灵活 工具，可以无需实体类对数据库进行增删改查以及分页查询。 与此同时，MyBatis-Flex 内置的 QueryWrapper^灵活 可以轻易的帮助我们实现 多表查询、链接查询、子查询 等等常见的 SQL 场景。
- 强大
支持任意关系型数据库，还可以通过方言持续扩展，同时支持 多（复合）主键、逻辑删除、乐观锁配置、数据脱敏、数据审计、 数据填充 等等功能。
与同类框架的对比
功能对比
功能或特点 | 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 | ? | ? | ? |
性能对比
测试结果如下：
- 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://gitee.com/mybatis-flex/mybatis-benchmark
Mybatis-Flex支持哪些数据库
MyBatis-Flex 支持的数据库类型，如下表格所示，我们还可以通过自定义方言的方式，持续添加更多的数据库支持。
数据库 | 描述 |
mysql | MySQL 数据库 |
mariadb | MariaDB 数据库 |
oracle | Oracle11g 及以下数据库 |
oracle12c | Oracle12c 及以上数据库 |
db2 | DB2 数据库 |
H2 | H2 数据库 |
hsql | HSQL 数据库 |
sqlite | SQLite 数据库 |
postgresql | PostgreSQL 数据库 |
sqlserver2005 | SQLServer2005 数据库 |
sqlserver | SQLServer 数据库 |
dm | 达梦数据库 |
xugu | 虚谷数据库 |
kingbasees | 人大金仓数据库 |
phoenix | Phoenix HBase 数据库 |
gauss | Gauss 数据库 |
clickhouse | ClickHouse 数据库 |
gbase | 南大通用(华库)数据库 |
gbase-8s | 南大通用数据库 GBase 8s |
oscar | 神通数据库 |
sybase | Sybase ASE 数据库 |
OceanBase | OceanBase 数据库 |
Firebird | Firebird 数据库 |
derby | Derby 数据库 |
highgo | 瀚高数据库 |
cubrid | CUBRID 数据库 |
goldilocks | GOLDILOCKS 数据库 |
csiidb | CSIIDB 数据库 |
hana | SAP_HANA 数据库 |
impala | Impala 数据库 |
vertica | Vertica 数据库 |
xcloud | 行云数据库 |
redshift | 亚马逊 redshift 数据库 |
openGauss | 华为 openGauss 数据库 |
TDengine | TDengine 数据库 |
informix | Informix 数据库 |
greenplum | Greenplum 数据库 |
uxdb | 优炫数据库 |
Doris | Doris数据库 |
Hive SQL | Hive 数据库 |
lealone | Lealone 数据库 |
sinodb | 星瑞格数据库 |
基本使用
下面的演示案例代码，基于MyBatis-Flex的代码生成器进行实现。
创建数据表
创建数据表user_order，建表脚本如下：
DROP TABLE IF EXISTS `user_order`;
CREATE TABLE `user_order`
(
`id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '自增ID；【必须保留自增ID，不要将一些有随机特性的字段值设计为主键，例如order_id，会导致innodb内部page分裂和大量随机I/O，性能下降】int 大约21亿左右，超过会报错。bigint 大约9千亿左右。',
`user_name` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '用户姓名；',
`user_id` varchar(24) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '用户编号；',
`user_mobile` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '用户电话；使用varchar(20)存储手机号，不要使用整型。手机号不会做数学计算、涉及到区号或者国家代号，可能出现+-()、支持模糊查询，例如：like“135%”',
`sku` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '商品编号',
`sku_name` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '商品名称',
`order_id` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '订单ID',
`quantity` int(11) NOT NULL DEFAULT 1 COMMENT '商品数量；整形定义中不显示规定显示长度，比如使用 INT，而不使用 INT(4)',
`unit_price` decimal(10, 2) NOT NULL COMMENT '商品价格；小数类型为 decimal，禁止使用 float、double',
`discount_amount` decimal(10, 2) NOT NULL COMMENT '折扣金额；',
`tax` decimal(4, 2) NOT NULL COMMENT '费率金额；',
`total_amount` decimal(10, 2) NOT NULL COMMENT '支付金额；(商品的总金额 - 折扣) * (1 - 费率)',
`order_date` datetime NOT NULL COMMENT '订单日期；timestamp的时间范围在1970-01-01 00:00:01到2038-01-01 00:00:00之间',
`order_status` tinyint(1) NOT NULL COMMENT '订单状态；0 创建、1完成、2掉单、3关单 【不要使用 enum 要使用 tinyint 替代。0-80 范围，都可以使用 tinyint】',
`is_delete` tinyint(1) NOT NULL DEFAULT 0 COMMENT '逻辑删单；0未删除，1已删除 【表达是否概念的字段必须使用is_】',
`uuid` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '唯一索引；分布式下全局唯一，用于binlog 同步 ES 方便使用',
`ipv4` int(10) UNSIGNED NOT NULL DEFAULT 2130706433 COMMENT '设备地址；存储IPV4地址，通过MySQL 函数转换，inet_ntoa、inet_aton 示例；SELECT INET_ATON(‘209.207.224.40′); 3520061480 SELECT INET_NTOA(3520061480); 209.207.224.40所有字段定义为NOT NULL，并设置默认值，因为null值的字段会导致每一行都占用额外存储空间\\n数据迁移容易出错，在聚合函数计算结果偏差（如count结果不准）并且null的列使索引/索引统计/值比较都更加复杂，MySQL内部需要进行特殊处理，表中有较多空字段的时候，数据库性能下降严重。开发中null只能采用is null或is not null检索，而不能采用=、in、<、<>、!=、not in这些操作符号。如：where name!=’abc’，如果存在name为null值的记录，查询结果就不会包含name为null值的记录',
`ipv6` varbinary(16) NOT NULL COMMENT '设备地址；存储IPV6地址，VARBINARY(16) 插入：INET6_ATON(\'2001:0db8:85a3:0000:0000:8a2e:0370:7334\') 查询：SELECT INET6_NTOA(ip_address) ',
`ext_data` json NOT NULL COMMENT '扩展数据；记录下单时用户的设备环境等信息(核心业务字段，要单独拆表)。【select user_name, ext_data, ext_data->>\'$.device\', ext_data->>\'$.device.machine\' from `user_order`;】',
`update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
`create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
PRIMARY KEY (`id`) USING BTREE,
UNIQUE INDEX `uq_orderid` (`order_id`) USING BTREE,
UNIQUE INDEX `uq_uuid` (`uuid`) USING BTREE,
INDEX `idx_order_date` (`order_date`) USING BTREE,
INDEX `idx_sku_unit_price_total_amount` (`sku`, `unit_price`, `total_amount`) USING BTREE
);创建Spring Boot项目
项目工程结构如下，在pomx.xml中添加相关依赖。
pom.xml
org.springframework.boot
spring-boot-starter-web
com.mysql
mysql-connector-j
runtime
org.projectlombok
lombok
true
org.springframework.boot
spring-boot-starter-test
test
com.mybatis-flex
mybatis-flex-spring-boot-starter
1.6.5
com.mybatis-flex
mybatis-flex-processor
1.6.5
provided
com.mybatis-flex
mybatis-flex-codegen
1.6.5
com.zaxxer
HikariCP
4.0.3
项目配置
在配置文件application.yml中配置数据源等。
# 数据源配置
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/ballcat
username: root
password: root_123在项目启动类上添加@MapperScan 配置扫描的文件夹：
@SpringBootApplication
@MapperScan("com.xxkfz.simplememory.mapper")
public class XxkfzMybatisFlexApplication {
public static void main(String[] args) {
SpringApplication.run(XxkfzMybatisFlexApplication.class, args);
}
}经过上面的步骤，一个基于Mybatis-Flex的简单Spring Boot项目创建并配置完成了。
下面我们将使用Mybatis-Flex代码生成器，生成基于表user-order的基本操作代码。
配置代码生成器
运行CodegenMain.java main方法即可，即可在路径：com/xxkfz/simplememory/下面生成相应的文件。
import com.mybatisflex.codegen.Generator;
import com.mybatisflex.codegen.config.ColumnConfig;
import com.mybatisflex.codegen.config.GlobalConfig;
import com.mybatisflex.core.service.IService;
import com.mybatisflex.spring.service.impl.ServiceImpl;
import com.zaxxer.hikari.HikariDataSource;
/**
* @author 公众号: SimpleMemory
* @version 1.0.0
* @ClassName Codegen.java
* @Description 代码生成器
* @createTime 2023年09月21日 18:12:00
*/
public class CodegenMain {
public static void main(String[] args) {
//数据源配置
HikariDataSource dataSource = new HikariDataSource();
dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/ballcat?characterEncoding=utf-8");
dataSource.setUsername("xxkfz");
dataSource.setPassword("xxkfz");
//创建配置内容，两种风格都可以。
GlobalConfig globalConfig = createGlobalConfig();
//GlobalConfig globalConfig = createGlobalConfigUseStyle2();
//通过 datasource 和 globalConfig 创建代码生成器
Generator generator = new Generator(dataSource, globalConfig);
//生成代码
generator.generate();
}
/**
* GlobalConfig 基本配置
*
* @return
*/
public static GlobalConfig createGlobalConfig() {
//创建配置内容
GlobalConfig globalConfig = new GlobalConfig();
//设置根包
globalConfig.setBasePackage("com.xxkfz.simplememory");
//设置表前缀和只生成哪些表
globalConfig.setGenerateTable("user_order");
//设置生成 entity 并启用 Lombok
globalConfig.setEntityGenerateEnable(true);
globalConfig.setEntityWithLombok(true);
//设置生成 controller
globalConfig.setControllerGenerateEnable(true);
//设置生成 service
globalConfig.setServiceGenerateEnable(true);
//设置生成 serviceImpl
globalConfig.setServiceImplGenerateEnable(true);
//设置生成 mapper
globalConfig.setMapperGenerateEnable(true);
//设置生成 mapperXml
globalConfig.setMapperXmlGenerateEnable(true);
globalConfig.getControllerConfig().setClassPrefix("").setClassSuffix("Controller").setRestStyle(true);
globalConfig.getServiceConfig().setClassPrefix("").setClassSuffix("Service").setSuperClass(IService.class).setOverwriteEnable(true);
globalConfig.getServiceImplConfig().setClassPrefix("").setClassSuffix("ServiceImpl").setSuperClass(ServiceImpl.class).setOverwriteEnable(true);
globalConfig.getMapperXmlConfig().setFilePrefix("/com/xxkfz/simplememory/").setFileSuffix("Mapper").setOverwriteEnable(true);
//可以单独配置某个列
ColumnConfig columnConfig = new ColumnConfig();
columnConfig.setColumnName("tenant_id");
columnConfig.setLarge(true);
columnConfig.setVersion(true);
globalConfig.setColumnConfig("tb_account", columnConfig);
return globalConfig;
}
}生成的代码结构如下：
启动项目测试
代码生成后，我们直接主启动类
XxkfzMybatisFlexApplication，即可启动项目。
启动成功后，访问UserOrderController 中分页查询中的page方法：
http://127.0.0.1:8080/userOrder/page
其他操作QueryWrapper的使用
查询表中user_name等于公众号Simplememory的user_id、order_id列QueryWrapper queryWrapper = QueryWrapper.create()
.select(USER_ORDER.USER_ID, USER_ORDER.ORDER_ID)
.where(USER_ORDER.USER_NAME
.eq("公众号Simplememory"));
List userOrders = userOrderMapper.selectListByQuery(queryWrapper);
System.out.println(userOrders); 在上面的例子中， USER_ORDER 为 MyBatis-Flex 通过 APT 自动生成的，无需手动编码，只需通过静态导入即可！
关于其他的用法可以进入：
https://mybatis-flex.com/zh/base/add-delete-update.html
Mybatis-Flex官方文档: https://mybatis-flex.com/
最后，关于上面的代码工程已上传到Gitee：
https://gitee.com/xxkfz/xxkfz-mybatis-flex.git