devbox
花生_TL007
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

MyBatis-Plus 可视化代码生成器来啦，生产力直接拉满

作者：花生_TL007 | 2024-03-13 23:22:52

赞

踩

mybatis-plus自动生成代码 github

dd9cae6fe1104cf419f9c664eca8cde5.png

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

503c11a018d81e67cca4f1dafbc2492d.png 982d54bc65860f1fe4c7ba31d6bb136a.png

功能列表：

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

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2.  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.  <modelVersion>4.0.0</modelVersion>
  5.  <groupId>com.yelang</groupId>
  6.  <artifactId>mybatis-plus-generator-ui-case</artifactId>
  7.  <version>0.0.1-SNAPSHOT</version>
  8.  
  9.  <dependencies>
  10.   <dependency>
  11.    <groupId>com.github.davidfantasy</groupId>
  12.    <artifactId>mybatis-plus-generator-ui</artifactId>
  13.    <version>1.4.5</version>
  14.   </dependency>
  15.   
  16.   <dependency>
  17.    <groupId>org.postgresql</groupId>
  18.    <artifactId>postgresql</artifactId>
  19.    <version>42.2.25</version>
  20.   </dependency>
  21.  </dependencies>
  22. </project>

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

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

  1. import com.github.davidfantasy.mybatisplus.generatorui.GeneratorConfig;
  2. import com.github.davidfantasy.mybatisplus.generatorui.MybatisPlusToolsApplication;
  3. import com.github.davidfantasy.mybatisplus.generatorui.mbp.NameConverter;
  4.  
  5. public class GeneratorMain {
  6.  
  7.     public static void main(String[] args) {
  8.         GeneratorConfig config = GeneratorConfig.builder().jdbcUrl("jdbc:postgresql://127.0.0.1:5432/ghyapp")
  9.             .userName("ghy01").password("ghy01").driverClassName("org.postgresql.Driver")
  10.             // 数据库schema，POSTGRE_SQL,ORACLE,DB2类型的数据库需要指定
  11.             // .schemaName("myBusiness")
  12.             // 如果需要修改各类生成文件的默认命名规则，可自定义一个NameConverter实例，覆盖相应的名称转换方法：
  13.             .nameConverter(new NameConverter() {
  14.                 /**
  15.       * 自定义Service类文件的名称规则
  16.       */
  17.                 public String serviceNameConvert(String tableName) {
  18.                     return this.entityNameConvert(tableName) + "Service";
  19.                 }
  20.  
  21.                 /**
  22.       * 自定义Controller类文件的名称规则
  23.       */
  24.                 public String controllerNameConvert(String tableName) {
  25.                     return this.entityNameConvert(tableName) + "Action";
  26.                 }
  27.             }).basePackage("com.github.davidfantasy.mybatisplustools.example").port(8068).build();
  28.  
  29.         MybatisPlusToolsApplication.run(config);
  30.  
  31.     }
  32.  
  33. }

在上面的配置中，我们连接的示例数据库是PostgerSQL，需要在Maven中定义相应的驱动程序，并且在上述代码中正确配置相应的类。最后指定了程序的运行端口为8086，这种运行方式跟SpringBoot非常相似。

3、实例运行

运行以上的main方法，在控制台可以看到以下输出即为成功部署。

73125526cc2538e144c721d21902d580.png

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

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

1、Table的查询和浏览

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

22456d8400c479a633c5e9fc2c4d4b87.png

2、输出配置

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

dc928c1456a0ae703e3c4949e5e9744e.png

3、策略配置

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

edcc8a6e49411e7654d09020263f2a25.png

4、SQL配置生成

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

92c1c08023aafe876d4679a921e4b5fd.png

5、代码生成

73ac2ff2bc94055c3b7a6dcc49701da8.png a17a52e92236f06e23e0e42d332bc22b.png

四、自定义扩展

1、相关模板调整

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

15722b0cb9af1c6be64a503cbcb3da3b.png 8165a36bf58d4d6deff42b4acafc74a6.png

2、代码层级的配置

在一些团队中，肯定对Mapper的定义为Dao，Controller层需要定义为Action，通过修改代码模板btl的方式是可以的，还有一种方式是通过调整内部映射的方式来进行修改。主要使用的类是NameConverter。

  1. /**
  2. * 自定义Service类文件的名称规则
  3. */
  4. public String serviceNameConvert(String tableName) {
  5.  return this.entityNameConvert(tableName) + "Service";
  6. }
  7.  
  8. /**
  9. * 自定义Controller类文件的名称规则
  10. */
  11. public String controllerNameConvert(String tableName) {
  12.   return this.entityNameConvert(tableName) + "Action";
  13. }

