MyBatis Plus中的代码生成器，让写代码变得如此简单

已于 2023-04-04 23:57:49 修改
阅读量345 收藏
点赞数
分类专栏： Java进修 # Spring Boot 文章标签： mybatis java spring spring boot 后端
于 2023-04-04 23:54:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/guo_erbin/article/details/129962087
版权

前言

进修者还清晰的记得，刚开始工作的时候，自己完全就是一个小白。在公司中总能听到前辈们互相吹嘘，说自己效率有多么的高。A前辈说：“我很会划水，一般闲聊30分钟，敲代码10分钟”。 B前辈也不甘示弱：“我一般先玩个40分钟，敲代码5分钟”。我当时心想：都这么牛批的吗？是真的牛批还是在吹牛皮。

自从使用了Mybatis Plus，我相信前辈们的话可能是真的。Mybatis Plus提供了代码生成的功能，让我们写代码变得如此简单！

正文

在开始分享前，进修者先给大家准备2道Mybatis的面试题，每天积累一点点面试经验。
1、Mybatis中#和$的区别？
2、Mybatis的原理是什么？
问题分析：面试官主要考察面试人员有没有实际开发经验，还有学习的深度。
答案：这里暂时不公布，大家先想想怎么回答。稍后会在评论区中给答案！
下面哦

一、MyBatis-Plus简介

MyBatis-Plus（简称 MP），它在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生，是一个 MyBatis的增强工具和最好的搭档。

二、 新建项目

新建项目，可以使用IDEA快速生成Spring Boot项目或使用MyEclipse创建。这里不做说明。创建好的项目目录如下图所示：
该项目为MyEclipse10创建

三、 添加相关依赖

在项目目录中找到pom.xml文件，打开文件并配置相关依赖，如：MyBatis-Plus、模板引擎、数据库等依赖。

添加Mybatis Plus相关依赖

Spring Boot整合MyBatis Plus，需要在配置文件中，添加上MyBatis Plus的依赖项。为使用MyBatis Plus的代码生成器功能，还要添加它的代码生成器的依赖。

    <dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-boot-starter</artifactId>
		<version>2.3.1</version>
	</dependency>
	<dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-generator</artifactId>
		<version>3.3.2</version>
	</dependency>
添加模板引擎依赖

MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl模板引擎。如果都不满足您的要求，也可以采用自定义模板引擎。这里进修者采用Freemarker模板引擎。

	<!-- 添加模板引擎 -->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-freemarker</artifactId>
		<version>2.3.12.RELEASE</version>
	</dependency>
完整pom.xml配置

项目会包含其他框架的依赖，这里不做一一说明，直接给出完整的配置。

<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.training</groupId>
	<artifactId>mybatisplus</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.22.RELEASE</version>
	</parent>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
		</dependency>
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>2.3.1</version>
		</dependency>
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-generator</artifactId>
			<version>3.3.2</version>
		</dependency>
		<!-- 添加模板引擎 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-freemarker</artifactId>
			<version>2.3.12.RELEASE</version>
		</dependency>
		<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>druid-spring-boot-starter</artifactId>
			<version>1.1.10</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<configuration>
					<source>1.7</source>
					<target>1.7</target>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

四、 编写执行代码

实现代码也是我们代码生成器实现的重要部分，大家要认真阅读，进修者已经把整体拆开来方便大家学习。代码生成器主要包含：全局配置、数据源配置、包配置、自定义配置和策略配置。

全局配置

全局配置也是公有的配置，可以设置项目输出路径、作者、主键策略、是否开启Swagger2模式等。部分代码如下：

    // 全局配置
    GlobalConfig globalConfig = new GlobalConfig();
    final String projectPath = System.getProperty("user.dir");
    globalConfig.setOutputDir(projectPath + "/src/main/java");
    //System.out.println("项目路径："+projectPath);
    globalConfig.setAuthor("training");
    globalConfig.setOpen(false);
    // gc.setSwagger2(true); // 实体属性 Swagger2 注解
    globalConfig.setServiceName("%sService");
    mpg.setGlobalConfig(globalConfig);
数据源配置

数据源配置是说明使用哪种数据库来存储数据的，根据自己目前的需要进行配置，并已经在数据库中创建了对应的表。部分代码如下：

    // 数据源配置
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://localhost:3306/userssm?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
    dsc.setDriverName("com.mysql.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("root");
    mpg.setDataSource(dsc);
包配置

项目包配置用于生成业务类、控制器类、存储类、实体类等包。不进行设置包名称将会按照默认包名生成。部分代码如下：

   // 包配置
   PackageConfig pc = new PackageConfig();
   pc.setModuleName(null);
   pc.setParent("com.training");
   mpg.setPackageInfo(pc);
自定义模板

自定义模板可以将Mapper.xml文件生成到我们指定的地方。如果我们想要将其放到resources目录下面就可以通过自定义模板来完成。部分代码如下：

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // blank
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
			@Override
			public String outputFile(TableInfo tableInfo) {
				// TODO Auto-generated method stub
				return projectPath + "/src/main/resources/mapper/"
                + "/" + tableInfo.getEntityName() + "Mapper" + ConstVal.XML_SUFFIX;
			}
        });
