MyBatisPlus 3.1.X代码生成器

最新推荐文章于 2025-03-02 08:54:50 发布
原创 最新推荐文章于 2025-03-02 08:54:50 发布 · 1.2k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文介绍了一种基于数据库的代码生成器实现，通过AutoGenerator类及其配置，如DataSourceConfig、StrategyConfig、PackageConfig等，自动生成PO、Mapper、Service、Controller层代码，提高开发效率。

通过代码生成器可以根据数据库中的实体生成对应的po、mapper、service、controller层代码，可以大大提高开发效率。代码生成器的核心是AutoGenerator类中的execute方法，文章将从AutoGenerator类讲起

核心类AutoGenerator.java

public class AutoGenerator {
    private static final Logger logger = LoggerFactory.getLogger(AutoGenerator.class);
    protected ConfigBuilder config;
    protected InjectionConfig injectionConfig;
    private DataSourceConfig dataSource;
    private StrategyConfig strategy;
    private PackageConfig packageInfo;
    private TemplateConfig template;
    private GlobalConfig globalConfig;
    private AbstractTemplateEngine templateEngine;

    public void execute() {
        logger.debug("==========================准备生成文件...==========================");
        if (null == this.config) {
            this.config = new ConfigBuilder(this.packageInfo, this.dataSource, this.strategy, this.template, this.globalConfig);
            if (null != this.injectionConfig) {
                this.injectionConfig.setConfig(this.config);
            }
        }

        if (null == this.templateEngine) {
            this.templateEngine = new VelocityTemplateEngine();
        }

        this.templateEngine.init(this.pretreatmentConfigBuilder(this.config)).mkdirs().batchOutput().open();
        logger.debug("==========================文件生成完成！！！==========================");
    }
}

查看AutoGenerator类源码发现，自动生成代码的核心就是创建DataSourceConfig，InjectionConfig，StrategyConfig，PackageConfig，TemplateConfig， GlobalConfig配置类，在execute方法中将根据这些配置为我们生成代码

创建DataSourceConfig类

private static DataSourceConfig buildDataSourceConfig() {
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(URL);
        // dsc.setSchemaName("public");
        dsc.setDriverName(DRIVER_NAME);
        dsc.setUsername(USERNAME);
        dsc.setPassword(PASSWORD);
        dsc.setTypeConvert(new MySqlTypeConvert() {
            @Override
            public DbColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                //将数据库中timestamp转换成date
                if ( fieldType.toLowerCase().contains( "timestamp" ) ) {
                    return DbColumnType.DATE;
                }
                return (DbColumnType) super.processTypeConvert(globalConfig, fieldType);
            }
        });
        return dsc;
    }

创建StrategyConfig类

private static StrategyConfig buildStrategyConfig() {
        StrategyConfig strategy = new StrategyConfig();
        // 命名规则
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        // 默认生成的po类不继承，手动修改继承
        //strategy.setSuperEntityClass((String) null);
        // 实体是否使用Lombok插件
        strategy.setEntityLombokModel(false);
        // 自定义 service 父类
        strategy.setSuperServiceClass("com.h2t.study.BaseService");
        // 自定义 service 实现类父类
        strategy.setSuperServiceImplClass("com.h2t.study.BaseServiceImpl");
        // 控制层是否使用Rest风格
        strategy.setRestControllerStyle(true);
        return strategy;
    }

这里自定义Service以及serviceImpl的父类，BaseServiceImpl对原有的父类进行了封装，封装目的：

  • 不需要在每个业务实现类中都创建Wrapper，代码更通用
  • 可以对业务层进行一个统一的校验拦截，可以通过拦截BaseServiceImpl做一个通用的拦截校验

创建PackageConfig类

private static PackageConfig buildPackageConfig() {
        PackageConfig pc = new PackageConfig();
        //pc.setModuleName(scanner("模块名"));
        pc.setParent(PACKAGE_NAME);
        pc.setEntity("po");
        pc.setXml("mapper");
        pc.setController("controller");
        pc.setService("service");
        return pc;
    }

