當(dāng)前位置：首頁(yè) > 编程语言 > asp.net >内容正文

asp.net

mybatis入门（二）之XML 映射配置文件

發(fā)布時(shí)間：2023/12/3 asp.net 23 豆豆

生活随笔收集整理的這篇文章主要介紹了 mybatis入门（二）之XML 映射配置文件小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

轉(zhuǎn)載自? ?mybatis XML 映射配置文件

MyBatis 的配置文件包含了會(huì)深深影響 MyBatis 行為的設(shè)置（settings）和屬性（properties）信息。文檔的頂層結(jié)構(gòu)如下：

configuration 配置
- properties 屬性
- settings 設(shè)置
- typeAliases 類(lèi)型別名
- typeHandlers 類(lèi)型處理器
- objectFactory 對(duì)象工廠
- plugins 插件
- environments 環(huán)境
  - environment 環(huán)境變量
    - transactionManager 事務(wù)管理器
    - dataSource 數(shù)據(jù)源
- databaseIdProvider 數(shù)據(jù)庫(kù)廠商標(biāo)識(shí)
- mappers 映射器

properties

這些屬性都是可外部配置且可動(dòng)態(tài)替換的，既可以在典型的 Java 屬性文件中配置，亦可通過(guò) properties 元素的子元素來(lái)傳遞。例如：

然后其中的屬性就可以在整個(gè)配置文件中被用來(lái)替換需要?jiǎng)討B(tài)配置的屬性值。比如:

這個(gè)例子中的 username 和 password 將會(huì)由 properties 元素中設(shè)置的相應(yīng)值來(lái)替換。 driver 和 url 屬性將會(huì)由 config.properties 文件中對(duì)應(yīng)的值來(lái)替換。這樣就為配置提供了諸多靈活選擇。

屬性也可以被傳遞到 SqlSessionFactoryBuilder.build()方法中。例如：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);// ... or ...SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

如果屬性在不只一個(gè)地方進(jìn)行了配置，那么 MyBatis 將按照下面的順序來(lái)加載：

在 properties 元素體內(nèi)指定的屬性首先被讀取。
然后根據(jù) properties 元素中的 resource 屬性讀取類(lèi)路徑下屬性文件或根據(jù) url 屬性指定的路徑讀取屬性文件，并覆蓋已讀取的同名屬性。
最后讀取作為方法參數(shù)傳遞的屬性，并覆蓋已讀取的同名屬性。

因此，通過(guò)方法參數(shù)傳遞的屬性具有最高優(yōu)先級(jí)，resource/url 屬性中指定的配置文件次之，最低優(yōu)先級(jí)的是 properties 屬性中指定的屬性。

從MyBatis 3.4.2開(kāi)始，你可以為占位符指定一個(gè)默認(rèn)值。例如：

這個(gè)特性默認(rèn)是關(guān)閉的。如果你想為占位符指定一個(gè)默認(rèn)值，你應(yīng)該添加一個(gè)指定的屬性來(lái)開(kāi)啟這個(gè)特性。例如：

提示?你可以使用?":"?作為屬性鍵(e.g.?db:username) 或者你也可以在sql定義中使用 OGNL 表達(dá)式的三元運(yùn)算符(e.g.?${tableName != null ? tableName : 'global_constants'})，你應(yīng)該通過(guò)增加一個(gè)指定的屬性來(lái)改變分隔鍵和默認(rèn)值的字符。例如：

settings

這是 MyBatis 中極為重要的調(diào)整設(shè)置，它們會(huì)改變 MyBatis 的運(yùn)行時(shí)行為。下表描述了設(shè)置中各項(xiàng)的意圖、默認(rèn)值等。

設(shè)置參數(shù)描述有效值默認(rèn)值

