easymybatis是一个对Mybatis的增强框架(插件)。在Spring集成Mybatis的基础上,将项目开发中对数据库的常用操作统一化。使用本框架可以很便捷的对数据库进行操作,提高开发效率,减少机械行为。 项目主页:https:mybatis。zuoyu。top API文档地址:https:mybatis。zuoyu。topdocindex。html GitHub地址:https:github。comzuoyuipeasymybatis Gitee地址:https:gitee。comzuoyuipeasymybatis Maven依赖引入!https:mvnrepository。comartifacttop。zuoyu。mybatiseasymybatisspringbootstarterdependencygroupIdtop。zuoyu。mybatisgroupIdeasymybatisspringbootstarterartifactIdversion1。0。0versiondependency Gradle依赖引入https:mvnrepository。comartifacttop。zuoyu。mybatiseasymybatisspringbootstarterimplementationtop。zuoyu。mybatis:easymybatisspringbootstarter:1。0。0框架初衷 这个框架的初衷是,减少Java程序员千篇一律的数据库操作。 对于开发人员来说:精力应该花费在业务逻辑上,而非机械式的技术上。项目中减少无关痛痒的代码,从抽象的角度看实现。各司其职,各劳其力,追求项目角度的服务流水线。服务分离的时代 如今已很难看到单体架构的项目(感兴趣的可以查看我对架构演变的描述《浅谈微服务》),目前的项目大都是通过RESTful、MQ、Socket的方式(协议)进行数据传输。 这让我开始质疑传统JavaWeb项目中的数据库操作模式即Model(DTO)存在的意义。理论上,数据库设计是不可能完全遵循视图模型的,这就导致正确的做法是在项目中引入VO,由多个DTO来组装。 那么,为什么不能用灵活的Map来替代呢? 对一个Map的方法进行拓展,增加其对Json的解析能力,那么是不是就可以摆脱POJO的各种麻烦组装。思考框架设计 我在思考如何设计这个框架的时候,被需要考虑的方方面面给阻挡住了。 因为一个数据库框架需要考虑的东西实在太多了,比如:事务机制类型转换会话管理 思来想去,发现自己方向跑偏了,我只是希望统一数据库操作的接口摆脱Model,没必要重新平地起墙,完全可以在一个现有的框架基础上进行封装。 那么,对这个现有框架的选择就尤为重要了。现有框架的选择 目前Java中主流的数据库操作框架:SpringJDBCSpringDataJPAMybatisHibernate 选择现有框架有一个原则统一数据库操作的接口摆脱Model是对该框架的加强,而非变异;不能因为统一数据库操作的接口摆脱Model而无法使用原框架的部分功能。 摆脱Model这个特点,首先就要排除重度ORM框架,也就是支持JPA操作的数据库SpringDataJPA、Hibernate;原因很简单,这两个框架的强大之处恰恰就在它完全面向Model操作。 剩下的就只有两个框架了,SpringJDBC和Mybatis。其中,SpringJDBC留给了开发人员大量的可操作空间,更加自由,但恰恰是这种自由使得它更加繁琐。而Mybatis是一个轻量ORM框架,准确来说Mybatis不能称为ORM框架,因为它并不是面向Model操作数据库,仅仅是将数据库字段与Model字段互相赋值,并没有做到ORM定义的关系映射。抉择 由以上各框架的特点,结合国内Java语言中数据库操作框架的热度,毫无疑问的选择了Mybatis。 考虑到SpringBoot对Mybatis优秀的支持级别,我决定基于mybatisspringbootstarter开发这款框架,准备来说应该称其为插件。框架特性更便捷 摒弃传统mybatis的model、xml、dao数据库操作模式,避繁就简,快速开发。更高效 采用预编译SQL,拒绝运行期间反射生成SQL,性能更高效。无侵入 只是对MybatisSpring的增强插件,对已有工程不做任何修改,仍可使用原生框架的功能,仅仅是简化了开发阶段对数据库的操作。统一操作接口 对数据库的所有操作共用一个接口,降低使用门槛,轻松操作数据库。统一操作对象 使用JsonObject为数据对象,提供一系列操作方法,方便从持久化对象组装为视图对象。易上手 整个框架只提供了一个接口、一个注解、两个对象,仅仅一行配置便可完成对数据库进行常用操作。。。。安利在mybatisspringboot环境下,使用该框架(插件),可以减少传统Mybatis使用中对model、xml、dao的机械式开发。所有的数据库操作均使用MapperRepository接口,通过注解Magic(xxx)标记接口的数据表归属,即可直接使用。该框架(插件)不妨碍同时使用传统Mybatis中model、xml、dao的数据库开发方式。快速上手安装安装mybatisspringboot环境 mybatisspringboot的Maven依赖parentgroupIdorg。springframework。bootgroupIdspringbootstarterparentartifactIdversion{springboot。version}versionrelativePathparentdependenciesdependencygroupIdorg。mybatis。spring。bootgroupIdmybatisspringbootstarterartifactIdversion{mybatisspringboot。version}versiondependencydependencies mybatisspringboot的Gradle依赖plugins{idorg。springframework。bootversion{springBootVersion}idio。spring。dependencymanagementversion{springManagementVersion}idjava}dependencies{implementationorg。mybatis。spring。boot:mybatisspringbootstarter:{mybatisSpringVersion}}安装本框架(插件) Maven依赖引入!https:mvnrepository。comartifacttop。zuoyu。mybatiseasymybatisspringbootstarterdependencygroupIdtop。zuoyu。mybatisgroupIdeasymybatisspringbootstarterartifactIdversion1。0。0versiondependency Gradle依赖引入https:mvnrepository。comartifacttop。zuoyu。mybatiseasymybatisspringbootstarterimplementationtop。zuoyu。mybatis:easymybatisspringbootstarter:1。0。0配置 这里以MySQL数据库为例,Oracle数据库配置请参考配置说明配置springbootjdbc数据库spring:datasource:type:com。zaxxer。hikari。HikariDataSourcedriverclassname:com。mysql。cj。jdbc。Driverurl:jdbc:mysql:172。0。0。1:3306xxxxusername:xxxxpassword:xxxx 关于springBoot的配置,这里不多赘述,更多移步springBoot官网。配置easymybatis支持的表名(例子)easymybatis:tablenames:teacher,student 这里的tablenames配置,表示需要easymybatis框架支持的数据表名,多个表名使用逗号隔开。 即可使用easymybatis框架操作teacher和student两个数据表,如果需要支持其他数据表,需要在此配置。操作数据库(例子)SpringBootTestclassDemoApplicationTests{表示该接口用来操作名称为teacher的数据表Magic(teacher)privateMapperRepositoryteacherRepository;表示该接口用来操作名称为student的数据表Magic(student)privateMapperRepositorystudentRepository;查询teacher表下所有数据TestvoidteacherTest(){teachertRepository。selectList()。forEach(System。out::println);}查询student表下符合特定条件的数据TestvoidstudentTest(){studentRepository。selectListByExample(newJsonObject()。put(birthday,2009121212:12:12))。forEach(System。out::println);}} 使用MapperRepository接口对数据库进行操作,需要使用Magic(表名称)标记该接口的数据表归属。 在本例中,Magic(teacher)表示该MapperRepository为teacher数据表的操作接口,可以通过teacherRepository调用一系列方法完成对teacher数据表的操作。配置说明 该框架(插件)的全部相关配置easymybatis的相关配置easymybatis:表示需要载入的数据库表tablenames:SYSUSER,SYSDEPT默认的日期字符串格式dataformat:yyyyMMddHH:mm:ss当数据库为Oracle时,数据表对应的主键SEQ名称sequences:SYSUSER:SEQSYSUSER,SYSDEPT:SEQSYSDEPT当数据库为Oracle时,数据表的日期类型字段格式oracledateformat:yyyymmddhh24:mi:ss详细说明tablenames 此配置表示需要载入的数据表,多个表名由逗号隔开,只有在此处配置了的数据表,才能在项目中使用Magic(表名称)标记MapperRepository接口的数据表归属。dataformat 此配置表示在JsonObject中的日期存在格式,JsonObject中对日期的存储类型为String类型,可通过此配置自定义存储格式,默认格式为yyyyMMddHH:mm:ss。 注意 当dataformat的格式修改,请务必将oracledateformat的格式与之匹配。sequences 此配置表示当数据库为Oracle时,每个数据表的主键生成器名称,以键值对的格式进行参数配置。若此处没有对数据表的主键生成器进行配置,那么在做该数据表的数据插入行为时需自定义填充主键数值。oracledateformat 此配置表示当数据库为Oracle时,传入日期格式字段时的参数格式,即TODATE(field,dateFormat)。 注意 当oracledateformat的格式修改,请务必将dataformat的格式与之匹配。操作接口约定 本框架(插件)的数据库操作唯一接口top。zuoyu。mybatis。service。MapperRepository。以ByExample为结尾的方法 此类是根据JsonObject类型的参数example中键值对,对符合要求的数据进行操作,例如:构建example,这里指字段birthday为2009121212:12:12JsonObjectexamplenewJsonObject()。put(birthday,2009121212:12:12);查询所有字段birthday为2009121212:12:12的学生数据ListJsonObjectstudentListstudentRepository。selectListByExample(example); 这里的selectListByExample方法就是根据参数example中键值对查找符合要求的数据。 同理,countByExample方法就是获取符合参数example中键值对的数据总量。。。以By为结尾的方法 此类是根据String类型的参数suffixSql对方法追加参数中SQL语句的内容,例如:查找isdelete字段为0的数据,并以年龄进行排序ListJsonObjectteachersteacherRepository。selectListBy(WHEREisdelete0ORDERBYage);将birthday字段大于19901100:00:00的数据,salary字段改为20000。(也就是出生日期在1990年之前的老师,工资改为2W)JsonObjectexamplenewJsonObject()。put(salary,20000);intcountteacherRepository。updateBy(example,WHEREbirthday19901100:00:00); 这里的selectListBy方法就是查找出符合参数中SQL语句要求的内容,updateBy方法就是将符合参数中SQL语句要求的数据修改为example定义的数值。 同理,countBy方法就是获取符合参数中SQL语句要求的数据总量。。。insert、insertBatch方法 当数据库为MySQL时,如果数据表主键自增,则无需定义主键数值;若主键为非自增,则需定义主键数值。 当数据库为Oracle时,如果在配置中定义了数据表的主键生成器,则无需定义主键数值;反之,则需定义主键数值。MapperRepository提供了丰富的方法,以方便对数据库的CURD操作,更多关于MapperRepository的使用说明请移步MapperRepository说明、MapperRepository的API文档。操作对象约定 数据库接口的操作对象主要为JsonObject类型和JsonArray类型。其中top。zuoyu。mybatis。json。JsonObject为键值对容器,以键值的形式装载,数据结构为:{field1:value1,field2:value2,field3:value3,。。。} 键的类型为java。lang。String类型,值的类型可以为任何类型。 JsonObject提供了丰富的方法,以方便操作键值对和类型转换,更多关于JsonObject的使用说明请移步JsonObject说明、JsonObject的API文档。其中top。zuoyu。mybatis。json。JsonArray为数组容器,以多个单位的形式装载,数据结构为:〔object1,object2,object3,。。。〕 每个单位可以为任何类型,且各单位类型允许与其他单位类型不同。 JsonArray提供了丰富的方法,以方便操作键值对和类型转换,更多关于JsonArray的使用说明请移步JsonArray说明、JsonArray的API文档。 具体方法可参考API文档。MapperRepository说明查询所有selectList查询所有return所有数据ListJsonObjectselectList();查询符合样例的数据selectListByExample根据已有键值查询paramexample已有键值return符合要求的数据集合ListJsonObjectselectListByExample(JsonObjectexample);根据主键查询唯一对象selectByPrimaryKey根据主键查询唯一对象paramprimaryKey主键return唯一对象JsonObjectselectByPrimaryKey(SerializableprimaryKey);查询符合条件的数据selectListBy查询符合条件的数据paramsuffixSql条件语句(例如:wherefieldxxx)return数据数量ListJsonObjectselectListBy(StringsuffixSql);查询特定的字段或结果selectFields查询特定的字段或结果(例如:fieldA,fieldB,fieldC)(例如:COUNT(field))paramfields特定的字段或结果return特定的字段或结果JsonArrayselectFields(Stringfields);根据样例查询特定的字段或结果selectFieldsByExample根据已有键值查询特定的字段或结果(例如:fieldA,fieldB,fieldC)(例如:COUNT(field))paramfields特定的字段或结果paramexample已有键值return特定的字段或结果JsonArrayselectFieldsByExample(Stringfields,JsonObjectexample);根据主键查询特定的字段或结果selectFieldsByPrimaryKey根据主键查询特定的字段或结果paramfields特定的字段或结果(例如:fieldA,fieldB,fieldC)paramprimaryKey主键return特定的字段或结果JsonArrayselectFieldsByPrimaryKey(Stringfields,SerializableprimaryKey);根据主键集合查询特定的字段或结果selectFieldsByPrimaryKeys根据主键集合查询特定的字段或结果paramfields特定的字段或结果(例如:fieldA,fieldB,fieldC)paramprimaryKeys主键集合return特定的字段或结果JsonArrayselectFieldsByPrimaryKeys(Stringfields,Serializable〔〕primaryKeys);查询符合条件的数据selectFieldsBy查询符合条件的数据paramfields特定的字段或结果(例如:fieldA,fieldB,fieldC)paramsuffixSql条件语句(例如:wherefieldxxx)return特定的字段或结果JsonArrayselectFieldsBy(Stringfields,StringsuffixSql);查询符合条件的数据数量countBy查询符合条件的数据数量paramsuffixSql条件语句(例如:wherefieldxxx)return数据数量longcountBy(StringsuffixSql);查询是否存在符合样例的数据数量countByExample根据已有键值查询是否存在符合条件的数据数量paramexample已有键值return数据数量longcountByExample(JsonObjectexample);是否存在符合条件的数据existsBy是否存在符合条件的数据paramsuffixSql条件语句(例如:wherefieldxxx)return是否存在booleanexistsBy(StringsuffixSql);是否存在符合样例的数据existsByExample根据已有键值查询是否存在符合条件的数据paramexample已有键值return是否存在booleanexistsByExample(JsonObjectexample);新增对象insert新增对象paramjsonObject对象键值return变动数据的数量intinsert(JsonObjectjsonObject);批量新增对象insertBatch批量新增对象paramjsonObjects对象键值集合return变动数据的数量intinsertBatch(ListJsonObjectjsonObjects);根据主键修改对象属性updateByPrimaryKey根据主键修改对象属性paramjsonObject包含主键对象键值return变动数据的数量intupdateByPrimaryKey(JsonObjectjsonObject);修改特定条件的对象属性updateBy修改特定条件的对象属性paramjsonObject要修改的键值paramsuffixSql条件语句(例如:wherefieldxxx)return变动数据的数量intupdateBy(JsonObjectjsonObject,StringsuffixSql);批量根据主键修改对象属性updateByPrimaryKeyBatch批量根据主键修改对象属性paramjsonObjects对象键值集合return变动数据的数量intupdateByPrimaryKeyBatch(ListJsonObjectjsonObjects);根据主键删除对象deleteByPrimaryKey根据主键删除对象paramprimaryKey主键return变动数据的数量intdeleteByPrimaryKey(SerializableprimaryKey);删除符合条件的数据deleteBy删除符合条件的数据paramsuffixSql条件语句(例如:wherefieldxxx)return变动数据的数量intdeleteBy(StringsuffixSql);批量根据主键删除对象deleteByPrimaryKeys批量根据主键删除对象paramprimaryKeys主键组return变动数据的数量intdeleteByPrimaryKeys(Serializable〔〕primaryKeys);根据样例删除对象deleteByExample根据已有键值删除对象paramexample已有键值return变动数据的数量intdeleteByExample(JsonObjectexample);JsonObject说明 top。zuoyu。mybatis。json。JsonObject为键值对容器,以键值的形式装载,数据结构为:{field1:value1,field2:value2,field3:value3,。。。} 键的类型为java。lang。String类型,值的类型可以为任何类型。类型转换 内部默认已包含常规的类型转换,默认支持以下类型:java。math。BigIntegerjava。math。BigDecimaljava。lang。Booleanjava。lang。Bytejava。lang。Characterjava。util。Datejava。lang。Doublejava。lang。Floatjava。lang。Integerjava。lang。Longjava。lang。Shortjava。lang。String 如果默认的转换器无法满足需求,或者需要转换为其他类型,可通过自定义转换器ConvertClass进行实现,接口方法:publicinterfaceConvertClassT{将给定的value对象转换为T类型paramvalue给定对象return目标转换类型的对象Tconvert(Objectvalue);将给定的value对象转换为T类型,否则返回defaultValueparamvalue给定对象paramdefaultValue默认值return目标转换类型的对象Tconvert(Objectvalue,TdefaultValue);}示例TestvoidconvertTest(){使用JSON字符串初始化对象JsonObjectstudentnewJsonObject(studentJSON);获取学生的性别,如果无法转换则返回未知Stringsexstudent。getValue(sex,newSexConvert());获取学生的性别,如果无法转换则返回未录入StringsexOrDefaultstudent。getValue(sex,newSexConvert(),未录入);}staticclassSexConvertimplementsConvertClassString{OverridepublicStringconvert(Objectvalue){if(valueinstanceofInteger){if((Integer)value1){return男;}elseif((Integer)value0){return女;}}return未知;}OverridepublicStringconvert(Objectvalue,StringdefaultValue){if(valueinstanceofInteger){if((Integer)value1){return男;}elseif((Integer)value0){return女;}}returndefaultValue;}} 本示例也可使用StringConvert转换器,StringConvert为ConvertClass的子接口。 也可以通过toClass方法,将JsonObject对象转换为指定类型的实体类。子接口:BigDecimalConvertBigIntegerConvertBooleanConvertByteConvertCharacterConvertDateConvertDoubleConvertFloatConvertIntegerConvertLongConvertShortConvertStringConvert 更多方法请移步JsonObject的API文档。JsonArray说明 top。zuoyu。mybatis。json。JsonArray为数组容器,以多个单位的形式装载,数据结构为:〔object1,object2,object3,。。。〕 每个单位可以为任何类型,且各单位类型允许与其他单位类型不同。类型转换 具体使用方法与JsonObject在类型转换操作一致,参考JsonObject的类型转换操作 原文链接:https:www。cnblogs。com1214804270hackerp15765776。html