顶部右侧 | 自行修改
顶部左侧内容
百度360必应搜狗淘宝本站头条
打开后台 看右上角 主题配置 自行修改
当前位置：网站首页 > 在线教程 > 正文

最新版本的MyBatis Plus 代码生成器使用指南

gosiye 2024-08-19 14:53 6 浏览 0 评论

#头条创作挑战赛#

官方文档

  • 快速入门
  • 代码生成器配置（新）

示例项目技术栈

  • spring boot 2.7.4
  • mybatis 3.5.9
  • mybatis plus 3.5.2
  • mybatis plus generator 3.5.3
  • mysql 8
  • velocity 2.3
  • hutool 5.8.8
  • lombok 1.2.11

示例程序选择的技术都是目前为止的最新版本。

示例项目创建步骤

1、创建测试数据表

建表脚本：

DROP TABLE IF EXISTS `sys_menu`;
CREATE TABLE `sys_menu`  (
  `menu_id` bigint NOT NULL AUTO_INCREMENT COMMENT 'ID',
  `pid` bigint COMMENT '上级菜单ID',
  `sub_count` int NULL DEFAULT 0 COMMENT '子菜单数目',
  `type` int COMMENT '菜单类型',
  `title` varchar(255)  COMMENT '菜单标题',
  `name` varchar(255)  COMMENT '组件名称',
  `component` varchar(255)  COMMENT '组件',
  `menu_sort` int COMMENT '排序',
  `icon` varchar(255)  COMMENT '图标',
  `path` varchar(255)  COMMENT '链接地址',
  `i_frame` bit(1) COMMENT '是否外链',
  `cache` bit(1) NULL DEFAULT b'0' COMMENT '缓存',
  `hidden` bit(1) NULL DEFAULT b'0' COMMENT '隐藏',
  `permission` varchar(255) COMMENT '权限',
  `create_by` varchar(255) COMMENT '创建者',
  `update_by` varchar(255) COMMENT '更新者',
  `create_time` datetime(0) COMMENT '创建日期',
  `update_time` datetime(0) COMMENT '更新时间',
  PRIMARY KEY (`menu_id`) USING BTREE,
  UNIQUE INDEX `uniq_title`(`title`) USING BTREE,
  UNIQUE INDEX `uniq_name`(`name`) USING BTREE,
  INDEX `inx_pid`(`pid`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 116 CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '系统菜单' ROW_FORMAT = COMPACT;

2、创建一个 Spring Boot 项目

创建一个 Spring Boot 项目，在pom.xml文件中引入如下依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.2</version>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.2</version>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.5.3</version>
    </dependency>

    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.3</version>
    </dependency>

    <dependency>
        <groupId>cn.hutool</groupId>
        <artifactId>hutool-all</artifactId>
        <version>5.8.8</version>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>

</dependencies>

MyBatis Plus Generator支持的模板引擎有Velocity、Beetl、FreeMarker，笔者这里选择的是MyBatis Plus Generator默认的模板引擎 —— Velocity。

2、创建代码生成器启动类

数据源配置

FastAutoGenerator
    // 配置数据源
    .create("jdbc:mysql://127.0.0.1:3306/eladmin?characterEncoding=UTF-8&useUnicode=true&useSSL=false", "root", "123456")
    // 全局配置
    .globalConfig( ... )
    // 包配置
    .packageConfig( ... )
    // 策略配置
    .strategyConfig( ... )
    // 执行
    .execute();

全局配置

FastAutoGenerator
    // 配置数据源
    .create("jdbc:mysql://127.0.0.1:3306/eladmin?characterEncoding=UTF-8&useUnicode=true&useSSL=false", "root", "123456")
    // 全局配置
    .globalConfig(builder -> {
        builder.author("wanggc") // 设置作者
            .commentDate("yyyy-MM-dd hh:mm:ss")   // 注释日期
            .outputDir(System.getProperty("user.dir") + "/src/main/java") // 指定输出目录
            .disableOpenDir() //禁止打开输出目录，默认打开
        ;
    })
    // 包配置
    .packageConfig( ... )
    // 策略配置
    .strategyConfig( ... )
    // 执行
    .execute();

笔者在全局配置中配置了作者名称、代码注释中日期格式、生成文件存储目录，生成代码完成后会默认打开输出目录，笔者感觉没必要，这里就禁止打开输出目录了。

包配置

FastAutoGenerator
    // 配置数据源
    .create("jdbc:mysql://127.0.0.1:3306/eladmin?characterEncoding=UTF-8&useUnicode=true&useSSL=false", "root", "123456")
    // 全局配置
    .globalConfig( ... )
    // 包配置
    // 包配置
    .packageConfig(builder -> {
        builder.parent("demo.generator") // 设置父包名
            .pathInfo(Collections.singletonMap(OutputFile.xml, System.getProperty("user.dir") + "/src/main/resources/mappers")); // 设置mapperXml生成路径
    })
    // 策略配置
    .strategyConfig( ... )
    // 执行
    .execute();

在包配置中，笔者配置了父包名，配置了mybatis mapper文件存储路径。在包配置中是可以配置 Entity 包名、Mapper 包名、Service 包名、Controller 包名的，笔者这里没有这个需求，就没有配置。

策略配置

FastAutoGenerator
    // 配置数据源
    .create("jdbc:mysql://127.0.0.1:3306/eladmin?characterEncoding=UTF-8&useUnicode=true&useSSL=false", "root", "123456")
    // 全局配置
    .globalConfig( ... )
    // 包配置
    .packageConfig( ... )
    // 策略配置
    .strategyConfig(builder -> {
        builder.addInclude("sys_menu") // 设置需要生成的表名
            .addTablePrefix("sys_") // 设置过滤表前缀
            // Entity 策略配置
            .entityBuilder()
            .enableLombok() //开启 Lombok
            .enableFileOverride() // 覆盖已生成文件
            .naming(NamingStrategy.underline_to_camel)  //数据库表映射到实体的命名策略：下划线转驼峰命
            .columnNaming(NamingStrategy.underline_to_camel)    //数据库表字段映射到实体的命名策略：下划线转驼峰命
            // Mapper 策略配置
            .mapperBuilder()
            .enableFileOverride() // 覆盖已生成文件
            // Service 策略配置
            .serviceBuilder()
            .enableFileOverride() // 覆盖已生成文件
            .formatServiceFileName("%sService") //格式化 service 接口文件名称，%s进行匹配表名，如 UserService
            .formatServiceImplFileName("%sServiceImpl") //格式化 service 实现类文件名称，%s进行匹配表名，如 UserServiceImpl
            // Controller 策略配置
            .controllerBuilder()
            .enableFileOverride() // 覆盖已生成文件
        ;
    })
    // 执行
    .execute();

在策略配置中，笔者配置了需要生成的表名、过滤表前缀、开启 Lombok、覆盖已生成文件、下划线转驼峰命、Service 接口文件及实现类的文件名。

代码生成器启动类完整代码

完整的代码生成器启动类 —— CodeGenerator.java —— 内容如下：

package demo.generator;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.Collections;

public class CodeGenerator {
    public static void main(String[] args) {
        FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/eladmin?characterEncoding=UTF-8&useUnicode=true&useSSL=false", "root", "abc123")
                // 全局配置
                .globalConfig(builder -> {
                    builder.author("wanggc") // 设置作者
                            .commentDate("yyyy-MM-dd hh:mm:ss")   //注释日期
                            .outputDir(System.getProperty("user.dir") + "/src/main/java") // 指定输出目录
                            .disableOpenDir() //禁止打开输出目录，默认打开
                    ;
                })
                // 包配置
                .packageConfig(builder -> {
                    builder.parent("demo.generator") // 设置父包名
                            .pathInfo(Collections.singletonMap(OutputFile.xml, System.getProperty("user.dir") + "/src/main/resources/mappers")); // 设置mapperXml生成路径
                })
                // 策略配置
                .strategyConfig(builder -> {
                    builder.addInclude("sys_menu") // 设置需要生成的表名
                            .addTablePrefix("sys_") // 设置过滤表前缀
                            // Entity 策略配置
                            .entityBuilder()
                            .enableLombok() //开启 Lombok
                            .enableFileOverride() // 覆盖已生成文件
                            .naming(NamingStrategy.underline_to_camel)  //数据库表映射到实体的命名策略：下划线转驼峰命
                            .columnNaming(NamingStrategy.underline_to_camel)    //数据库表字段映射到实体的命名策略：下划线转驼峰命
                            // Mapper 策略配置
                            .mapperBuilder()
                            .enableFileOverride() // 覆盖已生成文件
                            // Service 策略配置
                            .serviceBuilder()
                            .enableFileOverride() // 覆盖已生成文件
                            .formatServiceFileName("%sService") //格式化 service 接口文件名称，%s进行匹配表名，如 UserService
                            .formatServiceImplFileName("%sServiceImpl") //格式化 service 实现类文件名称，%s进行匹配表名，如 UserServiceImpl
                            // Controller 策略配置
                            .controllerBuilder()
                            .enableFileOverride() // 覆盖已生成文件
                    ;
                })
                .execute();

    }
}

注意：全局配置中的用于覆盖已生成文件的方法fileOverride在当前版本中已过时，官方文档中目前还未更新。笔者查源码了解到当前版本配置覆盖已生成文件的方法是在策略配置中使用enableFileOverride方法。 配置方式可以看上面的代码。与之前版本不同的是，现在配置Entity、Mapper、Service、Controller覆盖已生成文件需要单独配置，而不是像之前一样只配置一处，所有已生成的文件都会被覆盖。

效果图

后记

MyBatis Plus Generator 根据默认模板生成的代码是比较简单的，在实际的应用中需要根据自身需要编写代码模板。

相关推荐

全球最大的H5网站模板库（h5页面模板下载）

当今社会，互联网迅猛发展，在网络营销中，客户往往通过企业的网站建设留下对该企业的第一印象，一个优秀的企业网站已成为企业发展的重要纽带，嗨创H5，拥有国内外一流的技术团队，潜心专研网站建设6年，是全球最...

wordpress集团公司网站模板:XSgr（wordpress建站公司）

小兽wordpress推出一款高端集团公司主题，打造高品质官网。高端是一种态度和坚持，因为我坚信贴合产品及品牌理念的高端深度定制才能最大化地呈现企业的务实严谨与产品的专业品质相比，某种程度上讲–...

私心推荐，小编酷爱的五款高逼格网站模板

建站宝盒的网站模板上千套之多，各有各的风格色彩，但是，弱水三千，小编我却只取一瓢饮，在这上千套模板之中，小编酷爱的网站模板有五套，让小编私心推荐一下吧！1、茶叶贸易公司网站模板小编对这款网站模板可是一...

「书讯」政府网站用户行为研究与应用

《政府网站用户行为研究与应用》作者:刘合翔著出版日期：2018年6月开本：16开出版社：经济管理出版社小编推荐《政府网站用户行为研究与应用》的主题是关于政府网站用户行为的特征规律及其在政府网站优...

免费服务器-搭建模板网站的操作流程(图文版)

之前发文《创业者的官网：如何搭建免费云服务器及操作面板（图文版）》，因为做了视频才发现，创业者对视频的需求，远远低于对图文解说的需求。因此，补充图文教程，不清楚的看官们，可以直接看视频版本进行细部学...

快收藏这些高逼格H5网站模板吧，不绕弯子直接下载

上面这些响应式H5网站是不是很炫酷，比起那些“在线一键生成”是不是好太多了？关键是，那些一键制作都不会开放源码给你，自定义性也很局限。不过说到底还是难看。今天笔者推荐大家一个模板网站，全都是高质量的响...

如何开发网站建设管理系统模板（如何开发网站建设管理系统模板图片）

根据用户网站需求文档设计美工图，并设计数据库结构，让网站开发人员可以更多地关注前台美工，先对照美工图，编写静态HTML页面，按网站建设管理系统模板语法，修改编写好的静态HTML页面，运行。不再需要对...

C语言的数据类型介绍（c语言的数据类型介绍是什么）

在计算机系统中，数据是放在内存中的，数字、文字、符号、图形、音频、视频等数据都是以二进制形式存储在内存中的，它们并没有本质上的区别，那么0001000该理解为数字8呢，还是图像中某个像素的颜色...

C 语言格式化输出函数中常用的格式符号

在之前介绍输入输出函数的文章中，有提到格式化输入输出函数都有包含一种特殊的符号——格式符号。那篇文章中关于格式符号也只是一笔带过，没有进行深入挖掘。本篇文章主要对输出函数（printf）中的一些常用格...

C#中的类型转换（c#数据转换类）

计算机存储的基本单位：字节我们知道一个字节（Byte）有8个比特(bit)构成，比特是存储的最小单位，表示0和1，但为什么计算机存储的基本单位是字节，而不是比特呢？假设我们要存储数字3（二进制：11...

Java8中String内存空间占用分析（电脑里下载的文件怎样删除才不会占用内存空间）

1.前言分析之前，简单回顾一下对象的内存分布。在HotSpot虚拟机中，对象在堆内存中的存储布局可以划分为三部分：对象头、实例数据和对齐填充。对象头包含两部分内容：MarkWord和类型指针。实例数据...

「每日C语言」数据类型大小和取值范围

对于c语言来说，数据类型是一个很重要的概念和知识点，它涉及到的是内存的空间，这在和硬件交互的时候是非常重要的。K&R给出了7个数据类型相关的关键字，分别是：int、long、short、uns...

【c语言学习笔记】数据类型（c语言里面的数据类型）

c语言学习笔记，欢迎大家能在评论区提出我学习错误的地方方便我进行改正~在计算机中，计算机用二进制来储存数据，在c语言中有许多的数据类型用来存储数据，当然不同的数据类型所用的内存占用也不一样，下面就来用...

关于MySQL varchar类型最大值，原来一直都理解错了

我是架构精进之路，点击上方“关注”，坚持每天为你分享技术干货，私信我回复“01”，送你一份程序员成长进阶大礼包。写在前面关于MySQLvarchar字段类型的最大值计算，也许我们一直都理解错误了，...

C语言数据类型的转换（c语言数据类型的转换方式）

类型转换在C语言程序中，经常需要对不同类型的数据进行运算，为了解决数据类型不一致的问题，需要对数据的类型进行转换。例如一个浮点数和一个整数相加，必须先将两个数转换成同一类型。C语言程序中的类型...

取消回复欢迎 你 发表评论:

一周热门
最近发表
标签列表

Powered By Z-BlogPHP,Theme By 天兴工作室