cacheEnabled	全局地開(kāi)啟或關(guān)閉配置文件中的所有映射器已經(jīng)配置的任何緩存。	true \| false	true
lazyLoadingEnabled	延遲加載的全局開(kāi)關(guān)。當(dāng)開(kāi)啟時(shí)，所有關(guān)聯(lián)對(duì)象都會(huì)延遲加載。特定關(guān)聯(lián)關(guān)系中可通過(guò)設(shè)置fetchType屬性來(lái)覆蓋該項(xiàng)的開(kāi)關(guān)狀態(tài)。	true \| false	false
aggressiveLazyLoading	當(dāng)開(kāi)啟時(shí)，任何方法的調(diào)用都會(huì)加載該對(duì)象的所有屬性。否則，每個(gè)屬性會(huì)按需加載（參考lazyLoadTriggerMethods).	true \| false	false (true in ≤3.4.1)
multipleResultSetsEnabled	是否允許單一語(yǔ)句返回多結(jié)果集（需要兼容驅(qū)動(dòng)）。	true \| false	true
useColumnLabel	使用列標(biāo)簽代替列名。不同的驅(qū)動(dòng)在這方面會(huì)有不同的表現(xiàn)，具體可參考相關(guān)驅(qū)動(dòng)文檔或通過(guò)測(cè)試這兩種不同的模式來(lái)觀察所用驅(qū)動(dòng)的結(jié)果。	true \| false	true
useGeneratedKeys	允許 JDBC 支持自動(dòng)生成主鍵，需要驅(qū)動(dòng)兼容。如果設(shè)置為 true 則這個(gè)設(shè)置強(qiáng)制使用自動(dòng)生成主鍵，盡管一些驅(qū)動(dòng)不能兼容但仍可正常工作（比如 Derby）。	true \| false	False
autoMappingBehavior	指定 MyBatis 應(yīng)如何自動(dòng)映射列到字段或?qū)傩浴?NONE 表示取消自動(dòng)映射；PARTIAL 只會(huì)自動(dòng)映射沒(méi)有定義嵌套結(jié)果集映射的結(jié)果集。 FULL 會(huì)自動(dòng)映射任意復(fù)雜的結(jié)果集（無(wú)論是否嵌套）。	NONE, PARTIAL, FULL	PARTIAL
autoMappingUnknownColumnBehavior	指定發(fā)現(xiàn)自動(dòng)映射目標(biāo)未知列（或者未知屬性類(lèi)型）的行為。 NONE: 不做任何反應(yīng) WARNING: 輸出提醒日志 ('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior'的日志等級(jí)必須設(shè)置為?WARN) FAILING: 映射失敗 (拋出?SqlSessionException)	NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默認(rèn)的執(zhí)行器。SIMPLE 就是普通的執(zhí)行器；REUSE 執(zhí)行器會(huì)重用預(yù)處理語(yǔ)句（prepared statements）； BATCH 執(zhí)行器將重用語(yǔ)句并執(zhí)行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	設(shè)置超時(shí)時(shí)間，它決定驅(qū)動(dòng)等待數(shù)據(jù)庫(kù)響應(yīng)的秒數(shù)。	任意正整數(shù)	Not Set (null)
defaultFetchSize	為驅(qū)動(dòng)的結(jié)果集獲取數(shù)量（fetchSize）設(shè)置一個(gè)提示值。此參數(shù)只可以在查詢?cè)O(shè)置中被覆蓋。	任意正整數(shù)	Not Set (null)
safeRowBoundsEnabled	允許在嵌套語(yǔ)句中使用分頁(yè)（RowBounds）。如果允許使用則設(shè)置為false。	true \| false	False
safeResultHandlerEnabled	允許在嵌套語(yǔ)句中使用分頁(yè)（ResultHandler）。如果允許使用則設(shè)置為false。	true \| false	True
mapUnderscoreToCamelCase	是否開(kāi)啟自動(dòng)駝峰命名規(guī)則（camel case）映射，即從經(jīng)典數(shù)據(jù)庫(kù)列名 A_COLUMN 到經(jīng)典 Java 屬性名 aColumn 的類(lèi)似映射。	true \| false	False
localCacheScope	MyBatis 利用本地緩存機(jī)制（Local Cache）防止循環(huán)引用（circular references）和加速重復(fù)嵌套查詢。默認(rèn)值為 SESSION，這種情況下會(huì)緩存一個(gè)會(huì)話中執(zhí)行的所有查詢。若設(shè)置值為 STATEMENT，本地會(huì)話僅用在語(yǔ)句執(zhí)行上，對(duì)相同 SqlSession 的不同調(diào)用將不會(huì)共享數(shù)據(jù)。	SESSION \| STATEMENT	SESSION
jdbcTypeForNull	當(dāng)沒(méi)有為參數(shù)提供特定的 JDBC 類(lèi)型時(shí)，為空值指定 JDBC 類(lèi)型。某些驅(qū)動(dòng)需要指定列的 JDBC 類(lèi)型，多數(shù)情況直接用一般類(lèi)型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量. 大多都為: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定哪個(gè)對(duì)象的方法觸發(fā)一次延遲加載。	用逗號(hào)分隔的方法列表。	equals,clone,hashCode,toString
defaultScriptingLanguage	指定動(dòng)態(tài) SQL 生成的默認(rèn)語(yǔ)言。	一個(gè)類(lèi)型別名或完全限定類(lèi)名。	org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
defaultEnumTypeHandler	指定 Enum 使用的默認(rèn)?TypeHandler?。 (從3.4.5開(kāi)始)	一個(gè)類(lèi)型別名或完全限定類(lèi)名。	org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls	指定當(dāng)結(jié)果集中值為 null 的時(shí)候是否調(diào)用映射對(duì)象的 setter（map 對(duì)象時(shí)為 put）方法，這對(duì)于有 Map.keySet() 依賴(lài)或 null 值初始化的時(shí)候是有用的。注意基本類(lèi)型（int、boolean等）是不能設(shè)置成 null 的。	true \| false	false
returnInstanceForEmptyRow	當(dāng)返回行的所有列都是空時(shí)，MyBatis默認(rèn)返回null。當(dāng)開(kāi)啟這個(gè)設(shè)置時(shí)，MyBatis會(huì)返回一個(gè)空實(shí)例。請(qǐng)注意，它也適用于嵌套的結(jié)果集 (i.e. collectioin and association)。（從3.4.2開(kāi)始）	true \| false	false
logPrefix	指定 MyBatis 增加到日志名稱(chēng)的前綴。	任何字符串	Not set
logImpl	指定 MyBatis 所用日志的具體實(shí)現(xiàn)，未指定時(shí)將自動(dòng)查找。	SLF4J \| LOG4J \| LOG4J2 \| JDK_LOGGING \| COMMONS_LOGGING \| STDOUT_LOGGING \| NO_LOGGING	Not set
proxyFactory	指定 Mybatis 創(chuàng)建具有延遲加載能力的對(duì)象所用到的代理工具。	CGLIB \| JAVASSIST	JAVASSIST (MyBatis 3.3 or above)
vfsImpl	指定VFS的實(shí)現(xiàn)	自定義VFS的實(shí)現(xiàn)的類(lèi)全限定名，以逗號(hào)分隔。	Not set
useActualParamName	允許使用方法簽名中的名稱(chēng)作為語(yǔ)句參數(shù)名稱(chēng)。為了使用該特性，你的工程必須采用Java 8編譯，并且加上-parameters選項(xiàng)。（從3.4.1開(kāi)始）	true \| false	true
configurationFactory	指定一個(gè)提供Configuration實(shí)例的類(lèi)。這個(gè)被返回的Configuration實(shí)例用來(lái)加載被反序列化對(duì)象的懶加載屬性值。這個(gè)類(lèi)必須包含一個(gè)簽名方法static Configuration getConfiguration(). (從 3.2.3 版本開(kāi)始)	類(lèi)型別名或者全類(lèi)名.	Not set

