本文檔為學習記錄,參考博文:
https://www.cnblogs.com/handsomeye/p/6268513.html
https://www.cnblogs.com/maanshancss/p/6027999.html
實現步驟:
1)新建Maven工程
新建一個Maven工程,專用於進行生成代碼
2)POM文件添加Mybatis generator依賴
dependencies中添加:
1 <dependency> 2 <groupId>org.mybatis.generator</groupId> 3 <artifactId>mybatis-generator-core</artifactId> 4 <version>1.3.2</version> 5 </dependency>
在build的plugins中添加:
1 <plugin> 2 <groupId>org.mybatis.generator</groupId> 3 <artifactId>mybatis-generator-maven-plugin</artifactId> 4 <version>1.3.2</version> 5 <configuration> 6 <!-- mybatis用於生成代碼的配置文件 --> 7 <configurationFile>src/main/resources/generatorConfig.xml</configurationFile> 8 <verbose>true</verbose> 9 <overwrite>true</overwrite> 10 </configuration> 11 </plugin>
3.配置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 <generatorConfiguration> 6 <classPathEntry 7 location="/Users/yehaixiao/Maven/mysql/mysql-connector-java/5.1.30/mysql-connector-java.jar"/> 8 <context id="my" targetRuntime="MyBatis3"> 9 10 <!-- 生成的Java文件的編碼 --> 11 <property name="javaFileEncoding" value="UTF-8"/> 12 <!-- 格式化java代碼 --> 13 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 14 <!-- 格式化XML代碼 --> 15 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 16 17 <commentGenerator> 18 <property name="suppressDate" value="false"/> 19 <property name="suppressAllComments" value="true"/> 20 </commentGenerator> 21 22 <!-- mysql數據庫連接 --> 23 <jdbcConnection driverClass="com.mysql.jdbc.Driver" 24 connectionURL="jdbc:mysql://127.0.0.1:3306/test" userId="root" 25 password="******"/> 26 27 <!-- 生成model實體類文件位置 --> 28 <javaModelGenerator targetPackage="com.ssmgen.demo.model" 29 targetProject="/Users/yehaixiao/asiainfo/ssm-demo/src/main/java"> 30 <property name="enableSubPackages" value="true"/> 31 <property name="trimStrings" value="true"/> 32 </javaModelGenerator> 33 34 <!-- 生成mapper.xml配置文件位置 --> 35 <sqlMapGenerator targetPackage="com.ssmgen.demo.mapper" 36 targetProject="/Users/yehaixiao/asiainfo/ssm-demo/src/main/java"> 37 <property name="enableSubPackages" value="true"/> 38 </sqlMapGenerator> 39 40 <!-- 生成mapper接口文件位置 --> 41 <javaClientGenerator targetPackage="com.ssmgen.demo.mapper" 42 targetProject="/Users/yehaixiao/asiainfo/ssm-demo/src/main/java" type="XMLMAPPER"> 43 <property name="enableSubPackages" value="true"/> 44 </javaClientGenerator> 45 46 <!-- 需要生成的實體類對應的表名,多個實體類復制多份該配置即可 --> 47 <table tableName="TEST1" domainObjectName="Test" 48 enableCountByExample="false" enableUpdateByExample="false" 49 enableDeleteByExample="false" enableSelectByExample="false" 50 selectByExampleQueryId="false"> 51 </table> 52 </context> 53 </generatorConfiguration>
配置說明:
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 12 另外,如果使用了mybatis-generator-maven-plugin,那么在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用 13 <properties resource="" url="" /> 14 --> 15 16 <!-- 在MBG工作的時候,需要額外加載的依賴包 17 location屬性指明加載jar/zip包的全路徑 18 <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" /> 19 --> 20 21 <!-- 22 context:生成一組對象的環境 23 id:必選,上下文id,用於在生成錯誤時提示 24 defaultModelType:指定生成對象的樣式 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 32 <!-- 自動識別數據庫關鍵字,默認false,如果設置為true,根據SqlReservedWords中定義的關鍵字列表; 33 一般保留默認值,遇到數據庫關鍵字(Java關鍵字),使用columnOverride覆蓋 34 --> 35 <property name="autoDelimitKeywords" value="false"/> 36 <!-- 生成的Java文件的編碼 --> 37 <property name="javaFileEncoding" value="UTF-8"/> 38 <!-- 格式化java代碼 --> 39 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 40 <!-- 格式化XML代碼 --> 41 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 42 43 <!-- beginningDelimiter和endingDelimiter:指明數據庫的用於標記數據庫對象名的符號,比如ORACLE就是雙引號,MYSQL默認是`反引號; --> 44 <property name="beginningDelimiter" value="`"/> 45 <property name="endingDelimiter" value="`"/> 46 47 <!-- 必須要有的,使用這個配置鏈接數據庫 48 @TODO:是否可以擴展 49 --> 50 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin"> 51 <!-- 這里面可以設置property屬性,每一個property屬性都設置到配置的Driver上 --> 52 </jdbcConnection> 53 54 <!-- java類型處理器 55 用於處理DB中的類型到Java中的類型,默認使用JavaTypeResolverDefaultImpl; 56 注意一點,默認會先嘗試使用Integer,Long,Short等來對應DECIMAL和 NUMERIC數據類型; 57 --> 58 <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> 59 <!-- 60 true:使用BigDecimal對應DECIMAL和 NUMERIC數據類型 61 false:默認, 62 scale>0;length>18:使用BigDecimal; 63 scale=0;length[10,18]:使用Long; 64 scale=0;length[5,9]:使用Integer; 65 scale=0;length<5:使用Short; 66 --> 67 <property name="forceBigDecimals" value="false"/> 68 </javaTypeResolver> 69 70 71 <!-- java模型創建器,是必須要的元素 72 負責:1,key類(見context的defaultModelType);2,java類;3,查詢類 73 targetPackage:生成的類要放的包,真實的包受enableSubPackages屬性控制; 74 targetProject:目標項目,指定一個存在的目錄下,生成的內容會放到指定目錄中,如果目錄不存在,MBG不會自動建目錄 75 --> 76 <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java"> 77 <!-- for MyBatis3/MyBatis3Simple 78 自動為每一個生成的類創建一個構造方法,構造方法包含了所有的field;而不是使用setter; 79 --> 80 <property name="constructorBased" value="false"/> 81 82 <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認為false --> 83 <property name="enableSubPackages" value="true"/> 84 85 <!-- for MyBatis3 / MyBatis3Simple 86 是否創建一個不可變的類,如果為true, 87 那么MBG會創建一個沒有setter方法的類,取而代之的是類似constructorBased的類 88 --> 89 <property name="immutable" value="false"/> 90 91 <!-- 設置一個根對象, 92 如果設置了這個根對象,那么生成的keyClass或者recordClass會繼承這個類;在Table的rootClass屬性中可以覆蓋該選項 93 注意:如果在key class或者record class中有root class相同的屬性,MBG就不會重新生成這些屬性了,包括: 94 1,屬性名相同,類型相同,有相同的getter/setter方法; 95 --> 96 <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/> 97 98 <!-- 設置是否在getter方法中,對String類型字段調用trim()方法 --> 99 <property name="trimStrings" value="true"/> 100 </javaModelGenerator> 101 102 103 <!-- 生成SQL map的XML文件生成器, 104 注意,在Mybatis3之后,我們可以使用mapper.xml文件+Mapper接口(或者不用mapper接口), 105 或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的話,這個元素就必須配置 106 targetPackage/targetProject:同javaModelGenerator 107 --> 108 <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources"> 109 <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認為false --> 110 <property name="enableSubPackages" value="true"/> 111 </sqlMapGenerator> 112 113 114 <!-- 對於mybatis來說,即生成Mapper接口,注意,如果沒有配置該元素,那么默認不會生成Mapper接口 115 targetPackage/targetProject:同javaModelGenerator 116 type:選擇怎么生成mapper接口(在MyBatis3/MyBatis3Simple下): 117 1,ANNOTATEDMAPPER:會生成使用Mapper接口+Annotation的方式創建(SQL生成在annotation中),不會生成對應的XML; 118 2,MIXEDMAPPER:使用混合配置,會生成Mapper接口,並適當添加合適的Annotation,但是XML會生成在XML中; 119 3,XMLMAPPER:會生成Mapper接口,接口完全依賴XML; 120 注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER 121 --> 122 <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java"> 123 <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認為false --> 124 <property name="enableSubPackages" value="true"/> 125 126 <!-- 可以為所有生成的接口添加一個父接口,但是MBG只負責生成,不負責檢查 127 <property name="rootInterface" value=""/> 128 --> 129 </javaClientGenerator> 130 131 <!-- 選擇一個table來生成相關文件,可以有一個或多個table,必須要有table元素 132 選擇的table會生成一下文件: 133 1,SQL map文件 134 2,生成一個主鍵類; 135 3,除了BLOB和主鍵的其他字段的類; 136 4,包含BLOB的類; 137 5,一個用戶生成動態查詢的條件類(selectByExample, deleteByExample),可選; 138 6,Mapper接口(可選) 139 140 tableName(必要):要生成對象的表名; 141 注意:大小寫敏感問題。正常情況下,MBG會自動的去識別數據庫標識符的大小寫敏感度,在一般情況下,MBG會 142 根據設置的schema,catalog或tablename去查詢數據表,按照下面的流程: 143 1,如果schema,catalog或tablename中有空格,那么設置的是什么格式,就精確的使用指定的大小寫格式去查詢; 144 2,否則,如果數據庫的標識符使用大寫的,那么MBG自動把表名變成大寫再查找; 145 3,否則,如果數據庫的標識符使用小寫的,那么MBG自動把表名變成小寫再查找; 146 4,否則,使用指定的大小寫格式查詢; 147 另外的,如果在創建表的時候,使用的""把數據庫對象規定大小寫,就算數據庫標識符是使用的大寫,在這種情況下也會使用給定的大小寫來創建表名; 148 這個時候,請設置delimitIdentifiers="true"即可保留大小寫格式; 149 150 可選: 151 1,schema:數據庫的schema; 152 2,catalog:數據庫的catalog; 153 3,alias:為數據表設置的別名,如果設置了alias,那么生成的所有的SELECT SQL語句中,列名會變成:alias_actualColumnName 154 4,domainObjectName:生成的domain類的名字,如果不設置,直接使用表名作為domain類的名字;可以設置為somepck.domainName,那么會自動把domainName類再放到somepck包里面; 155 5,enableInsert(默認true):指定是否生成insert語句; 156 6,enableSelectByPrimaryKey(默認true):指定是否生成按照主鍵查詢對象的語句(就是getById或get); 157 7,enableSelectByExample(默認true):MyBatis3Simple為false,指定是否生成動態查詢語句; 158 8,enableUpdateByPrimaryKey(默認true):指定是否生成按照主鍵修改對象的語句(即update); 159 9,enableDeleteByPrimaryKey(默認true):指定是否生成按照主鍵刪除對象的語句(即delete); 160 10,enableDeleteByExample(默認true):MyBatis3Simple為false,指定是否生成動態刪除語句; 161 11,enableCountByExample(默認true):MyBatis3Simple為false,指定是否生成動態查詢總條數語句(用於分頁的總條數查詢); 162 12,enableUpdateByExample(默認true):MyBatis3Simple為false,指定是否生成動態修改語句(只修改對象中不為空的屬性); 163 13,modelType:參考context元素的defaultModelType,相當於覆蓋; 164 14,delimitIdentifiers:參考tableName的解釋,注意,默認的delimitIdentifiers是雙引號,如果類似MYSQL這樣的數據庫,使用的是`(反引號,那么還需要設置context的beginningDelimiter和endingDelimiter屬性) 165 15,delimitAllColumns:設置是否所有生成的SQL中的列名都使用標識符引起來。默認為false,delimitIdentifiers參考context的屬性 166 167 注意,table里面很多參數都是對javaModelGenerator,context等元素的默認屬性的一個復寫; 168 --> 169 <table tableName="userinfo" > 170 171 <!-- 參考 javaModelGenerator 的 constructorBased屬性--> 172 <property name="constructorBased" value="false"/> 173 174 <!-- 默認為false,如果設置為true,在生成的SQL中,table名字不會加上catalog或schema; --> 175 <property name="ignoreQualifiersAtRuntime" value="false"/> 176 177 <!-- 參考 javaModelGenerator 的 immutable 屬性 --> 178 <property name="immutable" value="false"/> 179 180 <!-- 指定是否只生成domain類,如果設置為true,只生成domain類,如果還配置了sqlMapGenerator,那么在mapper XML文件中,只生成resultMap元素 --> 181 <property name="modelOnly" value="false"/> 182 183 <!-- 參考 javaModelGenerator 的 rootClass 屬性 184 <property name="rootClass" value=""/> 185 --> 186 187 <!-- 參考javaClientGenerator 的 rootInterface 屬性 188 <property name="rootInterface" value=""/> 189 --> 190 191 <!-- 如果設置了runtimeCatalog,那么在生成的SQL中,使用該指定的catalog,而不是table元素上的catalog 192 <property name="runtimeCatalog" value=""/> 193 --> 194 195 <!-- 如果設置了runtimeSchema,那么在生成的SQL中,使用該指定的schema,而不是table元素上的schema 196 <property name="runtimeSchema" value=""/> 197 --> 198 199 <!-- 如果設置了runtimeTableName,那么在生成的SQL中,使用該指定的tablename,而不是table元素上的tablename 200 <property name="runtimeTableName" value=""/> 201 --> 202 203 <!-- 注意,該屬性只針對MyBatis3Simple有用; 204 如果選擇的runtime是MyBatis3Simple,那么會生成一個SelectAll方法,如果指定了selectAllOrderByClause,那么會在該SQL中添加指定的這個order條件; 205 --> 206 <property name="selectAllOrderByClause" value="age desc,username asc"/> 207 208 <!-- 如果設置為true,生成的model類會直接使用column本身的名字,而不會再使用駝峰命名方法,比如BORN_DATE,生成的屬性名字就是BORN_DATE,而不會是bornDate --> 209 <property name="useActualColumnNames" value="false"/> 210 211 212 <!-- generatedKey用於生成生成主鍵的方法, 213 如果設置了該元素,MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素,該元素可選 214 column:主鍵的列名; 215 sqlStatement:要生成的selectKey語句,有以下可選項: 216 Cloudscape:相當於selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL() 217 DB2 :相當於selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL() 218 DB2_MF :相當於selectKey的SQL為:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1 219 Derby :相當於selectKey的SQL為:VALUES IDENTITY_VAL_LOCAL() 220 HSQLDB :相當於selectKey的SQL為:CALL IDENTITY() 221 Informix :相當於selectKey的SQL為:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1 222 MySql :相當於selectKey的SQL為:SELECT LAST_INSERT_ID() 223 SqlServer :相當於selectKey的SQL為:SELECT SCOPE_IDENTITY() 224 SYBASE :相當於selectKey的SQL為:SELECT @@IDENTITY 225 JDBC :相當於在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性 226 <generatedKey column="" sqlStatement=""/> 227 --> 228 229 <!-- 230 該元素會在根據表中列名計算對象屬性名之前先重命名列名,非常適合用於表中的列都有公用的前綴字符串的時候, 231 比如列名為:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等; 232 那么就可以設置searchString為"^CUST_",並使用空白替換,那么生成的Customer對象中的屬性名稱就不是 233 custId,custName等,而是先被替換為ID,NAME,EMAIL,然后變成屬性:id,name,email; 234 235 注意,MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的, 236 如果使用了columnOverride元素,該屬性無效; 237 238 <columnRenamingRule searchString="" replaceString=""/> 239 --> 240 241 242 <!-- 用來修改表中某個列的屬性,MBG會使用修改后的列來生成domain的屬性; 243 column:要重新設置的列名; 244 注意,一個table元素中可以有多個columnOverride元素哈~ 245 --> 246 <columnOverride column="username"> 247 <!-- 使用property屬性來指定列要生成的屬性名稱 --> 248 <property name="property" value="userName"/> 249 250 <!-- javaType用於指定生成的domain的屬性類型,使用類型的全限定名 251 <property name="javaType" value=""/> 252 --> 253 254 <!-- jdbcType用於指定該列的JDBC類型 255 <property name="jdbcType" value=""/> 256 --> 257 258 <!-- typeHandler 用於指定該列使用到的TypeHandler,如果要指定,配置類型處理器的全限定名 259 注意,mybatis中,不會生成到mybatis-config.xml中的typeHandler 260 只會生成類似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數描述 261 <property name="jdbcType" value=""/> 262 --> 263 264 <!-- 參考table元素的delimitAllColumns配置,默認為false 265 <property name="delimitedColumnName" value=""/> 266 --> 267 </columnOverride> 268 269 <!-- ignoreColumn設置一個MGB忽略的列,如果設置了改列,那么在生成的domain中,生成的SQL中,都不會有該列出現 270 column:指定要忽略的列的名字; 271 delimitedColumnName:參考table元素的delimitAllColumns配置,默認為false 272 273 注意,一個table元素中可以有多個ignoreColumn元素 274 <ignoreColumn column="deptId" delimitedColumnName=""/> 275 --> 276 </table> 277 278 </context>
4)執行生成
到此為止,所有的配置已完畢,如果在ecplise中使用,則右擊工程,maven build,添加命令mybatis-generator:generate,代碼生成完畢!
生成帶字段注釋的
按照上面的生成,pojo類中沒有關於字段的注釋,參照 https://www.jb51.net/article/148070.htm 一文的講解,重新修改
1)配置pom文件,只需要引入自動生成的jar包,不在配置插件
1 <?xml version="1.0" encoding="UTF-8"?> 2 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>org.springframework.boot</groupId> 7 <artifactId>spring-boot-starter-parent</artifactId> 8 <version>2.1.5.RELEASE</version> 9 <relativePath/> <!-- lookup parent from repository --> 10 </parent> 11 <groupId>com.swyx</groupId> 12 <artifactId>swyx_form_api</artifactId> 13 <version>0.0.1-SNAPSHOT</version> 14 <name>swyx_form_api</name> 15 <description>Demo project for Spring Boot</description> 16 17 <properties> 18 <java.version>1.8</java.version> 19 </properties> 20 21 <dependencies> 22 <dependency> 23 <groupId>org.springframework.boot</groupId> 24 <artifactId>spring-boot-starter-web</artifactId> 25 </dependency> 26 <dependency> 27 <groupId>org.mybatis.spring.boot</groupId> 28 <artifactId>mybatis-spring-boot-starter</artifactId> 29 <version>2.0.1</version> 30 </dependency> 31 <dependency> 32 <groupId>org.springframework.boot</groupId> 33 <artifactId>spring-boot-starter-test</artifactId> 34 <scope>test</scope> 35 </dependency> 36 37 <!-- mysql --> 38 <dependency> 39 <groupId>mysql</groupId> 40 <artifactId>mysql-connector-java</artifactId> 41 <scope>runtime</scope> 42 </dependency> 43 <dependency> 44 <groupId>org.mybatis.generator</groupId> 45 <artifactId>mybatis-generator-core</artifactId> 46 <version>1.3.7</version> 47 </dependency> 48 49 </dependencies> 50 51 <build> 52 <plugins> 53 <plugin> 54 <groupId>org.springframework.boot</groupId> 55 <artifactId>spring-boot-maven-plugin</artifactId> 56 </plugin> 57 </plugins> 58 </build> 59 </project>
2)編寫自動生成工具類
1 package com.swyx.form.api; 2 3 import org.mybatis.generator.api.CommentGenerator; 4 import org.mybatis.generator.api.IntrospectedColumn; 5 import org.mybatis.generator.api.IntrospectedTable; 6 import org.mybatis.generator.api.dom.java.*; 7 import org.mybatis.generator.api.dom.xml.XmlElement; 8 import java.util.Properties; 9 import java.util.Set; 10 import org.mybatis.generator.api.dom.java.Field; 11 import org.mybatis.generator.api.dom.java.TopLevelClass; 12 import java.text.SimpleDateFormat; 13 import java.util.Date; 14 15 public class MySQLCommentGenerator extends EmptyCommentGenerator { 16 17 private Properties properties; 18 19 public MySQLCommentGenerator() { 20 properties = new Properties(); 21 } 22 23 @Override 24 public void addConfigurationProperties(Properties properties) { 25 // 獲取自定義的 properties 26 this.properties.putAll(properties); 27 } 28 29 @Override 30 public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { 31 String author = properties.getProperty("author"); 32 String dateFormat = properties.getProperty("dateFormat", "yyyy-MM-dd"); 33 SimpleDateFormat dateFormatter = new SimpleDateFormat(dateFormat); 34 35 // 獲取表注釋 36 String remarks = introspectedTable.getRemarks(); 37 38 topLevelClass.addJavaDocLine("/**"); 39 topLevelClass.addJavaDocLine(" * " + remarks); 40 topLevelClass.addJavaDocLine(" *"); 41 topLevelClass.addJavaDocLine(" * @author " + author); 42 topLevelClass.addJavaDocLine(" * @date " + dateFormatter.format(new Date())); 43 topLevelClass.addJavaDocLine(" */"); 44 } 45 46 @Override 47 public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { 48 // 獲取列注釋 49 String remarks = introspectedColumn.getRemarks(); 50 field.addJavaDocLine("/**"); 51 field.addJavaDocLine(" * " + remarks); 52 field.addJavaDocLine(" */"); 53 } 54 } 55 56 class EmptyCommentGenerator implements CommentGenerator { 57 58 @Override 59 public void addConfigurationProperties(Properties properties) { 60 61 } 62 63 @Override 64 public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { 65 66 } 67 68 @Override 69 public void addFieldComment(Field field, IntrospectedTable introspectedTable) { 70 71 } 72 73 @Override 74 public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { 75 76 } 77 78 @Override 79 public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) { 80 81 } 82 83 @Override 84 public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean b) { 85 86 } 87 88 @Override 89 public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) { 90 91 } 92 93 @Override 94 public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { 95 96 } 97 98 @Override 99 public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { 100 101 } 102 103 @Override 104 public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) { 105 106 } 107 108 @Override 109 public void addJavaFileComment(CompilationUnit compilationUnit) { 110 111 } 112 113 @Override 114 public void addComment(XmlElement xmlElement) { 115 116 } 117 118 @Override 119 public void addRootComment(XmlElement xmlElement) { 120 121 } 122 123 @Override 124 public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) { 125 126 } 127 128 @Override 129 public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) { 130 131 } 132 133 @Override 134 public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) { 135 136 } 137 138 @Override 139 public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) { 140 141 } 142 143 @Override 144 public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) { 145 146 } 147 }
1 package com.swyx.form.api; 2 3 import org.mybatis.generator.api.MyBatisGenerator; 4 import org.mybatis.generator.config.Configuration; 5 import org.mybatis.generator.config.xml.ConfigurationParser; 6 import org.mybatis.generator.internal.DefaultShellCallback; 7 import java.io.File; 8 import java.util.ArrayList; 9 import java.util.List; 10 11 public class MySQLGenerator { 12 13 public static void main( String[] args ) throws Exception { 14 List<String> warnings = new ArrayList<>(); 15 File configFile = new File("src/main/resources/generatorConfig.xml"); 16 ConfigurationParser cp = new ConfigurationParser(warnings); 17 Configuration config = cp.parseConfiguration(configFile); 18 DefaultShellCallback callback = new DefaultShellCallback(true); 19 MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings); 20 myBatisGenerator.generate(null); 21 } 22 23 }
3)編寫配置生成文件generatorConfig.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE generatorConfiguration PUBLIC 3 "-//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 location="E:\apache-maven-3.6.0\repository\mysql\mysql-connector-java\8.0.16"/> 8 <context id="my" targetRuntime="MyBatis3"> 9 <!-- 生成的 Java 文件的編碼 --> 10 <property name="javaFileEncoding" value="UTF-8"/> 11 <!-- 格式化 Java 代碼 --> 12 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 13 <!-- 格式化 XML 代碼 --> 14 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 15 16 <!-- 自定義注釋生成器 --> 17 <commentGenerator type="com.swyx.form.api.MySQLCommentGenerator"> 18 <property name="author" value="wangbaojun1992@163.com"/> 19 <property name="dateFormat" value="yyyy/MM/dd"/> 20 </commentGenerator> 21 22 <!-- 配置數據庫連接 --> 23 <jdbcConnection driverClass="com.mysql.jdbc.Driver" 24 connectionURL="jdbc:mysql://localhost:3306/swyx_form?serverTimezone=UTC" 25 userId="root" password="wbj@1992*"> 26 <!-- 設置 useInformationSchema 屬性為 true --> 27 <property name="useInformationSchema" value="true" /> 28 </jdbcConnection> 29 30 <!-- 生成實體的位置 --> 31 <javaModelGenerator targetPackage="com.swyx.form.api.form.domain.pojo" targetProject="H:\swyx\codes\swyx_form\swyx_form_api\src\main\java"> 32 <property name="enableSubPackages" value="true"/> 33 </javaModelGenerator> 34 35 <!-- 生成 Mapper 接口的位置 --> 36 <sqlMapGenerator targetPackage="com.swyx.form.api.form.domain.mapper" targetProject="H:\swyx\codes\swyx_form\swyx_form_api\src\main\java"> 37 <property name="enableSubPackages" value="true"/> 38 </sqlMapGenerator> 39 40 <!-- 生成 Mapper XML 的位置 --> 41 <javaClientGenerator targetPackage="com.swyx.form.api.form.domain.mapper" type="XMLMAPPER" targetProject="H:\swyx\codes\swyx_form\swyx_form_api\src\main\java"> 42 <property name="enableSubPackages" value="true"/> 43 </javaClientGenerator> 44 45 <!-- 設置數據庫的表名和實體類名 --> 46 <table tableName="form_scheme" domainObjectName="FormScheme" 47 enableCountByExample="true" enableUpdateByExample="false" 48 enableDeleteByExample="false" enableSelectByExample="true" 49 selectByExampleQueryId="false"> 50 </table> 51 52 </context> 53 </generatorConfiguration>
4)執行MySQLGenerator 的main方法生成mapper
生成后工程目錄結構: