MyBatis-Plus之程式碼生成器

林夕$相心發表於2020-10-18

為什麼要有程式碼生成器

程式碼生成器解決什麼樣的問題

和MyBatis一樣,解決重複性程式碼編寫的時間成本和易錯問題。

MyBatis-Plus的程式碼生成器說明

本次我使用的還是低版本2.1.9,
目前MyBatis-Plus最新版本為3.3.1。
理由很簡單,夠用。不想盲目的追趕高版本,同時高版本伴隨著的不穩定性的存在,企業級應用開發是不允許這樣的風險存在,畢竟開發的東西是要給客戶用的,穩定性壓倒一切。這個低版本我用了兩年多時間,不僅僅在我自己的專案中用,我所待過的公司也用,基本上就沒出現因版本問題導致程式碼不穩定性錯誤。

程式碼生成器實現

引入Maven依賴

        <dependency>
            <artifactId>velocity</artifactId>
            <groupId>org.apache.velocity</groupId>
            <version>1.7</version>
        </dependency>

        <!-- mysql驅動 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>2.1.9</version>
        </dependency>

程式碼例子(單元測試或main方法就能執行並生成對應的程式碼,有對應的註釋說明程式碼的意思)

package com.springcloud.blog.code.generator;
import com.baomidou.mybatisplus.enums.FieldFill;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.FileOutConfig;
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.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.DbType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.*;

public class Generator {
    public static void main(String[] args) {
        // 自定義需要填充的欄位
        List<TableFill> tableFillList = new ArrayList<>();
        tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE));

        // 程式碼生成器
        AutoGenerator mpg = new AutoGenerator().setGlobalConfig(
                // 全域性配置
                new GlobalConfig()
                        .setOutputDir("D://程式碼生成器")//輸出目錄
                        .setFileOverride(true)// 是否覆蓋檔案
                        .setActiveRecord(true)// 開啟 activeRecord 模式
                        .setEnableCache(false)// XML 二級快取
                        .setBaseResultMap(true)// XML ResultMap
                        .setBaseColumnList(true)// XML columList
                        .setAuthor("youcong")
                        // 自定義檔案命名,注意 %s 會自動填充表實體屬性!

                        .setMapperName("%sDao")
                        .setXmlName("%sDao")
                        .setServiceName("%sService")
                        .setServiceImplName("%sServiceImpl")
                        .setControllerName("%sController")
        ).setDataSource(
                // 資料來源配置
                new DataSourceConfig()
                        .setDbType(DbType.MYSQL)// 資料庫型別
                        .setTypeConvert(new MySqlTypeConvert() {
                            // 自定義資料庫表欄位型別轉換【可選】
                            @Override
                            public DbColumnType processTypeConvert(String fieldType) {
                                System.out.println("轉換型別:" + fieldType);
                                // if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
                                //    return DbColumnType.BOOLEAN;
                                // }
                                return super.processTypeConvert(fieldType);
                            }
                        })
                        .setDriverName("com.mysql.jdbc.Driver")
                        .setUsername("root")
                        .setPassword("123456")
                        .setUrl("jdbc:mysql://127.0.0.1:3306/blog?characterEncoding=utf8")
        ).setStrategy(
                // 策略配置
                new StrategyConfig()
                        // .setCapitalMode(true)// 全域性大寫命名
                        // .setDbColumnUnderline(true)//全域性下劃線命名
                        .setTablePrefix(new String[]{"wp_"})// 此處可以修改為您的表字首
                        .setNaming(NamingStrategy.underline_to_camel)// 表名生成策略
//                        .setInclude("wechat_reply") //指定生成表,註釋掉或不寫,預設生成所有
                        // .setExclude(new String[]{"test"}) // 排除生成的表
                        // 自定義實體父類
                        // .setSuperEntityClass("com.baomidou.demo.TestEntity")
                        // 自定義實體,公共欄位

                        // .setSuperEntityColumns(new String[]{"id"})
                        .setTableFillList(tableFillList)
        ).setPackageInfo(
                // 包配置
                new PackageConfig()
                        .setParent("com.springcloud.blog")// 自定義包路徑
                        .setController("controller")// 這裡是控制器包名,預設 web
                        .setMapper("dao")
                        .setEntity("entity")
                        .setService("service")
                        .setServiceImpl("service.impl")
        ).setCfg(
                // 注入自定義配置,可以在 VM 中使用 cfg.abc 設定的值
                new InjectionConfig() {
                    @Override
                    public void initMap() {
                        Map<String, Object> map = new HashMap<>();
                        map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "");
                        this.setMap(map);
                    }
                }.setFileOutConfigList(Collections.<FileOutConfig>singletonList(new FileOutConfig("/templates/mapper.xml.vm") {
                    // 自定義輸出檔案目錄
                    @Override
                    public String outputFile(TableInfo tableInfo) {
                        return "D://程式碼生成器//" + tableInfo.getEntityName() + "Dao.xml";
                    }
                }))
        ).setTemplate(
                // 關閉預設 xml 生成,調整生成 至 根目錄
                new TemplateConfig().setXml(null)

        );

        // 執行生成
        mpg.execute();

        // 列印注入設定,這裡演示模板裡面怎麼獲取注入內容【可無】
        System.err.println(mpg.getCfg().getMap().get("abc"));

    }
}

生成效果圖,如下:
image.png

相關文章