Mybatis Plus 程式碼生成器的實現
阿新 • • 發佈：2020-03-26
程式碼生成器
MyBatis Plus是MyBatis的擴充套件框架，而程式碼生成器是MP的核心功能之一，另外還有 “條件構造器”和“通用CRUD”等功能。
步驟演示
mp的程式碼生成器有兩種方式自動生成程式碼，一種是通過main方法來執行程式，另一種是通過maven外掛build產生。第二種方法需要在pom.xml中新增大量的配置資訊，因此本人偏向於使用第一種方式。步驟如下：
一、新增mybatis plus依賴：
如果還沒有建立專案，當然需要先建立一個工程專案，然後將jar包依賴新增到專案的classpath下，如果是含有pom.xml的maven專案，比如我最近在使用的springboot專案，那麼可以直接新增pom依賴：
<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>2.3</version> </dependency>
連線：maven中央庫，阿里庫
二、建立生成器主類
官方給出的例項連線：程式碼生成器， 此處貼出我整理過後的程式碼：
package com.mht.springbootmybatis.generate;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;
/**
* <p>
* 程式碼生成器演示
* </p>
*/
public class MpGenerator {
/**
* <p>
* MySQL 生成演示
* </p>
*/
public static void main(String[] args) {
AutoGenerator mpg = new AutoGenerator();
// 選擇 freemarker 引擎，預設 Veloctiy
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
// 全域性配置
GlobalConfig gc = new GlobalConfig();
gc.setAuthor("Mht");
gc.setOutputDir("D://workspace/spring-boot-mybatis/src/main/java");
gc.setFileOverride(false);// 是否覆蓋同名檔案，預設是false
gc.setActiveRecord(true);// 不需要ActiveRecord特性的請改為false
gc.setEnableCache(false);// XML 二級快取
gc.setBaseResultMap(true);// XML ResultMap
gc.setBaseColumnList(false);// XML columList
/* 自定義檔案命名，注意 %s 會自動填充表實體屬性！ */
// gc.setMapperName("%sDao");
// gc.setXmlName("%sDao");
// gc.setServiceName("MP%sService");
// gc.setServiceImplName("%sServiceDiy");
// gc.setControllerName("%sAction");
mpg.setGlobalConfig(gc);
// 資料來源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);
dsc.setTypeConvert(new MySqlTypeConvert() {
// 自定義資料庫表字段型別轉換【可選】
@Override
public DbColumnType processTypeConvert(String fieldType) {
System.out.println("轉換型別：" + fieldType);
// 注意！！processTypeConvert 存在預設型別轉換，如果不是你要的效果請自定義返回、非如下直接返回。
return super.processTypeConvert(fieldType);
}
});
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setUrl("jdbc:mysql://localhost:3306/ease-run?useUnicode=true&characterEncoding=utf8");
mpg.setDataSource(dsc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// strategy.setCapitalMode(true);// 全域性大寫命名 ORACLE 注意
strategy.setTablePrefix(new String[] { "user_" });// 此處可以修改為您的表字首
strategy.setNaming(NamingStrategy.nochange);// 表名生成策略
strategy.setInclude(new String[] { "user" }); // 需要生成的表
// strategy.setExclude(new String[]{"test"}); // 排除生成的表
// 自定義實體父類
// strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
// 自定義實體，公共欄位
// strategy.setSuperEntityColumns(new String[] { "test_id","age" });
// 自定義 mapper 父類
// strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
// 自定義 service 父類
// strategy.setSuperServiceClass("com.baomidou.demo.TestService");
// 自定義 service 實現類父類
// strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
// 自定義 controller 父類
// strategy.setSuperControllerClass("com.baomidou.demo.TestController");
// 【實體】是否生成欄位常量（預設 false）
// public static final String ID = "test_id";
// strategy.setEntityColumnConstant(true);
// 【實體】是否為構建者模型（預設 false）
// public User setName(String name) {this.name = name; return this;}
// strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.mht.springbootmybatis");
// pc.setModuleName("test");
mpg.setPackageInfo(pc);
// 注入自定義配置，可以在 VM 中使用 cfg.abc 【可無】
// InjectionConfig cfg = new InjectionConfig() {
// @Override
// public void initMap() {
// Map<String,Object> map = new HashMap<String,Object>();
// map.put("abc",this.getConfig().getGlobalConfig().getAuthor() + "-mp");
// this.setMap(map);
// }
// };
//
// // 自定義 xxList.jsp 生成
// List<FileOutConfig> focList = new ArrayList<>();
// focList.add(new FileOutConfig("/template/list.jsp.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// // 自定義輸入檔名稱
// return "D://my_" + tableInfo.getEntityName() + ".jsp";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
//
// // 調整 xml 生成目錄演示
// focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
//
// // 關閉預設 xml 生成，調整生成 至 根目錄
// TemplateConfig tc = new TemplateConfig();
// tc.setXml(null);
// mpg.setTemplate(tc);
// 自定義模板配置，可以 copy 原始碼 mybatis-plus/src/main/resources/templates 下面內容修改，
// 放置自己專案的 src/main/resources/templates 目錄下,預設名稱一下可以不配置，也可以自定義模板名稱
// TemplateConfig tc = new TemplateConfig();
// tc.setController("...");
// tc.setEntity("...");
// tc.setMapper("...");
// tc.setXml("...");
// tc.setService("...");
// tc.setServiceImpl("...");
// 如上任何一個模組如果設定 空 OR Null 將不生成該模組。
// mpg.setTemplate(tc);
// 執行生成
mpg.execute();
// 列印注入設定【可無】
// System.err.println(mpg.getCfg().getMap().get("abc"));
}
}檔案基本可以拿過來直接用，但需要注意這兩句程式碼：
gc.setOutputDir("D://workspace/spring-boot-mybatis/src/main/java");// 設定檔案輸出路徑
pc.setParent("com.mht.springbootmybatis");// 父包名
下圖是我專案的路徑（執行程式碼生成器之後的專案結構）：
執行main方法前請注意，在生成檔案的時候需要有一個模板引擎的選擇，MyBatis Plus的預設模板引擎是velocity。我們可以使用freemarker。
<dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> </dependency>
最後執行main方法就可以了。
執行控制檯如下：
注意，程式碼生成前請確保資料庫中表已經存在。
參考文章：
《MyBatis Plus程式碼生成器》
《MyBatis Plus學習》
《mybatis-plus思維導圖，讓mybatis-plus不再難懂》
到此這篇關於Mybatis Plus 程式碼生成器的實現的文章就介紹到這了,更多相關Mybatis Plus 程式碼生成器內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！