一個(gè)配置完整的 settings 元素的示例如下：

typeAliases

類(lèi)型別名是為 Java 類(lèi)型設(shè)置一個(gè)短的名字。它只和 XML 配置有關(guān)，存在的意義僅在于用來(lái)減少類(lèi)完全限定名的冗余。例如:

當(dāng)這樣配置時(shí)，Blog可以用在任何使用domain.blog.Blog的地方。

也可以指定一個(gè)包名，MyBatis 會(huì)在包名下面搜索需要的 Java Bean，比如:

每一個(gè)在包?domain.blog?中的 Java Bean，在沒(méi)有注解的情況下，會(huì)使用 Bean 的首字母小寫(xiě)的非限定類(lèi)名來(lái)作為它的別名。比如?domain.blog.Author?的別名為?author；若有注解，則別名為其注解值。看下面的例子：

@Alias("author") public class Author {... }

這是一些為常見(jiàn)的 Java 類(lèi)型內(nèi)建的相應(yīng)的類(lèi)型別名。它們都是大小寫(xiě)不敏感的，需要注意的是由基本類(lèi)型名稱(chēng)重復(fù)導(dǎo)致的特殊處理。

別名映射的類(lèi)型

_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

typeHandlers

無(wú)論是 MyBatis 在預(yù)處理語(yǔ)句（PreparedStatement）中設(shè)置一個(gè)參數(shù)時(shí)，還是從結(jié)果集中取出一個(gè)值時(shí)，都會(huì)用類(lèi)型處理器將獲取的值以合適的方式轉(zhuǎn)換成 Java 類(lèi)型。下表描述了一些默認(rèn)的類(lèi)型處理器。

提示?從 3.4.5 開(kāi)始，MyBatis 默認(rèn)支持 JSR-310(日期和時(shí)間 API) 。

類(lèi)型處理器Java 類(lèi)型JDBC 類(lèi)型

BooleanTypeHandler	java.lang.Boolean,?boolean	數(shù)據(jù)庫(kù)兼容的?BOOLEAN
ByteTypeHandler	java.lang.Byte,?byte	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?BYTE
ShortTypeHandler	java.lang.Short,?short	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?SHORT INTEGER
IntegerTypeHandler	java.lang.Integer,?int	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?INTEGER
LongTypeHandler	java.lang.Long,?long	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?LONG INTEGER
FloatTypeHandler	java.lang.Float,?float	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?FLOAT
DoubleTypeHandler	java.lang.Double,?double	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?DOUBLE
BigDecimalTypeHandler	java.math.BigDecimal	數(shù)據(jù)庫(kù)兼容的?NUMERIC?或?DECIMAL
StringTypeHandler	java.lang.String	CHAR,?VARCHAR
ClobReaderTypeHandler	java.io.Reader	-
ClobTypeHandler	java.lang.String	CLOB,?LONGVARCHAR
NStringTypeHandler	java.lang.String	NVARCHAR,?NCHAR
NClobTypeHandler	java.lang.String	NCLOB
BlobInputStreamTypeHandler	java.io.InputStream	-
ByteArrayTypeHandler	byte[]	數(shù)據(jù)庫(kù)兼容的字節(jié)流類(lèi)型
BlobTypeHandler	byte[]	BLOB,?LONGVARBINARY
DateTypeHandler	java.util.Date	TIMESTAMP
DateOnlyTypeHandler	java.util.Date	DATE
TimeOnlyTypeHandler	java.util.Date	TIME
SqlTimestampTypeHandler	java.sql.Timestamp	TIMESTAMP
SqlDateTypeHandler	java.sql.Date	DATE
SqlTimeTypeHandler	java.sql.Time	TIME
ObjectTypeHandler	Any	OTHER?或未指定類(lèi)型
EnumTypeHandler	Enumeration Type	VARCHAR-任何兼容的字符串類(lèi)型，存儲(chǔ)枚舉的名稱(chēng)（而不是索引）
EnumOrdinalTypeHandler	Enumeration Type	任何兼容的?NUMERIC?或?DOUBLE?類(lèi)型，存儲(chǔ)枚舉的索引（而不是名稱(chēng)）。
InstantTypeHandler	java.time.Instant	TIMESTAMP
LocalDateTimeTypeHandler	java.time.LocalDateTime	TIMESTAMP
LocalDateTypeHandler	java.time.LocalDate	DATE
LocalTimeTypeHandler	java.time.LocalTime	TIME
OffsetDateTimeTypeHandler	java.time.OffsetDateTime	TIMESTAMP
OffsetTimeTypeHandler	java.time.OffsetTime	TIME
ZonedDateTimeTypeHandler	java.time.ZonedDateTime	TIMESTAMP
YearTypeHandler	java.time.Year	INTEGER
MonthTypeHandler	java.time.Month	INTEGER
YearMonthTypeHandler	java.time.YearMonth	VARCHAR?or?LONGVARCHAR
JapaneseDateTypeHandler	java.time.chrono.JapaneseDate	DATE

你可以重寫(xiě)類(lèi)型處理器或創(chuàng)建你自己的類(lèi)型處理器來(lái)處理不支持的或非標(biāo)準(zhǔn)的類(lèi)型。具體做法為：實(shí)現(xiàn)?org.apache.ibatis.type.TypeHandler?接口，或繼承一個(gè)很便利的類(lèi)?org.apache.ibatis.type.BaseTypeHandler，然后可以選擇性地將它映射到一個(gè) JDBC 類(lèi)型。比如：