创建GlobalConfig类

 private static GlobalConfig buildGlobalConfig() {
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        //项目所在地址
        gc.setOutputDir(OUTPUT_DIR);
        //注释作者
        gc.setAuthor(AUTHOR);
        //生成文件不打开
        gc.setOpen(false);
        gc.setFileOverride(true);
        gc.setActiveRecord(true);
        // XML 二级缓存
        gc.setEnableCache(false);
        //生成result map
        // XML ResultMap
        gc.setBaseResultMap(true);
        //生成java mysql字段映射
        // XML columList
        gc.setBaseColumnList(true);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        // 自定义文件命名，注意 %s 会自动填充表实体属性！
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");
        return gc;
    }

创建InjectionConfig类

 InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

TemplateConfig

TemplateConfig templateConfig = new TemplateConfig();

完整代码生成器代码

public class MpGenerator {
    /**
     * 包名
     */
    private static final String PACKAGE_NAME = "com.h2t.study";

    /**
     * 代码生成路径
     */
    private static final String OUTPUT_DIR = "C:\\Users\\hetiantian\\Desktop\\test";

    /**
     * 代码注释作者
     */
    private static final String AUTHOR = "hetiantian";

    private static final String DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
    private static final String HOST = "localhost";
    private static final String PORT = "3306";
    /**
     * 数据库信息
     */
    private static final String DATABASE = "test";
    private static final String USERNAME = "root";
    private static final String PASSWORD = "123456";
    private static final String URL = "jdbc:mysql://" + HOST + ":" + PORT + "/" + DATABASE
            + "?characterEncoding=UTF8&serverTimezone=UTC";

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        mpg.setGlobalConfig(buildGlobalConfig());
        // 数据源配置
        mpg.setDataSource(buildDataSourceConfig());
        // 包配置
        mpg.setPackageInfo(buildPackageConfig());
        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        mpg.setCfg(cfg);
        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        //不生成mapper xml文件
        //templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);
        // 策略配置
        mpg.setStrategy(buildStrategyConfig());
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

    /**
     * 全局构造配置类
     *
     * @return
     * */
    private static GlobalConfig buildGlobalConfig() {
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        //项目所在地址
        gc.setOutputDir(OUTPUT_DIR);
        //注释作者
        gc.setAuthor(AUTHOR);
        //生成文件不打开
        gc.setOpen(false);
        gc.setFileOverride(true);
        gc.setActiveRecord(true);
        // XML 二级缓存
        gc.setEnableCache(false);
        //生成result map
        // XML ResultMap
        gc.setBaseResultMap(true);
        //生成java mysql字段映射
        // XML columList
        gc.setBaseColumnList(true);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        // 自定义文件命名，注意 %s 会自动填充表实体属性！
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");
        return gc;
    }

    /**
     * 数据库配置信息
     *
     * @return
     * */
    private static DataSourceConfig buildDataSourceConfig() {
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(URL);
        // dsc.setSchemaName("public");
        dsc.setDriverName(DRIVER_NAME);
        dsc.setUsername(USERNAME);
        dsc.setPassword(PASSWORD);
        dsc.setTypeConvert(new MySqlTypeConvert() {
            @Override
            public DbColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                //将数据库中timestamp转换成date
                if ( fieldType.toLowerCase().contains( "timestamp" ) ) {
                    return DbColumnType.DATE;
                }
                return (DbColumnType) super.processTypeConvert(globalConfig, fieldType);
            }
        });
        return dsc;
    }

    private static PackageConfig buildPackageConfig() {
        PackageConfig pc = new PackageConfig();
        //pc.setModuleName(scanner("模块名"));
        pc.setParent(PACKAGE_NAME);
        pc.setEntity("po");
        pc.setXml("mapper");
        pc.setController("controller");
        pc.setService("service");
        return pc;
    }

    private static StrategyConfig buildStrategyConfig() {
        StrategyConfig strategy = new StrategyConfig();
        // 命名规则
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        // 默认生成的po类不继承，手动修改继承
        //strategy.setSuperEntityClass((String) null);
        // 实体是否使用Lombok插件
        strategy.setEntityLombokModel(false);
        // 自定义 service 父类
        strategy.setSuperServiceClass("com.h2t.study.BaseService");
        // 自定义 service 实现类父类
        strategy.setSuperServiceImplClass("com.h2t.study.BaseServiceImpl");
        // 控制层是否使用Rest风格
        strategy.setRestControllerStyle(true);
        return strategy;
    }
}

