mybatis-plus-generator-ui
提供交互式的Web UI用于生成兼容mybatis-plus框架的相关功能代码,包括Entity,Mapper,Mapper.xml,Service,Controller等 ,可以自定义模板以及各类输出参数,也可通过SQL查询语句直接生成代码。
使用方法
- 引入maven的相关依赖,注意scope只需要写test就可以了
<dependency>
<groupId>com.github.davidfantasy</groupId>
<artifactId>mybatis-plus-generator-ui</artifactId>
<version>1.1.2</version>
<scope>test</scope>
</dependency>
注意:由于本项目引入了mybatis-plus-generator依赖,会间接依赖于mybatis-plus,请尽量使用与当前业务项目中引入mybatis-plus版本兼容的mybatis-plus-generator-ui版本, 否则可能出现依赖冲突的问题,mybatis-plus-generator-ui与mybatis-plus版本对照表如下:
mybatis-plus-generator-ui版本 | mybatis-plus版本 |
---|---|
1.0.X | 3.3.1 |
1.1.X | 3.3.2 |
- 在项目的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")
.basePackage("com.github.davidfantasy.mybatisplustools.example")
.port(8068)
.build();
MybatisPlusToolsApplication.run(config);
}
}
GeneratorConfig包含一些基本的配置参数以及各个可扩展的接口,比如文件的定制或者自定义模板参数,这些都不太好通过UI进行操作。
- 运行该启动类,启动一个Generator Server。然后访问 http://localhost:8068 (端口是可配置的)即可进入到管理界面。
主要功能
- 数据表的查询和浏览:可以直接浏览和查询配置的数据源的数据表信息,可选择一个或多个生成模板代码:
- 输出文件的配置:内置Entity,Mapper,Service,Controller等6种类型代码的模板配置,可以上传模板进行替换,并修改各类参数,配置参数已经按照影响的文件类型重新进行了分类,并加入了部分文本说明;也可以自行添加其它类型的自定义输出文件。所有的配置项都会按照项目包名进行保存,只需一次性设置就可以了。
- 代码生成选项:将每次生成代码时可能变动的内容加入到代码生成选项中,方便调整每次的生成策略,比如:是否覆盖原文件,生成文件的种类等等:
- SQL结果集自动生成代码:通过输入查询SQL,自动在Mapper.xml中生成查询方法,DTO对象和ResultMap(结果集映射配置)
常见问题
Q:下载源码中怎么直接运行?
不建议直接下载源码运行,该项目是设计为直接嵌入到对应的业务项目中使用,可以自动识别项目路径等环境变量。如需采用源码运行,需要另行编译src\frontend中的静态资源(源码中不包含已编译的页面),在src\frontend文件夹中执行:
yarn install
yarn run build
然后修改src\test\java\TestApplication中数据库的相关配置,并运行。
Q:支持哪些类型的数据库?
支持几乎所有主流的数据库,具体可参考mybatis-plus-generator框架的文档。需要自行引入数据库的driver包,并在 GeneratorConfig中指定driverClassName。
Q:怎么自定义模板参数?
在GeneratorConfig中自定义TemplateVaribleInjecter,返回需要在模板中使用的参数,例如:
GeneratorConfig config = GeneratorConfig.builder()
.templateVaribleInjecter(new TemplateVaribleInjecter() {
@Override
public Map<String, Object> getCustomTemplateVaribles(TableInfo tableInfo) {
Map<String,Object> params = new HashMap<>();
return params;
}
})
后面会考虑在页面上添加直接修改自定义参数的功能。
Q:怎么自定义输出文件名,还有数据库字段名称的转换规则?
在GeneratorConfig中自定义NameConverter,可以定义各类输出文件,entity,还有数据库字段名的转换规则,默认的转换规则是下划线转驼峰。 NameConverter有一个默认的实现类,DefaultNameConverter,也可以重新覆盖该类中需要自定义的方法,例如:
GeneratorConfig config = GeneratorConfig.builder().jdbcUrl("jdbc:mysql://192.168.1.211:3306/cimc-user-center")
.userName("root")
.password("root")
.driverClassName("com.mysql.cj.jdbc.Driver")
.basePackage("example")
.nameConverter(new DefaultNameConverter(){
@Override
public String propertyNameConvert(String fieldName) {
return null;
}
})
.port(8068)
.build();
Q:保存的配置是存储到什么地方的?
所有的用户保存的配置是按照basePackage分组保存到user.home目录的.mybatis-plus-generator-ui中的,不同项目的配置不会互相影响。