// ExampleTypeHandler.java @MappedJdbcTypes(JdbcType.VARCHAR) public class ExampleTypeHandler extends BaseTypeHandler<String> {@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {ps.setString(i, parameter);}@Overridepublic String getNullableResult(ResultSet rs, String columnName) throws SQLException {return rs.getString(columnName);}@Overridepublic String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {return rs.getString(columnIndex);}@Overridepublic String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {return cs.getString(columnIndex);} }  <typeHandlers><typeHandler handler="org.mybatis.example.ExampleTypeHandler"/> </typeHandlers>

使用這個(gè)的類(lèi)型處理器將會(huì)覆蓋已經(jīng)存在的處理 Java 的 String 類(lèi)型屬性和 VARCHAR 參數(shù)及結(jié)果的類(lèi)型處理器。要注意 MyBatis 不會(huì)窺探數(shù)據(jù)庫(kù)元信息來(lái)決定使用哪種類(lèi)型，所以你必須在參數(shù)和結(jié)果映射中指明那是 VARCHAR 類(lèi)型的字段，以使其能夠綁定到正確的類(lèi)型處理器上。這是因?yàn)?#xff1a;MyBatis 直到語(yǔ)句被執(zhí)行才清楚數(shù)據(jù)類(lèi)型。

通過(guò)類(lèi)型處理器的泛型，MyBatis 可以得知該類(lèi)型處理器處理的 Java 類(lèi)型，不過(guò)這種行為可以通過(guò)兩種方法改變：

在類(lèi)型處理器的配置元素（typeHandler element）上增加一個(gè)?javaType?屬性（比如：javaType="String"）；
在類(lèi)型處理器的類(lèi)上（TypeHandler class）增加一個(gè)?@MappedTypes?注解來(lái)指定與其關(guān)聯(lián)的 Java 類(lèi)型列表。如果在?javaType?屬性中也同時(shí)指定，則注解方式將被忽略。

可以通過(guò)兩種方式來(lái)指定被關(guān)聯(lián)的 JDBC 類(lèi)型：

在類(lèi)型處理器的配置元素上增加一個(gè)?jdbcType?屬性（比如：jdbcType="VARCHAR"）；
在類(lèi)型處理器的類(lèi)上（TypeHandler class）增加一個(gè)?@MappedJdbcTypes?注解來(lái)指定與其關(guān)聯(lián)的 JDBC 類(lèi)型列表。如果在?jdbcType?屬性中也同時(shí)指定，則注解方式將被忽略。

當(dāng)決定在ResultMap中使用某一TypeHandler時(shí)，此時(shí)java類(lèi)型是已知的（從結(jié)果類(lèi)型中獲得），但是JDBC類(lèi)型是未知的。因此Mybatis使用javaType=[TheJavaType], jdbcType=null的組合來(lái)選擇一個(gè)TypeHandler。這意味著使用@MappedJdbcTypes注解可以限制TypeHandler的范圍，同時(shí)除非顯式的設(shè)置，否則TypeHandler在ResultMap中將是無(wú)效的。如果希望在ResultMap中使用TypeHandler，那么設(shè)置@MappedJdbcTypes注解的includeNullJdbcType=true即可。然而從Mybatis 3.4.0開(kāi)始，如果只有一個(gè)注冊(cè)的TypeHandler來(lái)處理Java類(lèi)型，那么它將是ResultMap使用Java類(lèi)型時(shí)的默認(rèn)值（即使沒(méi)有includeNullJdbcType=true）。

最后，可以讓 MyBatis 為你查找類(lèi)型處理器：

<typeHandlers><package name="org.mybatis.example"/> </typeHandlers>

注意在使用自動(dòng)檢索（autodiscovery）功能的時(shí)候，只能通過(guò)注解方式來(lái)指定 JDBC 的類(lèi)型。

你可以創(chuàng)建一個(gè)能夠處理多個(gè)類(lèi)的泛型類(lèi)型處理器。為了使用泛型類(lèi)型處理器，需要增加一個(gè)接受該類(lèi)的 class 作為參數(shù)的構(gòu)造器，這樣在構(gòu)造一個(gè)類(lèi)型處理器的時(shí)候 MyBatis 就會(huì)傳入一個(gè)具體的類(lèi)。

//GenericTypeHandler.java public class GenericTypeHandler<E extends MyObject> extends BaseTypeHandler<E> {private Class<E> type;public GenericTypeHandler(Class<E> type) {if (type == null) throw new IllegalArgumentException("Type argument cannot be null");this.type = type;}...

EnumTypeHandler?和?EnumOrdinalTypeHandler?都是泛型類(lèi)型處理器（generic TypeHandlers），我們將會(huì)在接下來(lái)的部分詳細(xì)探討。

處理枚舉類(lèi)型

若想映射枚舉類(lèi)型?Enum，則需要從?EnumTypeHandler?或者?EnumOrdinalTypeHandler?中選一個(gè)來(lái)使用。

比如說(shuō)我們想存儲(chǔ)取近似值時(shí)用到的舍入模式。默認(rèn)情況下，MyBatis 會(huì)利用?EnumTypeHandler?來(lái)把?Enum?值轉(zhuǎn)換成對(duì)應(yīng)的名字。

注意?EnumTypeHandler?在某種意義上來(lái)說(shuō)是比較特別的，其他的處理器只針對(duì)某個(gè)特定的類(lèi)，而它不同，它會(huì)處理任意繼承了?Enum?的類(lèi)。

