更便捷的Mybatis插件——EasyMybatis

easy-mybatis是一个对Mybatis的增强框架&＃xff08;插件&＃xff09;。在Spring集成Mybatis的基础上&＃xff0c;将项目开发中对数据库的常用操作统一化。使用本框架可以很便捷的对数据库进行操作&＃xff0c;提高开发效率&＃xff0c;减少机械行为。

项目主页&＃xff1a;mybatis.zuoyu.top

API文档地址&＃xff1a;mybatis.zuoyu.top/doc/index.h…

GitHub地址&＃xff1a;github.com/zuoyuip/eas…

Gitee地址&＃xff1a;gitee.com/zuoyuip/eas…

Maven依赖引入



top.zuoyu.mybatiseasy-mybatis-spring-boot-starter1.0.0


Gradle依赖引入


// https://mvnrepository.com/artifact/top.zuoyu.mybatis/easy-mybatis-spring-boot-starter
implementation &＃39;top.zuoyu.mybatis:easy-mybatis-spring-boot-starter:1.0.0&＃39;

框架初衷

这个框架的初衷是&＃xff0c;减少Java程序员千篇一律的数据库操作。

对于开发人员来说&＃xff1a;

• 精力应该花费在业务逻辑上&＃xff0c;而非机械式的“技术”上。
• 项目中减少无关痛痒的代码&＃xff0c;从抽象的角度看实现。
• 各司其职&＃xff0c;各劳其力&＃xff0c;追求项目角度的服务流水线。

服务分离的时代

如今已很难看到单体架构的项目&＃xff08;感兴趣的可以查看我对架构演变的描述《浅谈微服务》&＃xff09;&＃xff0c;目前的项目大都是通过RESTful、MQ、Socket的方式&＃xff08;协议&＃xff09;进行数据传输。

这让我开始质疑传统JavaWeb项目中的数据库操作模式——即Model(DTO)存在的意义。理论上&＃xff0c;数据库设计是不可能完全遵循视图模型的&＃xff0c;这就导致“正确”的做法是在项目中引入VO&＃xff0c;由多个DTO来组装。

那么&＃xff0c;为什么不能用灵活的Map来替代呢&＃xff1f;

对一个Map的方法进行拓展&＃xff0c;增加其对Json的解析能力&＃xff0c;那么是不是就可以摆脱POJO的各种麻烦组装。

思考框架设计

我在思考如何设计这个框架的时候&＃xff0c;被需要考虑的方方面面给阻挡住了。

因为一个数据库框架需要考虑的东西实在太多了&＃xff0c;比如&＃xff1a;

1. 事务机制
2. 类型转换
3. 会话管理

···

思来想去&＃xff0c;发现自己方向跑偏了&＃xff0c;我只是希望统一数据库操作的接口 &＃43; 摆脱Model&＃xff0c;没必要重新平地起墙&＃xff0c;完全可以在一个现有的框架基础上进行封装。

那么&＃xff0c;对这个现有框架的选择就尤为重要了。

现有框架的选择

目前Java中主流的数据库操作框架&＃xff1a;

• Spring JDBC
• Spring Data JPA
• Mybatis
• Hibernate

选择现有框架有一个原则——“统一数据库操作的接口 &＃43; 摆脱Model”是对该框架的加强&＃xff0c;而非变异&＃xff1b;不能因为“统一数据库操作的接口 &＃43; 摆脱Model”而无法使用原框架的部分功能。

“摆脱Model”这个特点&＃xff0c;首先就要排除重度ORM框架&＃xff0c;也就是支持JPA操作的数据库——Spring Data JPA、Hibernate&＃xff1b;原因很简单&＃xff0c;这两个框架的强大之处恰恰就在它完全面向Model操作。

剩下的就只有两个框架了&＃xff0c;Spring JDBC和Mybatis。其中&＃xff0c;Spring JDBC留给了开发人员大量的可操作空间&＃xff0c;更加自由&＃xff0c;但恰恰是这种自由使得它更加繁琐。而Mybatis是一个轻量ORM框架&＃xff0c;准确来说Mybatis不能称为ORM框架&＃xff0c;因为它并不是面向Model操作数据库&＃xff0c;仅仅是将数据库字段与Model字段互相赋值&＃xff0c;并没有做到ORM定义的关系映射。

