基于mybatis-plus的代码自动生成工具(工具类)

使用教程

一、添加依赖

		<!-- mysql数据驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!-- 代码生成器 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
        <!-- Freemarker模板引擎 -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.31</version>
        </dependency>

二、编写配置

常量定义

 /**
     * 数据源常量
     */
    private final static String url = "jdbc:mysql:///database?serverTimezone=UTC&characterEncoding=utf-8";
    private final static String driverName = "com.mysql.cj.jdbc.Driver";
    private final static String username = "用户名";
    private final static String password = "密码";

    /**
     * 包名常量
     */
    private final static String parentPackageName = "com.csdn";
    private final static String moduleName = "模块名(应用名)";

    /**
     * 数据库配置
     */
    private final static String tablePrefix = "t_(表前缀)";

全局配置

 // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        //生成文件的输出目录
        gc.setOutputDir(projectPath + "/src/main/java");
        //是否覆盖已有文件
        gc.setFileOverride(true);
        //开发人员
        gc.setAuthor("jobob");
        //是否打开输出目录
        gc.setOpen(false);
        //开启 swagger2 模式
        gc.setSwagger2(true);
        //开启 BaseResultMap
        gc.setBaseResultMap(true);
        //开启 baseColumnList
        gc.setBaseColumnList(true);
        //时间类型对应策略
//        gc.setDateType(DateType.SQL_PACK);
        //指定生成的主键的ID类型
        gc.setIdType(IdType.ASSIGN_UUID);

数据源配置

 // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        //数据库类型
//        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl(url);
        dsc.setDriverName(driverName);
        dsc.setUsername(username);
        dsc.setPassword(password);
        mpg.setDataSource(dsc);

包名配置

 //包名配置
        PackageConfig pc = new PackageConfig();
        //父包模块名
        pc.setModuleName(moduleName);
        //父包名。如果为空,将下面子包名必须写全部, 否则就只需写子包名
        pc.setParent(parentPackageName);
        mpg.setPackageInfo(pc);

数据库表配置

// 数据库表配置
        StrategyConfig strategy = new StrategyConfig();
        //数据库表映射到实体的命名策略
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //表前缀
        strategy.setTablePrefix(tablePrefix);
        //字段前缀
        //自定义继承的Entity类全称,带包名
//        strategy.setSuperEntityClass("com.fjy.generator.BaseEntity");
        // 写于父类中的公共字段
//        strategy.setSuperEntityColumns("create_time","update_time");
        //自定义继承的Controller类全称,带包名
//        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        //Boolean类型字段是否移除is前缀(默认 false)
        strategy.setEntityBooleanColumnRemoveIsPrefix(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(true);
        //【实体】是否为lombok模型(默认 false)
        strategy.setEntityLombokModel(true);
        //需要包含的表名,当enableSqlFilter为false时,允许正则表达式(与exclude二选一配置)
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        //驼峰转连字符
//        strategy.setControllerMappingHyphenStyle(true);
        //逻辑删除属性名称
//        strategy.setLogicDeleteFieldName("del");
        //表填充字段
//        strategy.setTableFillList()
        //是否生成实体时,生成字段注解
//        strategy.setEntityTableFieldAnnotationEnable(true);
        mpg.setStrategy(strategy);

完整工具类代码

package com.fjy.generator;

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.core.toolkit.StringUtils;
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.TableFill;
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 java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

public class CodeGenerator {
    /**
     * 数据源常量
     */
    private final static String url = "jdbc:mysql:///database?serverTimezone=UTC&characterEncoding=utf-8";
    private final static String driverName = "com.mysql.cj.jdbc.Driver";
    private final static String username = "用户名";
    private final static String password = "密码";

    /**
     * 包名常量
     */
    private final static String parentPackageName = "父包路径(net.csdn)";
    private final static String moduleName = "模块名";

    /**
     * 数据库配置
     */
    private final static String tablePrefix = "t_";

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    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 + "!");
    }

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

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        //生成文件的输出目录
        gc.setOutputDir(projectPath + "/src/main/java");
        //是否覆盖已有文件
        gc.setFileOverride(true);
        //开发人员
        gc.setAuthor("jobob");
        //是否打开输出目录
        gc.setOpen(false);
        //开启 swagger2 模式
        gc.setSwagger2(true);
        //开启 BaseResultMap
        gc.setBaseResultMap(true);
        //开启 baseColumnList
        gc.setBaseColumnList(true);
        //时间类型对应策略
//        gc.setDateType(DateType.SQL_PACK);
        //指定生成的主键的ID类型
        gc.setIdType(IdType.ASSIGN_UUID);
        mpg.setGlobalConfig(gc);


        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        //数据库类型
//        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl(url);
        dsc.setDriverName(driverName);
        dsc.setUsername(username);
        dsc.setPassword(password);
        mpg.setDataSource(dsc);

        //包名配置
        PackageConfig pc = new PackageConfig();
        //父包模块名
        pc.setModuleName(moduleName);
        //父包名。如果为空,将下面子包名必须写全部, 否则就只需写子包名
        pc.setParent(parentPackageName);
        mpg.setPackageInfo(pc);

        // 数据库表配置
        StrategyConfig strategy = new StrategyConfig();
        //数据库表映射到实体的命名策略
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //表前缀
        strategy.setTablePrefix(tablePrefix);
        //字段前缀
        //自定义继承的Entity类全称,带包名
//        strategy.setSuperEntityClass("com.fjy.generator.BaseEntity");
        // 写于父类中的公共字段
//        strategy.setSuperEntityColumns("create_time","update_time");
        //自定义继承的Controller类全称,带包名
//        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        //Boolean类型字段是否移除is前缀(默认 false)
        strategy.setEntityBooleanColumnRemoveIsPrefix(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(true);
        //【实体】是否为lombok模型(默认 false)
        strategy.setEntityLombokModel(true);
        //需要包含的表名,当enableSqlFilter为false时,允许正则表达式(与exclude二选一配置)
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        //驼峰转连字符
//        strategy.setControllerMappingHyphenStyle(true);
        //逻辑删除属性名称
//        strategy.setLogicDeleteFieldName("del");
        //表填充字段
//        strategy.setTableFillList()
        //是否生成实体时,生成字段注解
//        strategy.setEntityTableFieldAnnotationEnable(true);
        mpg.setStrategy(strategy);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            //注入自定义 Map 对象(注意需要setMap放进去)
            @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/mapper/" + 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);
        mpg.setCfg(cfg);

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

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

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


        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

只需要修改常量值,其它基本不用改,执行运行即可

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

爱马氏

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

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

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

打赏作者

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

抵扣说明:

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

余额充值