MyBatis-Plus可视化代码生成器，让你的开发效率大大提速

ゝ一纸荒年。 2024-02-05 19:20 14阅读 0赞

## 1 前言 ##

在基于Mybatis的开发模式中，很多开发者还会Mybatis-Plus来辅助功能开发，从而提高开发的效率。虽然Mybatis也有代码生成的工具，但是Mybatis-Plus由于在Mybatis基础上做了一些调整，因此，常规的生成生成工具的代码还有一些不太符合预期。而且对于多数据库的支持也不是很好。

因此，我们需要一篇支持高度定制化，带图形UI页面，能够配备大部分数据库的基础程序生成框架。本文就介绍这篇基于Mybatis-Plus的代码自助生成器

> 文章通过实例集成的方式来详细讲解mybatis-plus-generator-ui，感兴趣的朋友可以自己克隆下来(地址文末会给出)，也可以自己进行扩展自定义。

## 2 mybatis-plus-generator-ui是什么？ ##

它是对mybatis-plus-generator进行封装的，通过Web UI快速生成兼容Spring boot，mybatis-plus框架的各类业务代码。提供交互式的Web UI用于生成兼容mybatis-plus框架的相关功能代码，包括等Entity、Mapper、Mapper.xml、Service、Controller，可以自定义模板以及输出参数，也可以通过SQL查询语句直接生成代码。  
![在这里插入图片描述][c82adb6672704546bce67de3cad04d08.png]  
![在这里插入图片描述][572e954ad3c44af7adcbfbfb838e5aab.png]  
功能列表：

*  **表查询**：查询配置的关系型数据库表的列表查询。
 *  **输出配置**：对生成需要的相关代码，比如Entity、Mapper、Servcie、Controller等代码模板信息进行配置，用于在转换时调用。
 *  **项目导入**：可以导入其他项目配置好的信息给本项目使用。
 *  **下载模板**：支持本项目配置的模板信息下载后共享。
 *  **策略配置**：直接设置各种文件的生成策略。
 *  **模板上传**：支持从其他项目中下载模板，同上传供本项目使用。
 *  **SQL输入上传**：支持将查询语句直接上传或者复制到输入框。
 *  **SQL代码生成**：基于SQL脚本生成相应的代码。

## 3 mybatis-plus-generator-ui 怎么用？ ##

mybatis-plus-generator-ui提供以jar包的形式为外部项目提供服务，通过配置的数据库配置读取数据库的配置信息，并通过Web UI的方式提供给开发者使用。支持mybatis-plus-generator-ui等POSTGRE\_SQL、ORACLE、DB2、MySQL、SQLSERVER常见的关系型数据库。

### 3.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>

### 3.2 新建程序入口，以main函数的方式运行 ###

mybatis-plus-generator-ui在1.4.0版本之后，可支持将GeberatorUIServer独立部署为一个单独的spring boot项目，通过页面指定目标项目根目录的方式为多个项目提供源码生成服务。这种方式适用于有多个需要独立的项目库进行开发的模式。实例关键代码如下：

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.3 实例运行 ###

运行以上的main方法，在控制台可以看到以下输出即为部署成功。

![在这里插入图片描述][90f962922d644f609b952709d08cedbf.png]

在输出的日志中，可以看到程序的运行端口，以及默认的模板目录地址。在浏览器中输入访问地址http://localhost:8068/，即可进行配置生成。

## 4 mybatis-plus-generator-ui代码生成 ##

### 4.1 表格的查询和浏览 ###

可以直接浏览和查询配置的数据源的数据表信息，选择一个或多个生成模板代码。

![在这里插入图片描述][43260fe042144b169574bb4a708a6200.png]

### 4.2 输出配置 ###

内置Entity、Mapper、Service、Controller等6种类型代码的模板配置，可以上传模板进行替换，并修改类型参数，配置参数已经按照影响的文件类型重新进行了分类，并加入了部分文本说明；也可以添加自己其他类型的自定义输出文件。所有的配置项都会按照项目包名进行保存，只需一次性设置就可以了。

![在这里插入图片描述][40a2b266331e475a9101f65e0174425b.png]

### 4.3 配置策略 ###

将每次生成代码时可能的内容加入到代码生成选项中，方便调整每次的策略生成，比如：是否覆盖种类原文件，生成文件的等等：