除了Service、Controller、Entity、FieldName都可以实现自定义的扩展。下面是NameConverter类的核心代码，这里有详细的定义。

  1. package com.github.davidfantasy.mybatisplus.generatorui.mbp;
  2.  
  3. import cn.hutool.core.util.StrUtil;
  4. import com.github.davidfantasy.mybatisplus.generatorui.dto.Constant;
  5. import com.google.common.base.Strings;
  6.  
  7. import static com.github.davidfantasy.mybatisplus.generatorui.dto.Constant.DOT_JAVA;
  8. import static com.github.davidfantasy.mybatisplus.generatorui.dto.Constant.DOT_XML;
  9.  
  10. /**
  11.  * 自定义各类名称转换的规则
  12.  */
  13. public interface NameConverter {
  14.  
  15.     /**
  16.      * 自定义Entity.java的类名称
  17.      *
  18.      * @param tableName 表名称
  19.      * @return
  20.      */
  21.     default String entityNameConvert(String tableName) {
  22.         if (Strings.isNullOrEmpty(tableName)) {
  23.             return "";
  24.         }
  25.         tableName = tableName.substring(tableName.indexOf(StrUtil.UNDERLINE) + 1, tableName.length());
  26.         return StrUtil.upperFirst(StrUtil.toCamelCase(tableName.toLowerCase()));
  27.     }
  28.  
  29.     /**
  30.      * 自定义表字段名到实体类属性名的转换规则
  31.      *
  32.      * @param fieldName 表字段名称
  33.      * @return
  34.      */
  35.     default String propertyNameConvert(String fieldName) {
  36.         if (Strings.isNullOrEmpty(fieldName)) {
  37.             return "";
  38.         }
  39.         if (fieldName.contains("_")) {
  40.             return StrUtil.toCamelCase(fieldName.toLowerCase());
  41.         }
  42.         return fieldName;
  43.     }
  44.  
  45.     /**
  46.      * 自定义Mapper.java的类名称
  47.      */
  48.     default String mapperNameConvert(String tableName) {
  49.         return entityNameConvert(tableName) + "Mapper";
  50.     }
  51.  
  52.     /**
  53.      * 自定义Mapper.xml的文件名称
  54.      */
  55.     default String mapperXmlNameConvert(String tableName) {
  56.         return entityNameConvert(tableName) + "Mapper";
  57.     }
  58.  
  59.     /**
  60.      * 自定义Service.java的类名称
  61.      */
  62.     default String serviceNameConvert(String tableName) {
  63.         return "I" + entityNameConvert(tableName) + "Service";
  64.     }
  65.  
  66.     /**
  67.      * 自定义ServiceImpl.java的类名称
  68.      */
  69.     default String serviceImplNameConvert(String tableName) {
  70.         return entityNameConvert(tableName) + "ServiceImpl";
  71.     }
  72.  
  73.     /**
  74.      * 自定义Controller.java的类名称
  75.      */
  76.     default String controllerNameConvert(String tableName) {
  77.         return entityNameConvert(tableName) + "Controller";
  78.     }
  79.  
  80.     /**
  81.      * 自定义其它生成文件的文件名（不包括entity,mapper.java,mapper.xml,service,serviceImpl,controller这6种）
  82.      *
  83.      * @param fileType  在页面上输入的输出文件标识
  84.      * @param tableName 关联的数据表名称名称
  85.      * @return 生成文件的名称，带后缀
  86.      */
  87.     default String outputFileNameConvert(String fileType, String tableName) {
  88.         if (fileType.equals(Constant.FILE_TYPE_ENTITY)) {
  89.             return this.entityNameConvert(tableName) + DOT_JAVA;
  90.         } else if (fileType.equals(Constant.FILE_TYPE_MAPPER)) {
  91.             return this.mapperNameConvert(tableName) + DOT_JAVA;
  92.         } else if (fileType.equals(Constant.FILE_TYPE_MAPPER_XML)) {
  93.             return this.mapperXmlNameConvert(tableName) + DOT_XML;
  94.         } else if (fileType.equals(Constant.FILE_TYPE_SERVICE)) {
  95.             return this.serviceNameConvert(tableName) + DOT_JAVA;
  96.         } else if (fileType.equals(Constant.FILE_TYPE_SERVICEIMPL)) {
  97.             return this.serviceImplNameConvert(tableName) + DOT_JAVA;
  98.         } else if (fileType.equals(Constant.FILE_TYPE_CONTROLLER)) {
  99.             return this.controllerNameConvert(tableName) + DOT_JAVA;
  100.         }
  101.         return this.entityNameConvert(tableName) + fileType;
  102.     }
  103.  
  104. }

mybatis-plus-generator-ui的功能非常丰富，甚至针对ui都是可以自定义修改的。如果需要定制UI的话，将代码clone下来后，进入到frontend目录下，进行相应的扩展开发。

bb374be48208fad8c10fdc3313804c7f.png

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

  1. yarn install
  2. yarn run build

五、总结

以上就是今天要讲的内容，本文简要介绍一款基于Mybatis-Plus的代码自助生成器，地址:

“

https://github.com/davidfantasy/mybatis-plus-generator-ui

文章通过实例集成的方式来详细讲解mybatis-plus-generator-ui，从相关概念到实际集成案例，以及具体的扩展开发介绍。如果在工作中有这种需要，不妨采用这种方式。希望本文对您有所帮助，欢迎指导交流。

来源：blog.csdn.net/yelangkingwuzuhu/

article/details/128077533

 
 
推荐
 
 
1af88dc5c9f2174f011db3ee39792e8d.gif
 
 
 
 
 
 
 
 
1. 优秀的 Java 代码都是如何分层的 ？看了直呼NB！
 
 
2. IDEA新UI速览，成了 VS Code 的样子？
 
 
3. 如果有一千万数据，怎么用Java快速查询？
 
 
4. 废物利用，拿自己的旧电脑搭建个服务器吧！
 
 
a9517c3a919602ad58bfe994fa7df589.png
 
 
  1. 最近面试BAT，整理一份面试资料《Java面试BATJ通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。
  2. 获取方式：点“在看”，关注公众号并回复 Java 领取，更多内容陆续奉上。
 
 
  1. PS：因公众号平台更改了推送规则，如果不想错过内容，记得读完点一下“在看”，加个“星标”，这样每次新文章推送才会第一时间出现在你的订阅列里。
  2. 点“在看”支持呀，谢谢啦
 


                

        
声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/花生_TL007/article/detail/231115
推荐阅读
相关标签
Copyright ©  2003-2013 www.wpsshop.cn  版权所有，并保留所有权利。

  
闽ICP备14008679号