mybatis-plus代码生成器的UI界面使用非常方便

介绍

MyBatis-Plus Generator-UI是一个对MyBatis-Plus Generator进行封装的工具,通过Web UI界面可以快速生成兼容Spring Boot和MyBatis-Plus框架的各类业务代码。这个工具提供交互式的Web UI用于生成与MyBatis-Plus框架相关的功能代码,包括Entity、Mapper、Mapper.xml、Service、Controller等,并且可以自定义模板以及各类输出参数,也可以通过SQL查询语句直接生成代码。

使用MyBatis-Plus Generator-UI可以大大提高开发效率,减少手动编写重复代码的工作量。它支持高度定制化,可以根据实际需求进行配置和扩展。此外,MyBatis-Plus Generator-UI还提供了一些实用的功能,如Table查询、输出配置、项目导入、下载模板和SQL代码生成等。

要使用MyBatis-Plus Generator-UI,需要先运行Generator Server,然后通过访问管理界面来选择需要生成的业务代码类型和配置参数。管理界面提供了可视化的操作界面,方便用户进行配置和操作。

功能列表:

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引入

 4.0.0
 com.yelang
 mybatis-plus-generator-ui-case
 0.0.1-SNAPSHOT
 
 
  
   com.github.davidfantasy
   mybatis-plus-generator-ui
   1.4.5
  
  
  
   org.postgresql
   postgresql
   42.2.25
  
 

2、新建程序入口,以main函数的方式运行


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


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方法,在控制台可以看到以下输出即为成功部署。

mybatis-plus代码生成器的UI界面使用非常方便_第1张图片
在输出的日志中,可以看到程序的运行端口,以及默认的模板目录地址。在浏览器中输入访问地址http://localhost:8068/,即可进行配置生成。

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


1、Table的查询和浏览


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

mybatis-plus代码生成器的UI界面使用非常方便_第2张图片
2、输出配置


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

mybatis-plus代码生成器的UI界面使用非常方便_第3张图片


3、策略配置

将每次生成代码时可能变动的内容加入到代码生成选项中,方便调整每次的生成策略,比如:是否覆盖原文件,生成文件的种类等等:
mybatis-plus代码生成器的UI界面使用非常方便_第4张图片
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,mybatis,ui)