代碼生成器

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 引擎，默認 Veloctiympg.setTemplateEngine(new FreemarkerTemplateEngine());// 全局配置GlobalConfig gc = new GlobalConfig();gc.setAuthor("Mht");gc.setOutputDir("D://workspace/spring-boot-mybatis/src/main/java");gc.setFileOverride(false);// 是否覆蓋同名文件，默認是falsegc.setActiveRecord(true);// 不需要ActiveRecord特性的請改為falsegc.setEnableCache(false);// XML 二級緩存gc.setBaseResultMap(true);// XML ResultMapgc.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() {// 自定義數據庫表字段類型轉換【可選】@Overridepublic 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————代码生成器的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。