Mybatis-Plus开发提速器mybatis-plus-generator-ui_mybatisplus generator

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6

前言

       在基于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 bootmybatis-plus框架的各类业务代码。提供交互式的Web UI用于生成兼容mybatis-plus框架的相关功能代码包括Entity,Mapper,Mapper.xml,Service,Controller等 可以自定义模板以及各类输出参数也可通过SQL查询语句直接生成代码。

e6927af544754f648791caac3fb5ecba.png

7afd27972f0942efb4deaf6c07e10cc4.png

功能列表

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

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

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

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")
				// 数据库schemaPOSTGRE_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方法在控制台可以看到以下输出即为成功部署。

1af61643019c4e71ac6f887faae3f2d7.png

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

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

1、Table的查询和浏览

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

2b2be25ebf1c496fa031f3ecbc45a22d.png

 2、输出配置

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

5d45575e060545e093081a0c1bea48ca.png

 3、策略配置

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

2907b966884b463c95516d5af9672c1b.png

 4、SQL配置生成

      通过输入查询SQL可自动在MapperXml及Java中生成对应的查询方法DTO对象和ResultMap结果集映射配置

652144671dd842f287b022c2f5a9c54c.png

 5、代码生成

b5674e572bc4405cb0f09160b372b4cd.png

 c3514e4ba9d24b8bac98cd603842862b.png

四、自定义扩展

1、相关模板调整

       在相关的页面中可以进行相应的调整在对应的btl模板中下载对应文件的具体模板使用文本工具打开直接修改源代码文中取一种方式示例其它方式一样。

5998559d8d12412c9fff669c6ee290c8.png

57de39b9532c42acb61f5d2aad7cba10.png

 2、代码层级的配置

      在一些团队中肯定对Mapper的定义为DaoController层需要定义为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";
}

       除了ServiceController,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目录下进行相应的扩展开发。

dac019825bd14aad8364a30de1f098c5.png       修改完成后需要另行编译src\frontend中的静态资源源码中不包含已编译的页面在src\frontend文件夹中执行

yarn install
yarn run build

 五、总结

        以上就是今天要讲的内容本文简要介绍一款基于Mybatis-Plus的代码自助生成器地址:mybatis-plus-generator-ui。文章通过实例集成的方式来详细讲解mybatis-plus-generator-ui从相关概念到实际集成案例以及具体的扩展开发介绍。如果在工作中有这种需要不妨采用这种方式。希望本文对您有所帮助欢迎指导交流。

 

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6
返回列表

上一篇：基于GUI用户界面的yolov5人脸口罩检测实战项目

下一篇：Linux项目实战——五子棋（单机人人对战版）

“Mybatis-Plus开发提速器mybatis-plus-generator-ui_mybatisplus generator” 的相关文章

Rust基础08-模式匹配1年前 (2023-02-02)
JavaScript笔记1年前 (2023-02-02)
Postman实现UI自动化测试1年前 (2023-02-02)
LeetCode.面试题02.05-链表求和-题解分析1年前 (2023-02-02)
适配器模式1年前 (2023-02-02)
读函数式编程思维笔记03_权责让渡1年前 (2023-02-02)
LESSON TWO : 前言和基础知识1年前 (2023-02-02)
免费内网穿透教程【无公网IP】1年前 (2023-02-02)
【云原生 | 从零开始学istio】二、Istio核心特性与架构_istio 架构变化1年前 (2023-02-02)
C/C++重点八股文1年前 (2023-02-02)

阿里云国际版