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函數，就可以自動生成主體代碼啦…