MyBatisPlus3.x中使用代码生成器(全注释)

更新时间：2020年09月01日 10:38:20 作者：BADAO_LIUMANG_QIZHI

这篇文章主要介绍了MyBatisPlus3.x中使用代码生成器(全注释)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

场景

MyBaitsPlus3.x与2.x是不一样的。这里使用3.0.1版本。

官方文档

https://mp.baomidou.com/guide/generator.html

这里在IDEA上的SpringBoot项目中进行代码生成测试。

实现

添加依赖

添加代码生成器依赖

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

注意：MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖

    <!-- 模板引擎velocity start-->
      <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
      </dependency>
      <!-- 模板引擎velocity end-->
      <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.1</version>
      </dependency>

模板引擎

MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎。

注意！如果您选择了非默认引擎，需要在 AutoGenerator 中设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());

编写代码

在test下新建单元测试类Generatortest.java

全局配置

//全局配置
    GlobalConfig config = new GlobalConfig();
    //设置是否支持AR模式
    config.setActiveRecord(true)
        //设置生成代码的作者
        .setAuthor("badaoliumangqizhi")
        //设置输出代码的位置
        .setOutputDir("f:output")
        //.setEnableCache(false)// XML 二级缓存
        //.setBaseResultMap(true)// XML ResultMap
        //.setBaseColumnList(true)// XML columList
        //.setKotlin(true) 是否生成 kotlin 代码
        //设置是否覆盖原来的代码
        .setFileOverride(true);

数据源配置

//数据库连接url
    String dbUrl = "jdbc:sqlserver://;DatabaseName=";
    //数据源配置
    DataSourceConfig dataSourceConfig = new DataSourceConfig();
    //数据库类型 枚举
    dataSourceConfig.setDbType(DbType.SQL_SERVER)
        //设置url
        .setUrl(dbUrl)
        //设置用户名
        .setUsername("")
        //设置密码
        .setPassword("")
        //设置数据库驱动
        .setDriverName("com.microsoft.sqlserver.jdbc.SQLServerDriver")
        // 自定义数据库表字段类型转换【可选】
        .setTypeConvert(new MySqlTypeConvert() {
          @Override
          public DbColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
            System.out.println("转换类型：" + fieldType);
            //tinyint转换成Boolean
             if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
              return DbColumnType.BOOLEAN;
             }
             //将数据库中datetime转换成date
            if ( fieldType.toLowerCase().contains( "datetime" ) ) {
              return DbColumnType.DATE;
            }
            return (DbColumnType) super.processTypeConvert(globalConfig, fieldType);
          }
        });

策略配置

//策略配置
    StrategyConfig strategyConfig = new StrategyConfig();
    strategyConfig
        //全局大写命名是否开启
        .setCapitalMode(true)
        //【实体】是否为lombok模型
        .setEntityLombokModel(true)
        //表名生成策略 下划线转驼峰
        .setNaming(NamingStrategy.underline_to_camel)
        //自动填充设置
        //.setTableFillList(tableFillList)
        //修改替换成你需要的表名，多个表名传数组
        .setInclude("wms_receive_order");

集成注入配置

//注入全局设置
    new AutoGenerator().setGlobalConfig(config)
        //注入数据源配置
        .setDataSource(dataSourceConfig)
        //注入策略配置
        .setStrategy(strategyConfig)
        //设置包名信息
        .setPackageInfo(
            new PackageConfig()
                //提取公共父级包名
                .setParent("com.badao.bus.sys")
                //设置controller信息
                .setController("controller")
                //设置实体类信息
                .setEntity("entity")
        )
        //设置自定义模板
        .setTemplate(
            new TemplateConfig()
                //.setXml(null)//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
                //注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
                // 自定义模板配置，模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
                // 至您项目 src/main/resources/template 目录下，模板名称也可自定义如下配置：
                // .setController("...");
                // .setEntity("...");
                // .setMapper("...");
                // .setXml("...");
                // .setService("...");
                 .setServiceImpl("templates/serviceImpl.java")
        )
        //开始执行代码生成
        .execute();
  }

完整生成器代码

package com.ws.test.generator;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import org.junit.Test;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;
import java.util.List;

/**
 * Created by badado on 2019/4/25.
 */
