前 言
在基于 Mybatis 的开发模式中,很多开发者还会选择 Mybatis-Plus 来辅助功能开发,以此提高开发的效率。
虽然 Mybatis 也有代码生成的工具,但 Mybatis-Plus 由于在 Mybatis 基础上做了一些调整,因此,常规的生成工具生成的代码还有一些不太符合预期。而且对于多数据库的支持不是很好。
因此,我们需要一款支持高度定制化,带图形 UI 页面,能适配多数数据库的基础程序生成框架。本文就介绍这款基于 Mybatis-Plus 的代码自助生成器: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 项目,通过页面指定目标项目根目录的方式为多个项目提供源码生成服务。这种方式适