MyBatisPlus-生成代码工具类

小锴的学习笔记

已于 2022-08-04 16:28:07 修改

阅读量815

点赞数

CC 4.0 BY-SA版权

分类专栏： MyBatis MyBatisPlus 工具文章标签： java

于 2021-01-12 09:00:49 首次发布

本文链接：https://blog.youkuaiyun.com/qq_40925525/article/details/112505855

工具同时被 3 个专栏收录

14 篇文章

订阅专栏

MyBatis

12 篇文章

订阅专栏

MyBatisPlus

4 篇文章

订阅专栏

博客提及 Java 3.5.1 版本以上相关内容，但信息较少。Java 是后端开发常用语言，此版本信息或对相关开发有一定参考价值。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

package com.test.boot.demo.util;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.apache.commons.lang3.StringUtils;

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

public class MyBatisPlusGeneratorUtil {

    // ********************************************************* 需要生成的表的名称  多个表名用英文逗号分隔 *************************************************************
    public static String tableName = "test";

    // ********重新生成时是否覆盖原来生成的文件********  true = 覆盖  false = 不覆盖
    public static boolean fileOverride = true;

    // ********是否需要忽略数据库的表前缀********  true = 需要忽略  false = 不需要忽略
    public static boolean ignoreTablePrefixFlag = true;
    // ********数据库需要忽略的表前缀********  需要  ignoreTablePrefixFlag = true
    public static String tablePrefix = "t_";


    // ************数据源配置****************
    public static String databaseUrl = "jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false&rewriteBatchedStatements=true";
    public static String driverName = "com.mysql.cj.jdbc.Driver";
    public static String username = "root";
    public static String password = "root";

    // 生成的Java代码在 src.main.java 下的路径  也就是项目的域名  不包括项目名
    public static String parentPath = "com.test.boot";
    // 生成的Java代码在 src.main.java.parentPath 下的路径  也就是项目名
    public static String modelName = "demo";
    //  Xxx.java             实体类           生成的   包的名称
    public static String entityPackageName = "entity";
    //  XxxController.java   控制层类         生成的   包的名称
    public static String controllerPackageName = "controller";
    //  XxxMapper.java       Mapper类         生成的   包的名称
    public static String mapperPackageName = "mapper";
    //  XxxService.java      服务层接口       生成的   包的名称
    public static String servicePackageName = "service";
    //  XxxServiceImpl.java  服务层实现类     生成的   包的名称
    public static String serviceImplPackageName = "service.impl";

    // XxxMapper.xml    生成在 src.main.resources 下的路径
    public static String mapperXmlPath = "mapper/";

    // ********代码注释的作者名称********
    public static String authorName = "Zongkai.Li";


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

        // 全局配置类
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");        // 代码生成的目录
        globalConfig.setOutputDir(projectPath + "/src/main/java");  // 代码最终输出的目录
        globalConfig.setOpen(false);                                // 配置生成完成后是否打开目录，false 为不打开（可选）
        globalConfig.setServiceName("%sService");                   // ************** 默认service接口名IXXXService  自定义指定之后就不会用I开头了*************
        globalConfig.setAuthor(authorName);                         // 设置生成的代码中的注释中的作者名称
        globalConfig.setFileOverride(fileOverride);                 // 重新生成时是否覆盖原来生成的文件
        globalConfig.setDateType(DateType.ONLY_DATE);               // ****************定义生成的实体类中的日期类型*****************
        globalConfig.setSwagger2(true);                             // 实体属性 Swagger2 注解
        globalConfig.setBaseColumnList(true);                       // ********************  mapper.xml 文件中生成  通用查询结果列 **************************
        globalConfig.setBaseResultMap(true);                        // ********************   mapper.xml 文件中生成 通用查询映射结果   *****************************
//        globalConfig.setIdType(IdType.AUTO);                      // 配置主键生成策略，此处为 ASSIGN_ID（可选）
//        globalConfig.setActiveRecord(true);                         // 配置实体类是否继承 通用Model类  不建议
//        globalConfig.setKotlin(true);                               // 不懂什么意思 好像和安卓的函数式编程有关 没啥用
        mybatisPlusGenerator.setGlobalConfig(globalConfig);

        // 数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setUrl(databaseUrl);
        dataSourceConfig.setDriverName(driverName);
        dataSourceConfig.setUsername(username);
        dataSourceConfig.setPassword(password);
//        dataSourceConfig.setDbType(DbType.MYSQL);                   //  支持的数据库有:   MySql数据库  MariaDB数据库  达梦数据库  SQLServer数据库  SQLite数据库
                                                                    // Oracle11g及以下数据库(高版本推荐使用ORACLE_NEW)    Oracle12c+数据库    DB2数据库    H2数据库
                                                                    // HSQL数据库  Postgre数据库  SQLServer2005数据库  虚谷数据库  人大金仓数据库  其他数据库
//        dataSourceConfig.setDbQuery();                              //  不懂
//        dataSourceConfig.setTypeConvert()                           //  设置自定义类型转换器
        mybatisPlusGenerator.setDataSource(dataSourceConfig);

