Mybatis generator
mybatis 自动生成代码工具介绍
mybatis使用起来轻便,可编写Sql。受到很多开发者的喜爱。但是由于项目需要大量sql也让人很烦躁。
所以mybatis自己开发出了自动生成代码工具。
MBG官方源码
MBG官方文档
官方文档很详细但是还是有一些很好用的功能细节没有提及,在这里简单介绍一下。
MBG生成的代码是可以和mybatis发行的版本兼容的。
-
targetRuntime 生成代码的目标
-
MyBatis3DynamicSql 要求
MyBatis3.4.2+
,Java8+
还需要依赖MyBatis Dynamic SQL
选择该目标model为flat类型忽略defaultModelType配置。使用注解动态sql方式,不会生成XML文件。 -
MyBatis3 要求
MyBatis3.0+
Java5+
生成XML配置文件和额外的Example类,Example不用写Sql就可以实现对单表的复杂查询操作。 -
MyBatis3Simple 和MyBatis3类似,但是不会生成Example类。
-
-
defaultModelType 这个是生成model的类型(实体类)
-
flat 一个table对应一个model
-
hierarchical 生成只含有主键的类,然后生成含有基本字段的类继承主键类, 生成只含有BLOB字段的类继承基础类,
-
conditional 和hierarchical类似,只不过如果主键只有一个字段,则会合并到基础类中
-
其他配置文件在文尾给出。
在使用MBG时。当对一个表重复生成代码,mybatis 生成的xml文件会根据id前缀ibatorgenerated_
abatorgenerated_
或者生成的注释进行合并。有时候我们不喜欢自动生成乱七八糟的注释,希望根据ID合并 但是MBG没有这个选项。
MBG同样也不支持Model,Mapper类合并。这是很痛苦的事情,例如,我们在数据库添加一个字段,重新生成一遍。它会覆盖掉之前生成的Model,Mapper,Example类。如果我们在Model和其他Model类有了依赖,在配置一对一,一对多时,这是非常糟糕的。自动生成的Mapper里的方法包括了所有的单表操作,然而我们经常面对多表操作,如果我们在Mapper里定义自己的方法。重新执行MBG时也会被覆盖掉。
针对这些问题,我们自己可以稍微修改了一下MBG源码。支持以上功能
代码实现预想细节,
xml根据ID合并,如果存在的文件ID是自动生成的则删掉。
生成的Example不合并,直接覆盖。
Mapper类只合并方法。
Model类,已存在的类的字段如果不含有@mbg.generated
(生成代码时自动添加的)注释则保留。新生成的字段+保留字段 为合并后的类。
同时也可以添加Lombok功能。不用写setter,getter方法。
实现源码
https://gitee.com/youth_is_doing/generator
可以直接下载 发行版mybatis-generator-core-1.4.0.jar
包,然后使用maven安装到本地使用。
下载地址mybatis-generator-core-1.4.0.jar
需要注意的是。使用这个jar时需要引用javaparser
maven示例配置文件
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
<configuration>
<overwrite>false</overwrite>
<configurationFile>${basedir}/src/main/resources/generatorConfig.xml
</configurationFile>
</configuration>
<dependencies>
<dependency>