![在这里插入图片描述][16797a22b4304220b64166f2c940efef.jpeg]

### 4.4 SQL配置生成 ###

通过输入查询SQL，可自动在Mapper（Xml及Java）中生成对应的查询方法，DTO对象和ResultMap（结果集映射配置）  
![在这里插入图片描述][a8e67e8a50794a6e98101f050bedc43f.png]

### 4.5 代码生成 ###

![在这里插入图片描述][ef926581127a41d99386a1d23070e1c7.png]  
![在这里插入图片描述][2b2ec59fa2fa42118d0f4a3dda4ffdc9.png]

## 5 自定义扩展 ##

### 5.1 相关模板调整 ###

在相关的页面中，可以进行相应的调整，在对应的btl模板中下载对应文件的具体模板，使用文本工具打开，直接修改源代码，文中取一种方式示例，其他方式一样。  
![在这里插入图片描述][cb1885936d5543b19a19982b06d730de.png]

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="${package.Mapper}.${table.mapperName}">
    
    <% if(enableCache){ %>
        
        <cache type="${cacheClassName}"/>
    
    <% } %>
    <% if(baseResultMap){ %>
        
        <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
    <% for(field in table.fields){ %>
       <% /** 生成主键排在第一位 **/ %>
       <% if(field.keyFlag){ %>
            <id column="${field.name}" property="${field.propertyName}" />
       <% } %>
    <% } %>
    <% for(field in table.commonFields){ %>
        <% /** 生成公共字段 **/ %>
            <result column="${field.name}" property="${field.propertyName}" />
    <% } %>
    <% for(field in table.fields){ %>
       <% /** 生成普通字段 **/ %>
       <% if(!field.keyFlag){ %>
            <result column="${field.name}" property="${field.propertyName}" />
       <% } %>
    <% } %>
        </resultMap>
    <% } %>
    <% if(baseColumnList){ %>
        
        <sql id="Base_Column_List">
    <% for(field in table.commonFields){ %>
            ${field.columnName},
    <% } %>
            ${table.fieldNames}
        </sql>
    
    <% } %>
    </mapper>

### 5.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类的核心代码，这里有详细的定义。

/**
     * 自定义各类名称转换的规则
     */
    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目录下，进行相应的扩展开发。

![在这里插入图片描述][706842e649f441229aaac58e76457e9c.png]  
修改完成后，需要另外编译src\\frontend中的静态资源（源码中不包含已编译的页面），在src\\frontend文件夹中执行：

yarn install
    yarn run build

## 6 总结 ##

以上就是今天要讲的内容，本文简要介绍了一篇基于Mybatis-Plus的自助代码生成器，  
地址：[https://github.com/davidfantasy/mybatis-plus-generator-ui][https_github.com_davidfantasy_mybatis-plus-generator-ui]

[c82adb6672704546bce67de3cad04d08.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f57bdc0fd4024a6da088eefb1340d8bf.png
[572e954ad3c44af7adcbfbfb838e5aab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/dc86e0101382452191a6b8f7f456a28a.png
[90f962922d644f609b952709d08cedbf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/ae1c4756147d433b85ae8057b2e8408a.png
[43260fe042144b169574bb4a708a6200.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/caa753607c864091bdeb0d43d1c39163.png
[40a2b266331e475a9101f65e0174425b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/13a3f74ff1904b4cbc3dcecf7e6530fc.png
[16797a22b4304220b64166f2c940efef.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/c9165f4513ad402a953d64777d4a91ea.png
[a8e67e8a50794a6e98101f050bedc43f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/209e99141fc4474bbf533cbc9c7a33d6.png
[ef926581127a41d99386a1d23070e1c7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/c34cade87b8f4b1abf84c273b928fcf6.png
[2b2ec59fa2fa42118d0f4a3dda4ffdc9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9435804f956044d6ad868f32ca3ad6dc.png
[cb1885936d5543b19a19982b06d730de.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/a5073f0835424f599fceb12367276c37.png
[706842e649f441229aaac58e76457e9c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/51e2b3f4e4fe476fbb77fc9f8f9eefd2.png
[https_github.com_davidfantasy_mybatis-plus-generator-ui]: https://github.com/davidfantasy/mybatis-plus-generator-ui