MyBatis-Plus是一个比较流行的 MyBatis 的增强工具,它提供了一个代码生成框架mybatis-plus-generator 功能也非常强大,可以根据数据库表结构生成Entity,Mapper,Service,Controller等一系列的基础代码,配合框架的支持,基本实现了普通单表增删改查的0编码。
但是mybatis-plus-generator并没有提供交互的界面,只有一个简单的命令行用于输入表名,稍微复杂的定制都需要每次改动代码才能实现。而且目前mybatis-plus-generator提供的配置感觉有些让人疑惑,配置项被分割到了好几个不同的配置类当中,也没有一个统一的配置说明,只有通过阅读源码加不断的摸索才能搞清楚配置项的作用和影响范围。
针对上述的一些问题,我在mybatis-plus-generator框架的基础上重新封装了一个交互层——mybatis-plus-generator-ui 。它提供了一个UI server,启动后可以进入一个web控制台,在控制台中可以以UI交互的方式对各项参数进行配置,选择生成代码的种类和数据表,定制输出文件等,尽可能的将生成代码这件事情变得傻瓜化。
使用方法
- 引入maven的相关依赖,注意scope只需要写test就可以了
<dependency>
<groupId>com.github.davidfantasy</groupId>
<artifactId>mybatis-plus-generator-ui</artifactId>
<version>1.2.0</version>
<scope>test</scope>
</dependency>
- 在项目的test目录新建一个启动类,代码示例如下:
public class GeberatorUIServer {
public static void main(String[] args) {
GeneratorConfig config = GeneratorConfig.builder().jdbcUrl("jdbc:mysql://192.168.1.211:3306/example")
.userName("root")
.password("root")
.driverClassName("com.mysql.cj.jdbc.Driver")
//数据库schema,POSTGRE_SQL,ORACLE,DB2类型的数据库需要指定
.schemaName("myBusiness")
//如果需要修改各类生成文件的默认命名规则,可自定义一个NameConverter实例,覆盖相应的名称转换方法:
.nameConverter(new NameConverter() {
/**
* 自定义Service类文件的名称规则
*/
@Override
public String serviceNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Service";
}
/**
* 自定义Controller类文件的名称规则
*/
@Override
public String controllerNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Action";
}
})
.basePackage("com.github.davidfantasy.mybatisplustools.example")
.port(8068)
.build();
MybatisPlusToolsApplication.run(config);
}
}
GeneratorConfig还包含一些基本的配置参数以及各个可扩展的接口,比如自定义模板参数,具体的说明可查看源码注释。
- 运行该启动类,启动一个Generator Server。然后访问 http://localhost:8068 (端口是可配置的)即可进入到管理界面。
主要功能
- 数据表的查询和浏览:可以直接浏览和查询配置的数据源的数据表信息,可选择一个或多个生成模板代码:
- 输出文件的配置:内置Entity,Mapper,Service,Controller等6种类型代码的模板配置,可以上传模板进行替换,并修改各类参数,配置参数已经按照影响的文件类型重新进行了分类,并加入了部分文本说明;也可以自行添加其它类型的自定义输出文件。所有的配置项都会按照项目包名进行保存,只需一次性设置就可以了。
- 代码生成选项:将每次生成代码时可能变动的内容加入到代码生成选项中,方便调整每次的生成策略,比如:是否覆盖原文件,生成文件的种类等等:
- SQL结果集自动生成代码:通过输入查询SQL,自动在Mapper.xml中生成查询方法,DTO对象和ResultMap(结果集映射配置)
- 动态SQL增强:自动识别含有mybatis动态参数的where条件,转换为mybatis的动态SQL条件
后续视情况还会添加新的方便性功能,源代码请查看 mybatis-plus-generator-ui,觉得好用的话就Star一下吧~