【逆向工程】maven外掛 generator 的配置及使用
阿新 • • 發佈：2018-11-01
一、匯入mybatis-generator jar包
1 <dependency> 2 <groupId>org.mybatis.generator</groupId> 3 <artifactId>mybatis-generator-core</artifactId> 4 <version>1.3.5</version> 5 </dependency>
二、pom.xml檔案中配置generator外掛資訊
1 <plugins>2 <!-- generator外掛 --> 3 <plugin> 4 <groupId>org.mybatis.generator</groupId> 5 <artifactId>mybatis-generator-maven-plugin</artifactId> 6 <version>1.3.2</version> 7 <configuration> 8 <configurationFile>src/main/resources/mybatis/generatorConfig.xml</configurationFile> 9 <verbose>true</verbose> 10 <overwrite>true</overwrite> 11 </configuration> 12<executions> 13 <execution> 14 <id>Generate MyBatis Artifacts</id> 15 <goals> 16 <goal>generate</goal> 17 </goals> 18 </execution> 19 </executions> 20 </plugin> 21 </plugins>
三、新增配置檔案generatorConfig.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE generatorConfiguration 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> 5 6 <generatorConfiguration> 7 <classPathEntry 8 location="C:\repository\mysql\mysql-connector-java\8.0.11\mysql-connector-java-8.0.11.jar"/> 9 <context id="my" targetRuntime="MyBatis3"> 10 <commentGenerator> 11 <property name="suppressDate" value="false"/> 12 <property name="suppressAllComments" value="true"/> 13 </commentGenerator> 14 15 <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" 16 connectionURL="jdbc:mysql://127.0.0.1:3306/test_database?useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=false&allowMultiQueries=true" 17 userId="root" 18 password="123456"/> 19 20 <!-- model檔案配置 --> 21 <javaModelGenerator targetPackage="com.wj.bean.model" 22 targetProject="src/main/java"> 23 <property name="enableSubPackages" value="true"/> 24 <property name="trimStrings" value="true"/> 25 </javaModelGenerator> 26 27 <!-- mapper.xml檔案生成配置 --> 28 <sqlMapGenerator targetPackage="mappers._generator" 29 targetProject="src/main/resources"> 30 <property name="enableSubPackages" value="true"/> 31 </sqlMapGenerator> 32 33 <!-- mapper介面生成配置 --> 34 <javaClientGenerator targetPackage="com.wj.dao.mapper" 35 targetProject="src/main/java" type="XMLMAPPER"> 36 <property name="enableSubPackages" value="true"/> 37 </javaClientGenerator> 38 39 <!--<table tableName="CTAS_FEE_BASE" domainObjectName="FeeBase" 40 enableCountByExample="false" enableUpdateByExample="false" 41 enableDeleteByExample="false" enableSelectByExample="false" 42 selectByExampleQueryId="false"> 43 </table>--> 44 45 <table tableName="user_info"></table> 46 </context> 47 </generatorConfiguration>
四、使用方式
eclipse中，右擊專案 -> maven build
輸入：mvn mybatis-generator:generate
intellj IDEA中 直接雙擊即可生成程式碼
五、generatorConfig.xml配置詳解
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE generatorConfiguration 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> 5 <!-- 配置生成器 --> 6 <generatorConfiguration> 7 <!-- 可以用於載入配置項或者配置檔案，在整個配置檔案中就可以使用${propertyKey}的方式來引用配置項 8 resource：配置資源載入地址，使用resource，MBG從classpath開始找，比如com/myproject/generatorConfig.properties 9 url：配置資源載入地質，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties. 10 注意，兩個屬性只能選址一個; 11 另外，如果使用了mybatis-generator-maven-plugin，那麼在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用 12 <properties resource="" url="" /> 13 --> 14 <!-- 在MBG工作的時候，需要額外載入的依賴包 15 location屬性指明載入jar/zip包的全路徑 16 <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" /> 17 --> 18 <!-- 19 context:生成一組物件的環境 20 id:必選，上下文id，用於在生成錯誤時提示 21 defaultModelType:指定生成物件的樣式 22 1，conditional：類似hierarchical； 23 2，flat：所有內容（主鍵，blob）等全部生成在一個物件中； 24 3，hierarchical：主鍵生成一個XXKey物件(key class)，Blob等單獨生成一個物件，其他簡單屬性在一個物件中(record class) 25 targetRuntime: 26 1，MyBatis3：預設的值，生成基於MyBatis3.x以上版本的內容，包括XXXBySample； 27 2，MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample； 28 introspectedColumnImpl：類全限定名，用於擴充套件MBG 29 --> 30 <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple"> 31 <!-- 自動識別資料庫關鍵字，預設false，如果設定為true，根據SqlReservedWords中定義的關鍵字列表； 32 一般保留預設值，遇到資料庫關鍵字（Java關鍵字），使用columnOverride覆蓋 33 --> 34 <property name="autoDelimitKeywords" value="false"/> 35 <!-- 生成的Java檔案的編碼 --> 36 <property name="javaFileEncoding" value="UTF-8"/> 37 <!-- 格式化java程式碼 --> 38 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 39 <!-- 格式化XML程式碼 --> 40 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 41 <!-- beginningDelimiter和endingDelimiter：指明資料庫的用於標記資料庫物件名的符號，比如ORACLE就是雙引號，MYSQL預設是`反引號； --> 42 <property name="beginningDelimiter" value="`"/> 43 <property name="endingDelimiter" value="`"/> 44 <!-- 必須要有的，使用這個配置連結資料庫 45 @TODO:是否可以擴充套件 46 --> 47 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" 48 password="admin"> 49 <!-- 這裡面可以設定property屬性，每一個property屬性都設定到配置的Driver上 --> 50 </jdbcConnection> 51 <!-- java型別處理器 52 用於處理DB中的型別到Java中的型別，預設使用JavaTypeResolverDefaultImpl； 53 注意一點，預設會先嚐試使用Integer，Long，Short等來對應DECIMAL和 NUMERIC資料型別； 54 --> 55 <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> 56 <!-- 57 true：使用BigDecimal對應DECIMAL和 NUMERIC資料型別 58 false：預設, 59 scale>0;length>18：使用BigDecimal; 60 scale=0;length[10,18]：使用Long； 61 scale=0;length[5,9]：使用Integer； 62 scale=0;length<5：使用Short； 63 --> 64 <property name="forceBigDecimals" value="false"/> 65 </javaTypeResolver> 66 67 <!-- java模型建立器，是必須要的元素 68 負責：1，key類（見context的defaultModelType）；2，java類；3，查詢類 69 targetPackage：生成的類要放的包，真實的包受enableSubPackages屬性控制； 70 targetProject：目標專案，指定一個存在的目錄下，生成的內容會放到指定目錄中，如果目錄不存在，MBG不會自動建目錄 71 --> 72 <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java"> 73 <!-- for MyBatis3/MyBatis3Simple 74 自動為每一個生成的類建立一個構造方法，構造方法包含了所有的field；而不是使用setter； 75 --> 76 <property name="constructorBased" value="false"/> 77 <!-- 在targetPackage的基礎上，根據資料庫的schema再生成一層package，最終生成的類放在這個package下，預設為false --> 78 <property name="enableSubPackages" value="true"/> 79 <!-- for MyBatis3 / MyBatis3Simple 80 是否建立一個不可變的類，如果為true， 81 那麼MBG會建立一個沒有setter方法的類，取而代之的是類似constructorBased的類 82 --> 83 <property name="immutable" value="false"/> 84 <!-- 設定一個根物件， 85 如果設定了這個根物件，那麼生成的keyClass或者recordClass會繼承這個類；在Table的rootClass屬性中可以覆蓋該選項 86 注意：如果在key class或者record class中有root class相同的屬性，MBG就不會重新生成這些屬性了，包括： 87 1，屬性名相同，型別相同，有相同的getter/setter方法； 88 --> 89 <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/> 90 <!-- 設定是否在getter方法中，對String型別欄位呼叫trim()方法 --> 91 <property name="trimStrings" value="true"/> 92 </javaModelGenerator> 93 94 <!-- 生成SQL map的XML檔案生成器， 95 注意，在Mybatis3之後，我們可以使用mapper.xml檔案+Mapper介面（或者不用mapper介面）， 96 或者只使用Mapper介面+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的話，這個元素就必須配置 97 targetPackage/targetProject:同javaModelGenerator 98 --> 99 <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources"> 100 <!-- 在targetPackage的基礎上，根據資料庫的schema再生成一層package，最終生成的類放在這個package下，預設為false --> 101 <property name="enableSubPackages" value="true"/> 102 </sqlMapGenerator> 103 104 <!-- 對於mybatis來說，即生成Mapper介面，注意，如果沒有配置該元素，那麼預設不會生成Mapper介面 105 targetPackage/targetProject:同javaModelGenerator 106 type：選擇怎麼生成mapper介面（在MyBatis3/MyBatis3Simple下）： 107 1，ANNOTATEDMAPPER：會生成使用Mapper介面+Annotation的方式建立（SQL生成在annotation中），不會生成對應的XML； 108 2，MIXEDMAPPER：使用混合配置，會生成Mapper介面，並適當新增合適的Annotation，但是XML會生成在XML中； 109 3，XMLMAPPER：會生成Mapper介面，介面完全依賴XML； 110 注意，如果context是MyBatis3Simple：只支援ANNOTATEDMAPPER和XMLMAPPER 111 --> 112 <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" 113 targetProject="src/main/java"> 114 <!-- 在targetPackage的基礎上，根據資料庫的schema再生成一層package，最終生成的類放在這個package下，預設為false --> 115 <property name="enableSubPackages" value="true"/> 116 <!-- 可以為所有生成的介面新增一個父介面，但是MBG只負責生成，不負責檢查 117 <property name="rootInterface" value=""/> 118 --> 119 </javaClientGenerator> 120 <!-- 選擇一個table來生成相關檔案，可以有一個或多個table，必須要有table元素 121 選擇的table會生成一下檔案： 122 1，SQL map檔案 123 2，生成一個主鍵類； 124 3，除了BLOB和主鍵的其他欄位的類； 125 4，包含BLOB的類； 126 5，一個使用者生成動態查詢的條件類（selectByExample, deleteByExample），可選； 127 6，Mapper介面（可選） 128 tableName（必要）：要生成物件的表名； 129 注意：大小寫敏感問題。正常情況下，MBG會自動的去識別資料庫識別符號的大小寫敏感度，在一般情況下，MBG會 130 根據設定的schema，catalog或tablename去查詢資料表，按照下面的流程： 131 1，如果schema，catalog或tablename中有空格，那麼設定的是什麼格式，就精確的使用指定的大小寫格式去查詢； 132 2，否則，如果資料庫的識別符號使用大寫的，那麼MBG自動把表名變成大寫再查詢； 133 3，否則，如果資料庫的識別符號使用小寫的，那麼MBG自動把表名變成小寫再查詢； 134 4，否則，使用指定的大小寫格式查詢； 135 另外的，如果在建立表的時候，使用的""把資料庫物件規定大小寫，就算資料庫識別符號是使用的大寫，在這種情況下也會使用給定的大小寫來建立表名； 136 這個時候，請設定delimitIdentifiers="true"即可保留大小寫格式； 137 可選： 138 1，schema：資料庫的schema； 139 2，catalog：資料庫的catalog； 140 3，alias：為資料表設定的別名，如果設定了alias，那麼生成的所有的SELECT SQL語句中，列名會變成：alias_actualColumnName 141 4，domainObjectName：生成的domain類的名字，如果不設定，直接使用表名作為domain類的名字；可以設定為somepck.domainName，那麼會自動把domainName類再放到somepck包裡面； 142 5，enableInsert（預設true）：指定是否生成insert語句； 143 6，enableSelectByPrimaryKey（預設true）：指定是否生成按照主鍵查詢物件的語句（就是getById或get）； 144 7，enableSelectByExample（預設true）：MyBatis3Simple為false，指定是否生成動態查詢語句； 145 8，enableUpdateByPrimaryKey（預設true）：指定是否生成按照主鍵修改物件的語句（即update)； 146 9，enableDeleteByPrimaryKey（預設true）：指定是否生成按照主鍵刪除物件的語句（即delete）； 147 10，enableDeleteByExample（預設true）：MyBatis3Simple為false，指定是否生成動態刪除語句； 148 11，enableCountByExample（預設true）：MyBatis3Simple為false，指定是否生成動態查詢總條數語句（用於分頁的總條數查詢）； 149 12，enableUpdateByExample（預設true）：MyBatis3Simple為false，指定是否生成動態修改語句（只修改物件中不為空的屬性）； 150 13，modelType：參考context元素的defaultModelType，相當於覆蓋； 151 14，delimitIdentifiers：參考tableName的解釋，注意，預設的delimitIdentifiers是雙引號，如果類似MYSQL這樣的資料庫，使用的是`（反引號，那麼還需要設定context的beginningDelimiter和endingDelimiter屬性） 152 15，delimitAllColumns：設定是否所有生成的SQL中的列名都使用識別符號引起來。預設為false，delimitIdentifiers參考context的屬性 153 注意，table裡面很多引數都是對javaModelGenerator，context等元素的預設屬性的一個複寫； 154 --> 155 <table tableName="userinfo"> 156 <!-- 參考 javaModelGenerator 的 constructorBased屬性--> 157 <property name="constructorBased" value="false"/> 158 <!-- 預設為false，如果設定為true，在生成的SQL中，table名字不會加上catalog或schema； --> 159 <property name="ignoreQualifiersAtRuntime" value="false"/> 160 <!-- 參考 javaModelGenerator 的 immutable 屬性 --> 161 <property name="immutable" value="false"/> 162 <!-- 指定是否只生成domain類，如果設定為true，只生成domain類，如果還配置了sqlMapGenerator，那麼在mapper XML檔案中，只生成resultMap元素 --> 163 <property name="modelOnly" value="false"/> 164 <!-- 參考 javaModelGenerator 的 rootClass 屬性 165 <property name="rootClass" value=""/> 166 --> 167 <!-- 參考javaClientGenerator 的 rootInterface 屬性 168 <property name="rootInterface" value=""/> 169 --> 170 <!-- 如果設定了runtimeCatalog，那麼在生成的SQL中，使用該指定的catalog，而不是table元素上的catalog 171 <property name="runtimeCatalog" value=""/> 172 --> 173 <!-- 如果設定了runtimeSchema，那麼在生成的SQL中，使用該指定的schema，而不是table元素上的schema 174 <property name="runtimeSchema" value=""/> 175 --> 176 <!-- 如果設定了runtimeTableName，那麼在生成的SQL中，使用該指定的tablename，而不是table元素上的tablename 177 <property name="runtimeTableName" value=""/> 178 --> 179 <!-- 注意，該屬性只針對MyBatis3Simple有用； 180 如果選擇的runtime是MyBatis3Simple，那麼會生成一個SelectAll方法，如果指定了selectAllOrderByClause，那麼會在該SQL中新增指定的這個order條件； 181 --> 182 <property name="selectAllOrderByClause" value="age desc,username asc"/> 183 <!-- 如果設定為true，生成的model類會直接使用column本身的名字，而不會再使用駝峰命名方法，比如BORN_DATE，生成的屬性名字就是BORN_DATE,而不會是bornDate --> 184 <property name="useActualColumnNames" value="false"/> 185 186 <!-- generatedKey用於生成生成主鍵的方法， 187 如果設定了該元素，MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素，該元素可選 188 column:主鍵的列名； 189 sqlStatement：要生成的selectKey語句，有以下可選項： 190 Cloudscape:相當於selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL() 191 DB2 :相當於selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL() 192 DB2_MF :相當於selectKey的SQL為：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1 193 Derby :相當於selectKey的SQL為：VALUES IDENTITY_VAL_LOCAL() 194 HSQLDB :相當於selectKey的SQL為：CALL IDENTITY() 195 Informix :相當於selectKey的SQL為：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1 196 MySql :相當於selectKey的SQL為：SELECT LAST_INSERT_ID() 197 SqlServer :相當於selectKey的SQL為：SELECT SCOPE_IDENTITY() 198 SYBASE :相當於selectKey的SQL為：SELECT @@IDENTITY 199 JDBC :相當於在生成的insert元素上新增useGeneratedKeys="true"和keyProperty屬性 200 <generatedKey column="" sqlStatement=""/> 201 --> 202 <!-- 203 該元素會在根據表中列名計算物件屬性名之前先重新命名列名，非常適合用於表中的列都有公用的字首字串的時候， 204 比如列名為：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等； 205 那麼就可以設定searchString為"^CUST_"，並使用空白替換，那麼生成的Customer物件中的屬性名稱就不是 206 custId,custName等，而是先被替換為ID,NAME,EMAIL,然後變成屬性：id，name，email； 207 注意，MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的， 208 如果使用了columnOverride元素，該屬性無效； 209 <columnRenamingRule searchString="" replaceString=""/> 210 --> 211 212 <!-- 用來修改表中某個列的屬性，MBG會使用修改後的列來生成domain的屬性； 213 column:要重新設定的列名； 214 注意，一個table元素中可以有多個columnOverride元素哈~ 215 --> 216 <columnOverride column="username"> 217 <!-- 使用property屬性來指定列要生成的屬性名稱 --> 218 <property name="property" value="userName"/> 219 <!-- javaType用於指定生成的domain的屬性型別，使用型別的全限定名 220 <property name="javaType" value=""/> 221 --> 222 <!-- jdbcType用於指定該列的JDBC型別 223 <property name="jdbcType" value=""/> 224 --> 225 <!-- typeHandler 用於指定該列使用到的TypeHandler，如果要指定，配置型別處理器的全限定名 226 注意，mybatis中，不會生成到mybatis-config.xml中的typeHandler 227 只會生成類似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的引數描述 228 <property name="jdbcType" value=""/> 229 --> 230 <!-- 參考table元素的delimitAllColumns配置，預設為false 231 <property name="delimitedColumnName" value=""/> 232 --> 233 </columnOverride> 234 <!-- ignoreColumn設定一個MGB忽略的列，如果設定了改列，那麼在生成的domain中，生成的SQL中，都不會有該列出現 235 column:指定要忽略的列的名字； 236 delimitedColumnName：參考table元素的delimitAllColumns配置，預設為false 237 注意，一個table元素中可以有多個ignoreColumn元素 238 <ignoreColumn column="deptId" delimitedColumnName=""/> 239 --> 240 </table> 241 </context> 242 </generatorConfiguration>