专栏名称: Java基基
一个苦练基本功的 Java 公众号,所以取名 Java 基基
目录
相关文章推荐
新腕儿  ·  拼多多与芒果TV发布短剧激励新政策 ·  2 天前  
新腕儿  ·  拼多多与芒果TV发布短剧激励新政策 ·  2 天前  
融媒吴江  ·  太火爆!大涨600%! ·  2 天前  
融媒吴江  ·  太火爆!大涨600%! ·  2 天前  
51好读  ›  专栏  ›  Java基基

MyBatis-Plus 开发提速器:mybatis-plus-generator-ui

Java基基  · 公众号  · 科技自媒体  · 2024-09-05 21:06

主要观点总结

本文介绍了基于Mybatis-Plus的代码自助生成器mybatis-plus-generator-ui,通过实例集成的方式详细讲解了其使用方法和功能特点。

关键观点总结

关键观点1: mybatis-plus-generator-ui是什么

mybatis-plus-generator-ui是一款基于Mybatis-Plus的代码自助生成器,提供了交互式的Web UI用于生成兼容Mybatis-Plus框架的相关功能代码,包括Entity、Mapper、Service、Controller等。

关键观点2: mybatis-plus-generator-ui的使用方式

mybatis-plus-generator-ui的使用方式包括maven pom引入、新建程序入口以main函数的方式运行、实例运行等步骤。

关键观点3: mybatis-plus-generator-ui的代码生成功能

mybatis-plus-generator-ui提供了Table的查询和浏览、输出配置、策略配置、SQL配置生成等代码生成功能。

关键观点4: mybatis-plus-generator-ui的自定义扩展

mybatis-plus-generator-ui支持自定义扩展,包括相关模板调整和代码层级的配置。可以通过修改模板文件和调整NameConverter类来实现自定义的生成规则。

关键观点5: 总结

文章对mybatis-plus-generator-ui的功能和特点进行了总结,并提供了加入知识星球的方式和文章有帮助的反馈方式。


正文

👉 这是一个或许对你有用 的社群

🐱 一对一交流/面试小册/简历优化/求职解惑,欢迎加入 芋道快速开发平台 知识星球。 下面是星球提供的部分资料:

👉 这是一个或许对你有用的开源项目

国产 Star 破 10w+ 的开源项目,前端包括管理后台 + 微信小程序,后端支持单体和微服务架构。

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号等等功能:

  • Boot 地址:https://gitee.com/zhijiantianya/ruoyi-vue-pro
  • Cloud 地址:https://gitee.com/zhijiantianya/yudao-cloud
  • 视频教程:https://doc.iocoder.cn
来源:blog.csdn.net/yelangkingwuzuhu
/article/details/128077533

前言

在基于Mybatis的开发模式中,很多开发者还会选择Mybatis-Plus来辅助功能开发,以此提高开发的效率。虽然Mybatis也有代码生成的工具,但Mybatis-Plus由于在Mybatis基础上做了一些调整,因此,常规的生成工具生成的代码还有一些不太符合预期。而且对于多数据库的支持不是很好。

因此,我们需要一款支持高度定制化,带图形UI页面,能适配多数数据库的基础程序生成框架。本文就介绍这款基于Mybatis-Plus的代码自助生成器,github地址: mybatis-plus-generator-ui

文章通过实例集成的方式来详细讲解 mybatis-plus-generator-ui ,感兴趣的朋友可以自己clone下来,也可以自己进行扩展自定义。

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/ruoyi-vue-pro
  • 视频教程:https://doc.iocoder.cn/video/

一、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脚本生成相应的代码。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/yudao-cloud
  • 视频教程:https://doc.iocoder.cn/video/

二、 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.0modelVersion>
 <groupId>com.yelanggroupId>
 <artifactId>mybatis-plus-generator-ui-caseartifactId>
 <version>0.0.1-SNAPSHOTversion>
 
 <dependencies>
  <dependency>
   <groupId>com.github.davidfantasygroupId>
   <artifactId>mybatis-plus-generator-uiartifactId>
   <version>1.4.5version>
  dependency>
  
  <dependency>
   <groupId>org.postgresqlgroupId>
   <artifactId>postgresqlartifactId>
   <version>42.2.25version>
  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






请到「今天看啥」查看全文