        // 包配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setParent(parentPath);
        packageConfig.setModuleName(modelName);                     // 从代码中获取项目名称
//        packageConfig.setModuleName(scanner("模块名"));          //  从控制台输入
        packageConfig.setEntity(entityPackageName);
        packageConfig.setController(controllerPackageName);
        packageConfig.setMapper(mapperPackageName);
        packageConfig.setService(servicePackageName);
        packageConfig.setServiceImpl(serviceImplPackageName);
//        packageConfig.setXml();                                     //  本类使用 mapperXmlPath 进行控制.
//        packageConfig.setPathInfo();                                //
        mybatisPlusGenerator.setPackageInfo(packageConfig);

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

        // 如果模板引擎是 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) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath
                        + "/src/main/resources/"
                        + mapperXmlPath
//                        + pc.getModuleName()
                        + "/" + tableInfo.getEntityName()
                        + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mybatisPlusGenerator.setCfg(cfg);

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

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

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

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);          // 数据库表映射到实体的命名策略
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);    // 数据库表字段映射到实体的命名策略
        strategy.setEntityLombokModel(true);                            // *******************  lombok 模型 @Accessors(chain = true) 链式编程  *******************
        strategy.setRestControllerStyle(true);                          // RestFul API 风格 Controller
//        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));       //从控制台获取需要生成的表的名称 多个表名用英文逗号分隔
        strategy.setInclude(tableName.split(","));               // 需要生成的表的名称  多个表名用英文逗号分隔
        strategy.setControllerMappingHyphenStyle(true);                 // Controller类中 URL中驼峰转连字符
        if (ignoreTablePrefixFlag){
            strategy.setTablePrefix(tablePrefix);                       // 忽略表前缀  如 t_
        }else {
            strategy.setTablePrefix(packageConfig.getModuleName() + "_");
        }
        mybatisPlusGenerator.setStrategy(strategy);
        mybatisPlusGenerator.setTemplateEngine(new FreemarkerTemplateEngine());
        mybatisPlusGenerator.execute();
    }


    /**
     * 读取控制台内容
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }


/*    pom.xml文件需要的依赖:
    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>

        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

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




}

3.5.1版本以上

package cn.rntd.gis.util;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.Collections;

/*
 * MyBatisPlus代码生成器
 * 3.5.1
 *
 */
public class CodeGenerator {


    public static void main(String[] args) {

        String url = "jdbc:mysql://1.15.237.127:3306/map_data?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8&rewriteBatchedStatements=true";
        String username = "root";
        String password = "scr123456";

        String drive = System.getProperty("user.dir") + "\\gis-api\\src\\";
        String xmlpath = drive + "main\\resources\\mapping";
        String projectPath = System.getProperty("user.dir");
        System.out.println("projectPath = " + projectPath);
        String tableName = "hohhot_unicom";//*************************

        FastAutoGenerator.create(url, username, password)
                .globalConfig(builder -> {
                    builder.author("Zongkai Li")// 设置作者
                            .enableSwagger() // 开启 swagger 模式
                            //.fileOverride() // 覆盖已生成文件
                            .outputDir(drive); // 指定输出目录

                })
                .packageConfig(builder -> {
                    builder.parent("main.java.cn.rntd.gis") // 设置父包名
                            //.moduleName("gis") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, xmlpath)); // 设置mapperXml生成路径
                })
                //实体策略配置
                .strategyConfig(builder -> {
                    builder.entityBuilder()
                            .disableSerialVersionUID()
                            .enableTableFieldAnnotation()
                            .enableChainModel() // 开启链式模型
                            .logicDeletePropertyName("is_delete")
                            .enableLombok(); //开启Lombok，默认生成@Get，@Set，可以手动换成@Data
                })
                //控制类策略配置
                .strategyConfig(builder -> {
                    builder.controllerBuilder()
                            //.superClass(BaseController.class)  //如果没有父类请注释掉
                            .enableRestStyle();
                })
                //服务类策略配置
                .strategyConfig(builder -> {
                    builder.serviceBuilder()
                            .formatServiceFileName("%sService")
                            .formatServiceImplFileName("%sServiceImpl");
                })
                .strategyConfig(builder -> {
                    builder.addInclude(tableName)// 设置数据库中表名，按其中属性内容进行生成
                            .enableSkipView()
//                            .addInclude("tb_name2")
                            .addTablePrefix("tb_", "c_", "sys_"); // 设置过滤表前缀进行生成 多个逗号分隔
                })
                .strategyConfig(builder -> {
                    builder.mapperBuilder()
                            .enableMapperAnnotation()
                            .enableBaseResultMap()
                            .enableBaseColumnList()
                            .build();
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();

    }
}