1. 程式人生 > 程式設計 >MyBatis-Plus Generator配置詳解

MyBatis-Plus Generator配置詳解

本文僅對使用MyBatis-Plus的程式碼生成器配置做儲存,適合使用了該外掛的童鞋做參考。

內部有大量預設配置,有性趣的童鞋可以研究下原始碼。

ps:官方文件更齊全http://mp.baomidou.com/

package com.kichun.ucenter.service;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
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 com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.io.File;
import java.util.*;

/**
 * Created by wangqichang on 2018/6/1.
 */
public class MabatisPlusGenerator {

  //生成檔案所在專案路徑
  private static String baseProjectPath = "D:\\Git\\strandrd_official_website\\kichun\\kichun-ucenter\\kichun-ucenter-entity";

  //基本包名
  private static String basePackage="com.kichun.ucenter";
  //作者
  private static String authorName="wangqichang";
  //要生成的表名
  private static String[] tables= {"t_role","t_resource","t_role_resource","t_user_role"};
  //table字首
  private static String prefix="t_";

  //資料庫配置四要素
  private static String driverName = "net.sf.log4jdbc.DriverSpy";
  private static String url = "jdbc:log4jdbc:mysql://127.0.0.1:3306/kichun_dev?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true";
  private static String username = "不告訴你";
  private static String password = "密碼也不告訴你";


  public static void main(String[] args) {


    AutoGenerator gen = new AutoGenerator();

    /**
     * 資料庫配置
     */
    gen.setDataSource(new DataSourceConfig()
        .setDbType(DbType.MYSQL)
        .setDriverName(driverName)
        .setUrl(url)
        .setUsername(username)
        .setPassword(password)
        .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);
          }
        }));

    /**
     * 全域性配置
     */
    gen.setGlobalConfig(new GlobalConfig()
        .setOutputDir( baseProjectPath + "/src/main/java")//輸出目錄
        .setFileOverride(true)// 是否覆蓋檔案
        .setActiveRecord(true)// 開啟 activeRecord 模式
        .setEnableCache(false)// XML 二級快取
        .setBaseResultMap(true)// XML ResultMap
        .setBaseColumnList(true)// XML columList
        .setOpen(false)//生成後開啟資料夾
        .setAuthor(authorName)
        // 自定義檔案命名,注意 %s 會自動填充表實體屬性!
        .setMapperName("%sMapper")
        .setXmlName("%sMapper")
        .setServiceName("%sService")
        .setServiceImplName("%sServiceImpl")
        .setControllerName("%sController")
    );

    /**
     * 策略配置
     */
    gen.setStrategy(new StrategyConfig()
        // .setCapitalMode(true)// 全域性大寫命名
        //.setDbColumnUnderline(true)//全域性下劃線命名
        .setTablePrefix(new String[]{prefix})// 此處可以修改為您的表字首
        .setNaming(NamingStrategy.underline_to_camel)// 表名生成策略
        .setInclude(tables) // 需要生成的表
        .setRestControllerStyle(true)
        //.setExclude(new String[]{"test"}) // 排除生成的表
        // 自定義實體父類
        // .setSuperEntityClass("com.baomidou.demo.TestEntity")
        // 自定義實體,公共欄位
        //.setSuperEntityColumns(new String[]{"test_id"})
        //.setTableFillList(tableFillList)
        // 自定義 mapper 父類 預設BaseMapper
        //.setSuperMapperClass("com.baomidou.mybatisplus.mapper.BaseMapper")
        // 自定義 service 父類 預設IService
        // .setSuperServiceClass("com.baomidou.demo.TestService")
        // 自定義 service 實現類父類 預設ServiceImpl
        // .setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl")
        // 自定義 controller 父類
        //.setSuperControllerClass("com.kichun."+packageName+".controller.AbstractController")
        // 【實體】是否生成欄位常量(預設 false)
        // public static final String ID = "test_id";
        // .setEntityColumnConstant(true)
        // 【實體】是否為構建者模型(預設 false)
        // public User setName(String name) {this.name = name; return this;}
        // .setEntityBuilderModel(true)
        // 【實體】是否為lombok模型(預設 false)<a href="https://projectlombok.org/" rel="external nofollow" >document</a>
        .setEntityLombokModel(true)
        // Boolean型別欄位是否移除is字首處理
        // .setEntityBooleanColumnRemoveIsPrefix(true)
        // .setRestControllerStyle(true)
        // .setControllerMappingHyphenStyle(true)
    );

    /**
     * 包配置
     */
    gen.setPackageInfo(new PackageConfig()
            //.setModuleName("User")
            .setParent(basePackage)// 自定義包路徑
            .setController("controller")// 這裡是控制器包名,預設 web
            .setEntity("entity")
            .setMapper("dao")
            .setService("service")
            .setServiceImpl("service.impl")
            .setXml("mapper")
            );

    /**
     * 注入自定義配置
     */
    // 注入自定義配置,可以在 VM 中使用 cfg.abc 設定的值
    InjectionConfig abc = new InjectionConfig() {
      @Override
      public void initMap() {
        Map<String,Object> map = new HashMap<>();
        map.put("abc",this.getConfig().getGlobalConfig().getAuthor() + "-mp");
        this.setMap(map);
      }
    };
    //自定義檔案輸出位置(非必須)
    List<FileOutConfig> fileOutList = new ArrayList<>();
    fileOutList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
      @Override
      public String outputFile(TableInfo tableInfo) {
        return baseProjectPath + "/src/main/resources/mappers/" + tableInfo.getEntityName() + ".xml";
      }
    });
    abc.setFileOutConfigList(fileOutList);
    gen.setCfg(abc);

    /**
     * 指定模板引擎 預設是VelocityTemplateEngine ,需要引入相關引擎依賴
     */
    gen.setTemplateEngine(new FreemarkerTemplateEngine());

    /**
     * 模板配置
     */
    gen.setTemplate(
        // 關閉預設 xml 生成,調整生成 至 根目錄
        new TemplateConfig().setXml(null)
        // 自定義模板配置,模板可以參考原始碼 /mybatis-plus/src/main/resources/template 使用 copy
        // 至您專案 src/main/resources/template 目錄下,模板名稱也可自定義如下配置:
        // .setController("...");
        // .setEntity("...");
        // .setMapper("...");
        // .setXml("...");
        // .setService("...");
        // .setServiceImpl("...");
    );

    // 執行生成
    gen.execute();
  }
}

到此這篇關於MyBatis-Plus Generator配置詳解的文章就介紹到這了,更多相關MyBatis-Plus Generator配置內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!