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

news2025/1/18 14:43:24

前言

       在基于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查询语句直接生成代码。

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

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，可自动在Mapper（Xml及Java）中生成对应的查询方法，DTO对象和ResultMap（结果集映射配置）

652144671dd842f287b022c2f5a9c54c.png

 5、代码生成

b5674e572bc4405cb0f09160b372b4cd.png

 c3514e4ba9d24b8bac98cd603842862b.png

四、自定义扩展

1、相关模板调整

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

5998559d8d12412c9fff669c6ee290c8.png

57de39b9532c42acb61f5d2aad7cba10.png

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

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

yarn install
yarn run build

 五、总结

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

 

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/44438.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【一文秒懂——SLF4j日志】

【一文秒懂——SLF4j日志】

目录 1. SLF4j日志 2. 日志输出 1. SLF4j日志 在添加了spring-boot-starter的项目中&#xff0c;已经包含了SLF4j日志的相关依赖项。 在添加了lombok的项目中&#xff0c;可以在类上添加Slf4j注解&#xff0c;则lombok框架会在编译期在类中声明名为log的变量&#xff0c;通…
阅读更多...
农民歌唱家大衣哥喜迎贵客，这三位明星一般人还真请不动

农民歌唱家大衣哥喜迎贵客，这三位明星一般人还真请不动

都知道农民歌唱家大衣哥家里热闹&#xff0c;不过大部分都是蹭流量拍视频的&#xff0c;真正的好朋友绝对没有几个。虽然说没有几个好朋友&#xff0c;但是也不代表一个没有&#xff0c;看看在大衣哥家里吃饭的三位&#xff0c;每一个都不是一般人物。 如今的大衣哥&#xff0c…
阅读更多...
发现智能合约中的 bug 的 7 个方法

发现智能合约中的 bug 的 7 个方法

寻找智能合约bug可能是一项高回报的工作&#xff0c;而且它也保护了生态系统免受黑客攻击。我最近有幸采访了一位开发人员&#xff0c;他发现了一个价值 70 亿美元的错误&#xff0c;并因报告该错误而获得了 220 万美元的报酬。 在这篇文章中&#xff0c;我将详细介绍该开发人…
阅读更多...
路由和流量控制

路由和流量控制

路由策略 控制路由，从而影响IP包的转发路径。 路由策略的主要功能有两个，1）过滤路由信息，2）修改路由属性值。 路由匹配工具 acl 只有基本acl（Basic ACL，编号为 2000-2999）可以匹配路由。ACL匹配路由时只能匹配路由的网络号，但无法匹配掩码长度。 [RouterA] acl n…
阅读更多...
基于SpringBoot的会员制医疗预约服务管理信息系统

基于SpringBoot的会员制医疗预约服务管理信息系统

末尾获取源码 开发语言&#xff1a;Java Java开发工具&#xff1a;JDK1.8 后端框架&#xff1a;SpringBoot 前端&#xff1a;Vue、HTML 数据库&#xff1a;MySQL5.7和Navicat管理工具结合 服务器&#xff1a;Tomcat8.5 开发软件&#xff1a;IDEA / Eclipse 是否Maven项目&#…
阅读更多...
使用CSS实现多种Noise噪点效果

使用CSS实现多种Noise噪点效果

在插画中添加噪点肌理可以营造出一种自然的氛围。噪点肌理可以用于塑造阴影、高光、深度以及更多细节&#xff0c;并优化插画质感&#xff0c;应用噪点肌理的方式在扁平插画中广受欢迎。 在前端开发过程中&#xff0c;我们也有可能遇到噪点插画风格的设计稿&#xff0c;应用基…
阅读更多...
实验三-----数据库

实验三-----数据库

一、实验目的 1.掌握SQL Server Management Studio中SQL 查询操作&#xff1b; 2.掌握SQL 的单表查询命令&#xff1b; 3.掌握SQL 的连接查询操作&#xff1b; 4.掌握SQL 的嵌套查询操作&#xff1b; 5.掌握SQL 的集合查询操作。 二、实验环境 1&#xff0e;实验室名称&…
阅读更多...
Nevron 3DChart创建有吸引力的3D和2D图表

Nevron 3DChart创建有吸引力的3D和2D图表

Nevron 3DChart创建有吸引力的3D和2D图表 3DChart使用OpenGL 3D图形引擎创建复杂的2D和3D图表和图形，这些图表和图形可以包含静止或动画图像。3DChart包括用于生成图表模板的独立应用程序和ASP服务器配置实用程序。该组件还包括一个专门设计用于与3DChart集成的工具栏组件。用…
阅读更多...
SignalR简介及实践指南

SignalR简介及实践指南

SigalR简介 ASP.NET Core SignalR 是一个开放源代码库&#xff0c;可用于简化向应用添加实时 Web 功能。 实时 Web 功能使服务器端代码能够将内容推送到客户端。 适合 SignalR 的候选项&#xff1a; 需要从服务器进行高频率更新的应用。 示例包括游戏、社交网络、投票、拍卖…
阅读更多...
【LeetCode】No.102. Binary Tree Level Order Traversal -- Java Version