所需依赖

 <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>3.0.7</version>
    </dependency>

    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>3.1.2</version>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>6.0.6</version>
    </dependency>

    <!-- 模板引擎mybaties-plus  代码生成 -->
 
    <dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>2.3.23</version>
    </dependency>

目前代码生成器的不足

many errors， many bugs

  • 生成的po自动会继承Model类
  • 生成的po类缺少@TableName、@TableField等注解与数据库字段进行映射
    这些不足需要手动进行修改。聪明的网友如果知道如果修改，请一定要告诉我！！！
最后附完整项目地址：https://github.com/TiantianUpup/mp-generator
springboot2.x集成mybatisPlus3.x完美教程，带项目地址
胃病的不良少彦
07-05 6605
文章目录1. 从Hibernate到MybatisPlus的转换2. 去JPAmaven依赖，添加MyBatisPlus依赖3.代码自动生成工具3.1 启动后效果如下：3.2 注意！4. 全局配置相关的其它内容4.1 yml配置，根据生成包的路径配置4.2 Mapper配置4.3 启动类配置4.4 添加分页等插件配置 项目地址：github 1. 从Hibernate到MybatisPlus的...
mybatis-plus代码生成器使用（generator）
小张的博客
04-30 1269
mybatis plus 代码生成器简单使用
【Spring Boot】Mybatis Plus 3.1.X 自动生成代码配置
Dream it Possible
06-03 5263
【引言】     在前面的spring boot与mybatis plus 集成的相关博客中，用的是2.x的版本，而mybatis plus已经发布3.1.x版本，所以，参照着官方文档，将集成spring boot应用，实践下代码自动生成。 【核心源码】     AutoGenerator 是 MyBatis-Plus...
代码生成器-MybatisPlus
01-30 497
MybatisPlus快速生成代码
工具类：mybatis plus 代码生成器的使用(一）MyBatisPlusGenerator代码生成器自定义
热水钟博客
05-02 2126
参与此博客：https://blog.csdn.net/xie19900123/article/details/81448299 生成器的代码写法参考例子：https://gitee.com/oKong/mybatis-plus-samples/blob/master/src/test/java/cn/lqdev/learning/mybatisplus/samples/MysqlGenerat...
mybatisplus之代码生成器配置新（新版本代码生成器）
m0_73530657的博客
06-19 1602
的确是写在策略配置下的，但是又因为一整个大的策略配置下又包含了Entity，Controller，Service，Mapper四个小的分策略配置，所以，在配置这些分策略配置时需要额外加上他们对应的Builder，例如。快速开始就是举了一个简单的示例，要想配置更多细节方面的配置，还需要看第二个链接里面的介绍。首先第一步是添加代码生成器的相关依赖，这个没什么好说的，我这里用的是下面这一套依赖。但是值得说的一点是，我们发现，当我想把策略配置下Entity配置中的。加入到策略配置，因为它是属于策略配置下的。
mybatis-plus之代码生成器
(づ￣ 3￣)づxl
06-10 906
这个代码生成器比较原来那种插件感觉强大了不少，连controller、service都给我构造好了，service层而且还是有基础方法可以使用的简直是福利 这里要引入两个依赖： <dependency> <groupId>com.baomidou</groupId> <artifactId>myb...
《MyBatis-Plus 代码生成器基础入门》
Ta20220617的博客
11-13 1875
MyBatis-Plus 是一个 MyBatis 的增强工具，旨在简化开发、提高效率。它在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。MyBatis-Plus 提供了代码生成器功能，可以快速地根据数据库表结构生成 Entity（实体类）、Mapper（映射器接口）、Service（服务层接口及其实现）、Controller（控制层）等代码文件。
MybatisPlus官方提供了代码生成器根据数据库表结构生成PO、Mapper、Service等相关代码是哪个插件
最新发布
07-11
2. 引用[2]详细介绍了使用MyBatisPlus的逆向工程（即代码生成器）自动生成Mapper接口、xml文件、service接口、service实现以及controller，并整合SpringMVC。其中提到了逆向工程的执行文件配置，包括包路径和数据库...
SpringBoot+Mybatisplus+Mybatis+Swagger+代码自动生成
qq_41928043的博客
07-19 891
Springboot+mybaisplus+swagger
mybatis_plus 3.0以后版本代码生成器
04-24
该版本是mybatisplus3.0以后的自动生成代码的工具，包含vo,dto,domain,service,controller,dao
MyBatis Plus中代码生成器使用
程序和我有一个能跑就行了
05-23 1万+
按照官网上实例尝试了一下，感觉MyBatis plus中代码生成器还是很强大的，以下是测试的总结
mybatis-plus代码生成器使用及注意事项
kinghmj01的博客
07-30 9396
首先贴上官方文档地址Mybatis-Plus代码生成器，具体的参数配置参考官方文档。 Mybatis-plus的代码生成器是mybatis-plus组件的，并不是mybatis的，注意不要看错，这里会介绍代码生成器的主要用法以及需要注意的事项。 1.添加maven依赖 Mybatis-plus的代码生成器在3.0.3之后就独立出来，与mybatis-plus分开了，所以使用高版本的mybat...
mybatis-plus使用generator代码生成器生成实体类支持Swagger2
sj13074480550的博客
11-08 3996
mybatis-plus使用generator代码生成器生成实体类支持Swagger21.先搭建项目，引入maven依赖2.编写代码生成器代码（有说明）3.在resources目录下创建templates目录4.在templates目录下创建entity.java.vm模板(代码如下)5.基本完成只要运行代码生成器代码，输入表名即可 使用自定义模板生成支持Swagger2的实体类，生成的@ApiM...
myBatis-Plus讲解
wojiaowudia的博客
09-28 305
myBatis-Plus介绍 一、myBatis-Plus讲解 1.1、概述 1.2、特征 1.3、框架结构 二、快速开始 2.1、技术背景 2.2、开搞 2.2.1、创建数据库 2.2.2、创建工程 2.2.3、编码 三、代码生成器 3.1、配置 3.2、工具类 四、条件构造器 4.1、概述 4.2、实战 五、分页插件 5.1、配置 5.2、编码 一、MyBatis-Plus介绍 1.1、概述 ...
Mybatis-plus 代码生成器
Fitminf的博客
04-30 767
Mybatis-Plus 代码生成器配置 废话 Mybatis-Plus（简称MP）是我入行不久就接触过的一个简化持久层开发的工具，熟悉基本操作之后简直到了离不开的程度，这是它的官网：https://mp.baomidou.com/ 在接触 MP 之前也用过 TK-Mapper（通用Mapper），功能和 MP 类似，没有具体比较过优劣，只是单从两个工具的官网来看MP 的 UI 风格赏心悦目，所以后面换成 MP 之后就一直用它，这里主要记录一下个人在配置 MP 代码生成器的一点心得。 关于代码生成器，在上家
mybatis-plus代码生成器以及自定义vm模板使用
热门推荐
qq_39089503的博客
06-04 1万+
1.pom.xml <mybatis.version>3.1.1</mybatis.version> <!-- mybatis-plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-s...
Mybatis/tk-Mybatis/Mybatis-plus 中generator(代码生成器)的使用
weixin_43740223的博客
08-28 5545
mybatis-generator 代码生成器的应用
MyBatis-Plus代码生成器实战-3分钟生成全套代码，老板直呼内行！
程序猿小白菜
03-02 973
副标题：“CRUD搬砖工的自救指南——3分钟生成全套代码，老板直呼内行！” 参考官方文档作为当代「CV工程师」（Ctrl+C/V的那种），你是否也经历过这样的绝望？别慌！ 今天教你用MyBatis-Plus Generator（以下简称MPG）实现代码自动流水线生产，把重复劳动交给机器，把摸鱼时间留给自己！在中加入以下魔法药水： 吐槽：版本号请勿手抖，否则可能会喜提大礼包！新建一个代码生成器启动类，复制以下「咒语」： 重点解读：右键运行方法，控制台出现以下画面： 查看项目目录，你将收获： 三、高级玩法：自
MybatisPlus代码生成器装配时间
03-12
<think>好的，用户想了解如何配置和使用MyBatis Plus代码生成器。首先，我需要回忆一下相关的步骤和注意事项。根据提供的引用内容，特别是引用[2]，里面提到了创建Spring Boot项目、添加依赖、配置数据库连接、创建配置类等步骤。 首先，用户可能需要从零开始配置，所以第一步应该是创建Spring Boot项目。这时候需要确认用户是否已经熟悉如何创建，可能需要简要提及使用Spring Initializr或者IDE工具。然后添加必要的依赖，包括MyBatis Plus和代码生成器的依赖，这里要确保版本兼容性，但用户可能不需要太详细，除非有特殊版本需求。 接下来是配置数据库连接，这部分需要修改application.yml或application.properties文件，填写正确的数据库URL、用户名和密码。用户可能会遇到驱动类的问题，特别是如果用的是MySQL 8.x，驱动类应该是com.mysql.cj.jdbc.Driver，而旧版可能不同，需要提醒注意。 然后是代码生成器的配置类，这里需要详细说明如何编写配置类，包括包路径、全局配置、数据源配置、策略配置等。这部分是核心，用户可能需要具体的代码示例，比如如何设置作者、输出目录、开启Swagger或Lombok支持。此外，策略配置中的表名和字段名的策略需要解释清楚，避免用户生成代码时出现命名问题。 模板引擎部分，用户可能不知道需要添加Freemarker或Velocity依赖，所以需要明确说明，并给出依赖的示例。同时，运行代码生成器后，用户需要知道生成的代码位置，以及如何将这些代码整合到项目中。 可能还需要考虑用户在实际操作中遇到的常见问题，比如依赖冲突、配置文件路径错误、表名大小写敏感等。但根据用户的问题，可能不需要深入这些，但需要确保步骤清晰，避免遗漏关键点。 最后，用户可能需要生成后的代码结构和使用方法，比如如何注入Mapper进行数据库操作。此外，引用中的示例代码生成器配置类需要正确展示，确保语法正确，特别是使用正确的注释和配置方法。 总结一下，回答应该分步骤，先项目创建和依赖添加，然后是配置文件，接着是配置类的编写，最后是运行生成器。每个步骤需要简明扼要，必要时给出代码示例，并提醒可能的注意事项，比如版本和驱动类的问题。同时，根据用户提供的引用内容，确保引用标识正确添加，如引用[^2]在适当的位置。</think>以下是MyBatis Plus代码生成器的配置和使用方法详解： ### 一、环境准备 1. 创建Spring Boot项目 使用IDEA或Spring Initializr创建项目，选择Web、MyBatis Plus、数据库驱动（MySQL/Oracle等）依赖 2. 添加依赖（pom.xml） ```xml <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3.1</version> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.3.1</version> </dependency> <!-- 模板引擎 --> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> </dependency> ``` ### 二、配置文件 在`application.yml`中配置数据库连接： ```yaml spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/your_db?useSSL=false username: root password: 123456 ``` ### 三、生成器配置类 创建`CodeGenerator.java`类： ```java public class CodeGenerator { public static void main(String[] args) { AutoGenerator generator = new AutoGenerator(); // 全局配置 GlobalConfig gc = new GlobalConfig.Builder() .author("YourName") .outputDir(System.getProperty("user.dir") + "/src/main/java") .enableSwagger() .build(); // 数据源配置 DataSourceConfig dsc = new DataSourceConfig.Builder( "jdbc:mysql://localhost:3306/your_db", "root", "123456") .build(); // 包配置 PackageConfig pc = new PackageConfig.Builder() .parent("com.example") .moduleName("system") .entity("entity") .mapper("mapper") .build(); // 策略配置 StrategyConfig strategy = new StrategyConfig.Builder() .addInclude("user", "order") // 要生成的表名 .entityBuilder() .enableLombok() .naming(NamingStrategy.underline_to_camel) .build(); generator.global(gc) .dataSource(dsc) .packageInfo(pc) .strategy(strategy); generator.execute(); } } ``` ### 四、运行生成器 直接运行`CodeGenerator`类的main方法，生成的代码结构为： ``` src/main/java └── com.example └── system ├── entity # 实体类 ├── mapper # Mapper接口 └── service # Service层 ``` ### 五、使用说明 1. 生成的Mapper接口已包含基本CRUD方法 2. Service层自动继承`IService`接口 3. 实体类自动添加`@TableName`注解映射数据库表 [^1][^2]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值