不過(guò)，我們可能不想存儲(chǔ)名字，相反我們的 DBA 會(huì)堅(jiān)持使用整形值代碼。那也一樣輕而易舉：在配置文件中把?EnumOrdinalTypeHandler?加到?typeHandlers?中即可，這樣每個(gè)?RoundingMode?將通過(guò)他們的序數(shù)值來(lái)映射成對(duì)應(yīng)的整形。

<typeHandlers><typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="java.math.RoundingMode"/> </typeHandlers>

但是怎樣能將同樣的?Enum?既映射成字符串又映射成整形呢？

自動(dòng)映射器（auto-mapper）會(huì)自動(dòng)地選用?EnumOrdinalTypeHandler?來(lái)處理，所以如果我們想用普通的?EnumTypeHandler，就必須要顯式地為那些 SQL 語(yǔ)句設(shè)置要使用的類(lèi)型處理器。

（下一節(jié)才開(kāi)始介紹映射器文件，如果你是首次閱讀該文檔，你可能需要先跳過(guò)這里，過(guò)會(huì)再來(lái)看。）

<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="org.apache.ibatis.submitted.rounding.Mapper"><resultMap type="org.apache.ibatis.submitted.rounding.User" id="usermap"><id column="id" property="id"/><result column="name" property="name"/><result column="funkyNumber" property="funkyNumber"/><result column="roundingMode" property="roundingMode"/></resultMap><select id="getUser" resultMap="usermap">select * from users</select><insert id="insert">insert into users (id, name, funkyNumber, roundingMode) values (#{id}, #{name}, #{funkyNumber}, #{roundingMode})</insert><resultMap type="org.apache.ibatis.submitted.rounding.User" id="usermap2"><id column="id" property="id"/><result column="name" property="name"/><result column="funkyNumber" property="funkyNumber"/><result column="roundingMode" property="roundingMode" typeHandler="org.apache.ibatis.type.EnumTypeHandler"/></resultMap><select id="getUser2" resultMap="usermap2">select * from users2</select><insert id="insert2">insert into users2 (id, name, funkyNumber, roundingMode) values (#{id}, #{name}, #{funkyNumber}, #{roundingMode, typeHandler=org.apache.ibatis.type.EnumTypeHandler})</insert></mapper>

注意，這里的 select 語(yǔ)句強(qiáng)制使用?resultMap?來(lái)代替?resultType。

對(duì)象工廠（objectFactory）

MyBatis 每次創(chuàng)建結(jié)果對(duì)象的新實(shí)例時(shí)，它都會(huì)使用一個(gè)對(duì)象工廠（ObjectFactory）實(shí)例來(lái)完成。默認(rèn)的對(duì)象工廠需要做的僅僅是實(shí)例化目標(biāo)類(lèi)，要么通過(guò)默認(rèn)構(gòu)造方法，要么在參數(shù)映射存在的時(shí)候通過(guò)參數(shù)構(gòu)造方法來(lái)實(shí)例化。如果想覆蓋對(duì)象工廠的默認(rèn)行為，則可以通過(guò)創(chuàng)建自己的對(duì)象工廠來(lái)實(shí)現(xiàn)。比如：

// ExampleObjectFactory.java public class ExampleObjectFactory extends DefaultObjectFactory {public Object create(Class type) {return super.create(type);}public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {return super.create(type, constructorArgTypes, constructorArgs);}public void setProperties(Properties properties) {super.setProperties(properties);}public <T> boolean isCollection(Class<T> type) {return Collection.class.isAssignableFrom(type);}}  <objectFactory type="org.mybatis.example.ExampleObjectFactory"><property name="someProperty" value="100"/> </objectFactory>

ObjectFactory 接口很簡(jiǎn)單，它包含兩個(gè)創(chuàng)建用的方法，一個(gè)是處理默認(rèn)構(gòu)造方法的，另外一個(gè)是處理帶參數(shù)的構(gòu)造方法的。最后，setProperties 方法可以被用來(lái)配置 ObjectFactory，在初始化你的 ObjectFactory 實(shí)例后， objectFactory 元素體中定義的屬性會(huì)被傳遞給 setProperties 方法。

插件（plugins）

MyBatis 允許你在已映射語(yǔ)句執(zhí)行過(guò)程中的某一點(diǎn)進(jìn)行攔截調(diào)用。默認(rèn)情況下，MyBatis 允許使用插件來(lái)攔截的方法調(diào)用包括：

Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)

這些類(lèi)中方法的細(xì)節(jié)可以通過(guò)查看每個(gè)方法的簽名來(lái)發(fā)現(xiàn)，或者直接查看 MyBatis 發(fā)行包中的源代碼。如果你想做的不僅僅是監(jiān)控方法的調(diào)用，那么你最好相當(dāng)了解要重寫(xiě)的方法的行為。因?yàn)槿绻谠噲D修改或重寫(xiě)已有方法的行為的時(shí)候，你很可能在破壞 MyBatis 的核心模塊。這些都是更低層的類(lèi)和方法，所以使用插件的時(shí)候要特別當(dāng)心。

通過(guò) MyBatis 提供的強(qiáng)大機(jī)制，使用插件是非常簡(jiǎn)單的，只需實(shí)現(xiàn) Interceptor 接口，并指定想要攔截的方法簽名即可。

// ExamplePlugin.java @Intercepts({@Signature(type= Executor.class,method = "update",args = {MappedStatement.class,Object.class})}) public class ExamplePlugin implements Interceptor {public Object intercept(Invocation invocation) throws Throwable {return invocation.proceed();}public Object plugin(Object target) {return Plugin.wrap(target, this);}public void setProperties(Properties properties) {} }  <plugins><plugin interceptor="org.mybatis.example.ExamplePlugin"><property name="someProperty" value="100"/></plugin> </plugins>

