因此,我们需要一款支持高度定制化,带图形UI页面,能适配多数数据库的基础程序生成框架。本文就介绍这款基于Mybatis-Plus的代码自助生成器,github地址:mybatis-plus-generator-ui。文章通过实例集成的方式来详细讲解mybatis-plus-generator-ui,感兴趣的朋友可以自己clone下来,也可以自己进行扩展自定义。
SQL代码生成: 基于SQL脚本生成相应的代码。
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.yelang</groupId> <artifactId>mybatis-plus-generator-ui-case</artifactId> <version>0.0.1-SNAPSHOT</version> <dependencies> <dependency> <groupId>com.github.davidfantasy</groupId> <artifactId>mybatis-plus-generator-ui</artifactId> <version>1.4.5</version> </dependency> <dependency> <groupId>org.postgresql</groupId> <artifactId>postgresql</artifactId> <version>42.2.25</version> </dependency> </dependencies> </project>2、新建程序入口,以main函数的方式运行
package com.yelang; import com.github.davidfantasy.mybatisplus.generatorui.GeneratorConfig; import com.github.davidfantasy.mybatisplus.generatorui.MybatisPlusToolsApplication; import com.github.davidfantasy.mybatisplus.generatorui.mbp.NameConverter; public class GeneratorMain { public static void main(String[] args) { GeneratorConfig config = GeneratorConfig.builder().jdbcUrl("jdbc:postgresql://127.0.0.1:5432/ghyapp") .userName("ghy01").password("ghy01").driverClassName("org.postgresql.Driver") // 数据库schema,POSTGRE_SQL,ORACLE,DB2类型的数据库需要指定 // .schemaName("myBusiness") // 如果需要修改各类生成文件的默认命名规则,可自定义一个NameConverter实例,覆盖相应的名称转换方法: .nameConverter(new NameConverter() { /** * 自定义Service类文件的名称规则 */ public String serviceNameConvert(String tableName) { return this.entityNameConvert(tableName) + "Service"; } /** * 自定义Controller类文件的名称规则 */ public String controllerNameConvert(String tableName) { return this.entityNameConvert(tableName) + "Action"; } }).basePackage("com.github.davidfantasy.mybatisplustools.example").port(8068).build(); MybatisPlusToolsApplication.run(config); } }在上面的配置中,我们连接的示例数据库是PostgerSQL,需要在Maven中定义相应的驱动程序,并且在上述代码中正确配置相应的类。最后指定了程序的运行端口为8086,这种运行方式跟SpringBoot非常相似。
四、自定义扩展
2、代码层级的配置
/** * 自定义Service类文件的名称规则 */ public String serviceNameConvert(String tableName) { return this.entityNameConvert(tableName) + "Service"; } /** * 自定义Controller类文件的名称规则 */ public String controllerNameConvert(String tableName) { return this.entityNameConvert(tableName) + "Action"; }除了Service、Controller、Entity、FieldName都可以实现自定义的扩展。下面是NameConverter类的核心代码,这里有详细的定义。
package com.github.davidfantasy.mybatisplus.generatorui.mbp; import cn.hutool.core.util.StrUtil; import com.github.davidfantasy.mybatisplus.generatorui.dto.Constant; import com.google.common.base.Strings; import static com.github.davidfantasy.mybatisplus.generatorui.dto.Constant.DOT_JAVA; import static com.github.davidfantasy.mybatisplus.generatorui.dto.Constant.DOT_XML; /** * 堆代码 duidaima.com * 自定义各类名称转换的规则 */ public interface NameConverter { /** * 自定义Entity.java的类名称 * * @param tableName 表名称 * @return */ default String entityNameConvert(String tableName) { if (Strings.isNullOrEmpty(tableName)) { return ""; } tableName = tableName.substring(tableName.indexOf(StrUtil.UNDERLINE) + 1, tableName.length()); return StrUtil.upperFirst(StrUtil.toCamelCase(tableName.toLowerCase())); } /** * 自定义表字段名到实体类属性名的转换规则 * * @param fieldName 表字段名称 * @return */ default String propertyNameConvert(String fieldName) { if (Strings.isNullOrEmpty(fieldName)) { return ""; } if (fieldName.contains("_")) { return StrUtil.toCamelCase(fieldName.toLowerCase()); } return fieldName; } /** * 自定义Mapper.java的类名称 */ default String mapperNameConvert(String tableName) { return entityNameConvert(tableName) + "Mapper"; } /** * 自定义Mapper.xml的文件名称 */ default String mapperXmlNameConvert(String tableName) { return entityNameConvert(tableName) + "Mapper"; } /** * 自定义Service.java的类名称 */ default String serviceNameConvert(String tableName) { return "I" + entityNameConvert(tableName) + "Service"; } /** * 自定义ServiceImpl.java的类名称 */ default String serviceImplNameConvert(String tableName) { return entityNameConvert(tableName) + "ServiceImpl"; } /** * 自定义Controller.java的类名称 */ default String controllerNameConvert(String tableName) { return entityNameConvert(tableName) + "Controller"; } /** * 自定义其它生成文件的文件名(不包括entity,mapper.java,mapper.xml,service,serviceImpl,controller这6种) * * @param fileType 在页面上输入的输出文件标识 * @param tableName 关联的数据表名称名称 * @return 生成文件的名称,带后缀 */ default String outputFileNameConvert(String fileType, String tableName) { if (fileType.equals(Constant.FILE_TYPE_ENTITY)) { return this.entityNameConvert(tableName) + DOT_JAVA; } else if (fileType.equals(Constant.FILE_TYPE_MAPPER)) { return this.mapperNameConvert(tableName) + DOT_JAVA; } else if (fileType.equals(Constant.FILE_TYPE_MAPPER_XML)) { return this.mapperXmlNameConvert(tableName) + DOT_XML; } else if (fileType.equals(Constant.FILE_TYPE_SERVICE)) { return this.serviceNameConvert(tableName) + DOT_JAVA; } else if (fileType.equals(Constant.FILE_TYPE_SERVICEIMPL)) { return this.serviceImplNameConvert(tableName) + DOT_JAVA; } else if (fileType.equals(Constant.FILE_TYPE_CONTROLLER)) { return this.controllerNameConvert(tableName) + DOT_JAVA; } return this.entityNameConvert(tableName) + fileType; } }mybatis-plus-generator-ui的功能非常丰富,甚至针对ui都是可以自定义修改的。如果需要定制UI的话,将代码clone下来后,进入到frontend目录下,进行相应的扩展开发。
yarn install yarn run build五、总结