MyBatis-Plus 代码生成器

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

官方文档

  • Spring Boot:

    1
    2
    3
    4
    5
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.1</version>
    </dependency>

  • Spring MVC:

    1
    2
    3
    4
    5
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>3.4.1</version>
    </dependency>

MyBatis-Plus 代码生成器

1、添加依赖：

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

  • 添加 代码生成器 依赖 
1
2
3
4
5
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>

  • 添加 模板引擎 依赖： MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl

    Velocity

1
2
3
4
5
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>

​ Freemarker

1
2
3
4
5
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.30</version>
</dependency>

​ Beetl

1
2
3
4
5
<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.3.0.RELEASE</version>
</dependency>

2、编写配置：参考

  • 创建生成器对象：

    1
    2
    // 1、代码生成器
          AutoGenerator mpg = new AutoGenerator();

  • 配置 GlobalConfig ：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    // 2、全局配置
    GlobalConfig gc = new GlobalConfig();
    String projectPath = System.getProperty("user.dir");
    log.info(projectPath);
    gc.setOutputDir(projectPath+"/src/main/java");
    gc.setAuthor("dell");
    gc.setOpen(false);
    gc.setFileOverride(false);                      //重新生成时文件是否覆盖
    gc.setServiceName("%sService");	                //去掉Service接口的首字母I
    gc.setIdType(IdType.ID_WORKER_STR);             //主键策略
    gc.setDateType(DateType.ONLY_DATE);             //定义生成的实体类中日期类型
    gc.setSwagger2(true);                           //开启Swagger2模式

  • 配置数据源：

    1
    2
    3
    4
    5
    6
    7
    8
    // 3、数据源配置
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://192.168.121.152:3306/newbee_mall_db?useUnicode=true&useSSL=false&characterEncoding=utf8");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("123456");
    dsc.setDbType(DbType.MYSQL);
    mpg.setDataSource(dsc);

  • 包配置：

    1
    2
    3
    4
    5
    6
    7
    8
    9
            // 4、包配置
            PackageConfig pc = new PackageConfig();
    //        pc.setModuleName("provider");    //模块名
            pc.setParent("edu.lsl");
            pc.setController("controller");
            pc.setEntity("bean");
            pc.setService("service");
            pc.setMapper("mapper");
            mpg.setPackageInfo(pc);

  • 策略配置：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
            // 5、策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setNaming(NamingStrategy.underline_to_camel);          //数据库表映射到实体的命名策略
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);    //数据库表字段映射到实体的命名策略
            strategy.setEntityLombokModel(true);                            // lombok 模型 @Accessors(chain = true) setter链式操作
            strategy.setRestControllerStyle(true);                          //restful api风格控制器
            strategy.setControllerMappingHyphenStyle(true);                 //url中驼峰转连字符
            // 公共父类
    //        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
            // 写于父类中的公共字段
            strategy.setSuperEntityColumns("id");
    //        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            strategy.setInclude("tb_newbee_mall_admin_user");
            strategy.setControllerMappingHyphenStyle(true);
    //        strategy.setTablePrefix(pc.getModuleName() + "_");            //生成实体时去掉表前缀
            strategy.setTablePrefix("tb_newbee_");                          //生成实体时去掉表前缀
            mpg.setStrategy(strategy);

  • 模板配置：

    1
    mpg.setTemplateEngine(new FreemarkerTemplateEngine());          // 添加 模板引擎

  • 执行：

    1
    2
    // 6、执行
    mpg.execute();

3、Demo测试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
package edu.lsl.mbg;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
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.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

/**
 * @project: Mybatis-plus
 * @description: Mybatis-plus 代码生成器demo
 * @author: SongLin.Lu
 * @date: 2020/12/14 - 15:56
 */
public class CodeGenerator {
    private static String DataBaseName = "newbee_mall_db";
    private static String Url = "jdbc:mysql://192.168.121.152:3306/"+DataBaseName+"?useUnicode=true&useSSL=false&characterEncoding=utf8";
    private static String DriverName = "com.mysql.cj.jdbc.Driver";
    private static String Username = "root";
    private static String Password = "123456";
    private static String projectPath = System.getProperty("user.dir");
    
    public static void main(String[] args) {
        // 1、代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig()
                .setAuthor("dell")
                .setDateType(DateType.ONLY_DATE)            //定义生成的实体类中日期类型
                .setFileOverride(false)                     //重新生成时文件是否覆盖
                .setIdType(IdType.ID_WORKER_STR)            //主键策略
                .setOpen(false)
                .setOutputDir(projectPath+"/src/main/java") //输出路径
                .setServiceName("%sService")                //去掉Service接口的首字母I
                .setSwagger2(true)                          //开启Swagger2模式
                .setActiveRecord(false)
                .setControllerName(null);
        mpg.setGlobalConfig(gc);

        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig()
//                .setDbQuery()               // 数据库信息查询类
//                .setSchemaName()
//                .setTypeConvert()
                .setDbType(DbType.MYSQL)
                .setDriverName(DriverName)
                .setPassword(Password)
                .setUrl(Url)
                .setUsername(Username);
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig()
                .setParent("edu.lsl")
                .setController("controller")
                .setEntity("bean")
                .setMapper("mapper")
                .setService("service")
                .setModuleName("")
//                .setPathInfo()              // 路径配置信息
                .setServiceImpl("service.impl")
                .setXml("mapper.xml");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig()
                .setControllerMappingHyphenStyle(true)                  //url中驼峰转连字符
                .setColumnNaming(NamingStrategy.underline_to_camel)     //数据库表映射到实体的命名策略
                .setNaming(NamingStrategy.underline_to_camel)
                .setEntityLombokModel(true)
                .setRestControllerStyle(true)                           //restful api风格控制器
                .setTablePrefix("tb_newbee_")                            //生成实体时去掉表前缀
//                .setSuperControllerClass()                              //公共父类 , 你自己的父类控制器,没有就不用设置!
//                .setSuperEntityClass()                                  //自定义继承的Entity类全称，带包名
//                .setSuperEntityColumns()                                //写于父类中的公共字段
                .setInclude(
                        "tb_newbee_mall_admin_user",
                        "tb_newbee_mall_carousel"
                );
        mpg.setStrategy(strategy);

        // 6、添加模板引擎
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());          // 添加 模板引擎

        // 7、执行
        mpg.execute();
    }
}

4、参考博客：