MybatisPlus代码生成器AutoGenerator使用

一、引言

之前写过一篇关于代码自动生成的文章，当时使用的是

Mybatis

提供的

Generator

来实现自动生成

Entity、Mapper、Mapper XML、Service、Controller

等各个模块的代码，不了解的可以去看看。

Mybatis

逆向工程之

Mybatis Generator

的使用

https://blog.csdn.net/zxd1435513775/article/details/79257059

Mybatis Plus

主动集成了代码的自动生成，用起来也很方便，下面是官方文档，可以参考一下。

Mybatis Plus

代码生成器官方文档：

https://mp.baomidou.com/guide/generator.html

两种代码自动生成都用过，没有好坏之分，如果非要让我推荐使用哪一种，我会选择

Mybatis Plus

。

二、MyBatis-Plus 代码生成器

正如官方文档的描述，

AutoGenerator

是

MyBatis-Plus

的代码生成器，通过

AutoGenerator

可以快速生成

Entity、Mapper、Mapper XML、Service、Controller

等各个模块的代码，极大的提升了开发效率。

下面就来介绍一下具体怎么使用吧。

1、引入依赖

由于

MyBatis-Plus

从

3.0.3

版本之后移除了代码生成器与模板引擎的默认依赖，我们需要手动添加相关依赖：

<!--mybatis-plus 持久层-->
   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>3.0.5</version>
   </dependency>

   <!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
   <dependency>
       <groupId>org.apache.velocity</groupId>
       <artifactId>velocity-engine-core</artifactId>
       <version>2.0</version>
   </dependency>
           

注意：MyBatis-Plus 的默认模板引擎是使用 Velocity，如果你选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());
           

2、编写配置

最重要的地方来了，就是这个配置。

MyBatis-Plus

的代码生成器提供了大量的自定义参数供用户选择，能够满足绝大部分人的使用需求。

我们在项目的test目录下，新建一个

CodeGenerator

类，具体如下图：

创建完了，我们就可以把下面的配置代码拷贝进去了，下面我们来具体介绍一下。

public class CodeGenerator {

    @Test
    public void run() {

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

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        // 此处建议写项目/src/main/java源代码的绝对路径
        gc.setOutputDir("C:\\idea\\onlinedu-parent\\service\\service-edu" + "/src/main/java");
        // 生成注释时的作者
        gc.setAuthor("scorpios");
        //生成后是否打开资源管理器
        gc.setOpen(false);
        gc.setFileOverride(false); //重新生成时文件是否覆盖
        gc.setServiceName("%sService");	//去掉Service接口的首字母I
        gc.setIdType(IdType.ID_WORKER_STR); //主键策略
        gc.setDateType(DateType.ONLY_DATE); //定义生成的实体类中日期类型
        // 如果开启Swagger,要引入相应的包
        gc.setSwagger2(true); //开启Swagger2模式

        mpg.setGlobalConfig(gc);

        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mybatis_plus?serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig();
        // 此处要注意：parent + moduleName 为包的名字，在这个包下，创建对应的controller...
        pc.setParent("com.scorpios");
        pc.setModuleName("eduservice"); //模块名
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 数据库中表的名字，表示要对哪些表进行自动生成controller service、mapper...
        strategy.setInclude("edu_course","edu_course_description",
        	"edu_chapter","edu_video");
        // 数据库表映射到实体的命名策略,驼峰命名法
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 生成实体时去掉表前缀，比如edu_course，如果不加下面这句，生成的实体类名字就是：EduCourse
        strategy.setTablePrefix("edu_"); 
        //生成实体时去掉表前缀
		// strategy.setTablePrefix(pc.getModuleName() + "_"); 

		//数据库表字段映射到实体的命名策略
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作

        strategy.setRestControllerStyle(true); //restful api风格控制器
        strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符

        mpg.setStrategy(strategy);

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

           

把上面的信息配置好，执行run函数，就可以自动生成主体代码啦…