什么是Mybatis Generator
?? MyBatis Generator（MBG）是MyBatis和iBATIS的代碼生成器。能夠?yàn)樗邪姹镜腗yBatis以及版本2.2.0之后的iBATIS版本生成代碼。它將內(nèi)省數(shù)據(jù)庫表（或許多表）扎运，并將生成可用于訪問表的工件。這減少了設(shè)置對(duì)象和配置文件以與數(shù)據(jù)庫表交互的初始麻煩拍顷。
MyBatis Generator能夠生成：
- 與表結(jié)構(gòu)匹配的Java POJO;
- MyBatis/iBATIS兼容的SQL Map XML文件;
- 適用于MyBatis3.x Mapper基礎(chǔ)結(jié)構(gòu)的Dao接口;
怎么配置MBG
本文中使用的工具是IDEA钞支，使用Maven構(gòu)建項(xiàng)目。
- IDE：IDEA猖吴；
- 構(gòu)建工具：Maven；
- 項(xiàng)目結(jié)構(gòu)：Spring挥转、SpringMVC海蔽、Mybatis
pom.xml
<!-- Mybatis自動(dòng)生成實(shí)體代碼的插件 -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
<!-- 構(gòu)建項(xiàng)目需要的信息 -->
<build>
<!-- 產(chǎn)生的構(gòu)件的文件名，默認(rèn)值是${artifactId}-${version} -->
<finalName>ssm-note</finalName>
<!-- 子項(xiàng)目可以引用的默認(rèn)插件信息绑谣。 -->
<pluginManagement>
<!-- 插件列表 -->
<plugins>
<!-- 党窜。。借宵。其他的一些配置幌衣。。壤玫。-->
</plugins>
</pluginManagement>
<!-- 注意這個(gè)配置的結(jié)構(gòu)在<build></build>中的位置豁护，不然會(huì)不能引入插件 -->
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<configuration>
<!--MBG配置文件-->
<configurationFile>src/main/resources/config/mybatis-generator.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</execution>
</executions>
<!--dependencies依賴的組件-->
<dependencies>
<!--MySQL數(shù)據(jù)庫驅(qū)動(dòng)哼凯，你自己項(xiàng)目的數(shù)據(jù)庫驅(qū)動(dòng)-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.26</version>
</dependency>
<!--MBG生成器-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
<!--MBG-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.3.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
注意：plugins中配置的結(jié)構(gòu)，不是在<pluginManagement></pluginManagement>中配置楚里，應(yīng)該是在<build></build>的子級(jí)配置
mybatis-generator.xml
在pom.xml中配置了這個(gè)文件的路徑挡逼，src/main/resources/config/mybatis-generator.xml ，創(chuàng)建mybatis-generator.xml文件腻豌，其內(nèi)容以及詳細(xì)內(nèi)容如下：
因?yàn)槲业膉dbc.properties文件是在resources/config/jdbc.properties這個(gè)位置配置的家坎，因此你需要修改成你自己的。
<?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>
<!--數(shù)據(jù)庫驅(qū)動(dòng)-->
<properties resource="config/jdbc.properties"/>
<!-- 在MBG工作的時(shí)候吝梅，需要額外加載的依賴包 location屬性指明加載jar/zip包的全路徑-->
<classPathEntry
location="C:\Users\Mr.wang\.m2\repository\mysql\mysql-connector-java\5.1.26\mysql-connector-java-5.1.26.jar"/>
<context id="DB2Tables" targetRuntime="MyBatis3">
<!-- 自動(dòng)識(shí)別數(shù)據(jù)庫關(guān)鍵字虱疏，默認(rèn)false，如果設(shè)置為true苏携，根據(jù)SqlReservedWords中定義的關(guān)鍵字列表做瞪；
一般保留默認(rèn)值，遇到數(shù)據(jù)庫關(guān)鍵字（Java關(guān)鍵字）右冻，使用columnOverride覆蓋
-->
<property name="autoDelimitKeywords" value="false"/>
<!-- 生成的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>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--數(shù)據(jù)庫鏈接地址賬號(hào)密碼-->
<jdbcConnection driverClass="${jdbc.mysql.driver}"
connectionURL="${jdbc.mysql.url}"
userId="${jdbc.mysql.username}"
password="${jdbc.mysql.password}">
</jdbcConnection>
<!-- java類型處理器
用于處理DB中的類型到Java中的類型装蓬，默認(rèn)使用JavaTypeResolverDefaultImpl；
注意一點(diǎn)纱扭，默認(rèn)會(huì)先嘗試使用Integer牍帚，Long，Short等來對(duì)應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型乳蛾；
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 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)建目錄
-->
<!--生成Model類存放位置-->
<javaModelGenerator targetPackage="com.weyoung.generator.pojo" targetProject="src/main/java">
<!-- 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ù)庫的schema再生成一層package宪肖，最終生成的類放在這個(gè)package下表制，默認(rèn)為false -->
<property name="enableSubPackages" value="true"/>
<!-- for MyBatis3 / MyBatis3Simple
是否創(chuàng)建一個(gè)不可變的類健爬，如果為true，
那么MBG會(huì)創(chuàng)建一個(gè)沒有setter方法的類么介，取而代之的是類似constructorBased的類
-->
<!--<property name="immutable" value="false"/>-->
<!-- 設(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._520it.mybatis.domain.BaseDomain"/>-->
<!-- 設(shè)置是否在getter方法中跑慕，對(duì)String類型字段調(diào)用trim()方法 -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成SQL map的XML文件生成器，
注意摧找，在Mybatis3之后核行，我們可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
或者只使用Mapper接口+Annotation蹬耘，所以芝雪，如果 javaClientGenerator配置中配置了需要生成XML的話，這個(gè)元素就必須配置
targetPackage/targetProject:同javaModelGenerator
-->
<!--生成映射文件存放位置-->
<sqlMapGenerator
targetPackage="com.weyoung.generator.mappers"
targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 對(duì)于mybatis來說综苔，即生成Mapper接口绵脯，注意，如果沒有配置該元素休里，那么默認(rèn)不會(huì)生成Mapper接口
targetPackage/targetProject:同javaModelGenerator
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
-->
<!--生成Dao類存放位置-->
<javaClientGenerator
type="XMLMAPPER"
targetPackage="com.weyoung.generator.dao"
targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- 選擇一個(gè)table來生成相關(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ì)象的表名创橄；
注意：大小寫敏感問題。正常情況下结借，MBG會(huì)自動(dòng)的去識(shí)別數(shù)據(jù)庫標(biāo)識(shí)符的大小寫敏感度筐摘，在一般情況下，MBG會(huì)
根據(jù)設(shè)置的schema船老，catalog或tablename去查詢數(shù)據(jù)表咖熟，按照下面的流程：
1，如果schema柳畔，catalog或tablename中有空格馍管，那么設(shè)置的是什么格式，就精確的使用指定的大小寫格式去查詢薪韩；
2确沸，否則，如果數(shù)據(jù)庫的標(biāo)識(shí)符使用大寫的俘陷，那么MBG自動(dòng)把表名變成大寫再查找罗捎；
3，否則拉盾，如果數(shù)據(jù)庫的標(biāo)識(shí)符使用小寫的桨菜，那么MBG自動(dòng)把表名變成小寫再查找；
4捉偏，否則倒得，使用指定的大小寫格式查詢；
另外的夭禽，如果在創(chuàng)建表的時(shí)候霞掺，使用的""把數(shù)據(jù)庫對(duì)象規(guī)定大小寫，就算數(shù)據(jù)庫標(biāo)識(shí)符是使用的大寫讹躯，在這種情況下也會(huì)使用給定的大小寫來創(chuàng)建表名菩彬；
這個(gè)時(shí)候缠劝，請(qǐng)?jiān)O(shè)置delimitIdentifiers="true"即可保留大小寫格式；
可選：
1挤巡，schema：數(shù)據(jù)庫的schema剩彬；
2酷麦，catalog：數(shù)據(jù)庫的catalog矿卑；
3，alias：為數(shù)據(jù)表設(shè)置的別名沃饶，如果設(shè)置了alias母廷，那么生成的所有的SELECT SQL語句中，列名會(huì)變成：alias_actualColumnName
4糊肤，domainObjectName：生成的domain類的名字琴昆，如果不設(shè)置，直接使用表名作為domain類的名字馆揉；可以設(shè)置為somepck.domainName业舍，那么會(huì)自動(dòng)把domainName類再放到somepck包里面；
5升酣，enableInsert（默認(rèn)true）：指定是否生成insert語句舷暮；
6，enableSelectByPrimaryKey（默認(rèn)true）：指定是否生成按照主鍵查詢對(duì)象的語句（就是getById或get）噩茄；
7下面，enableSelectByExample（默認(rèn)true）：MyBatis3Simple為false，指定是否生成動(dòng)態(tài)查詢語句绩聘；
8沥割，enableUpdateByPrimaryKey（默認(rèn)true）：指定是否生成按照主鍵修改對(duì)象的語句（即update)；
9凿菩，enableDeleteByPrimaryKey（默認(rèn)true）：指定是否生成按照主鍵刪除對(duì)象的語句（即delete）机杜；
10，enableDeleteByExample（默認(rèn)true）：MyBatis3Simple為false衅谷，指定是否生成動(dòng)態(tài)刪除語句椒拗；
11，enableCountByExample（默認(rèn)true）：MyBatis3Simple為false会喝，指定是否生成動(dòng)態(tài)查詢總條數(shù)語句（用于分頁的總條數(shù)查詢）陡叠；
12，enableUpdateByExample（默認(rèn)true）：MyBatis3Simple為false肢执，指定是否生成動(dòng)態(tài)修改語句（只修改對(duì)象中不為空的屬性）枉阵；
13，modelType：參考context元素的defaultModelType预茄，相當(dāng)于覆蓋兴溜；
14侦厚，delimitIdentifiers：參考tableName的解釋，注意拙徽，默認(rèn)的delimitIdentifiers是雙引號(hào)刨沦，如果類似MYSQL這樣的數(shù)據(jù)庫，使用的是`（反引號(hào)膘怕，那么還需要設(shè)置context的beginningDelimiter和endingDelimiter屬性）
15想诅，delimitAllColumns：設(shè)置是否所有生成的SQL中的列名都使用標(biāo)識(shí)符引起來。默認(rèn)為false岛心，delimitIdentifiers參考context的屬性
注意来破，table里面很多參數(shù)都是對(duì)javaModelGenerator，context等元素的默認(rèn)屬性的一個(gè)復(fù)寫忘古；
-->
<!--生成對(duì)應(yīng)表及類名-->
<table tableName="sys_menu"
domainObjectName="SysMenu"
enableCountByExample="true"
enableUpdateByExample="true"
enableDeleteByExample="true"
enableSelectByExample="true"
selectByExampleQueryId="true">
<!-- 參考 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"/>-->
<!-- generatedKey用于生成生成主鍵的方法流码，
如果設(shè)置了該元素，MBG會(huì)在生成的<insert>元素中生成一條正確的<selectKey>元素延刘，該元素可選
column:主鍵的列名漫试；
sqlStatement：要生成的selectKey語句，有以下可選項(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.SYSDUMMY1
Derby :相當(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=1
MySql :相當(dāng)于selectKey的SQL為：SELECT LAST_INSERT_ID()
SqlServer :相當(dāng)于selectKey的SQL為：SELECT SCOPE_IDENTITY()
SYBASE :相當(dāng)于selectKey的SQL為：SELECT @@IDENTITY
JDBC :相當(dāng)于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性
<generatedKey column="" sqlStatement=""/>
-->
<!--
該元素會(huì)在根據(jù)表中列名計(jì)算對(duì)象屬性名之前先重命名列名碘赖，非常適合用于表中的列都有公用的前綴字符串的時(shí)候驾荣，
比如列名為：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
那么就可以設(shè)置searchString為"^CUST_"崖疤，并使用空白替換秘车，那么生成的Customer對(duì)象中的屬性名稱就不是
custId,custName等典勇，而是先被替換為ID,NAME,EMAIL,然后變成屬性：id劫哼，name，email割笙；
注意权烧，MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的，
如果使用了columnOverride元素伤溉，該屬性無效般码；
<columnRenamingRule searchString="" replaceString=""/>
-->
<!-- 用來修改表中某個(gè)列的屬性，MBG會(huì)使用修改后的列來生成domain的屬性乱顾；
column:要重新設(shè)置的列名板祝；
注意，一個(gè)table元素中可以有多個(gè)columnOverride元素哈~
-->
<!--<columnOverride column="username">-->
<!-- 使用property屬性來指定列要生成的屬性名稱 -->
<!--<property name="property" value="userName"/>-->
<!-- javaType用于指定生成的domain的屬性類型走净，使用類型的全限定名
<property name="javaType" value=""/>
-->
<!-- jdbcType用于指定該列的JDBC類型
<property name="jdbcType" value=""/>
-->
<!-- typeHandler 用于指定該列使用到的TypeHandler券时，如果要指定，配置類型處理器的全限定名
注意伏伯，mybatis中橘洞，不會(huì)生成到mybatis-config.xml中的typeHandler
只會(huì)生成類似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數(shù)描述
<property name="jdbcType" value=""/>
-->
<!-- 參考table元素的delimitAllColumns配置，默認(rèn)為false
<property name="delimitedColumnName" value=""/>
-->
<!--</columnOverride>-->
<!-- 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>
生成代碼
配置完成之后侯养，在如下位置，雙擊mybatis-generator:generate即可執(zhí)行
MBG安裝-1-201939192516
生成的代碼在src/main/java/com.weyoung.generator里面背伴，如下：
生成內(nèi)容如下-201939194822