【LeetCode】No.102. Binary Tree Level Order Traversal -- Java Version

题目链接&#xff1a;https://leetcode.com/problems/binary-tree-level-order-traversal/ 1. 题目介绍&#xff08;Binary Tree Level Order Traversal&#xff09; Given the root of a binary tree, return the level order traversal of its nodes’ values. (i.e., from …
阅读更多...
React Redux 中触发异步副作用

React Redux 中触发异步副作用

React Redux 中触发异步副作用 一些基本的配置&#xff08;这里使用 toolkit&#xff09;可以在这篇笔记中找到&#xff1a;react-redux 使用小结&#xff0c;这里不多赘述。 触发副作用主流的操作方式有两种&#xff1a; 组件内操作 适合只会在当前组件中触发的 API 操作 写…
阅读更多...
企业数仓DQC数据质量管理实践篇

企业数仓DQC数据质量管理实践篇

一.数据质量管理背景 以大数据平台的核心理念是构建于业务之上&#xff0c;用数据为业务创造价值。大数据平台、数据仓库的搭建之初&#xff0c;优先满足业务的使用需求&#xff0c;数据质量往往是被忽视的一环。但随着业务的逐渐稳定&#xff0c;数据质量越来越被人们所重视。…
阅读更多...
2.1.3 运算放大器的参数以及选型、静态、交流技术指标

2.1.3 运算放大器的参数以及选型、静态、交流技术指标

笔者电子信息专业硕士毕业&#xff0c;获得过多次电子设计大赛、大学生智能车、数学建模国奖&#xff0c;现就职于南京某半导体芯片公司&#xff0c;从事硬件研发&#xff0c;电路设计研究。对于学电子的小伙伴&#xff0c;深知入门的不易&#xff0c;特开次博客交流分享经验&a…
阅读更多...
基于小脑模型神经网络轨迹跟踪matlab程序

基于小脑模型神经网络轨迹跟踪matlab程序

1 CMAC概述 小脑模型神经网络(Cerebellar Model Articulation Controller,CMAC)是一种表达复杂非线性函数的表格查询型自适应神经网络&#xff0c;该网络可通过学习算法改变表格的内容&#xff0c;具有信息分类 存储的能力。 CMAC把系统的输入状态作为一个指针&#xff0c;把相…
阅读更多...
Oracle-Autoupgrade方式升级19c

Oracle-Autoupgrade方式升级19c

前言: Autoupgrade是Oracle 推出的自动升级工具&#xff0c;通过该工具可以将数据库升级为Oracle12.2之后的版本&#xff0c;工具支持升级前的检查、升级问题修复、一键式自动升级以及升级后的问题修复&#xff0c;极大的简化数据库的升级步骤。 支持的目标升级版本: Oracle D…
阅读更多...
用 Java 实现爬虫 (爬取本地html中的人物信息并可视化人物关系)

用 Java 实现爬虫 (爬取本地html中的人物信息并可视化人物关系)

目录 爬虫简介 常用的工具框架 selenium Jsoup Jsoup介绍 Jsoup的主要功能如下&#xff1a; HTML 相关知识 通过Jsoup元素获取 案例 爬取本地html中的角色信息 HtmlParseUtil 可以利用relation-graph 将人物关系可视化 使用爬虫要注意 查看网站的爬虫协议 爬虫简介…
阅读更多...
面试：ANR原因及排查

面试：ANR原因及排查

ANR原因 1、CPU满负荷&#xff0c;I/O阻塞 2、内存不足&#xff0c;系统分配给一个应用的内存是有上限的&#xff0c;长期处于内存紧张&#xff0c;会导致频繁内存交换&#xff0c;进而导致应用的一些操作超时。自己内存泄漏或者其他应用占用的大量内存 3、四大组件ANR 4、…
阅读更多...
字符串压缩（一）之ZSTD

字符串压缩（一）之ZSTD

一、zstd压缩与解压 ZSTD_compress属于ZSTD的Simple API范畴&#xff0c;只有压缩级别可以设置。 ZSTD_compress函数原型如下&#xff1a; size_t ZSTD_compress(void* dst, size_t dstCapacity, const void* src, size_t srcSize, int compressionLevel) ZSTD_decompress函数原…
阅读更多...
Mysql replace into

Mysql replace into

CREATE TABLE t (id int(11) NOT NULL AUTO_INCREMENT,age int(11) DEFAULT NULL,msg varchar(10) DEFAULT NULL,PRIMARY KEY (id),UNIQUE KEY uniq_age (age) ) ENGINEInnoDB DEFAULT CHARSETutf8;insert into t (age, msg) values (1,aaa),(2,bbb),(3,ccc);id 为自增主键、ag…
阅读更多...
「重学JS」你真的懂数据类型吗?

「重学JS」你真的懂数据类型吗?

前言 学习了这么久前端&#xff0c;发现自己对于基础知识的掌握并没有那么通透&#xff0c;于是打算重新学一遍JS&#xff0c;引用经济学的一句话&#xff1a;JS基础决定能力高度&#x1f926;&#x1f3fb; 基础很重要&#xff0c;只有基础好才会很少出 bug&#xff0c;大多数…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023