mybatis-plus 代码生成器

分享一个基于 mybatis-plus 实现的自动生成数据库表的映射类和三层架构对应实现类的工具类。

首先，需要引入依赖：

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-annotation</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-core</artifactId>
            <version>3.4.1</version>
        </dependency>

工具类：

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
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.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.springframework.util.StringUtils;

/**
 * mybatisPlus代码自动生成类
 *
 * @author by MoCheng
 * @date 2024/3/4
 */
public class CodeGenerator {

    public static void main(String[] args) {

        // 所需要生成的表 ,
        String[] tables = {"tbl_table1", "tbl_table2"};
        // "创建人XXX" ,填写自己
        String author = "MoCheng";

        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        // 选择 freemarker 引擎，默认 Veloctiy
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectDir = System.getProperty("user.dir");
        //生成文件的输出目录
        gc.setOutputDir(projectDir + "/src/test");
        //作者
        gc.setAuthor(author);
        //是否覆蓋已有文件 默认值：false
        gc.setFileOverride(true);
        //是否打开输出目录 默认值:true
        gc.setOpen(false);
        //开启 swagger2 模式 默认false
        gc.setSwagger2(false);
        //开启 baseColumnList 默认false
        gc.setBaseColumnList(true);
        //开启 BaseResultMap 默认false
        gc.setBaseResultMap(true);
        //实体命名方式  默认值：null 例如：%sEntity 生成 UserEntity
//        gc.setEntityName("%sEntity");
        //mapper 命名方式 默认值：null 例如：%sDao 生成 UserDao
        gc.setMapperName("%sMapper");
        //Mapper xml 命名方式   默认值：null 例如：%sDao 生成 UserDao.xml
        gc.setXmlName("%sMapper");
        //service 命名方式   默认值：null 例如：%sBusiness 生成 UserBusiness
        gc.setServiceName("I%sDbService");
        //service impl 命名方式  默认值：null 例如：%sBusinessImpl 生成 UserBusinessImpl
        gc.setServiceImplName("%sDbServiceImpl");
        //controller 命名方式    默认值：null 例如：%sAction 生成 UserAction
        gc.setControllerName("%sController");
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        //数据库类型	该类内置了常用的数据库类型【必须】
        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl("jdbc:mysql://127.0.0.1:3060/test?characterEncoding=utf8&useUnicode=true&useSSL=false&serverTimezone=UTC");
        // dsc.setSchemaName("public");
        //新版8.0的MySQL驱动配置改变
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123");
        mpg.setDataSource(dsc);

        // 包路径配置
        PackageConfig pc = new PackageConfig();
//	        pc.setModuleName(scanner("模块名"));
        // 主目录
        pc.setParent("com.mocheng.test");
        mpg.setPackageInfo(pc);
        pc.setEntity("model.entity");

        // 自定义配置
//	        InjectionConfig cfg = new InjectionConfig() {
//	            @Override
//	            public void initMap() {		//注入自定义 Map 对象
//	                // to do nothing
//	            }
//	        };
//	        List<FileOutConfig> focList = new ArrayList<>();
//	        focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
//	            @Override
//	            public String outputFile(TableInfo tableInfo) {
//	                // 自定义输入文件名称
//	                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
//	                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
//	            }
//	        });
//	        cfg.setFileOutConfigList(focList);
//	        mpg.setCfg(cfg);
//	        mpg.setTemplate(new TemplateConfig().setXml(null));

        // 策略配置	数据库表配置，通过该配置，可指定需要生成哪些表或者排除哪些表
        StrategyConfig strategy = new StrategyConfig();
        //表名生成策略
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 全局大写命名 ORACLE 注意
//	        strategy.setCapitalMode(true);
//	        strategy.setTablePrefix("prefix");		//表前缀
//        strategy.setSuperEntityClass("com.mocheng.test.model.entity");	//自定义继承的Entity类全称，带包名
//	        strategy.setSuperEntityColumns(new String[] { "test_id", "age" }); 	//自定义实体，公共字段
        //【实体】是否为lombok模型（默认 false
        strategy.setEntityLombokModel(true);
        // 【实体】表名注解
        strategy.setEntityTableFieldAnnotationEnable(true);
        // 逻辑删除字段名称
        strategy.setLogicDeleteFieldName("status");
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(true);

//	        strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");	//自定义继承的Controller类全称，带包名
        //需要包含的表名，允许正则表达式（与exclude二选一配置）
        strategy.setInclude(tables);

//	        strategy.setExclude(new String[]{"test"}); // 排除生成的表
        //驼峰转连字符
        strategy.setControllerMappingHyphenStyle(true);
        //是否生成实体时，生成字段注解
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);

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

}