抉择

由以上各框架的特点&＃xff0c;结合国内Java语言中数据库操作框架的热度&＃xff0c;毫无疑问的选择了Mybatis。

考虑到SpringBoot对Mybatis优秀的支持级别&＃xff0c;我决定基于mybatis-spring-boot-starter开发这款框架&＃xff0c;准备来说应该称其为“插件”。

框架特性

• 更便捷

摒弃传统mybatis的model、xml、dao数据库操作模式&＃xff0c;避繁就简&＃xff0c;快速开发。

• 更高效

采用预编译SQL&＃xff0c;拒绝运行期间反射生成SQL&＃xff0c;性能更高效。

• 无侵入

只是对Mybatis-Spring的增强插件&＃xff0c;对已有工程不做任何修改&＃xff0c;仍可使用原生框架的功能&＃xff0c;仅仅是简化了开发阶段对数据库的操作。

• 统一操作接口

对数据库的所有操作共用一个接口&＃xff0c;降低使用门槛&＃xff0c;轻松操作数据库。

• 统一操作对象

使用JsonObject为数据对象&＃xff0c;提供一系列操作方法&＃xff0c;方便从持久化对象组装为视图对象。

• 易上手

整个框架只提供了一个接口、一个注解、两个对象&＃xff0c;仅仅一行配置便可完成对数据库进行常用操作。

• ...

安利

• 在mybatis-spring-boot环境下&＃xff0c;使用该框架&＃xff08;插件&＃xff09;&＃xff0c;可以减少传统Mybatis使用中对model、xml、dao的机械式开发。

• 所有的数据库操作均使用MapperRepository接口&＃xff0c;通过注解&＃64;Magic("xxx")标记接口的数据表归属&＃xff0c;即可直接使用。

• 该框架&＃xff08;插件&＃xff09;不妨碍同时使用传统Mybatis中model、xml、dao的数据库开发方式。

快速上手

安装

• 安装mybatis-spring-boot环境

mybatis-spring-boot的Maven依赖

org.springframework.bootspring-boot-starter-parent${spring-boot.version}org.mybatis.spring.bootmybatis-spring-boot-starter${mybatis-spring-boot.version}


mybatis-spring-boot的Gradle依赖

plugins {id &＃39;org.springframework.boot&＃39; version &＃39;${springBootVersion}&＃39;id &＃39;io.spring.dependency-management&＃39; version &＃39;${springManagementVersion}&＃39;id &＃39;java&＃39;}dependencies {implementation &＃39;org.mybatis.spring.boot:mybatis-spring-boot-starter:${mybatisSpringVersion}&＃39;}


• 安装本框架&＃xff08;插件&＃xff09;

Maven依赖引入



top.zuoyu.mybatiseasy-mybatis-spring-boot-starter1.0.0


Gradle依赖引入


// https://mvnrepository.com/artifact/top.zuoyu.mybatis/easy-mybatis-spring-boot-starter
implementation &＃39;top.zuoyu.mybatis:easy-mybatis-spring-boot-starter:1.0.0&＃39;

配置

这里以MySQL数据库为例&＃xff0c;Oracle数据库配置请参考配置说明

1. 配置spring-boot-jdbc数据库


spring:datasource:type: com.zaxxer.hikari.HikariDataSourcedriver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://172.0.0.1:3306/xxxxusername: xxxxpassword: xxxx

关于springBoot的配置&＃xff0c;这里不多赘述&＃xff0c;更多移步springBoot官网。

1. 配置easy-mybatis支持的表名&＃xff08;例子&＃xff09;


easy-mybatis:table-names: teacher, student

这里的table-names配置&＃xff0c;表示需要easy-mybatis框架支持的数据表名&＃xff0c;多个表名使用逗号隔开。

即可使用easy-mybatis框架操作teacher和student两个数据表&＃xff0c;如果需要支持其他数据表&＃xff0c;需要在此配置。

操作数据库&＃xff08;例子&＃xff09;


