• 概述
• 參考配置實例
• 運行 MyBatis Generator

概述

我們前面的博文中了解了MyBatis的基本用法，也寫了很多單表的CRUD方法，基本上每個表都需要用到這些方法，這些方法都很規范而且比較類似。

當數據庫表的字段較少時，寫起來還能接受，一旦字段過多或者需要在很多個表中寫這些基本方法的時候，是不是很崩潰？

MyBatis開發團隊提供了一個很強大的代碼生成器—MyBatis Generator (MBG).

MBG通過豐富的配置可以生成不同類型的代碼，代碼包含了數據庫表對應的實體類、Mapper接口類、Mapper XML文件和 Example對象等。 這些代碼文件幾乎包含了全部的單表操作方法。

使用MBG可以極大程度上方便我們使用MyBatis，減少很多重復操作。

---

參考配置實例

在項目的src/main/resources中創建一個generator目錄，在該目錄下創建一個generatorConfig.xml文件

內容如下：

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><!-- 配置生成器 --> <generatorConfiguration> <!-- 引用外部配置文件 --><properties resource="db.properties" /><!-- 在MBG工作的時候，需要額外加載的依賴包location屬性指明加載jar/zip包的全路徑 --><!--<classPathEntry location="F:\.m2\repository\mysql\mysql-connector-java\5.1.38\mysql-connector-java-5.1.38.jar"/>--><!-- id:必選，上下文id，用于在生成錯誤時提示targetRuntime:如果設置為MyBatis3，會自動生成Example相關的代碼，如果不需要可以設置為MyBatis3Simple-MyBatis3：默認的值，生成基于MyBatis3.x以上版本的內容，包括XXXBySample；-MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample；defaultModelType:指定生成對象的樣式設置為flat,目的是只使一個表生成一個實體類。 當沒有復雜的繼承的時候，使用比較方便。選項如下-conditional：類似hierarchical；-flat：所有內容（主鍵，blob）等全部生成在一個對象中；-hierarchical：主鍵生成一個XXKey對象(key class)，Blob等單獨生成一個對象，其他簡單屬性在一個對象中(record class)--><context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat"><!-- beginningDelimiter/endingDelimiter: 指明數據庫的用于標記數據庫對象名的符號，比如ORACLE是雙引號，MYSQL默認是`反引號 --><property name="beginningDelimiter" value="`"/><property name="endingDelimiter" value="`"/><!-- 生成的Java文件的編碼 --><property name="javaFileEncoding" value="UTF-8"/><!-- 格式化java代碼 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>--><!-- 格式化XML代碼<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>--><!-- commentGenerator還可以配置一個type，設置自己的注解生成器，默認使用的是org.mybatis.generator.internal.DefaultCommentGenerator --><commentGenerator><!-- suppressDate是去掉生成日期那行注釋，suppressAllComments是去掉所有的注解 --><property name="suppressDate" value="true"/><!-- 在生成的實體類中附帶表字段的注釋 MBG1.3.3中新增的功能 --><property name="addRemarkComments" value="true"/></commentGenerator><!-- 必須存在，使用這個配置鏈接數據庫--><jdbcConnection driverClass="${jdbc.driver}"connectionURL="${jdbc.url}"userId="${jdbc.username}"password="${jdbc.password}"><!-- 這里面可以設置property屬性，每一個property屬性都設置到配置的Driver上 --></jdbcConnection><!-- 默認false，把JDBC DECIMAL 和 NUMERIC 類型解析為 Integer，為 true時把JDBC DECIMAL 和 NUMERIC 類型解析為java.math.BigDecimal <javaTypeResolver><property name="forceBigDecimals" value="false" /></javaTypeResolver>--><!-- java模型創建器，是必須要的元素負責：1，key類（見context的defaultModelType）；2，java類；3，查詢類targetPackage：生成的類要放的包，真實的包受enableSubPackages屬性控制；targetProject：目標項目，指定一個存在的目錄下，生成的內容會放到指定目錄中，如果目錄不存在，MBG不會自動建目錄--><javaModelGenerator targetPackage="test.model" targetProject="src\main\java"><!-- 設置是否在getter方法中，對String類型字段調用trim()方法 --><property name="trimStrings" value="true" /><!-- 設置一個根對象， 如果設置了這個根對象，那么生成的keyClass或者recordClass會繼承這個類；在Table的rootClass屬性中可以覆蓋該選項 注意：如果在key class或者record class中有root class相同的屬性，MBG就不會重新生成這些屬性了，包括： 1，屬性名相同，類型相同，有相同的getter/setter方法；如果生成對象生成的類型或者getter和setter方法在RootClass中存在,則不會自動生成和覆蓋 --><property name="rootClass" value="com.artisan.mybatis.simple.model.BaseEntity" /><!-- for MyBatis3/MyBatis3Simple 自動為每一個生成的類創建一個構造方法，構造方法包含了所有的field；而不是使用setter； <property name="constructorBased" value="false"/> --><!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package，最終生成的類放在這個package下，默認為false <property name="enableSubPackages" value="true"/> --><!-- for MyBatis3 / MyBatis3Simple 是否創建一個不可變的類，如果為true， 那么MBG會創建一個沒有setter方法的類，取而代之的是類似constructorBased的類 <property name="immutable" value="false"/> --></javaModelGenerator><!-- 生成SQL map的XML文件生成器，注意，在Mybatis3之后，我們可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的話，這個元素就必須配置targetPackage/targetProject:同javaModelGenerator--><sqlMapGenerator targetPackage="test.xml" targetProject="src\main\resources"><!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package，最終生成的類放在這個package下，默認為false <property name="enableSubPackages" value="true"/> --></sqlMapGenerator><!-- 對于mybatis來說，即生成Mapper接口，注意，如果沒有配置該元素，那么默認不會生成Mapper接口 targetPackage/targetProject:同javaModelGeneratortype：選擇怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：1，ANNOTATEDMAPPER：會生成使用Mapper接口+Annotation的方式創建（SQL生成在annotation中），不會生成對應的XML；2，MIXEDMAPPER：使用混合配置，會生成Mapper接口，并適當添加合適的Annotation，但是XML會生成在XML中；3，XMLMAPPER：會生成Mapper接口，接口完全依賴XML；注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER--><javaClientGenerator type="XMLMAPPER" targetPackage="test.dao" targetProject="src\main\java"><!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package，最終生成的類放在這個package下，默認為false <property name="enableSubPackages" value="true"/> --><!-- 可以為所有生成的接口添加一個父接口，但是MBG只負責生成，不負責檢查 <property name="rootInterface" value=""/> --></javaClientGenerator><!-- 選擇一個table來生成相關文件，可以有一個或多個table，必須要有table元素選擇的table會生成一下文件：1，SQL map文件2，生成一個主鍵類；3，除了BLOB和主鍵的其他字段的類；4，包含BLOB的類；5，一個用戶生成動態查詢的條件類（selectByExample, deleteByExample），可選；6，Mapper接口（可選）tableName（必要）：要生成對象的表名；注意：大小寫敏感問題。正常情況下，MBG會自動的去識別數據庫標識符的大小寫敏感度，在一般情況下，MBG會根據設置的schema，catalog或tablename去查詢數據表，按照下面的流程：1，如果schema，catalog或tablename中有空格，那么設置的是什么格式，就精確的使用指定的大小寫格式去查詢；2，否則，如果數據庫的標識符使用大寫的，那么MBG自動把表名變成大寫再查找；3，否則，如果數據庫的標識符使用小寫的，那么MBG自動把表名變成小寫再查找；4，否則，使用指定的大小寫格式查詢；另外的，如果在創建表的時候，使用的""把數據庫對象規定大小寫，就算數據庫標識符是使用的大寫，在這種情況下也會使用給定的大小寫來創建表名；這個時候，請設置delimitIdentifiers="true"即可保留大小寫格式；可選：1，schema：數據庫的schema；2，catalog：數據庫的catalog；3，alias：為數據表設置的別名，如果設置了alias，那么生成的所有的SELECT SQL語句中，列名會變成：alias_actualColumnName4，domainObjectName：生成的domain類的名字，如果不設置，直接使用表名作為domain類的名字；可以設置為somepck.domainName，那么會自動把domainName類再放到somepck包里面；5，enableInsert（默認true）：指定是否生成insert語句；6，enableSelectByPrimaryKey（默認true）：指定是否生成按照主鍵查詢對象的語句（就是getById或get）；7，enableSelectByExample（默認true）：MyBatis3Simple為false，指定是否生成動態查詢語句；8，enableUpdateByPrimaryKey（默認true）：指定是否生成按照主鍵修改對象的語句（即update)；9，enableDeleteByPrimaryKey（默認true）：指定是否生成按照主鍵刪除對象的語句（即delete）；10，enableDeleteByExample（默認true）：MyBatis3Simple為false，指定是否生成動態刪除語句；11，enableCountByExample（默認true）：MyBatis3Simple為false，指定是否生成動態查詢總條數語句（用于分頁的總條數查詢）；12，enableUpdateByExample（默認true）：MyBatis3Simple為false，指定是否生成動態修改語句（只修改對象中不為空的屬性）；13，modelType：參考context元素的defaultModelType，相當于覆蓋；14，delimitIdentifiers：參考tableName的解釋，注意，默認的delimitIdentifiers是雙引號，如果類似MYSQL這樣的數據庫，使用的是`（反引號，那么還需要設置context的beginningDelimiter和endingDelimiter屬性）15，delimitAllColumns：設置是否所有生成的SQL中的列名都使用標識符引起來。默認為false，delimitIdentifiers參考context的屬性注意，table里面很多參數都是對javaModelGenerator，context等元素的默認屬性的一個復寫；--><!-- % 通配符 匹配數據庫中所有的表 --><table tableName="%"><!-- generatedKey用于生成生成主鍵的方法，如果設置了該元素，MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素，該元素可選column:主鍵的列名；sqlStatement：要生成的selectKey語句，有以下可選項：Cloudscape:相當于selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL()DB2 :相當于selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL()DB2_MF :相當于selectKey的SQL為：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1Derby :相當于selectKey的SQL為：VALUES IDENTITY_VAL_LOCAL()HSQLDB :相當于selectKey的SQL為：CALL IDENTITY()Informix :相當于selectKey的SQL為：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1MySql :相當于selectKey的SQL為：SELECT LAST_INSERT_ID()SqlServer :相當于selectKey的SQL為：SELECT SCOPE_IDENTITY()SYBASE :相當于selectKey的SQL為：SELECT @@IDENTITYJDBC :相當于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性--><generatedKey column="id" sqlStatement="MySql"/><!-- 參考 javaModelGenerator 的 constructorBased屬性<property name="constructorBased" value="false"/>--><!-- 默認為false，如果設置為true，在生成的SQL中，table名字不會加上catalog或schema；<property name="ignoreQualifiersAtRuntime" value="false"/> --><!-- 參考 javaModelGenerator 的 immutable 屬性 <property name="immutable" value="false"/>--><!-- 指定是否只生成domain類，如果設置為true，只生成domain類，如果還配置了sqlMapGenerator，那么在mapper XML文件中，只生成resultMap元素<property name="modelOnly" value="false"/> --><!-- 參考 javaModelGenerator 的 rootClass 屬性 <property name="rootClass" value=""/>--><!-- 參考javaClientGenerator 的 rootInterface 屬性<property name="rootInterface" value=""/>--><!-- 如果設置了runtimeCatalog，那么在生成的SQL中，使用該指定的catalog，而不是table元素上的catalog <property name="runtimeCatalog" value=""/>--><!-- 如果設置了runtimeSchema，那么在生成的SQL中，使用該指定的schema，而不是table元素上的schema <property name="runtimeSchema" value=""/>--><!-- 如果設置了runtimeTableName，那么在生成的SQL中，使用該指定的tablename，而不是table元素上的tablename <property name="runtimeTableName" value=""/>--><!-- 注意，該屬性只針對MyBatis3Simple有用；如果選擇的runtime是MyBatis3Simple，那么會生成一個SelectAll方法，如果指定了selectAllOrderByClause，那么會在該SQL中添加指定的這個order條件；<property name="selectAllOrderByClause" value="age desc,username asc"/>--><!-- 如果設置為true，生成的model類會直接使用column本身的名字，而不會再使用駝峰命名方法，比如BORN_DATE，生成的屬性名字就是BORN_DATE,而不會是bornDate<property name="useActualColumnNames" value="false"/> --><!-- ignoreColumn設置一個MGB忽略的列，如果設置了改列，那么在生成的domain中，生成的SQL中，都不會有該列出現 column:指定要忽略的列的名字；delimitedColumnName：參考table元素的delimitAllColumns配置，默認為false注意，一個table元素中可以有多個ignoreColumn元素<ignoreColumn column="deptId" delimitedColumnName=""/>--></table></context> </generatorConfiguration>