public class Generatortest {
  @Test
  public void generateTest(){
    //全局配置
    GlobalConfig config = new GlobalConfig();
    //设置是否支持AR模式
    config.setActiveRecord(true)
        //设置生成代码的作者
        .setAuthor("badaoliumangqizhi")
        //设置输出代码的位置
        .setOutputDir("f:output")
        //.setEnableCache(false)// XML 二级缓存
        //.setBaseResultMap(true)// XML ResultMap
        //.setBaseColumnList(true)// XML columList
        //.setKotlin(true) 是否生成 kotlin 代码
        //设置是否覆盖原来的代码
        .setFileOverride(true);

    //******************************数据源配置***************************************
    //数据库连接url
    String dbUrl = "jdbc:sqlserver://;DatabaseName=";
    //数据源配置
    DataSourceConfig dataSourceConfig = new DataSourceConfig();
    //数据库类型 枚举
    dataSourceConfig.setDbType(DbType.SQL_SERVER)
        //设置url
        .setUrl(dbUrl)
        //设置用户名
        .setUsername("")
        //设置密码
        .setPassword("")
        //设置数据库驱动
        .setDriverName("com.microsoft.sqlserver.jdbc.SQLServerDriver")
        // 自定义数据库表字段类型转换【可选】
        .setTypeConvert(new MySqlTypeConvert() {
          @Override
          public DbColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
            System.out.println("转换类型：" + fieldType);
            //tinyint转换成Boolean
             if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
              return DbColumnType.BOOLEAN;
             }
             //将数据库中datetime转换成date
            if ( fieldType.toLowerCase().contains( "datetime" ) ) {
              return DbColumnType.DATE;
            }
            return (DbColumnType) super.processTypeConvert(globalConfig, fieldType);
          }
        });

    //******************************策略配置******************************************************
    // 自定义需要填充的字段 数据库中的字段
    List<TableFill> tableFillList = new ArrayList<>();
    tableFillList.add(new TableFill("gmt_modified", FieldFill.INSERT_UPDATE));
    tableFillList.add(new TableFill("modifier_id", FieldFill.INSERT_UPDATE));
    tableFillList.add(new TableFill("creator_id", FieldFill.INSERT));
    tableFillList.add(new TableFill("gmt_creat", FieldFill.INSERT));
    tableFillList.add(new TableFill("available_flag", FieldFill.INSERT));
    tableFillList.add(new TableFill("deleted_flag", FieldFill.INSERT));
    tableFillList.add(new TableFill("sync_flag", FieldFill.INSERT));
    //策略配置
    StrategyConfig strategyConfig = new StrategyConfig();
    strategyConfig
        //全局大写命名是否开启
        .setCapitalMode(true)
        //【实体】是否为lombok模型
        .setEntityLombokModel(true)
        //表名生成策略 下划线转驼峰
        .setNaming(NamingStrategy.underline_to_camel)
        //自动填充设置
        .setTableFillList(tableFillList)
        //修改替换成你需要的表名，多个表名传数组
        .setInclude("wms_receive_order");
    //集成注入设置
    //注入全局设置
    new AutoGenerator().setGlobalConfig(config)
        //注入数据源配置
        .setDataSource(dataSourceConfig)
        //注入策略配置
        .setStrategy(strategyConfig)
        //设置包名信息
        .setPackageInfo(
            new PackageConfig()
                //提取公共父级包名
                .setParent("com.badao.bus.sys")
                //设置controller信息
                .setController("controller")
                //设置实体类信息
                .setEntity("entity")
        )
        //设置自定义模板
        .setTemplate(
            new TemplateConfig()
                //.setXml(null)//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
                //注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
                // 自定义模板配置，模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
                // 至您项目 src/main/resources/template 目录下，模板名称也可自定义如下配置：
                // .setController("...");
                // .setEntity("...");
                // .setMapper("...");
                // .setXml("...");
                // .setService("...");
                 .setServiceImpl("templates/serviceImpl.java")
        )
        //开始执行代码生成
        .execute();
  }
}

效果

运行测试

生成成功后会自动弹出生成代码的目录

到此这篇关于MyBatisPlus3.x中使用代码生成器(全注释)的文章就介绍到这了,更多相关MyBatisPlus3.x代码生成器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Springboot非分布式定时任务实现代码
这篇文章主要介绍了Springboot非分布式定时任务实现代码,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-11-11
SpringBoot热部署启动关闭流程详解
Spring Boot启动热部署是一种技术，它能让开发者在不重启应用程序的情况下实时更新代码。这样可以提高开发效率，避免频繁重启应用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-04-04
Java中的自旋锁与适应性自旋锁详解
这篇文章主要介绍了Java中的自旋锁与适应性自旋锁详解,在多处理器环境中某些资源的有限性,有时需要互斥访问,这时候就需要引入锁的概念,只有获取了锁的线程才能对资源进行访问,多线程的核心是CPU的时间分片,所以同一时刻只能有一个线程获取到锁,需要的朋友可以参考下
2023-10-10
Springboot-Management的项目实践
本文主要介绍了Springboot-Management的项目实践，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-05-05
使用Spring Cloud Feign上传文件的示例
本篇文章主要介绍了使用Spring Cloud Feign上传文件的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-12-12
Java GUI实现学生成绩管理系统
这篇文章主要为大家详细介绍了Java GUI实现学生成绩管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-01-01
SpringBoot+LayIM+t-io 实现好友申请通知流程
这篇文章主要介绍了 SpringBoot+LayIM+t-io 实现好友申请通知流程,本文图文并茂给大家介绍的非常详细，需要的朋友可以参考下
2017-12-12
java在hashmap初始化时赋初值过程解析
这篇文章主要介绍了java在hashmap初始化时赋初值过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-10-10
详解基于MVC的数据查询模块进行模糊查询
这篇文章主要介绍了Java基于MVC的数据查询模块进行模糊查询，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-01-01
Spring使用注解方式实现创建对象
这篇文章主要介绍了Spring使用注解方式实现创建对象，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2023-02-02