前语

在根据Mybatis的开发形式中，很多开发者还会挑选Mybatis-Plus来辅助功用开发，以此提高开发的效率。尽管Mybatis也有代码生成的东西，但Mybatis-Plus由于在Mybatis根底上做了一些调整，因而，常规的生成东西生成的代码还有一些不太符合预期。并且关于大都据库的支撑不是很好。

因而，咱们需求一款支撑高度定制化，带图形UI页面，能适配大都数据库的根底程序生成结构。本文就介绍这款根据Mybatis-Plus的代码自助生成器，github地址:mybatis-plus-generator-ui。

文章经过实例集成的办法来具体讲解mybatis-plus-generator-ui，感兴趣的朋友能够自己clone下来，也能够自己进行扩展自界说。

一、mybatis-plus-generator-ui是什么？

它是对mybatis-plus-generator进行封装，经过Web UI快速生成兼容Spring boot，mybatis-plus结构的各类业务代码。供给交互式的Web UI用于生成兼容mybatis-plus结构的相关功用代码，包括Entity、Mapper、Mapper.xml、Service、Controller等，能够自界说模板以及各类输出参数，也可经过SQL查询句子直接生成代码。

功用列表：

• Table查询： 查询装备的联系型数据库表的列表查询。
• 输出装备： 对需求生成的相关代码，比方Entity、Mapper、Servcie、Controller等代码模板信息进行装备，用于在转换时调用。
• 项目导入： 能够导入其它项目装备好的信息给本项目运用。
• 下载模板： 支撑本项目装备的模板信息下载后同享。
• 战略装备： 直接界说各种文件的生成战略。
• 模板上传： 支撑从别的项目中下载模板，同上传供本项目运用。
• SQL输入上传： 支撑将查询句子直接上传或许复制到输入框中。
• SQL代码生成： 根据SQL脚本生成相应的代码。

二、 mybatis-plus-generator-ui怎么用？

mybatis-plus-generator-ui供给以jar包的办法为外部项目供给服务，经过装备的数据库装备去读取数据库的装备信息，并经过Web UI的办法供给给开发者运用。mybatis-plus-generator-ui支撑POSTGRE_SQL、ORACLE、DB2、MySQL、SQLSERVER等常见的联系型数据库。

1、maven pom引进

<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函数的办法运转

mybatis-plus-generator-ui在1.4.0版别之后，可支撑将GeberatorUIServer独立布置为一个独自的spring boot项目，经过页面指定方针项目根目录的办法为多个项目供给源码生成服务。这种办法适用于有多个项目库需求独立进行开发的形式。实例要害代码如下：

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十分类似。

3、实例运转

运转以上的main办法，在控制台能够看到以下输出即为成功布置。

在输出的日志中，能够看到程序的运转端口，以及默许的模板目录地址。在浏览器中输入拜访地址http://localhost:8068/，即可进行装备生成。

三、mybatis-plus-generator-ui代码生成

1、Table的查询和浏览

能够直接浏览和查询装备的数据源的数据表信息，可挑选一个或多个生成模板代码。

2、输出装备

内置Entity、Mapper、Service、Controller等6种类型代码的模板装备，能够上传模板进行替换，并修正各类参数，装备参数已经依照影响的文件类型从头进行了分类，并加入了部分文本说明；也能够自行添加其它类型的自界说输出文件。一切的装备项都会依照项目包名进行保存，只需一次性设置就能够了。

3、战略装备

将每次生成代码时或许变化的内容加入到代码生成选项中，方便调整每次的生成战略，比方：是否掩盖原文件，生成文件的种类等等：

4、SQL装备生成

经过输入查询SQL，可自动在Mapper（Xml及Java）中生成对应的查询办法，DTO目标和ResultMap（成果集映射装备）

5、代码生成

四、自界说扩展

1、相关模板调整

在相关的页面中，能够进行相应的调整，在对应的btl模板中下载对应文件的具体模板，运用文本东西翻开，直接修正源代码，文中取一种办法示例，其它办法相同。

2、代码层级的装备

在一些团队中，肯定对Mapper的界说为Dao，Controller层需求界说为Action，经过修正代码模板btl的办法是能够的，还有一种办法是经过调整内部映射的办法来进行修正。主要运用的类是NameConverter。

/**
* 自界说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;
/**
 * 自界说各类称号转换的规矩
 */
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目录下，进行相应的扩展开发。

修正完成后，需求另行编译src\frontend中的静态资源（源码中不包括已编译的页面），在src\frontend文件夹中执行：

yarn install
yarn run build

五、总结

以上便是今天要讲的内容，本文简要介绍一款根据Mybatis-Plus的代码自助生成器，地址:

github.com/davidfantas…

文章经过实例集成的办法来具体讲解mybatis-plus-generator-ui，从相关概念到实际集成案例，以及具体的扩展开发介绍。如果在作业中有这种需求，不妨选用这种办法。期望本文对您有所帮助，欢迎指导交流。