关于后端:重磅MyBatisPlus-可视化代码生成器来啦开发效率提升2倍

41次阅读

共计 7158 个字符，预计需要花费 18 分钟才能阅读完成。

重磅！MyBatis-Plus 可视化代码生成器来啦，开发效率晋升 2 倍！！

  • 前言
  • 一、mybatis-plus-generator-ui 是什么？
  • 二、mybatis-plus-generator-ui 怎么用？
    • 1、maven pom 引入
    • 2、新建程序入口，以 main 函数的形式运行
    • 3、实例运行
  • 三、mybatis-plus-generator-ui 代码生成
    • 1、Table 的查问和浏览
    • 2、输入配置
    • 3、策略配置
    • 4、SQL 配置生成
    • 5、代码生成
  • 四、自定义扩大
    • 1、相干模板调整
    • 2、代码层级的配置
  • 五、总结

前言

在基于 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 的代码自助生成器，地址:

  • https://github.com/davidfantasy/mybatis-plus-generator-ui

文章通过实例集成的形式来具体解说mybatis-plus-generator-ui，从相干概念到理论集成案例，以及具体的扩大开发介绍。如果在工作中有这种须要，无妨采纳这种形式。心愿本文对您有所帮忙，欢送领导交换。

本文由 mdnice 多平台公布

正文完
后端
发表至： 后端
2023-06-08
 0
关于后端:springMVC图书管理系统借阅
关于后端:我在京东做研发丨京东云全链路应用性能监控体系建设
关于后端:OpenSergo-CloudWeGo-共同保障微服务运行时流量稳定性
关于后端:如何破解AI落地应用难题深信服边缘AI技术助你轻松实现