使用代碼生成器自定義Entity的部分註解

Posted on by

代碼生成器自定義Entity部分註解

對mybatis-plus代碼生成器的entity模板進行部分自定義

此文章觀看前提：已經能用mybatis-plus自動生成代碼

前因

因為原有模板自動生成的entity為下面這樣，表字段為name，age，number，但我想生成圖2的樣子，在每個字段前面添加個註解@ApiModelProperty()

查找瞭我的代碼生成器那個配置類

debug瞭最後要生成模板的兩句，找到瞭我的entity的生成模板為/templates/entity.java.ftl(因為模板引擎是freemarker，所以後綴為ftl)

隨後在templates/entity.java.ftl裡

找到模板生成的代碼，然後在屬性模板前面加上這個代碼

<#if swagger2>
    @ApiModelProperty(value = "${field.propertyName}",dataType = "${field.propertyType}",required = true)
</#if>

還有一點

記得在配置類中設置開啟 swagger2 模式

代碼生成器最新版配置方案

因為最近寫項目使用到瞭MyBatis-Plus，所以去官網找到瞭一個代碼生成器的新版，現在網上能查到的都是之前的舊版生成器代碼，官方提供的快速生成沒有開啟Lombok、RestController還有很多自定義類名的策略。

新版對依賴版本有要求，適用版本：mybatis-plus-generator 3.5.1 及其以上版本，對歷史版本不兼容！

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>
<!--對MyBatisPlus代碼生成器進行支持的模板引擎-->
<dependency>
     <groupId>org.freemarker</groupId>
     <artifactId>freemarker</artifactId>
     <version>2.3.30</version>
</dependency>
<dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-boot-starter</artifactId>
     <version>3.5.1</version>
</dependency>

本著喜新厭舊的初心，我根據官方文檔配置瞭一個新版常用的快速生成器，修改數據庫配置並設計好表之後填入表名直接運行使用就行瞭，如果要配置詳細的策略請去官網查文檔配置。MyBatis代碼生成器官方文檔 

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import xyz.tylt.controller.BaseController;
import java.util.Collections;
/*
 * MyBatisPlus代碼生成器
 */
public class CodeGenerator {
    public static void main(String[] args) {
        String drive = "D://";
        String xmlpath = drive + "xyz//resource//mapper";
        String projectPath = System.getProperty("user.dir");
        FastAutoGenerator.create("jdbc:mysql://localhost:3306/databasename?useSSl=ture&serverTimezone=UTC&useUnicode=true&characterEncoding=UTF-8", "root", "1234")
                .globalConfig(builder -> {
                    builder.author("tylt6688")// 設置作者
                            .enableSwagger() // 開啟 swagger 模式
                            .fileOverride() // 覆蓋已生成文件
                            .outputDir(drive); // 指定輸出目錄
                })
                .packageConfig(builder -> {
                    builder.parent("xyz.tylt") // 設置父包名
//                            .moduleName("system") // 設置父包模塊名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, xmlpath)); // 設置mapperXml生成路徑
                })
                //實體策略配置
                .strategyConfig(builder -> {
                    builder.entityBuilder()
                            //開啟Lombok，默認生成@Get，@Set，可以手動換成@Data
                            .enableLombok();
                })
                //控制類策略配置
                .strategyConfig(builder -> {
                    builder.controllerBuilder()
                             //如果沒有父類請註釋掉
                            .superClass(BaseController.class)
                            .enableRestStyle();
                })
                //服務類策略配置
                .strategyConfig(builder -> {
                    builder.serviceBuilder()
                            .formatServiceFileName("%sService")
                            .formatServiceImplFileName("%sServiceImp");
                })
                .strategyConfig(builder -> {
                    builder.addInclude("tb_teachplan")// 設置數據庫中表名，按其中屬性內容進行生成
//                            .addInclude("tb_floor")
//                            .addInclude("tb_room")
                            .addTablePrefix("tb_", "c_", "sys_"); // 設置過濾表前綴進行生成
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默認的是Velocity引擎模板
                .execute();
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：