---

運行 MyBatis Generator

常用的有如下方式：

• 使用Java編寫運行代碼
• 從命令提示符運行
• 使用Maven Plugin運行
• 使用Eclipse插件運行

我們這里使用 第一種方式 Java編寫代碼運行

第一步： 添加Maven依賴

<dependency><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-core</artifactId><version>${mybatis-generator-core.version}</version> </dependency>

第二步： 編寫Java代碼

package com.mybatis.generator;import java.io.InputStream; import java.util.ArrayList; import java.util.List;import org.mybatis.generator.api.MyBatisGenerator; import org.mybatis.generator.config.Configuration; import org.mybatis.generator.config.xml.ConfigurationParser; import org.mybatis.generator.internal.DefaultShellCallback;/*** * * @ClassName: Generator* * @Description: 讀取 MBG 配置生成代碼* * @author: Mr.Yang* * @date: 2018年4月27日 下午4:31:42*/ public class Generator {public static void main(String[] args) throws Exception {// MBG 執行過程中的警告信息List<String> warnings = new ArrayList<String>();// 當生成的代碼重復時，覆蓋原代碼boolean overwrite = true;// 讀取MBG配置文件InputStream is = Generator.class.getResourceAsStream("/generator/generatorConfig.xml");ConfigurationParser cp = new ConfigurationParser(warnings);Configuration config = cp.parseConfiguration(is);is.close();DefaultShellCallback callback = new DefaultShellCallback(overwrite);// 創建 MBGMyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);// 執行生成代碼myBatisGenerator.generate(null);// 輸出警告信息for (String warning : warnings) {System.out.println(warning);}}}

使用Java編碼方式運行的好處是，generatorConfig.xml配置的一些特殊的類（比如commentGenerator標簽中type屬性配置的MyCommentGenerator）只要在當前項目中，或者在當前項目的Classpath中，就可以直接使用。 使用其他方式的時候都需要特別配置才能在MBG執行過程中找到MyCommentGenerator類并實例化，否則會拋出異常。

不便之處在于，它和當前項目是綁定在一起的， 唉maven多子模塊的情況下，可能需要增加代碼量和配置量，配置多個，管理不方便。

但是總和來說，這種方式出現的問題最少，配置最為容易，因此推薦使用。

運行后生成的代碼如下結構

大致用法，總結完畢

總結

以上是生活随笔為你收集整理的MyBatis-17MyBatis代码生成器（逆向工程）MBG使用的全部內容，希望文章能夠幫你解決所遇到的問題。

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