上面的插件將會(huì)攔截在 Executor 實(shí)例中所有的 “update” 方法調(diào)用，這里的 Executor 是負(fù)責(zé)執(zhí)行低層映射語(yǔ)句的內(nèi)部對(duì)象。

提示?覆蓋配置類(lèi)

除了用插件來(lái)修改 MyBatis 核心行為之外，還可以通過(guò)完全覆蓋配置類(lèi)來(lái)達(dá)到目的。只需繼承后覆蓋其中的每個(gè)方法，再把它傳遞到 SqlSessionFactoryBuilder.build(myConfig) 方法即可。再次重申，這可能會(huì)嚴(yán)重影響 MyBatis 的行為，務(wù)請(qǐng)慎之又慎。

配置環(huán)境（environments）

MyBatis 可以配置成適應(yīng)多種環(huán)境，這種機(jī)制有助于將 SQL 映射應(yīng)用于多種數(shù)據(jù)庫(kù)之中，現(xiàn)實(shí)情況下有多種理由需要這么做。例如，開(kāi)發(fā)、測(cè)試和生產(chǎn)環(huán)境需要有不同的配置；或者共享相同 Schema 的多個(gè)生產(chǎn)數(shù)據(jù)庫(kù)，想使用相同的 SQL 映射。許多類(lèi)似的用例。

不過(guò)要記住：盡管可以配置多個(gè)環(huán)境，每個(gè) SqlSessionFactory 實(shí)例只能選擇其一。

所以，如果你想連接兩個(gè)數(shù)據(jù)庫(kù)，就需要?jiǎng)?chuàng)建兩個(gè) SqlSessionFactory 實(shí)例，每個(gè)數(shù)據(jù)庫(kù)對(duì)應(yīng)一個(gè)。而如果是三個(gè)數(shù)據(jù)庫(kù)，就需要三個(gè)實(shí)例，依此類(lèi)推，記起來(lái)很簡(jiǎn)單：

每個(gè)數(shù)據(jù)庫(kù)對(duì)應(yīng)一個(gè) SqlSessionFactory 實(shí)例

為了指定創(chuàng)建哪種環(huán)境，只要將它作為可選的參數(shù)傳遞給 SqlSessionFactoryBuilder 即可。可以接受環(huán)境配置的兩個(gè)方法簽名是：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果忽略了環(huán)境參數(shù)，那么默認(rèn)環(huán)境將會(huì)被加載，如下所示：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, properties);

環(huán)境元素定義了如何配置環(huán)境。

注意這里的關(guān)鍵點(diǎn):

默認(rèn)的環(huán)境 ID（比如:default="development"）。
每個(gè) environment 元素定義的環(huán)境 ID（比如:id="development"）。
事務(wù)管理器的配置（比如:type="JDBC"）。
數(shù)據(jù)源的配置（比如:type="POOLED"）。

默認(rèn)的環(huán)境和環(huán)境 ID 是自解釋的，因此一目了然。你可以對(duì)環(huán)境隨意命名，但一定要保證默認(rèn)的環(huán)境 ID 要匹配其中一個(gè)環(huán)境 ID。

事務(wù)管理器（transactionManager）

在 MyBatis 中有兩種類(lèi)型的事務(wù)管理器（也就是 type=”[JDBC|MANAGED]”）：

JDBC – 這個(gè)配置就是直接使用了 JDBC 的提交和回滾設(shè)置，它依賴(lài)于從數(shù)據(jù)源得到的連接來(lái)管理事務(wù)作用域。
MANAGED – 這個(gè)配置幾乎沒(méi)做什么。它從來(lái)不提交或回滾一個(gè)連接，而是讓容器來(lái)管理事務(wù)的整個(gè)生命周期（比如 JEE 應(yīng)用服務(wù)器的上下文）。默認(rèn)情況下它會(huì)關(guān)閉連接，然而一些容器并不希望這樣，因此需要將 closeConnection 屬性設(shè)置為 false 來(lái)阻止它默認(rèn)的關(guān)閉行為。例如: <transactionManager type="MANAGED"><property name="closeConnection" value="false"/> </transactionManager>

提示如果你正在使用 Spring + MyBatis，則沒(méi)有必要配置事務(wù)管理器，因?yàn)?Spring 模塊會(huì)使用自帶的管理器來(lái)覆蓋前面的配置。

這兩種事務(wù)管理器類(lèi)型都不需要任何屬性。它們不過(guò)是類(lèi)型別名，換句話說(shuō)，你可以使用 TransactionFactory 接口的實(shí)現(xiàn)類(lèi)的完全限定名或類(lèi)型別名代替它們。

public interface TransactionFactory {void setProperties(Properties props); Transaction newTransaction(Connection conn);Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit); }

任何在 XML 中配置的屬性在實(shí)例化之后將會(huì)被傳遞給 setProperties() 方法。你也需要?jiǎng)?chuàng)建一個(gè) Transaction 接口的實(shí)現(xiàn)類(lèi)，這個(gè)接口也很簡(jiǎn)單：

public interface Transaction {Connection getConnection() throws SQLException;void commit() throws SQLException;void rollback() throws SQLException;void close() throws SQLException;Integer getTimeout() throws SQLException; }

使用這兩個(gè)接口，你可以完全自定義 MyBatis 對(duì)事務(wù)的處理。

數(shù)據(jù)源（dataSource）

dataSource 元素使用標(biāo)準(zhǔn)的 JDBC 數(shù)據(jù)源接口來(lái)配置 JDBC 連接對(duì)象的資源。

