mybatis-plus代码生成器

mybatis-plus的代码生成器官网有对应的文档。

https://baomidou.com/pages/779a6e/

　　我这里呢是把我写得生成器的代码贴一下，因为有些小伙伴可能有些参数不是很清楚。

　　话不多说上代码

需要导入的依赖

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

//代码生成器

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.TableInfo;
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;

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

    /**
     * <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.isNotEmpty(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.setOutputDir("D:\\test");
        //作者姓名
        gc.setAuthor("Dshzs月");
        
        //生成是否打开
        gc.setOpen(false);
        
        //实体属性 Swagger2 注解
        // gc.setSwagger2(true);
        
        // 是否覆盖
        //gc.setFileOverride(true); 
        
        //去掉service前面的I前缀
        gc.setServiceName("%sService");
        
        //设置日期生成策略
        //gc.setDateType(DateType.ONLY_DATE);
        
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        //数据库的端口以及对应的数据库和字符设置，时区设置
        dsc.setUrl("jdbc:mysql://localhost:3306/你的数据库名?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
        // dsc.setSchemaName("public");
        //使用的是5.7以上就用下面这个，如果是5.7及以下就用com.mysql.jdbc.Driver
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        //数据库用户名，默认root
        dsc.setUsername("root");
        //数据库密码
        dsc.setPassword("密码");
        //数据库类型
        //dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //设置模块，如product->controller
        pc.setModuleName(null);
        //自己的包路径比如com.cn.me
        pc.setParent("包路径");
        //如果不想要默认包名则自己定义
        //pc.setEntity("pojo");
        //pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 自定义配置
        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/mapper/"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

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

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

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //设置命名规则下划线转驼峰
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //实体的列名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //是否生成lombok注解
        strategy.setEntityLombokModel(true);
        //逻辑删除字段配置
        // strategy.setLogicDeleteFieldName("deleted");
        //开启驼峰命名
        strategy.setRestControllerStyle(true);
        //指定要映射的数据库表，可以写多个表，用“，”隔开
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        //下划线转驼峰
        strategy.setControllerMappingHyphenStyle(true);
        //去掉这个是表的前缀比如sys_user，要去掉前缀就输入sys_
        strategy.setTablePrefix("需要去掉的前缀");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        //执行
        mpg.execute();
    }
}

最新的代码生成器是用的链式调用，和之前的代码出入不大，可是有些方法名字稍微有点调整

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>3.5.1</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>

//数据库端口，数据库，还有一些数据库设置
FastAutoGenerator.create("jdbc:mysql://localhost:3306/你的数据库名?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC", "root", "123456")
        // 全局配置
        .globalConfig((scanner, builder) -> builder
                .author("Dshzs月")/*作者*/
                .fileOverride()/*覆盖已生成文件*/
                .disableOpenDir()/*禁止打开输出目录*/
                .commentDate("yyyy-MM-dd")/*注释日期*/
                .outputDir("src/main/java")
                )
        // 包配置
        .packageConfig((scanner, builder) -> builder
                .parent("包名")/*包名如：com.cn.me*/
                //这是你mybatis需要的xml文件目录一般都是src/main/resources/mapper
                .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "src/main/resources/mapper")))
        // 策略配置
        .strategyConfig((scanner, builder) -> builder.addInclude(scanner.apply("请输入表名，多个英文逗号分隔？所有输入 all"))
                .addTablePrefix("需要去掉的前缀")/*去掉前缀如：sys_user,去掉前缀就是把sys_输入*/
                .serviceBuilder()/*service 策略配置*/
                .formatServiceFileName("%sService")/*去掉service前面的I前缀*/
                .controllerBuilder()/*controller 策略配置*/
                .enableRestStyle()/*开启生成@RestController 控制器*/
                .enableHyphenStyle()/*开启驼峰转连字符*/
                .entityBuilder()/*实体策略配置*/
                .enableLombok()/*开启 lombok 模型*/
                .entityBuilder().enableLombok().addTableFills(
                        new Column("create_time", FieldFill.INSERT)
                ).build())
        /*
            模板引擎配置，默认 Velocity 可选模板引擎 Beetl 或 Freemarker
           .templateEngine(new BeetlTemplateEngine())
           .templateEngine(new FreemarkerTemplateEngine())
         */
        .execute();