正文

Mybatis-Flex v1.0.4 及其 全新官网 发布

admin
admin V管理员 /0 评论 /231 阅读
0327
此篇文章发布距今已超过607天，您需要注意文章的内容或图片是否可用！

 

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

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

Mybatis-flex v1.0.4 主要更新如下：

  • 新增：@ColumnMask() 注解用于数据脱敏，内置 9 中脱敏方式
  • 新增：BaseMapper.selectAll() 方法
  • 新增：BaseMapper.selectListByMap(Map whereConditions, int count) 方法
  • 新增：添加 resource 配置，使得生成的代码自动集成到 classpath 中。 感谢 @piggsoft
  • 新增：mybatis-flex-codegen 模块，用于 数据库-> Java 的代码生成
  • 新增：@Table() 注解添加 OnInsert 和 OnUpdate 的配置支持
  • 文档：新文档站点 https://mybatis-flex.com 上线

特征

  • 1、很轻量，整个框架只依赖 Mybatis 再无其他第三方依赖
  • 2、只增强，支持 Entity 的增删改查、及分页查询，但不丢失 Mybatis 原有功能
  • 3、内置 Db + Row 工具，可以无需实体类对数据库进行增删改查
  • 4、支持多种数据库类型，还可以通过方言持续扩展
  • 5、支持多（联合）主键，以及不同的主键内容生成策略
  • 6、支持逻辑删除设置、更新或插入的默认值配置以及大字段等设置
  • 7、支持乐观锁字段配置，在数据更新时自动进行乐观锁检测
  • 8、极其友好的 SQL 联动查询，IDE 自动提示不再担心出错
  • 9、更多小惊喜

开始

  • 快速开始
  • 示例 1：Mybatis-Flex 原生（非 Spring）
  • 示例 2：Mybatis-Flex with Spring
  • 示例 3：Mybatis-Flex with Spring boot
  • 示例 4：Db + Row

hello world（原生）

第 1 步：编写 Entity 实体类

 @Table("tb_account") public class Account {      @Id(keyType = KeyType.Auto)     private Long id;     private String userName;     private Date birthday;     private int sex;      //getter setter }

第 2 步：开始查询数据

示例 1：查询 1 条数据

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } }

以上的 AccountMapper.class 为 Mybatis-Flex 自动通过 APT 生成，无需手动编码。也可以关闭自动生成功能，手动编写 AccountMapper，更多查看 APT 文档。

示例2：查询列表

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     );

示例3：分页查询

 // 示例3：分页查询 // 查询第 5 页，每页 10 条数据，通过 QueryWrapper 构建条件查询 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")))     .orderBy(ACCOUNT.ID.desc());  // 执行 SQL： // ELECT * FROM tb_account // WHERE id >=  100 // AND (user_name LIKE '%张%' OR user_name LIKE '%李%' ) // ORDER BY `id` DESC // LIMIT 40,10 Page<Account> accounts = MybatisFlexBootstrap.getInstance() .execute(AccountMapper.class,mapper->     mapper.paginate(5,10,query) );

QueryWrapper 示例

select *

 QueryWrapper query=new QueryWrapper(); query.select().from(ACCOUNT)  // SQL:  // SELECT * FROM tb_account

select columns

简单示例：

 QueryWrapper query=new QueryWrapper(); query.select(ACCOUNT.ID,ACCOUNT.USER_NAME)     .from(ACCOUNT)  // SQL:  // SELECT id, user_name  // FROM tb_account
 

多表查询（同时展现了功能强大的 as 能力）：

 QueryWrapper query = new QueryWrapper()     .select(ACCOUNT.ID         , ACCOUNT.USER_NAME         , ARTICLE.ID.as("articleId")         , ARTICLE.TITLE)     .from(ACCOUNT.as("a"), ARTICLE.as("b"))     .where(ACCOUNT.ID.eq(ARTICLE.ACCOUNT_ID));  // SQL:  // SELECT a.id, a.user_name, b.id AS articleId, b.title  // FROM tb_account AS a, tb_article AS b  // WHERE a.id = b.account_id
 

select functions

 QueryWrapper query=new QueryWrapper()     .select(         ACCOUNT.ID,         ACCOUNT.USER_NAME,         max(ACCOUNT.BIRTHDAY),         avg(ACCOUNT.SEX).as("sex_avg")     ).from(ACCOUNT);  // SQL:  // SELECT id, user_name,  // MAX(birthday),  // AVG(sex) AS sex_avg  // FROM tb_account
 

where

 QueryWrapper queryWrapper=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("michael"));  // SQL:  // SELECT * FROM tb_account  // WHERE id >=  ?   // AND user_name LIKE  ?
 

where 动态条件 1

 boolean flag = false; QueryWrapper queryWrapper = QueryWrapper.create()     .select().from(ACCOUNT)     .where(flag ? ACCOUNT.ID.ge(100) : noCondition())     .and(ACCOUNT.USER_NAME.like("michael"));  // SQL:  // SELECT * FROM tb_account  // WHERE user_name LIKE  ?
 

where 动态条件 2

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 0
 

where select

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 1
 

exists, not exists

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 2
 

and (...) or (...)

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 3
 

group by

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 4
 

having

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 5
 

orderBy

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 6
 

join

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 7
 

limit... offset

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 8
 

在以上的 "limit... offset" 示例中，Mybatis-Flex 能够自动识别当前数据库，并生成不同的 SQL，用户也可以很轻易的通过 DialectFactory 注册（新增或改写）自己的实现方言。

存在疑问？

疑问 1：QueryWrapper 是否可以在分布式项目中通过 RPC 传输？

答：可以。

疑问 2：如何通过实体类 Account.java 生成 QueryWrapper 所需要的 "ACCOUNT" 类 ?

答：Mybatis-Flex 使用了 APT（Annotation Processing Tool）技术，在项目编译的时候，会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类以及 Entity 对应的 Mapper 类， 通过开发工具构建项目（如下图），或者执行 maven 编译命令: mvn clean package 都可以自动生成。这个原理和 lombok 一致。

更多关于 Mybatis-Flex APT 的配置，请点击 这里。

Db + Row 工具类

Db + Row 工具类，提供了在 Entity 实体类之外的数据库操作能力。使用 Db + Row 时，无需对数据库表进行映射， Row 是一个 HashMap 的子类，相当于一个通用的 Entity。以下为 Db + Row 的一些示例：

 class HelloWorld {     public static void main(String... args) {          HikariDataSource dataSource = new HikariDataSource();         dataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/mybatis-flex");         dataSource.setUsername("username");         dataSource.setPassword("password");          MybatisFlexBootstrap.getInstance()                 .setDatasource(dataSource)                 .addMapper(AccountMapper.class)                 .start();           //示例1：查询 id=100 条数据         Account account = MybatisFlexBootstrap.getInstance()                 .execute(AccountMapper.class, mapper ->                         mapper.selectOneById(100)                 );     } } 9
 

Db 工具类还提供了更多 增、删、改、查和分页查询等方法。

具体参考： Db.java 。

更多关于 Row 插入时的主键生成机制、以及Db 的事务管理等，请点击 这里 。

Entity 部分字段更新

相比市面上的其他框架，这部分的功能应该也算是 MyBatis-Flex 的亮点之一。在 BaseMapper 中，Mybatis-Flex 提供了如下的方法：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 0
 
  • 第一个参数是 entity 的对象。
  • 第二个参数是是否忽略 null 值。

有些场景下，我们可能希望只更新 几个 字段，而其中个别字段需要更新为 null。此时需要用到 UpdateEntity 工具类，以下是示例代码：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 1
 

以上的示例中，会把 id 为 100 这条数据中的 user_name 字段更新为 null，sex 字段更新为 1，其他字段不会被更新。也就是说，通过 UpdateEntity 创建的对象，只会更新调用了 setter 方法的字段，若不调用 setter 方法，不管这个对象里的属性的值是什么，都不会更新到数据库。

其生成的 sql 内容如下：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 2
 

自定义 TypeHandler

使用 @column 注解：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 3
 

插入数据：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 4
 

mybatis 日志：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 5
 

多主键

Mybatis-Flex 多主键就是在 Entity 类里有多个 @Id 注解标识而已，比如：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 6
 

当我们保存数据的时候，Account 的 id 主键为自增，而 otherId 主键则通过 uuid 生成。

自定义主键生成器

第 1 步：编写一个类，实现 IKeyGenerator 接口，例如：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 7
 

第 2 步：注册 UUIDKeyGenerator

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 8
 

第 3 步：在 Entity 里使用 "myUUID" 生成器：

 //示例2：通过 QueryWrapper 构建条件查询数据列表 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")));  // 执行 SQL： // ELECT * FROM tb_account // WHERE tb_account.id >=  100 // AND (tb_account.user_name LIKE '%张%' OR tb_account.user_name LIKE '%李%' ) List<Account> accounts = MybatisFlexBootstrap.getInstance()     .execute(AccountMapper.class,mapper->         mapper.selectListByQuery(query)     ); 9
 

使用数据库 Sequence 生成

 // 示例3：分页查询 // 查询第 5 页，每页 10 条数据，通过 QueryWrapper 构建条件查询 QueryWrapper query=QueryWrapper.create()     .select()     .from(ACCOUNT)     .where(ACCOUNT.ID.ge(100))     .and(ACCOUNT.USER_NAME.like("张").or(ACCOUNT.USER_NAME.like("李")))     .orderBy(ACCOUNT.ID.desc());  // 执行 SQL： // ELECT * FROM tb_account // WHERE id >=  100 // AND (user_name LIKE '%张%' OR user_name LIKE '%李%' ) // ORDER BY `id` DESC // LIMIT 40,10 Page<Account> accounts = MybatisFlexBootstrap.getInstance() .execute(AccountMapper.class,mapper->     mapper.paginate(5,10,query) ); 0
 

更多关于主键的配置，请点击 这里

更多文档

  • https://mybatis-flex.com
宙飒天下网