許多 MyBatis 的應(yīng)用程序會(huì)按示例中的例子來(lái)配置數(shù)據(jù)源。雖然這是可選的，但為了使用延遲加載，數(shù)據(jù)源是必須配置的。

有三種內(nèi)建的數(shù)據(jù)源類(lèi)型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）：

UNPOOLED– 這個(gè)數(shù)據(jù)源的實(shí)現(xiàn)只是每次被請(qǐng)求時(shí)打開(kāi)和關(guān)閉連接。雖然有點(diǎn)慢，但對(duì)于在數(shù)據(jù)庫(kù)連接可用性方面沒(méi)有太高要求的簡(jiǎn)單應(yīng)用程序來(lái)說(shuō)，是一個(gè)很好的選擇。不同的數(shù)據(jù)庫(kù)在性能方面的表現(xiàn)也是不一樣的，對(duì)于某些數(shù)據(jù)庫(kù)來(lái)說(shuō)，使用連接池并不重要，這個(gè)配置就很適合這種情形。UNPOOLED 類(lèi)型的數(shù)據(jù)源僅僅需要配置以下 5 種屬性：

driver?– 這是 JDBC 驅(qū)動(dòng)的 Java 類(lèi)的完全限定名（并不是 JDBC 驅(qū)動(dòng)中可能包含的數(shù)據(jù)源類(lèi)）。
url?– 這是數(shù)據(jù)庫(kù)的 JDBC URL 地址。
username?– 登錄數(shù)據(jù)庫(kù)的用戶名。
password?– 登錄數(shù)據(jù)庫(kù)的密碼。
defaultTransactionIsolationLevel?– 默認(rèn)的連接事務(wù)隔離級(jí)別。

作為可選項(xiàng)，你也可以傳遞屬性給數(shù)據(jù)庫(kù)驅(qū)動(dòng)。要這樣做，屬性的前綴為“driver.”，例如：

driver.encoding=UTF8

這將通過(guò) DriverManager.getConnection(url,driverProperties) 方法傳遞值為?UTF8?的?encoding?屬性給數(shù)據(jù)庫(kù)驅(qū)動(dòng)。

POOLED– 這種數(shù)據(jù)源的實(shí)現(xiàn)利用“池”的概念將 JDBC 連接對(duì)象組織起來(lái)，避免了創(chuàng)建新的連接實(shí)例時(shí)所必需的初始化和認(rèn)證時(shí)間。這是一種使得并發(fā) Web 應(yīng)用快速響應(yīng)請(qǐng)求的流行處理方式。

除了上述提到 UNPOOLED 下的屬性外，還有更多屬性用來(lái)配置 POOLED 的數(shù)據(jù)源：

poolMaximumActiveConnections?– 在任意時(shí)間可以存在的活動(dòng)（也就是正在使用）連接數(shù)量，默認(rèn)值：10
poolMaximumIdleConnections?– 任意時(shí)間可能存在的空閑連接數(shù)。
poolMaximumCheckoutTime?– 在被強(qiáng)制返回之前，池中連接被檢出（checked out）時(shí)間，默認(rèn)值：20000 毫秒（即 20 秒）
poolTimeToWait?– 這是一個(gè)底層設(shè)置，如果獲取連接花費(fèi)了相當(dāng)長(zhǎng)的時(shí)間，連接池會(huì)打印狀態(tài)日志并重新嘗試獲取一個(gè)連接（避免在誤配置的情況下一直安靜的失敗），默認(rèn)值：20000 毫秒（即 20 秒）。
poolMaximumLocalBadConnectionTolerance?– 這是一個(gè)關(guān)于壞連接容忍度的底層設(shè)置，作用于每一個(gè)嘗試從緩存池獲取連接的線程. 如果這個(gè)線程獲取到的是一個(gè)壞的連接，那么這個(gè)數(shù)據(jù)源允許這個(gè)線程嘗試重新獲取一個(gè)新的連接，但是這個(gè)重新嘗試的次數(shù)不應(yīng)該超過(guò)?poolMaximumIdleConnections?與?poolMaximumLocalBadConnectionTolerance?之和。默認(rèn)值：3 (新增于 3.4.5)
poolPingQuery?– 發(fā)送到數(shù)據(jù)庫(kù)的偵測(cè)查詢，用來(lái)檢驗(yàn)連接是否正常工作并準(zhǔn)備接受請(qǐng)求。默認(rèn)是“NO PING QUERY SET”，這會(huì)導(dǎo)致多數(shù)數(shù)據(jù)庫(kù)驅(qū)動(dòng)失敗時(shí)帶有一個(gè)恰當(dāng)?shù)腻e(cuò)誤消息。
poolPingEnabled?– 是否啟用偵測(cè)查詢。若開(kāi)啟，需要設(shè)置?poolPingQuery?屬性為一個(gè)可執(zhí)行的 SQL 語(yǔ)句（最好是一個(gè)速度非常快的 SQL 語(yǔ)句），默認(rèn)值：false。
poolPingConnectionsNotUsedFor?– 配置 poolPingQuery 的頻率。可以被設(shè)置為和數(shù)據(jù)庫(kù)連接超時(shí)時(shí)間一樣，來(lái)避免不必要的偵測(cè)，默認(rèn)值：0（即所有連接每一時(shí)刻都被偵測(cè) — 當(dāng)然僅當(dāng) poolPingEnabled 為 true 時(shí)適用）。

JNDI?– 這個(gè)數(shù)據(jù)源的實(shí)現(xiàn)是為了能在如 EJB 或應(yīng)用服務(wù)器這類(lèi)容器中使用，容器可以集中或在外部配置數(shù)據(jù)源，然后放置一個(gè) JNDI 上下文的引用。這種數(shù)據(jù)源配置只需要兩個(gè)屬性：

