mybatis-flex 详解

简介:

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

官网:

MyBatis-Flex - MyBatis-Flex 官方网站https://mybatis-flex.com/说到持久层框架必然离不开mybatis,持久层框架的老大哥,以及现在最常用的mybatis-plus,作为mybatis的pro版本,多集成了很多功能,以便我进行开发,但如果用到多表联查等情景,很多人又会觉得不如mybatis老大哥好用,那么现在老大哥的ProMax版本来了-->mybatis-flex,官网对它的特点描述为:轻量(只集成了mybatis)、灵活（支持多表联查)、强大（数据脱敏、逻辑删除等）这些都是mybatis-plus所不曾拥有的，所以刷到？→ 撇了一眼 → 深深爱上。

依赖：

maven依赖：

<dependency>
    <groupId>com.mybatis-flex</groupId>
    <artifactId>mybatis-flex-spring-boot-starter</artifactId>
    <version>1.7.7</version>
</dependency>
<dependency>
    <groupId>com.mybatis-flex</groupId>
    <artifactId>mybatis-flex-processor</artifactId>
    <version>1.7.7</version>
    <scope>provided</scope>
</dependency>

Kotlin：

dependencies {
    implementation("com.mybatis-flex:mybatis-flex-spring-boot-starter:1.7.7")
}

Groovy：

dependencies {
    implementation 'com.mybatis-flex:mybatis-flex-spring-boot-starter:1.7.7'
}

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

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

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

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

与mybatis-plus对比

功能或特点	MyBatis-Flex	MyBatis-Plus	Fluent-Mybatis
对 entity 的基本增删改查	✅	✅	✅
分页查询	✅	✅	✅
分页查询之总量缓存	✅	❌	❌
分页查询无 SQL 解析设计（更轻量）	✅	❌	✅
多表查询： from 多张表	✅	❌	❌
多表查询： left join、inner join 等等	✅	❌	✅
单主键配置	✅	✅	✅
多种 id 生成策略	✅	✅	✅
支持多主键、复合主键	✅	❌	❌
字段的 typeHandler 配置	✅	✅	✅
除了 Mybatis，无其他第三方依赖（更轻量）	✅	❌	❌
逻辑删除	✅	✅	✅
乐观锁	✅	✅	✅
SQL 审计	✅	❌	❌
数据填充	✅	✅（收费）	✅
数据脱敏	✅	✅（收费）	❌
字段权限	✅	✅（收费）	❌
字段加密	✅	✅（收费）	❌
字典回显	✅	✅（收费）	❌
Db + Row	✅	❌	❌
Entity 监听	✅	❌	❌
多数据源支持	✅	✅	❌

 对比功能参考地址：与 Mybatis-plus 对比，Mybatis-Flex v1.0.7 发布 - OSCHINA - 中文开源技术交流社区

然后就是我喜欢的两点!!!(数据脱敏和内置多表联查)

数据脱敏

数据脱敏 - Mybatis-Flex 官方网站

@ColumnMask
Mybatis-Flex 提供了 @ColumnMask() 注解，以及内置的 9 种脱敏规则，帮助开发者方便的进行数据脱敏。例如：

@Table("tb_account")
public class Account {
 
    @Id(keyType = KeyType.Auto)
    private Long id;
 
    @ColumnMask(Masks.CHINESE_NAME)
    private String userName;
}

以上的示例中，使用了 CHINESE_NAME 的脱敏规则，其主要用于处理 "中文名字" 的场景。当我们查询到 userName 为 张三丰 的时候，其内容自动被处理成 张**。

除此之外，Mybatis-Flex 还提供了如下的 8 中脱敏规则，方便开发者直接使用：

手机号脱敏
固定电话脱敏
身份证号脱敏
身份证号脱敏
地址脱敏
邮件脱敏
密码脱敏
银行卡号脱敏
自定义脱敏规则
当 Mybaits-Flex 内置的 9 中脱敏规则无法满足要求时，我们还可以自定义脱敏规则，其步骤如下：

1、通过 MaskManager 注册新的脱敏规则：

MaskManager.registerMaskProcesser("自定义规则名称"
        , data -> {
            return data;
        })
2、使用自定义的脱敏规则

java

@Table("tb_account")
public class Account {
 
    @Id(keyType = KeyType.Auto)
    private Long id;
 
    @ColumnMask("自定义规则名称")
    private String userName;
}

取消脱敏处理
在某些场景下，程序希望查询得到的数据是原始数据，而非脱敏数据。比如要去查询用户的手机号，然后给用户发送短信。又或者说，我们进入编辑页面编辑用户数据， 如果编辑页面展示的是脱敏数据，然后再次点击保存，那么数据库的真实数据也会被脱敏覆盖。

因此，MaskManager 提供了 skipMask、restoreMask 两个方法来处理这种场景：

try {
    MaskManager.skipMask()
    
    //此处查询到的数据不会进行脱敏处理
    accountMapper.selectListByQuery(...)
} finally {
    MaskManager.restoreMask()
}

提示

在具体的应用中，我们通常会把 skipMask() 和 restoreMask() 放到统一的拦截器里，对某一类业务进行统一拦截和处理。

多表联查

各位客官请移步下一篇!

MyBatis-Flex(自动映射)-CSDN博客