1.概述
Mybatis Generator是一個(gè)很強(qiáng)大的代碼生成器，代碼包含了數(shù)據(jù)庫(kù)表對(duì)應(yīng)的實(shí)體類、Mapper接口類、Mapper XML文件和Example對(duì)象等，這些代碼文件中幾乎包含了全部的單表操作方法，使用MBG可以極大地方便我們使用MyBatis，減少很多重復(fù)工作。
2.配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC
"-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
<!-- 引入配置文件 -->
<properties resource="db.properties" />
<!-- 加載數(shù)據(jù)庫(kù)驅(qū)動(dòng) -->
<classPathEntry location="${class_path}" />
<!-- context:生成一組對(duì)象的環(huán)境
id:必選，上下文id，用于在生成錯(cuò)誤時(shí)提示
defaultModelType:指定生成對(duì)象的樣式
1，conditional：類似hierarchical；
2，flat：所有內(nèi)容（主鍵，blob）等全部生成在一個(gè)對(duì)象中，推薦使用；
3，hierarchical：主鍵生成一個(gè)XXKey對(duì)象(key class)，Blob等單獨(dú)生成一個(gè)對(duì)象，其他簡(jiǎn)單屬性在一個(gè)對(duì)象中(record class)
targetRuntime:
1，MyBatis3：默認(rèn)的值，生成基于MyBatis3.x以上版本的內(nèi)容，包括XXXBySample；
2，MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample；
-->
<context id="context1" targetRuntime="MyBatis3Simple" defaultModelType="flat">
<!-- 生成的Java文件的編碼 -->
<property name="javaFileEncoding" value="UTF-8"/>
<commentGenerator>
<!-- 是否去除自動(dòng)生成的注釋 true：是 ： false:否 -->
<property name="suppressAllComments" value="false" />
<!-- 阻止注釋中包含時(shí)間戳 true：是 ： false:否 -->
<property name="suppressDate" value="true" />
<!-- 注釋是否包含數(shù)據(jù)庫(kù)表的注釋信息 true：是 ： false:否 -->
<property name="addRemarkComments" value="true" />
</commentGenerator>
<!--數(shù)據(jù)庫(kù)連接的信息：驅(qū)動(dòng)類、連接地址、用戶名、密碼 -->
<jdbcConnection driverClass="${jdbc_driver}"
connectionURL="${jdbc_url}" userId="${jdbc_username}" password="${jdbc_password}" />
<!-- java模型創(chuàng)建器，是必須要的元素 負(fù)責(zé)：1，key類（見context的defaultModelType）；2，java類；3，查詢類
targetPackage：生成的類要放的包，真實(shí)的包受enableSubPackages屬性控制；
targetProject：目標(biāo)項(xiàng)目，指定一個(gè)存在的目錄下，生成的內(nèi)容會(huì)放到指定目錄中，如果目錄不存在，MBG不會(huì)自動(dòng)建目錄
-->
<javaModelGenerator targetPackage="com.enjoylearning.mybatis.entity" targetProject="${project_src}">
<!-- 設(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方法；
-->
<property name="rootClass" value="com.enjoylearning.mybatis.entity.BaseEntity" />
</javaModelGenerator>
<!-- 生成SQL map的XML文件生成器，
targetPackage：生成的類要放的包，真實(shí)的包受enableSubPackages屬性控制；
targetProject：目標(biāo)項(xiàng)目，指定一個(gè)存在的目錄下，生成的內(nèi)容會(huì)放到指定目錄中，如果目錄不存在，MBG不會(huì)自動(dòng)建目錄
-->
<sqlMapGenerator targetPackage="." targetProject="${project_mapper_xml}">
</sqlMapGenerator>
<!-- 對(duì)于mybatis來(lái)說(shuō)，即生成Mapper接口，注意，如果沒(méi)有配置該元素，那么默認(rèn)不會(huì)生成Mapper接口
type：選擇怎么生成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 targetPackage="com.enjoylearning.mybatis.mapper" targetProject="${project_src}" type="XMLMAPPER" />
<!-- shema 數(shù)據(jù)庫(kù) tableName表明 -->
<table schema="${jdbc_username}" tableName="%" >
<generatedKey column="id" sqlStatement="MySql"/>
</table>
</context>
</generatorConfiguration>
2.1 context屬性的說(shuō)明
id:必選，上下文id，用于在生成錯(cuò)誤時(shí)提示
defaultModelType:指定生成對(duì)象的樣式
1）conditional：類似hierarchical；
2）flat：所有內(nèi)容（主鍵，blob）等全部生成在一個(gè)對(duì)象中，推薦使用；
3）hierarchical：主鍵生成一個(gè)XXKey對(duì)象(key class)，Blob等單獨(dú)生成一個(gè)對(duì)象，其他簡(jiǎn)單屬性在一個(gè)對(duì)象中(record class)targetRuntime:
1）MyBatis3：默認(rèn)的值，生成基于MyBatis3.x以上版本的內(nèi)容，包括XXXBySample；
2）MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample；java模型創(chuàng)建器，是必須要的元素
負(fù)責(zé)：
1）key類（見context的defaultModelType）；
2）java類；
3）查詢類
targetPackage：生成的類要放的包，真實(shí)的包受enableSubPackages屬性控制；
targetProject：目標(biāo)項(xiàng)目，指定一個(gè)存在的目錄下，生成的內(nèi)容會(huì)放到指定目錄中，如果目錄不存在，MBG不會(huì)自動(dòng)建目錄設(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方法；生成SQL map的XML文件生成器
targetPackage：生成的類要放的包，真實(shí)的包受enableSubPackages屬性控制；
targetProject：目標(biāo)項(xiàng)目，指定一個(gè)存在的目錄下，生成的內(nèi)容會(huì)放到指定目錄中，如果目錄不存在，MBG不會(huì)自動(dòng)建目錄對(duì)于mybatis來(lái)說(shuō)，即生成Mapper接口，注意，如果沒(méi)有配置該元素，那么默認(rèn)不會(huì)生成Mapper接口
type：選擇怎么生成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
3 運(yùn)行MBG
3.1 作為Maven Plugin
pom.xml中要加入插件：
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</plugin>
maven運(yùn)行配置如下：
mybatis-generator:generate
結(jié)果：
[INFO] Saving file TUserRoleMapper.java
[WARNING] Column id, specified as a generated key column in table t_user_role, does not exist in the table.
[WARNING] Root class com.enjoylearning.mybatis.entity.BaseEntity cannot be loaded, checking for member overrides is disabled for this class
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.773 s
[INFO] Finished at: 2018-09-24T20:39:07+08:00
[INFO] ------------------------------------------------------------------------
需要加入com.enjoylearning.mybatis.entity.BaseEntity。
3.2 在Java中使用XML配置文件
@Test
public void mybatisGeneratorTest() throws FileNotFoundException {
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
String genCfg = "generatorConfig.xml";
File configFile = new File(getClass().getClassLoader().getResource(genCfg).getFile());
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = null;
try {
config = cp.parseConfiguration(configFile);
} catch (IOException e) {
e.printStackTrace();
} catch (XMLParserException e) {
e.printStackTrace();
}
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = null;
try {
myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
} catch (InvalidConfigurationException e) {
e.printStackTrace();
}
try {
myBatisGenerator.generate(null);
} catch (SQLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
3.3 從命令行使用xml配置文件
準(zhǔn)備好指定的文件夾、generatorConfig.xml配置文件和相應(yīng)的jar包。
執(zhí)行如下命令
java -Dfile.encoding=UTF-8 -jar mybatis-generator-core-1.3.5.jar -configfile generatorConfig.xml -overwrite
參考
- 1）享學(xué)課堂Lison老師筆記