initial_context?– 這個(gè)屬性用來(lái)在 InitialContext 中尋找上下文（即，initialContext.lookup(initial_context)）。這是個(gè)可選屬性，如果忽略，那么 data_source 屬性將會(huì)直接從 InitialContext 中尋找。
data_source?– 這是引用數(shù)據(jù)源實(shí)例位置的上下文的路徑。提供了 initial_context 配置時(shí)會(huì)在其返回的上下文中進(jìn)行查找，沒(méi)有提供時(shí)則直接在 InitialContext 中查找。

和其他數(shù)據(jù)源配置類(lèi)似，可以通過(guò)添加前綴“env.”直接把屬性傳遞給初始上下文。比如：

env.encoding=UTF8

這就會(huì)在初始上下文（InitialContext）實(shí)例化時(shí)往它的構(gòu)造方法傳遞值為?UTF8?的?encoding?屬性。

你可以通過(guò)實(shí)現(xiàn)接口?org.apache.ibatis.datasource.DataSourceFactory?來(lái)使用第三方數(shù)據(jù)源：

public interface DataSourceFactory {void setProperties(Properties props);DataSource getDataSource(); }

org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory?可被用作父類(lèi)來(lái)構(gòu)建新的數(shù)據(jù)源適配器，比如下面這段插入 C3P0 數(shù)據(jù)源所必需的代碼：

import org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory; import com.mchange.v2.c3p0.ComboPooledDataSource;public class C3P0DataSourceFactory extends UnpooledDataSourceFactory {public C3P0DataSourceFactory() {this.dataSource = new ComboPooledDataSource();} }

為了令其工作，記得為每個(gè)希望 MyBatis 調(diào)用的 setter 方法在配置文件中增加對(duì)應(yīng)的屬性。下面是一個(gè)可以連接至 PostgreSQL 數(shù)據(jù)庫(kù)的例子：

databaseIdProvider

MyBatis 可以根據(jù)不同的數(shù)據(jù)庫(kù)廠商執(zhí)行不同的語(yǔ)句，這種多廠商的支持是基于映射語(yǔ)句中的?databaseId?屬性。 MyBatis 會(huì)加載不帶?databaseId?屬性和帶有匹配當(dāng)前數(shù)據(jù)庫(kù)?databaseId屬性的所有語(yǔ)句。如果同時(shí)找到帶有?databaseId?和不帶?databaseId?的相同語(yǔ)句，則后者會(huì)被舍棄。為支持多廠商特性只要像下面這樣在 mybatis-config.xml 文件中加入?databaseIdProvider?即可：

這里的 DB_VENDOR 會(huì)通過(guò)?DatabaseMetaData#getDatabaseProductName()?返回的字符串進(jìn)行設(shè)置。由于通常情況下這個(gè)字符串都非常長(zhǎng)而且相同產(chǎn)品的不同版本會(huì)返回不同的值，所以最好通過(guò)設(shè)置屬性別名來(lái)使其變短，如下：

在提供了屬性別名時(shí)，DB_VENDOR databaseIdProvider 將被設(shè)置為第一個(gè)能匹配數(shù)據(jù)庫(kù)產(chǎn)品名稱(chēng)的屬性鍵對(duì)應(yīng)的值，如果沒(méi)有匹配的屬性將會(huì)設(shè)置為 “null”。在這個(gè)例子中，如果?getDatabaseProductName()?返回“Oracle (DataDirect)”，databaseId 將被設(shè)置為“oracle”。

你可以通過(guò)實(shí)現(xiàn)接口?org.apache.ibatis.mapping.DatabaseIdProvider?并在 mybatis-config.xml 中注冊(cè)來(lái)構(gòu)建自己的 DatabaseIdProvider：

public interface DatabaseIdProvider {void setProperties(Properties p);String getDatabaseId(DataSource dataSource) throws SQLException; }

映射器（mappers）

既然 MyBatis 的行為已經(jīng)由上述元素配置完了，我們現(xiàn)在就要定義 SQL 映射語(yǔ)句了。但是首先我們需要告訴 MyBatis 到哪里去找到這些語(yǔ)句。 Java 在自動(dòng)查找這方面沒(méi)有提供一個(gè)很好的方法，所以最佳的方式是告訴 MyBatis 到哪里去找映射文件。你可以使用相對(duì)于類(lèi)路徑的資源引用，或完全限定資源定位符（包括?file:///?的 URL），或類(lèi)名和包名等。例如：

<mappers><mapper resource="org/mybatis/builder/AuthorMapper.xml"/><mapper resource="org/mybatis/builder/BlogMapper.xml"/><mapper resource="org/mybatis/builder/PostMapper.xml"/> </mappers>  <mappers><mapper url="file:///var/mappers/AuthorMapper.xml"/><mapper url="file:///var/mappers/BlogMapper.xml"/><mapper url="file:///var/mappers/PostMapper.xml"/> </mappers>  <mappers><mapper class="org.mybatis.builder.AuthorMapper"/><mapper class="org.mybatis.builder.BlogMapper"/><mapper class="org.mybatis.builder.PostMapper"/> </mappers>  <mappers><package name="org.mybatis.builder"/> </mappers>

這些配置會(huì)告訴了 MyBatis 去哪里找映射文件，剩下的細(xì)節(jié)就應(yīng)該是每個(gè) SQL 映射文件了，也就是接下來(lái)我們要討論的。

總結(jié)

以上是生活随笔為你收集整理的mybatis入门（二）之XML 映射配置文件的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇：维盟路由如何设置DHCP服务维盟路由器如
下一篇： mybatis入门（三）之Mapper