本篇文章將介紹使用spring boot框架,引入mybatis-generator插件,結合tk.mybatis自動生成Mapper和Entity的一整套流程,其中包括最重要的踩坑與填坑。
一、基建
-
演示用數據庫
-
初始spring boot項目
二、主角登場
1.在pom.xml中引入mybatis-generator插件。注意,這里我使用的是tk.mybatis.所以需要引入相應的依賴。並添加mapper接口
1 <dependency>
2 <groupId>tk.mybatis</groupId>
3 <artifactId>mapper-spring-boot-starter</artifactId>
4 <version>2.0.2</version>
5 </dependency>
1 package com.tk; 2
3 import tk.mybatis.mapper.common.Mapper; 4 import tk.mybatis.mapper.common.MySqlMapper; 5
6 public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> { 7 }
configurationFile節點配置了生成mapper、entity所需的配置文件,所以我們需要在相應的位置添加gengeatorConfig.xml配置文件。
1
2 <plugin>
3 <groupId>org.mybatis.generator</groupId>
4 <artifactId>mybatis-generator-maven-plugin</artifactId>
5 <version>1.3.5</version>
6 <configuration>
7 <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
8 <overwrite>true</overwrite>
9 <verbose>true</verbose>
10 </configuration>
11 <dependencies>
12 <dependency>
13 <groupId>mysql</groupId>
14 <artifactId>mysql-connector-java</artifactId>
15 <version>${mysql.version}</version>
16 </dependency>
17 <dependency> 18 <groupId>tk.mybatis</groupId> 19 <artifactId>mapper</artifactId> 20 <version>3.4.4</version> 21 </dependency>
22 </dependencies>
23 </plugin>
2.添加generatorConfig.xml文件。文件位置要與pom.xml中配置的路徑一致。關於該配置文件各個配置節點的含義和用途,文章末尾有詳細解釋。
配置文件一開始引入了jdbc.properties數據庫連接配置文件,所以需要在resources文件夾下添加該配置文件。
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 <!-- 引入數據庫連接配置 -->
8 <properties resource="jdbc.properties"/>
9
10 <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
11 <property name="beginningDelimiter" value="`"/>
12 <property name="endingDelimiter" value="`"/>
13
14 <!-- 配置 tk.mybatis 插件 -->
15 <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
16 <property name="mappers" value="com.tk.MyMapper"/>
17 </plugin>
18
19 <!-- 配置數據庫連接 -->
20 <jdbcConnection 21 driverClass="${jdbc.driverClass}"
22 connectionURL="${jdbc.connectionURL}"
23 userId="${jdbc.username}"
24 password="${jdbc.password}">
25 </jdbcConnection>
26
27 <!-- 配置實體類存放路徑 -->
28 <javaModelGenerator targetPackage="com.senda.hello.spring.boot.entity" targetProject="src/main/java"/>
29
30 <!-- 配置 XML 存放路徑 -->
31 <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>
32
33 <!-- 配置 DAO 存放路徑 -->
34 <javaClientGenerator 35 targetPackage="com.senda.hello.spring.boot.mapper"
36 targetProject="src/main/java"
37 type="XMLMAPPER"/>
38
39 <!-- 配置需要指定生成的數據庫和表,% 代表所有表 -->
40 <table catalog="dbtest" tableName="%">
41 <!-- mysql 配置 -->
42 <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
43 </table>
44 </context>
45 </generatorConfiguration>
3.添加jdbc.properties數據庫連接配置文件。需要注意的是mysql8.0之后,driverClass的包名有變化。
1 jdbc.driverClass=com.mysql.jdbc.Driver 2 #8.0之后:jdbc.driverClass=com.mysql.cj.jdbc.Driver 3 jdbc.connectionURL=jdbc:mysql://127.0.0.1:3306/dbtest?useUnicode=true&characterEncoding=utf-8&useSSL=false 4 jdbc.username=root 5 jdbc.password=root
4.經過上述步驟后,工程結構如下圖所示。
5.萬事俱備,自動構建,啟動。雙擊mybatis-generator插件下的mybatis-generator:generate指令,開始自動構建。構建完成后,項目中就多了entity、dao、mapper,美滋滋啊!
6.現在簡單查一查數據庫,看這玩意兒好不好使。這里我使用的是阿里巴巴的的druid,所以需要引入相關依賴。
1 <dependency> 2 <groupId>com.alibaba</groupId> 3 <artifactId>druid-spring-boot-starter</artifactId> 4 <version>1.1.10</version> 5 </dependency> 6 <dependency> 7 <groupId>mysql</groupId> 8 <artifactId>mysql-connector-java</artifactId> 9 </dependency>
並在application.yml配置文件中添加相關的配置,包括druid和mybatis。
1 spring: 2 datasource: 3 druid: 4 url: jdbc:mysql://127.0.0.1:3306/dbtest?useUnicode=true&characterEncoding=utf-8&useSSL=false 5 username: root 6 password: root 7 initial-size: 1 8 min-idle: 1 9 max-active: 20 10 test-on-borrow: true 11 driver-class-name: com.mysql.jdbc.Driver 12 #MySQL 8.x: driver-class-name: com.mysql.cj.jdbc.Driver 13 14 mybatis: 15 type-aliases-package: com.senda.hello.spring.boot.mybatis.entity 16 mapper-locations: classpath:mapper/*.xml
還需要在啟動類加上MapperScan注解,指明Dao的位置。注意這里引入的是tk包下的MapperScan。
1 package com.senda.hello.spring.boot.mybatis; 2 3 import org.springframework.boot.SpringApplication; 4 import org.springframework.boot.autoconfigure.SpringBootApplication; 5 import tk.mybatis.spring.annotation.MapperScan; 6 7 @SpringBootApplication 8 @MapperScan(basePackages = "com.senda.hello.spring.boot.mapper") 9 public class HelloSpringBootMybatisApplication { 10 11 public static void main(String[] args) { 12 SpringApplication.run(HelloSpringBootMybatisApplication.class, args); 13 } 14 15 }
寫個測試方法,玩一玩吧!注意要在SpringBootTest注解里注明測試類,為了加載配置文件。
1 package com.senda.hello.spring.boot.mybatis; 2 3 import com.senda.hello.spring.boot.mapper.TbUserMapper; 4 import com.senda.hello.spring.boot.entity.TbUser; 5 import org.junit.Test; 6 import org.junit.runner.RunWith; 7 import org.springframework.beans.factory.annotation.Autowired; 8 import org.springframework.boot.test.context.SpringBootTest; 9 import org.springframework.test.context.junit4.SpringRunner; 10 11 import java.util.List; 12 13 @RunWith(SpringRunner.class) 14 @SpringBootTest(classes = HelloSpringBootMybatisApplication.class) 15 public class HelloSpringBootMybatisApplicationTests { 16 17 @Autowired 18 private TbUserMapper userMapper; 19 20 @Test 21 public void testSelect() { 22 List<TbUser> userList = userMapper.selectAll(); 23 for (TbUser user : userList) 24 System.out.println(user.getLoginname()); 25 } 26 27 }
運行測試類,Oops!報錯了!!!發現SQL語句錯了,數據庫和表名字中間多了一個點。腫么肥四。搞了這么大半天,你跟我說用不了嗎?
org.springframework.jdbc.BadSqlGrammarException:
### Error querying database. Cause: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '.tb_user' at line 1
### The error may exist in com/senda/hello/spring/boot/mapper/TbUserMapper.java (best guess)
### The error may involve defaultParameterMap
### The error occurred while setting parameters
### SQL: SELECT uid,loginname,loginpass,email,status,activationCode FROM dbtest..tb_user
### Cause: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '.tb_user' at line 1
; bad SQL grammar []; nested exception is com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '.tb_user' at line 1
遇到問題,要解決啊!!!打開生成的TbUser實體類,我們驚訝的發現,table的名字竟然多了一個點。趕緊刪除,再運行測試方法。bingo,完美運行,問題解決了。
三、分析問題
問題真的解決了么?真正的項目,動輒幾十、幾百張表的,難道要一個個刪點么?人家這么成熟的插件,難道會煩這么低級的錯誤?因為Entity、Dao、mapper都是根據generatorConfig.xml文件來生成的。所以,只可能是這個配置文件那里配錯了。那么到底是那里配錯了呢?
1.首先,我們需要知道,database、schema、catalog三者的聯系與區別。
按照SQL標准的解釋,在SQL環境下Catalog和Schema都屬於抽象概念,可以把它們理解為一個容器或者數據庫對象命名空間中的一個層次,主要 用來解決命名沖突問題。從概念上說,一個數據庫系統包含多個Catalog,每個Catalog又包含多個Schema,而每個Schema又包含多個數 據庫對象(表、視圖、字段等),反過來講一個數據庫對象必然屬於一個Schema,而該Schema又必然屬於一個Catalog,這樣我們就可以得到該數據庫對象的完全限定名稱從而解決命名沖突的問題了;例如數據庫對象表的完全限定名稱就可以表示為:Catalog名稱.Schema名稱.表名稱。這里 還有一點需要注意的是,SQL標准並不要求每個數據庫對象的完全限定名稱是唯一的,就象域名一樣,如果喜歡的話,每個IP地址都可以擁有多個域名。
MySQL 5.5的官方文檔是這么說的:
CREATE DATABASE creates a database with the given name. To use this statement, you need the CREATE privilege for the database. CREATE SCHEMA is a synonym for CREATE DATABASE.
[譯]
CREATE DATABASE根據給定的名稱創建數據庫。
你需要擁有數據庫的CREATE權限來使用這個語句。
CREATE SCHEMA是CREATE DATABASE的一個代名詞。
也就是說,在MySQL中,schema和database是同一個玩意兒。而MySQL又不支持catalog,所以,我們平常看到的MySQL數據庫對象表的完全限定名稱是:database.table.
下面給出常用數據庫對catalog、schema的支持情況:
供應商 |
Catalog支持 |
Schema支持 |
Oracle |
不支持 |
Oracle User ID |
MySQL |
不支持 |
數據庫名 |
MS SQL Server |
數據庫名 |
對象屬主名,2005版開始有變 |
DB2 |
指定數據庫對象時,Catalog部分省略 |
Catalog屬主名 |
Sybase |
數據庫名 |
數據庫屬主名 |
Informix |
不支持 |
不需要 |
PointBase |
不支持 |
數據庫名 |
2.好了,回歸我們的問題。有了上述背景知識,我們就可以快速定位generatorConfig.xml文件配置錯誤的地方了。在table節點,我們配置了catalog屬性為database名稱。現在一眼就知道配置錯了,無中生有,刪掉該屬性。
為了保險起見,我們還要在jdbcConnection節點中添加屬性,申明當前數據庫不支持catalog。
<property name="nullCatalogMeansCurrent" value="true"/>
3.現在讓我們重新運行命令,生成Entity、Dao、mapper,生成成功后,看看TbUser的table注解,已經變成了表名字了。在運行下測試類,完美!!!還說啥,直接開花就完事兒。
、
四、附錄
完整的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 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 1,conditional:類似hierarchical; 26 2,flat:所有內容(主鍵,blob)等全部生成在一個對象中; 27 3,hierarchical:主鍵生成一個XXKey對象(key class),Blob等單獨生成一個對象,其他簡單屬性在一個對象中(record class) 28 targetRuntime: 29 1,MyBatis3:默認的值,生成基於MyBatis3.x以上版本的內容,包括XXXBySample; 30 2,MyBatis3Simple:類似MyBatis3,只是不生成XXXBySample; 31 introspectedColumnImpl:類全限定名,用於擴展MBG 32 --> 33 <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" > 34 35 <!-- 自動識別數據庫關鍵字,默認false,如果設置為true,根據SqlReservedWords中定義的關鍵字列表; 36 一般保留默認值,遇到數據庫關鍵字(Java關鍵字),使用columnOverride覆蓋 37 --> 38 <property name="autoDelimitKeywords" value="false"/> 39 <!-- 生成的Java文件的編碼 --> 40 <property name="javaFileEncoding" value="UTF-8"/> 41 <!-- 格式化java代碼 --> 42 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 43 <!-- 格式化XML代碼 --> 44 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 45 46 <!-- beginningDelimiter和endingDelimiter:指明數據庫的用於標記數據庫對象名的符號,比如ORACLE就是雙引號,MYSQL默認是`反引號; --> 47 <property name="beginningDelimiter" value="`"/> 48 <property name="endingDelimiter" value="`"/> 49 50 <!-- 必須要有的,使用這個配置鏈接數據庫 51 @TODO:是否可以擴展 52 --> 53 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin"> 54 <!-- 這里面可以設置property屬性,每一個property屬性都設置到配置的Driver上 --> 55 </jdbcConnection> 56 57 <!-- java類型處理器 58 用於處理DB中的類型到Java中的類型,默認使用JavaTypeResolverDefaultImpl; 59 注意一點,默認會先嘗試使用Integer,Long,Short等來對應DECIMAL和 NUMERIC數據類型; 60 --> 61 <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> 62 <!-- 63 true:使用BigDecimal對應DECIMAL和 NUMERIC數據類型 64 false:默認, 65 scale>0;length>18:使用BigDecimal; 66 scale=0;length[10,18]:使用Long; 67 scale=0;length[5,9]:使用Integer; 68 scale=0;length<5:使用Short; 69 --> 70 <property name="forceBigDecimals" value="false"/> 71 </javaTypeResolver> 72 73 74 <!-- java模型創建器,是必須要的元素 75 負責:1,key類(見context的defaultModelType);2,java類;3,查詢類 76 targetPackage:生成的類要放的包,真實的包受enableSubPackages屬性控制; 77 targetProject:目標項目,指定一個存在的目錄下,生成的內容會放到指定目錄中,如果目錄不存在,MBG不會自動建目錄 78 --> 79 <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java"> 80 <!-- for MyBatis3/MyBatis3Simple 81 自動為每一個生成的類創建一個構造方法,構造方法包含了所有的field;而不是使用setter; 82 --> 83 <property name="constructorBased" value="false"/> 84 85 <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認為false --> 86 <property name="enableSubPackages" value="true"/> 87 88 <!-- for MyBatis3 / MyBatis3Simple 89 是否創建一個不可變的類,如果為true, 90 那么MBG會創建一個沒有setter方法的類,取而代之的是類似constructorBased的類 91 --> 92 <property name="immutable" value="false"/> 93 94 <!-- 設置一個根對象, 95 如果設置了這個根對象,那么生成的keyClass或者recordClass會繼承這個類;在Table的rootClass屬性中可以覆蓋該選項 96 注意:如果在key class或者record class中有root class相同的屬性,MBG就不會重新生成這些屬性了,包括: 97 1,屬性名相同,類型相同,有相同的getter/setter方法; 98 --> 99 <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/> 100 101 <!-- 設置是否在getter方法中,對String類型字段調用trim()方法 --> 102 <property name="trimStrings" value="true"/> 103 </javaModelGenerator> 104 105 106 <!-- 生成SQL map的XML文件生成器, 107 注意,在Mybatis3之后,我們可以使用mapper.xml文件+Mapper接口(或者不用mapper接口), 108 或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的話,這個元素就必須配置 109 targetPackage/targetProject:同javaModelGenerator 110 --> 111 <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources"> 112 <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認為false --> 113 <property name="enableSubPackages" value="true"/> 114 </sqlMapGenerator> 115 116 117 <!-- 對於mybatis來說,即生成Mapper接口,注意,如果沒有配置該元素,那么默認不會生成Mapper接口 118 targetPackage/targetProject:同javaModelGenerator 119 type:選擇怎么生成mapper接口(在MyBatis3/MyBatis3Simple下): 120 1,ANNOTATEDMAPPER:會生成使用Mapper接口+Annotation的方式創建(SQL生成在annotation中),不會生成對應的XML; 121 2,MIXEDMAPPER:使用混合配置,會生成Mapper接口,並適當添加合適的Annotation,但是XML會生成在XML中; 122 3,XMLMAPPER:會生成Mapper接口,接口完全依賴XML; 123 注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER 124 --> 125 <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java"> 126 <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認為false --> 127 <property name="enableSubPackages" value="true"/> 128 129 <!-- 可以為所有生成的接口添加一個父接口,但是MBG只負責生成,不負責檢查 130 <property name="rootInterface" value=""/> 131 --> 132 </javaClientGenerator> 133 134 <!-- 選擇一個table來生成相關文件,可以有一個或多個table,必須要有table元素 135 選擇的table會生成一下文件: 136 1,SQL map文件 137 2,生成一個主鍵類; 138 3,除了BLOB和主鍵的其他字段的類; 139 4,包含BLOB的類; 140 5,一個用戶生成動態查詢的條件類(selectByExample, deleteByExample),可選; 141 6,Mapper接口(可選) 142 143 tableName(必要):要生成對象的表名; 144 注意:大小寫敏感問題。正常情況下,MBG會自動的去識別數據庫標識符的大小寫敏感度,在一般情況下,MBG會 145 根據設置的schema,catalog或tablename去查詢數據表,按照下面的流程: 146 1,如果schema,catalog或tablename中有空格,那么設置的是什么格式,就精確的使用指定的大小寫格式去查詢; 147 2,否則,如果數據庫的標識符使用大寫的,那么MBG自動把表名變成大寫再查找; 148 3,否則,如果數據庫的標識符使用小寫的,那么MBG自動把表名變成小寫再查找; 149 4,否則,使用指定的大小寫格式查詢; 150 另外的,如果在創建表的時候,使用的""把數據庫對象規定大小寫,就算數據庫標識符是使用的大寫,在這種情況下也會使用給定的大小寫來創建表名; 151 這個時候,請設置delimitIdentifiers="true"即可保留大小寫格式; 152 153 可選: 154 1,schema:數據庫的schema; 155 2,catalog:數據庫的catalog; 156 3,alias:為數據表設置的別名,如果設置了alias,那么生成的所有的SELECT SQL語句中,列名會變成:alias_actualColumnName 157 4,domainObjectName:生成的domain類的名字,如果不設置,直接使用表名作為domain類的名字;可以設置為somepck.domainName,那么會自動把domainName類再放到somepck包里面; 158 5,enableInsert(默認true):指定是否生成insert語句; 159 6,enableSelectByPrimaryKey(默認true):指定是否生成按照主鍵查詢對象的語句(就是getById或get); 160 7,enableSelectByExample(默認true):MyBatis3Simple為false,指定是否生成動態查詢語句; 161 8,enableUpdateByPrimaryKey(默認true):指定是否生成按照主鍵修改對象的語句(即update); 162 9,enableDeleteByPrimaryKey(默認true):指定是否生成按照主鍵刪除對象的語句(即delete); 163 10,enableDeleteByExample(默認true):MyBatis3Simple為false,指定是否生成動態刪除語句; 164 11,enableCountByExample(默認true):MyBatis3Simple為false,指定是否生成動態查詢總條數語句(用於分頁的總條數查詢); 165 12,enableUpdateByExample(默認true):MyBatis3Simple為false,指定是否生成動態修改語句(只修改對象中不為空的屬性); 166 13,modelType:參考context元素的defaultModelType,相當於覆蓋; 167 14,delimitIdentifiers:參考tableName的解釋,注意,默認的delimitIdentifiers是雙引號,如果類似MYSQL這樣的數據庫,使用的是`(反引號,那么還需要設置context的beginningDelimiter和endingDelimiter屬性) 168 15,delimitAllColumns:設置是否所有生成的SQL中的列名都使用標識符引起來。默認為false,delimitIdentifiers參考context的屬性 169 170 注意,table里面很多參數都是對javaModelGenerator,context等元素的默認屬性的一個復寫; 171 --> 172 <table tableName="userinfo" > 173 174 <!-- 參考 javaModelGenerator 的 constructorBased屬性--> 175 <property name="constructorBased" value="false"/> 176 177 <!-- 默認為false,如果設置為true,在生成的SQL中,table名字不會加上catalog或schema; --> 178 <property name="ignoreQualifiersAtRuntime" value="false"/> 179 180 <!-- 參考 javaModelGenerator 的 immutable 屬性 --> 181 <property name="immutable" value="false"/> 182 183 <!-- 指定是否只生成domain類,如果設置為true,只生成domain類,如果還配置了sqlMapGenerator,那么在mapper XML文件中,只生成resultMap元素 --> 184 <property name="modelOnly" value="false"/> 185 186 <!-- 參考 javaModelGenerator 的 rootClass 屬性 187 <property name="rootClass" value=""/> 188 --> 189 190 <!-- 參考javaClientGenerator 的 rootInterface 屬性 191 <property name="rootInterface" value=""/> 192 --> 193 194 <!-- 如果設置了runtimeCatalog,那么在生成的SQL中,使用該指定的catalog,而不是table元素上的catalog 195 <property name="runtimeCatalog" value=""/> 196 --> 197 198 <!-- 如果設置了runtimeSchema,那么在生成的SQL中,使用該指定的schema,而不是table元素上的schema 199 <property name="runtimeSchema" value=""/> 200 --> 201 202 <!-- 如果設置了runtimeTableName,那么在生成的SQL中,使用該指定的tablename,而不是table元素上的tablename 203 <property name="runtimeTableName" value=""/> 204 --> 205 206 <!-- 注意,該屬性只針對MyBatis3Simple有用; 207 如果選擇的runtime是MyBatis3Simple,那么會生成一個SelectAll方法,如果指定了selectAllOrderByClause,那么會在該SQL中添加指定的這個order條件; 208 --> 209 <property name="selectAllOrderByClause" value="age desc,username asc"/> 210 211 <!-- 如果設置為true,生成的model類會直接使用column本身的名字,而不會再使用駝峰命名方法,比如BORN_DATE,生成的屬性名字就是BORN_DATE,而不會是bornDate --> 212 <property name="useActualColumnNames" value="false"/> 213 214 215 <!-- generatedKey用於生成生成主鍵的方法, 216 如果設置了該元素,MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素,該元素可選 217 column:主鍵的列名; 218 sqlStatement:要生成的selectKey語句,有以下可選項: 219 Cloudscape:相當於selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL() 220 DB2 :相當於selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL() 221 DB2_MF :相當於selectKey的SQL為:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1 222 Derby :相當於selectKey的SQL為:VALUES IDENTITY_VAL_LOCAL() 223 HSQLDB :相當於selectKey的SQL為:CALL IDENTITY() 224 Informix :相當於selectKey的SQL為:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1 225 MySql :相當於selectKey的SQL為:SELECT LAST_INSERT_ID() 226 SqlServer :相當於selectKey的SQL為:SELECT SCOPE_IDENTITY() 227 SYBASE :相當於selectKey的SQL為:SELECT @@IDENTITY 228 JDBC :相當於在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性 229 <generatedKey column="" sqlStatement=""/> 230 --> 231 232 <!-- 233 該元素會在根據表中列名計算對象屬性名之前先重命名列名,非常適合用於表中的列都有公用的前綴字符串的時候, 234 比如列名為:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等; 235 那么就可以設置searchString為"^CUST_",並使用空白替換,那么生成的Customer對象中的屬性名稱就不是 236 custId,custName等,而是先被替換為ID,NAME,EMAIL,然后變成屬性:id,name,email; 237 238 注意,MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的, 239 如果使用了columnOverride元素,該屬性無效; 240 241 <columnRenamingRule searchString="" replaceString=""/> 242 --> 243 244 245 <!-- 用來修改表中某個列的屬性,MBG會使用修改后的列來生成domain的屬性; 246 column:要重新設置的列名; 247 注意,一個table元素中可以有多個columnOverride元素哈~ 248 --> 249 <columnOverride column="username"> 250 <!-- 使用property屬性來指定列要生成的屬性名稱 --> 251 <property name="property" value="userName"/> 252 253 <!-- javaType用於指定生成的domain的屬性類型,使用類型的全限定名 254 <property name="javaType" value=""/> 255 --> 256 257 <!-- jdbcType用於指定該列的JDBC類型 258 <property name="jdbcType" value=""/> 259 --> 260 261 <!-- typeHandler 用於指定該列使用到的TypeHandler,如果要指定,配置類型處理器的全限定名 262 注意,mybatis中,不會生成到mybatis-config.xml中的typeHandler 263 只會生成類似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數描述 264 <property name="jdbcType" value=""/> 265 --> 266 267 <!-- 參考table元素的delimitAllColumns配置,默認為false 268 <property name="delimitedColumnName" value=""/> 269 --> 270 </columnOverride> 271 272 <!-- ignoreColumn設置一個MGB忽略的列,如果設置了改列,那么在生成的domain中,生成的SQL中,都不會有該列出現 273 column:指定要忽略的列的名字; 274 delimitedColumnName:參考table元素的delimitAllColumns配置,默認為false 275 276 注意,一個table元素中可以有多個ignoreColumn元素 277 <ignoreColumn column="deptId" delimitedColumnName=""/> 278 --> 279 </table> 280 281 </context> 282 283 </generatorConfiguration>
[完]