&＃64;SpringBootTest
class DemoApplicationTests {// 表示该接口用来操作名称为&＃39;teacher&＃39;的数据表&＃64;Magic("teacher")private MapperRepository teacherRepository;// 表示该接口用来操作名称为&＃39;student&＃39;的数据表&＃64;Magic("student")private MapperRepository studentRepository;// 查询teacher表下所有数据&＃64;Testvoid teacherTest() {teachertRepository.selectList().forEach(System.out::println);}// 查询student表下符合特定条件的数据&＃64;Testvoid studentTest() {studentRepository.selectListByExample(new JsonObject().put("birthday", "2009/12/12 12:12:12")).forEach(System.out::println);}}

使用MapperRepository接口对数据库进行操作&＃xff0c;需要使用&＃64;Magic("表名称")标记该接口的数据表归属。

在本例中&＃xff0c;&＃64;Magic("teacher")表示该MapperRepository为"teacher"数据表的操作接口&＃xff0c;可以通过teacherRepository调用一系列方法完成对"teacher"数据表的操作。

配置说明

该框架&＃xff08;插件&＃xff09;的全部相关配置


#easy-mybatis的相关配置
easy-mybatis:#表示需要载入的数据库表table-names: SYS_USER, SYS_DEPT#默认的日期字符串格式data-format: yyyy-MM-dd HH:mm:ss#当数据库为Oracle时&＃xff0c;数据表对应的主键SEQ名称sequences:SYS_USER: SEQ_SYS_USER,SYS_DEPT: SEQ_SYS_DEPT#当数据库为Oracle时&＃xff0c;数据表的日期类型字段格式oracle-date-format: yyyy-mm-dd hh24:mi:ss

详细说明

1. table-names

此配置表示需要载入的数据表&＃xff0c;多个表名由逗号隔开&＃xff0c;只有在此处配置了的数据表&＃xff0c;才能在项目中使用&＃64;Magic("表名称")标记MapperRepository接口的数据表归属。

1. data-format

此配置表示在JsonObject中的日期存在格式&＃xff0c;JsonObject中对日期的存储类型为String类型&＃xff0c;可通过此配置自定义存储格式&＃xff0c;默认格式为yyyy-MM-dd HH:mm:ss。

注意 当data-format的格式修改&＃xff0c;请务必将oracle-date-format的格式与之匹配。

1. sequences

此配置表示当数据库为Oracle时&＃xff0c;每个数据表的主键生成器名称&＃xff0c;以键值对的格式进行参数配置。若此处没有对数据表的主键生成器进行配置&＃xff0c;那么在做该数据表的数据插入行为时需自定义填充主键数值。

1. oracle-date-format

此配置表示当数据库为Oracle时&＃xff0c;传入日期格式字段时的参数格式&＃xff0c;即TO_DATE(field, &＃39;$dateFormat&＃39;)。

注意 当oracle-date-format的格式修改&＃xff0c;请务必将data-format的格式与之匹配。

操作接口约定

本框架&＃xff08;插件&＃xff09;的数据库操作唯一接口——top.zuoyu.mybatis.service.MapperRepository。

1. 以ByExample为结尾的方法

此类是根据JsonObject类型的参数example中键值对&＃xff0c;对符合要求的数据进行操作&＃xff0c;例如&＃xff1a;

// 构建example&＃xff0c;这里指字段"birthday"为"2009/12/12 12:12:12"JsonObject example &＃61; new JsonObject().put("birthday", "2009/12/12 12:12:12");// 查询所有字段"birthday"为"2009/12/12 12:12:12"的学生数据List studentList &＃61; studentRepository.selectListByExample(example);

这里的selectListByExample方法就是根据参数example中键值对查找符合要求的数据。 同理&＃xff0c; countByExample方法就是获取符合参数example中键值对的数据总量...

1. 以By为结尾的方法

此类是根据String类型的参数suffixSql对方法追加参数中SQL语句的内容&＃xff0c;例如&＃xff1a;

// 查找"is_delete"字段为0的数据&＃xff0c;并以年龄进行排序List teachers &＃61; teacherRepository.selectListBy("WHERE is_delete &＃61; 0 ORDER BY age");// 将"birthday"字段大于"1990/1/1 00:00:00"的数据&＃xff0c;"salary"字段改为20000。 &＃xff08;也就是出生日期在1990年之前的老师&＃xff0c;工资改为2W&＃xff09;JsonObject example &＃61; new JsonObject().put("salary", 20000);int count &＃61; teacherRepository.updateBy(example, "WHERE birthday <&＃39;1990/1/1 00:00:00&＃39;");

这里的selectListBy方法就是查找出符合参数中SQL语句要求的内容&＃xff0c;updateBy方法就是将符合参数中SQL语句要求的数据修改为example定义的数值。

同理&＃xff0c;countBy方法就是获取符合参数中SQL语句要求的数据总量...

1. insert、insertBatch方法

当数据库为MySQL时&＃xff0c;如果数据表主键自增&＃xff0c;则无需定义主键数值&＃xff1b;若主键为非自增&＃xff0c;则需定义主键数值。

当数据库为Oracle时&＃xff0c;如果在配置中定义了数据表的主键生成器&＃xff0c;则无需定义主键数值&＃xff1b;反之&＃xff0c;则需定义主键数值。

• MapperRepository提供了丰富的方法&＃xff0c;以方便对数据库的CURD操作&＃xff0c;更多关于MapperRepository的使用说明请移步MapperRepository说明、MapperRepository的API文档。

操作对象约定

数据库接口的操作对象主要为JsonObject类型和JsonArray类型。

1. 其中top.zuoyu.mybatis.json.JsonObject为键值对容器&＃xff0c;以键值的形式装载&＃xff0c;数据结构为&＃xff1a;


{&＃39;field1&＃39; : &＃39;value1&＃39;,&＃39;field2&＃39; : &＃39;value2&＃39;,&＃39;field3&＃39; : &＃39;value3&＃39;,...
}

键的类型为java.lang.String类型&＃xff0c;值的类型可以为任何类型。

JsonObject提供了丰富的方法&＃xff0c;以方便操作键值对和类型转换&＃xff0c;更多关于JsonObject的使用说明请移步JsonObject说明、JsonObject的API文档。

1. 其中top.zuoyu.mybatis.json.JsonArray为数组容器&＃xff0c;以多个单位的形式装载&＃xff0c;数据结构为&＃xff1a;


[object1,object2,object3,...
]

每个单位可以为任何类型&＃xff0c;且各单位类型允许与其他单位类型不同。

JsonArray提供了丰富的方法&＃xff0c;以方便操作键值对和类型转换&＃xff0c;更多关于JsonArray的使用说明请移步JsonArray说明、JsonArray的API文档。

具体方法可参考API文档。

MapperRepository说明

查询所有selectList

/*** 查询所有** &＃64;return 所有数据*/List selectList();


查询符合样例的数据selectListByExample

/*** 根据已有键值查询** &＃64;param example - 已有键值* &＃64;return 符合要求的数据集合*/List selectListByExample(JsonObject example);


根据主键查询唯一对象selectByPrimaryKey

/*** 根据主键查询唯一对象** &＃64;param primaryKey - 主键* &＃64;return 唯一对象*/JsonObject selectByPrimaryKey(Serializable primaryKey);


查询符合条件的数据selectListBy

/*** 查询符合条件的数据** &＃64;param suffixSql - 条件语句&＃xff08;例如&＃xff1a;where field &＃61; xxx&＃xff09;* &＃64;return 数据数量*/List selectListBy(String suffixSql);


查询特定的字段或结果selectFields

/*** 查询特定的字段或结果* &＃xff08;例如&＃xff1a;"fieldA, fieldB, fieldC"&＃xff09;* &＃xff08;例如&＃xff1a;"COUNT(field)"&＃xff09;** &＃64;param fields - 特定的字段或结果* &＃64;return 特定的字段或结果*/JsonArray selectFields(String fields);


根据样例查询特定的字段或结果selectFieldsByExample

/*** 根据已有键值查询特定的字段或结果* &＃xff08;例如&＃xff1a;"fieldA, fieldB, fieldC"&＃xff09;* &＃xff08;例如&＃xff1a;"COUNT(field)"&＃xff09;** &＃64;param fields - 特定的字段或结果* &＃64;param example - 已有键值* &＃64;return 特定的字段或结果*/JsonArray selectFieldsByExample(String fields, JsonObject example);


根据主键查询特定的字段或结果selectFieldsByPrimaryKey

/*** 根据主键查询特定的字段或结果** &＃64;param fields - 特定的字段或结果&＃xff08;例如&＃xff1a;"fieldA, fieldB, fieldC"&＃xff09;* &＃64;param primaryKey - 主键* &＃64;return 特定的字段或结果*/JsonArray selectFieldsByPrimaryKey(String fields, Serializable primaryKey);


根据主键集合查询特定的字段或结果selectFieldsByPrimaryKeys

/*** 根据主键集合查询特定的字段或结果** &＃64;param fields - 特定的字段或结果&＃xff08;例如&＃xff1a;"fieldA, fieldB, fieldC"&＃xff09;* &＃64;param primaryKeys - 主键集合* &＃64;return 特定的字段或结果*/JsonArray selectFieldsByPrimaryKeys(String fields, Serializable[] primaryKeys);


查询符合条件的数据selectFieldsBy

/*** 查询符合条件的数据** &＃64;param fields - 特定的字段或结果&＃xff08;例如&＃xff1a;"fieldA, fieldB, fieldC"&＃xff09;* &＃64;param suffixSql - 条件语句&＃xff08;例如&＃xff1a;where field &＃61; xxx&＃xff09;* &＃64;return 特定的字段或结果*/JsonArray selectFieldsBy(String fields, String suffixSql);


查询符合条件的数据数量countBy

/*** 查询符合条件的数据数量** &＃64;param suffixSql - 条件语句&＃xff08;例如&＃xff1a;where field &＃61; xxx&＃xff09;* &＃64;return 数据数量*/long countBy(String suffixSql);


查询是否存在符合样例的数据数量countByExample

/*** 根据已有键值查询是否存在符合条件的数据数量** &＃64;param example - 已有键值* &＃64;return 数据数量*/long countByExample(JsonObject example);


是否存在符合条件的数据existsBy

/*** 是否存在符合条件的数据** &＃64;param suffixSql - 条件语句&＃xff08;例如&＃xff1a;where field &＃61; xxx&＃xff09;* &＃64;return 是否存在*/boolean existsBy(String suffixSql);


是否存在符合样例的数据existsByExample

/*** 根据已有键值查询是否存在符合条件的数据** &＃64;param example - 已有键值* &＃64;return 是否存在*/boolean existsByExample(JsonObject example);


新增对象insert

/*** 新增对象** &＃64;param jsonObject - 对象键值* &＃64;return 变动数据的数量*/int insert(JsonObject jsonObject);


批量新增对象insertBatch

/*** 批量新增对象** &＃64;param jsonObjects - 对象键值集合* &＃64;return 变动数据的数量*/int insertBatch(List jsonObjects);


根据主键修改对象属性updateByPrimaryKey

/*** 根据主键修改对象属性** &＃64;param jsonObject - 包含主键对象键值* &＃64;return 变动数据的数量*/int updateByPrimaryKey(JsonObject jsonObject);


修改特定条件的对象属性updateBy

/*** 修改特定条件的对象属性** &＃64;param jsonObject - 要修改的键值* &＃64;param suffixSql - 条件语句&＃xff08;例如&＃xff1a;where field &＃61; xxx&＃xff09;* &＃64;return 变动数据的数量*/int updateBy(JsonObject jsonObject, String suffixSql);


批量根据主键修改对象属性updateByPrimaryKeyBatch

/*** 批量根据主键修改对象属性** &＃64;param jsonObjects - 对象键值集合* &＃64;return 变动数据的数量*/int updateByPrimaryKeyBatch(List jsonObjects);


根据主键删除对象deleteByPrimaryKey

/*** 根据主键删除对象** &＃64;param primaryKey - 主键* &＃64;return 变动数据的数量*/int deleteByPrimaryKey(Serializable primaryKey);


删除符合条件的数据deleteBy

/*** 删除符合条件的数据** &＃64;param suffixSql - 条件语句&＃xff08;例如&＃xff1a;where field &＃61; xxx&＃xff09;* &＃64;return 变动数据的数量*/int deleteBy(String suffixSql);


批量根据主键删除对象deleteByPrimaryKeys

/*** 批量根据主键删除对象** &＃64;param primaryKeys - 主键组* &＃64;return 变动数据的数量*/int deleteByPrimaryKeys(Serializable[] primaryKeys);


根据样例删除对象deleteByExample

/*** 根据已有键值删除对象** &＃64;param example - 已有键值* &＃64;return 变动数据的数量*/int deleteByExample(JsonObject example);


JsonObject说明

top.zuoyu.mybatis.json.JsonObject为键值对容器&＃xff0c;以键值的形式装载&＃xff0c;数据结构为&＃xff1a;

{&＃39;field1&＃39; : &＃39;value1&＃39;,&＃39;field2&＃39; : &＃39;value2&＃39;,&＃39;field3&＃39; : &＃39;value3&＃39;,...
}


键的类型为java.lang.String类型&＃xff0c;值的类型可以为任何类型。

类型转换

内部默认已包含常规的类型转换&＃xff0c;默认支持以下类型&＃xff1a;

• java.math.BigInteger
• java.math.BigDecimal
• java.lang.Boolean
• java.lang.Byte
• java.lang.Character
• java.util.Date
• java.lang.Double
• java.lang.Float
• java.lang.Integer
• java.lang.Long
• java.lang.Short
• java.lang.String

如果默认的转换器无法满足需求&＃xff0c;或者需要转换为其他类型&＃xff0c;可通过自定义转换器ConvertClass进行实现&＃xff0c;接口方法&＃xff1a;

public interface ConvertClass {/*** 将给定的 value 对象转换为 T 类型** &＃64;param value - 给定对象* &＃64;return 目标转换类型的对象*/T convert(Object value);/*** 将给定的 value 对象转换为 T 类型&＃xff0c; 否则返回 defaultValue** &＃64;param value - 给定对象* &＃64;param defaultValue - 默认值* &＃64;return 目标转换类型的对象*/T convert(Object value, T defaultValue);
}


示例

&＃64;Testvoid convertTest() {// 使用JSON字符串初始化对象JsonObject student &＃61; new JsonObject(studentJSON);// 获取学生的性别&＃xff0c;如果无法转换则返回"未知"String sex &＃61; student.getValue("sex", new SexConvert());// 获取学生的性别&＃xff0c;如果无法转换则返回"未录入"String sexOrDefault &＃61; student.getValue("sex", new SexConvert(), "未录入");}static class SexConvert implements ConvertClass {&＃64;Overridepublic String convert(Object value) {if (value instanceof Integer) {if ((Integer) value &＃61;&＃61; 1) {return "男";} else if ((Integer)value &＃61;&＃61; 0) {return "女";}}return "未知";}&＃64;Overridepublic String convert(Object value, String defaultValue) {if (value instanceof Integer) {if ((Integer) value &＃61;&＃61; 1) {return "男";} else if ((Integer)value &＃61;&＃61; 0) {return "女";}}return defaultValue;}}


本示例也可使用StringConvert转换器&＃xff0c;StringConvert为ConvertClass的子接口。

也可以通过toClass方法&＃xff0c;将JsonObject对象转换为指定类型的实体类。

子接口&＃xff1a;

• BigDecimalConvert
• BigIntegerConvert
• BooleanConvert
• ByteConvert
• CharacterConvert
• DateConvert
• DoubleConvert
• FloatConvert
• IntegerConvert
• LongConvert
• ShortConvert
• StringConvert

更多方法请移步JsonObject的API文档。

JsonArray说明

top.zuoyu.mybatis.json.JsonArray为数组容器&＃xff0c;以多个单位的形式装载&＃xff0c;数据结构为&＃xff1a;


[object1,object2,object3,...
]

每个单位可以为任何类型&＃xff0c;且各单位类型允许与其他单位类型不同。

类型转换

具体使用方法与JsonObject在类型转换操作一致&＃xff0c;参考JsonObject的类型转换操作