策略配置

策略配置主要用来对实体类和相关类的生成规则进行设置，部分代码如下：

      // 策略配置
      StrategyConfig strategy = new StrategyConfig();
      strategy.setNaming(NamingStrategy.underline_to_camel);
      strategy.setColumnNaming(NamingStrategy.underline_to_camel);
      strategy.setEntityLombokModel(true);
      strategy.setRestControllerStyle(true);
      strategy.setInclude(setTables().split(","));
      strategy.setControllerMappingHyphenStyle(true);
      strategy.setTablePrefix("m_");
完整代码

这里是整个项目的所有代码，整合了上面的所有功能代码片段。完整代码如下：

package com.training.generator;

import java.util.ArrayList;
import java.util.List;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.ConstVal;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.FileOutConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

/**
 * 代码生成器
 * <p>Copyright: training</p>
 * @author 进修者
 * @version 1.0 create time:2023-4-4
 */
public class CodeGenerator {

	// 设置表名称，多个表用逗号隔开
    public static String setTables() {
        return "user";
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        final String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath + "/src/main/java");
        //System.out.println("项目路径："+projectPath);
        globalConfig.setAuthor("training");
        globalConfig.setOpen(false);
        // gc.setSwagger2(true); // 实体属性 Swagger2 注解
        globalConfig.setServiceName("%sService");
        mpg.setGlobalConfig(globalConfig);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/userssm?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(null);
        pc.setParent("com.training");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // blank
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
			@Override
			public String outputFile(TableInfo tableInfo) {
				// TODO Auto-generated method stub
				return projectPath + "/src/main/resources/mapper/"
                + "/" + tableInfo.getEntityName() + "Mapper" + ConstVal.XML_SUFFIX;
			}
        });

        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setInclude(setTables().split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix("m_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

五、 结果展示

执行代码，然后查看项目目录，就会有相应包和代码生成。如下图所示：
执行结果图

小结

Spring Boot整合MyBatis-Plus非常简单。使用它的代码生成器功能，能够快速生成代码，提高了我们的工作效率。现在进修者也可以像当时的前辈那样吹嘘：“我也变得牛批了！哈哈哈，我可用不了5分钟哦”！

感谢您读完了进修者的内容分享，欢迎留言区一起聊聊天，聊聊关于您对MyBatis-Plus代码生成有什么更好的想法!

我是进修者，期待与您肩并肩，一起进化成长！
在这里插入图片描述

进修者之路
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
专栏目录
mybatis-plus代码生成器模版代码
08-17
mybatis-plus代码生成器模版代码
MyBatis Plus中代码生成器使用详解
09-07
主要介绍了MyBatis Plus中代码生成器使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Springboot+MybatisPlus 使用代码生成器会出现的问题及解决方案
qq_52692506的博客
07-28 1637
在使用MybatisPlus的时候还是要多加注意，要看依赖是否齐全版本也最好用最新的，防止远古bug未修复然后出现，在官网复制配置参数的时候最好弄清楚参数的意义，将没用的注释掉或者删掉，另外因为生成模板会自动创建包baomidou，这时候最好让启动类和存放模板的包属于同一个包。
优化mybatisPlus批量新增，新增mapper层批量新增方法，附带代码生成vm模板。
XuDream的博客
10-23 2330
经发现，mybatisPlus只有Service中存在saveBatch()方法，而Mapper中不存在批量新增的方法，深入了解，发现mybatisPlus的Service中saveBatch()方法也是循环一条一条插入数据库。上述mybatis-plus中源码中只是循环插入实现的批量新增，优化方式有以下几个思路。看到这里，这里提取Mapper.xml的方法，使代码生成的VM的自动生成（VM是mybatisPlus代码生成的模板）这里使用600条数据在模拟mybatisPlus新增和优化之后的新增。
若依 MyBatis改为MyBatis-Plus并修改代码生成器
最新发布
weixin_50531218的博客
03-28 1075
将若依的前后端分离版升级为Mybatis-Plus，同时修改代码生成器
mybatis-plus-generator代码生成器
失之东隅，收之桑榆
10-11 505
利用mybatis-plus-generator生成DTO、DO、VO、BO、Query对象，自定义模板生成mapper、service、controller文件
Mybatis-Plus代码生成器：提升开发效率的神兵利器
奇遇少年
01-16 2133
Mybatis-Plus代码生成器是Mybatis-Plus框架提供的一项功能强大的工具，旨在简化数据库访问层的开发。
详解:MyBatis-Plus 代码生成器的使用
Daniel
04-06 1323
文章目录一、入门介绍：二、代码案例：1、引入MyBatis-Plus相关依赖(在搭建完成的springboot项目的基础上)2、编写MyBatis-Plus代码生成器代码三、效果演示： 使用之前先了解MyBatis-Plus官方文档的介绍： 代码生成器（新） 一、入门介绍： 通过了解官方文档后，实现代码生成器需要配置六大步骤： DataSourceConfig（数据源配置，通过该配置，指定需要生成代码的具体数据库） StrategyConfig（数据库表配置，通过该配置，可指定需要生成哪些表或者
Mybatis Plus代码生成器 IDEA 插件版 （版本v0.0.6）
06-28
1.Mybatis Plus代码生成器 1.1.自定义配置模板 1.2.自定义表-实体映射信息 1.3.多数据源管理 1.4.操作记忆功能 1.5.操作化繁为简 2.工程化（maven,spring boot） 2.1.生成maven工程 2.2.生成...
mybatis-plus 达梦 代码生成
06-10
提供修改数据库地址后可直接使用的代码，提供达梦7的驱动包 提供所需maven以来 驱动包放置仓库位置等
mybatis-plus代码生成器代码.rar
07-14
mybatis-plus代码生成器，自动生成controller,dao,mapper,service,impl,entity到项目中，修改一下数据库连接，项目路径，即可使用
MyBatis代码生成器（改进版，生成实体类的字段备注）
01-08
基于原版MyBatis代码生成器改进， 生成的实体类的字段带出备注
ruoyi-vue-generator Mybatis-Plus 代码生成模板简化版
Tenk的博客
03-10 2622
使用的是若依官网原版ruoyi-vue项目3.7.0，后续的新版也可以参考使用 整合了Mybatis-Plus后，生成的Java代码还是老样子，就自己做了简单修改，从controller到xml使用Mybatis-Plus的方式（下文Mybatis-Plus简写为Mp） 仅修改了图中红色部分的模板 原始若依生成模板Mybatis-Plus改版 提取码: 5q5p 链接内只有修改了的6个文件 下载后直接解压或复制到 generator 模块的 main 文件夹下即可 部分代码展示 绿色：新增 红色：修改 c
Myabtis-Plus自定义代码生成器与自定义代码生成模板
a1091758887的博客
08-29 1412
在编写代码时我们会编写大量与业务无关的代码，比如Contoller，Service，Entity以及一些增删改查接口的定义，这些代码基本都是固定的模板，手动编写浪费大量时间，今天介绍一下Mybatis-Plus代码生成器来简化代码的开发，减少重复代码的编写。 ......
MyBatis-Plus之代码生成器使用方法
PJ小白的博客
06-10 308
-代码生成器-->--velocity模板引擎-->
MybatisPlus---代码生成器
zerodiyi的博客
12-22 649
/ 比如当前项目为springboot,它所在的路径为D://aa/springboot，所以System.getProperty("user.dir")就表示D://aa/springboot。// 默认的父包是"com.baomidou", 它会自动放在上面设置的globalConfig.setOutputDir路径下,此时也就变成了/springboot1/src/main/java/com/example。//设置生成的包的名字为bb.aa， 通过改变包的名字，可以将生成的包放在指定的包下，
程序员应该懂点Mybatis-Plus，真的好用（一）
weixin_44139519的博客
05-22 793
它是一个轻量级的连接池，具有优异的性能表现和低资源消耗，能够极大地提高应用程序的数据库访问性能和并发处理能力。Mybatis-plus 是一个 Mybatis 的增强工具，提供了很多实用的功能，同时也引入了一些新的配置项。Mybatis-plus 提供了丰富的文档和示例，使开发人员能够更快地上手和使用它的功能。，提供了许多便捷的 CRUD 操作和其他实用功能，简化了数据库访问的开发工作。注：有多数据源的要求，或者是主从部署的要求时需要引入多数据源的依赖。根据具体需求选择需要配置的配置项即可。
MyBatis-plus实现代码自动生成以及简单的增删改查
weixin_48524739的博客
04-07 4405
接着上篇博客前后端分离项目搭建，本片博客主要通过mybatis-plus实现代码自动生成以及简单的后端增删改查功能，话不多说，直接上代码。 首先pom文件将需要的依赖引入进来，我这边用到的依赖如下代码所示。 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instan
Mybatis-Plus 代码生成器（java.vm配置文件）
L2735516933的博客
05-05 1382
配置文件需要放在文件夹下才生效不要使用 idea 格式化以下自定义配置文件，否则生成出来的代码会很乱import $!# if($ {#end# if($ {#end /***/ @Api("xxx接口") # if($ {@ApiOperation("查询所有用户") @GetMapping public List < $ {return $ {
mybatis-plus不用写xml文件
06-28
除了简化了SQL语句的编写外，mybatis-plus还提供了很多其他的便利，如自动分页、代码生成器、性能分析等等，这些功能大大提高了开发效率和代码的可读性和可维护性。 总结起来，mybatis-plus的使用不需要编写繁琐的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

进修者之路

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值