概述

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

當(dāng)數(shù)據(jù)庫(kù)表的字段較少時(shí)，寫(xiě)起來(lái)還能接受，一旦字段過(guò)多或者需要在很多個(gè)表中寫(xiě)這些基本方法的時(shí)候，是不是很崩潰？

MyBatis開(kāi)發(fā)團(tuán)隊(duì)提供了一個(gè)很強(qiáng)大的代碼生成器—MyBatis Generator (MBG).

MBG通過(guò)豐富的配置可以生成不同類型的代碼，代碼包含了數(shù)據(jù)庫(kù)表對(duì)應(yīng)的實(shí)體類、Mapper接口類、Mapper XML文件和 Example對(duì)象等。 這些代碼文件幾乎包含了全部的單表操作方法。

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

參考配置實(shí)例
在項(xiàng)目的src/main/resources中創(chuàng)建一個(gè)generator目錄，在該目錄下創(chuàng)建一個(gè)generatorConfig.xml文件

內(nèi)容如下：

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

運(yùn)行 MyBatis Generator

常用的有如下方式：

使用Java編寫(xiě)運(yùn)行代碼
從命令提示符運(yùn)行
使用Maven Plugin運(yùn)行
使用Eclipse插件運(yùn)行
我們這里使用 第一種方式 Java編寫(xiě)代碼運(yùn)行

第一步： 添加Maven依賴

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

第二步： 編寫(xiě)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 執(zhí)行過(guò)程中的警告信息List<String> warnings = new ArrayList<String>();// 當(dāng)生成的代碼重復(fù)時(shí)，覆蓋原代碼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);// 創(chuàng)建 MBGMyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);// 執(zhí)行生成代碼myBatisGenerator.generate(null);// 輸出警告信息for (String warning : warnings) {System.out.println(warning);}}}

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

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

但是總和來(lái)說(shuō)，這種方式出現(xiàn)的問(wèn)題最少，配置最為容易，因此推薦使用。

運(yùn)行后生成的代碼如下結(jié)構(gòu)

大致用法，總結(jié)完畢

---------------------?
作者：小小工匠?
來(lái)源：CSDN?
原文：https://blog.csdn.net/yangshangwei/article/details/80115361?
版權(quán)聲明：本文為博主原創(chuàng)文章，轉(zhuǎn)載請(qǐng)附上博文鏈接！

總結(jié)

以上是生活随笔為你收集整理的MyBatis代码生成器（逆向工程）MBG使用的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。