一、MyBatis 配置文件基本結構
在使用mybatis框架時,首先導入其對應的jar包,並進行相應的配置,所以得對配置文件的每個參數都得了解。一個完全的mybatis配置文件結構如下:
properties
properties元素主要是用來定義配置外在化,比如數據庫的連接屬性等。這些屬性都是可外部配置且可動態替換的,既可以在典型的Java屬性文件中配置,亦可以通過properties元素的子元素來傳遞。例如:
其中的屬性就可以在整個配置文件中使用來替換需要動態配置的屬性值。比如在數據源中使用的例子:
這個例子中的username和password將會由properties元素中設置的相應值來替換。driver和url屬性將會由config.properties文件中對應的值來替換。這樣就爲配置提供了諸多靈活選擇。屬性也可以被傳遞到SqlSessionBuilder.build()方法中。例如:
但是,這也就涉及到了優先級的問題,如果屬性不只在一個地方配置,那麼mybatis將會按照下面的順序來加載:
- 在properties元素體內指定的屬性首先被讀取。
- 然後根據properties元素中的resource屬性讀取類路徑下屬性文件或根據url屬性指定的路徑讀取屬性文件,並覆蓋已讀取的同名屬性。
- 最後讀取作爲方法參數傳遞的屬性,並覆蓋已讀取的同名屬性。
settings
setting是指定MyBatis的一些全局配置屬性,這是MyBatis中極爲重要的調整設置,它們會改變MyBatis的運行時行爲,所以我們需要清楚的知道這些屬性的作用及默認值。
設置參數 | 描述 | 有效值 | 默認值 |
cacheEnabled | 該配置影響的所有映射器中配置的緩存的全局開關 | true | false | true |
lazyLoadingEnabled | 延遲加載的全局開關。當開啓時,所有關聯對象都會延遲加載。 特定關聯關係中可通過設置fetchType屬性來覆蓋該項的開關狀態 | true | false | false |
aggressiveLazyLoading | 當啓用時,對任意延遲屬性的調用會使帶有延遲加載屬性的對象完整加載;反之,每種屬性將會按需加載。 | true | false | true |
multipleResultSetsEnabled | 是否允許單一語句返回多結果集(需要兼容驅動)。 | true | false | true |
useColumnLabel | 使用列標籤代替列名。不同的驅動在這方面會有不同的表現, 具體可參考相關驅動文檔或通過測試這兩種不同的模式來觀察所用驅動的結果。 | true | false | true |
useGeneratedKeys | 允許 JDBC 支持自動生成主鍵,需要驅動兼容。 如果設置爲 true 則這個設置強制使用自動生成主鍵,儘管一些驅動不能兼容但仍可正常工作(比如 Derby)。 | true | false | False |
autoMappingBehavior | 指定 MyBatis 應如何自動映射列到字段或屬性。 NONE 表示取消自動映射;PARTIAL 只會自動映射沒有定義嵌套結果集映射的結果集。 FULL 會自動映射任意複雜的結果集(無論是否嵌套)。 | NONE, PARTIAL, FULL | PARTIAL |
defaultExecutorType | 配置默認的執行器。SIMPLE 就是普通的執行器;REUSE 執行器會重用預處理語句(prepared statements); BATCH 執行器將重用語句並執行批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
defaultStatementTimeout | 設置超時時間,它決定驅動等待數據庫響應的秒數。 | Any positive integer | Not Set (null) |
defaultFetchSize | Sets the driver a hint as to control fetching size for return results. This parameter value can be override by a query setting. | Any positive integer | Not Set (null) |
safeRowBoundsEnabled | 允許在嵌套語句中使用分頁(RowBounds)。 | true | false | False |
mapUnderscoreToCamelCase | 是否開啓自動駝峯命名規則(camel case)映射,即從經典數據庫列名 A_COLUMN 到經典 Java 屬性名 aColumn 的類似映射。 | true | false | False |
localCacheScope | MyBatis 利用本地緩存機制(Local Cache)防止循環引用(circular references)和加速重複嵌套查詢。 默認值爲 SESSION,這種情況下會緩存一個會話中執行的所有查詢。 若設置值爲 STATEMENT,本地會話僅用在語句執行上,對相同 SqlSession 的不同調用將不會共享數據。 | SESSION | STATEMENT | SESSION |
jdbcTypeForNull | 當沒有爲參數提供特定的 JDBC 類型時,爲空值指定 JDBC 類型。 某些驅動需要指定列的 JDBC 類型,多數情況直接用一般類型即可,比如 NULL、VARCHAR 或 OTHER。 | JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER | OTHER |
lazyLoadTriggerMethods | 指定哪個對象的方法觸發一次延遲加載。 | A method name list separated by commas | equals,clone,hashCode,toString |
defaultScriptingLanguage | 指定動態 SQL 生成的默認語言。 | A type alias or fully qualified class name. | org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver |
callSettersOnNulls | 指定當結果集中值爲 null 的時候是否調用映射對象的 setter(map 對象時爲 put)方法,這對於有 Map.keySet() 依賴或 null 值初始化的時候是有用的。注意基本類型(int、boolean等)是不能設置成 null 的。 | true | false | false |
logPrefix | 指定 MyBatis 增加到日誌名稱的前綴。 | Any String | Not set |
logImpl | 指定 MyBatis 所用日誌的具體實現,未指定時將自動查找。 | SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | Not set |
proxyFactory | 指定 Mybatis 創建具有延遲加載能力的對象所用到的代理工具。 | CGLIB | JAVASSIST | JAVASSIST (MyBatis 3.3 or above) |
一個完整的settings元素示例如下:
typeAliases
類型別名是爲Java類型設置一個短的名字。它只和xml配置有關,存在的意義僅在於用來減少類完全限定名的冗餘,例如:
當這樣配置時,Blog可以用在任何使用domain.blog.Blog的地方。
也可以指定一個包名,MyBatis會在包名下搜索需要的JavaBean,比如:
每一個在包domain.blog中的JavaBean,在沒有註解的情況下,會使用Bean的首字母小寫的非限類名來作爲它的別名。比如domain.blog.Author的別名爲author;若有註解,則別名爲註解值。看下面的例子:
已經爲許多常見的Java類型內建了相應的類型別名。它們都是大小寫不敏感的,需要注意的是有基本類型名稱重複導致的特殊處理。
別名 | 映射的類型 |
_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
無論是 MyBatis 在預處理語句(PreparedStatement)中設置一個參數時,還是從結果集中取出一個值時, 都會用類型處理器將獲取的值以合適的方式轉換成 Java 類型。下表描述了一些默認的類型處理器。
類型處理器 | Java 類型 | JDBC 類型 |
BooleanTypeHandler | java.lang.Boolean, boolean | 數據庫兼容的 BOOLEAN |
ByteTypeHandler | java.lang.Byte, byte | 數據庫兼容的 NUMERIC 或 BYTE |
ShortTypeHandler | java.lang.Short, short | 數據庫兼容的 NUMERIC 或 SHORT INTEGER |
IntegerTypeHandler | java.lang.Integer, int | 數據庫兼容的 NUMERIC 或 INTEGER |
LongTypeHandler | java.lang.Long, long | 數據庫兼容的 NUMERIC 或 LONG INTEGER |
FloatTypeHandler | java.lang.Float, float | 數據庫兼容的 NUMERIC 或 FLOAT |
DoubleTypeHandler | java.lang.Double, double | 數據庫兼容的 NUMERIC 或 DOUBLE |
BigDecimalTypeHandler | java.math.BigDecimal | 數據庫兼容的 NUMERIC 或 DECIMAL |
StringTypeHandler | java.lang.String | CHAR, VARCHAR |
ClobTypeHandler | java.lang.String | CLOB, LONGVARCHAR |
NStringTypeHandler | java.lang.String | NVARCHAR, NCHAR |
NClobTypeHandler | java.lang.String | NCLOB |
ByteArrayTypeHandler | byte[] | 數據庫兼容的字節流類型 |
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 或未指定類型 |
EnumTypeHandler | Enumeration Type | VARCHAR-任何兼容的字符串類型,存儲枚舉的名稱(而不是索引) |
EnumOrdinalTypeHandler | Enumeration Type | 任何兼容的 NUMERIC 或 DOUBLE 類型,存儲枚舉的索引(而不是名稱)。 |
可以重寫類型處理器或創建自己的類型處理器來處理不支持的或非標準的類型。具體的做法爲:實現org.apache.ibatis.type.TypeHandler接口,或繼承一個很便利的類org.apache.ibatis.type.BaseTypeHandler,然後可以選擇性地將它映射到一個JDBC類型。比如:
並且還需要在配置文件裏面加上:
使用這個的類型處理器將會覆蓋已經存在的處理Java的String類型屬性和VARCHAR參數及結果的類型處理器。要注意MyBatis不會窺探數據庫元信息來決定使用哪種類型,所以必須在參數和結果映射中指明是VARCHAR類型字段,以使其能綁定到正確的類型處理器上。這是因爲,MyBatis直到語句被執行才清楚數據類型。
通過類型處理器的泛型,MyBatis可以得知該類型處理器的Java類型,不過這種行爲可以通過兩種方法改變:
- 在類型處理器的元素(typeHandler element)上增加一個javaType屬性(比如,javaType="String");
- 在類型處理器的類上(TypeHandler class)增加一個@MappedTypes註解來指定與其關聯的Java類型列表。如果在javaType屬性中也同時制定,則註解方式將被忽略。
- 在類型處理器的配置元素上增加一個javaType屬性(比如:javaType="VARCHAR");
- 在類型處理器的類上(TypeHandler class)增加一個@MappedJdbcTypes註解來指定與其關聯的JDBC類型列表。如果在javaType屬性中也同時指定,則註解方式將被忽略。
注意在使用自動檢索(autodiscovery)功能的時候,只能通過註解的方式來指定JDBC類型。
你能創建一個泛型類型處理器,它可以處理多於一個類。爲達到此目的,需要增加一個接收該類作爲參數的構造器,這樣在構造一個類型處理器的時候MyBatis就會傳入一個具體的類。
EnumTypeHandler和EnumOrdinalTypeHandler都是泛型處理器(generic TypeHandlers),接下來的部分詳細探討。
處理枚舉類型
若想映射枚舉類型Enum,則需要從EnumTypeHandler或者EnumOrdinalTypeHandler中選一個來使用
比如說我們想存儲近似值時用到的舍入模式。默認情況下,MyBatis會利用EnumTypeHandler來把Enum值轉換成對應的名字。
注意EnumTypeHandler在某種意義上來說是比較特別的,其他的處理器只針對某個特定的類,而它不同,它會處理任意繼承了Enum的類。
不過,我們可能不想存儲名字,相反我們的DBA會堅持使用整形值代碼。那也一樣輕而易舉;在配置文件中把EnumOrdinalTypeHandler加到typeHandlers中即可,這樣每個RoundingMode將通過他們的序數值來映射成對應的整形。
但是怎麼樣能將同樣的Enum既映射成字符串又映射成整形呢?
自動映射器(auto-mapper)會自動選用EnumOrdinalTypeHandler來處理,所以如果我們想用普通的EnumTypeHandler,就非要爲那些SQL語句顯示地設置要用到的類型處理器不可。
注意,這裏的select語句強制使用resultMap來代替resultType。
對象工廠(objectFactory)
MyBatis每次創建結果對象的新實例時,它都會使用一個對象工廠(ObjectFactory)實例來完成。默認的對象工廠需要做的僅僅是實例化目標類,要麼通過默認構造方法,要麼在參數映射存在的時候通過參數構造方法來實例化。如果想覆蓋對象工廠的行爲,則可以通過創建自己的對象工廠來實現,比如:
ObjectFactory接口很簡單,它包含兩個創建用的方法,一個是處理默認構造方法的,另外一個是處理帶參數的構造方法。最後setProperties方法可以被用來配置ObjectFactory,初始化你的ObjectFactory實例後,objectFactory元素體內定義的屬性會被傳遞給setProperties方法。
插件(plugins)
MyBatis允許你在已映射的語句執行過程中的某一點進行攔截調用。默認情況下,Mybatis允許使用插件來攔截的方法調用包括:
- Executor(update,query,flushStatements,commit,rollback,getTransaction,close,isClosed)
- ParameterHandler(getParameterObejct,setParameters)
- ResultSetHandler(handlerResultSets,handlerOutputParameters)
- StatementHandler(prepare,parameterize,batch,update,query)
通過MyBatis提供強大的機制,使用插件是非常簡單的,只需要實現Interceptor接口,並指定想要攔截的方法簽名即可。
上面的插件將會攔截Executor實例中所有的“update”方法調用,這裏的Executor是負責執行底層映射語句的內部對象。
覆蓋配置類
除了用插件來修改MyBatis核心行爲之外,還可以通過完全覆蓋配置類來達到目的。只需繼承後覆蓋其中的每個方法,再把它傳遞到sqlSessionFactoryBuilder.build(myConfig)方法即可。再次重申,這可能會嚴重影響Mybatis的行爲,務請慎之又慎!
配置環境(environments)
MyBatis可以配置成適應多種環境,這種機制有助於將sql映射應用於多種數據庫中,現實情況下有多種理由需要這麼做。例如,開發、測試和生產環境需要有不同的配置;或者共享相同的Schema的多個生產數據庫,想使用相同的sql映射。許多類似的用例。儘管可以配置多個環境,但是每個SqlSessionFactory實例只能選擇其一。
所以,如果想連接兩個數據庫,就需要創建兩個SqlSessionFactory實例,每個數據庫對應一個。而如果是三個數據庫,就需要三個實例,依此類推。
每個數據庫對應一個SqlSessionFactory實例
爲了指定創建哪種環境,只要將它作爲可選參數傳遞給SqlSessionFactoryBuilder即可。可以接受環境配置的兩個方法簽名是:
如果忽略了環境參數,那麼默認環境將會被加載,如下所示:
環境元素定義瞭如何配置環境
注意這裏的關鍵點:
- 默認環境的ID(比如:default="development")
- 每個environment元素定義的環境ID(比如:id="development")
- 事務管理器的配置(比如:type="JDBC")
- 數據源的配置(比如:type="POOLED")
事務管理器(transactionManager)
在MyBatis中有兩種類型的事務管理器(也就是 type="[JDBC|MANAGED]")
- JDBC --- 這個配置就是直接使用了JDBC的提交和回滾設置,它依賴於從數據源得到的連接來管理事務範圍。
- MANAGED --- 這個配置幾乎沒做什麼。它從來不提交或回滾一個連接,而是讓容器來管理事務的整個生命週期(比如JEE應用服務器上下文)。默認情況下它會關閉連接,然而一些容器並不希望這樣,因此需要將closeConnection屬性設置爲false來阻止它默認的行爲。例如
這兩種事務管理器類型都不需要任何屬性。它們只不過是類型別名,換句話說,你可以使用TransactionFactory接口的實現類的完全限定名或類型別名替代它們。
任何在xml中配置的屬性在實例化之後將會被傳遞給setProperties方法。你也需要創建一個Transaction接口的實現類,這個接口也很簡單。
使用這兩個接口,完全可以自定義MyBatis對事務的處理。
數據源(dataSource)
dataSource元素使用了標準的JDBC數據源接口來配置JDBC連接對象的資源。
- 許多MyBatis的應用程序將會按示例中的例子來配置數據源。然而它並不是必須的。要知道爲了方便使用延遲加載,數據源纔是必須的。
UNPOOLED --- 這個數據源的實現只是被請求時打開和關閉連接。雖然有一點慢,它對在及時可用連接方面沒有性能要求的簡單應用是一個很好的選擇。不同的數據庫在這方面表現也是不一樣的,所以對某些數據庫來說使用連接池並不重要,這個配置也是理想。UNPOOLED類型的數據源僅僅需要配置以下5種屬性:
- driver -- 這是JDBC驅動的Java類的完全限定名(並不是JDBC驅動中可能包含的數據源類)
- url -- 這是數據庫的JDBC URL 地址。
- username -- 登錄數據庫的用戶名。
- password -- 登錄數據庫的密碼。
- defaultTransactionIsolationLevel -- 默認的連接事務隔離級別。
- driver.encoding=UTF-8
這將通過DriverManager,getConnection(url,driverProperties)方法傳遞值爲UTF-8的encoding屬性給數據庫驅動。
POOLED --- 這種數據源的實現利用“池”的概念將JDBC連接對象組織起來,避免了創建新的連接實例時所必需的初始化和認證時間。這是一種使得併發web應用快速響應請求的流行處理方式。
除了上述提到UNPOOLED下的屬性外,會有更多屬性用來配置POOLED的數據源:
- poolMaximumActiveConnections -- 在任意時間可以存在的活動(也就是正在使用)連接數量,默認值10
- poolMaximumIdleConnections -- 任意時間可能存在的空閒連接數。
- poolMaximumCheckoutTime -- 在被強制返回之前,池中連接被檢出(checked out)時間,默認值:20000毫秒(即20秒)
- poolTimeToWait -- 這是一個底層設置,如果獲取連接花費的相當長的時間,它會給連接池打印狀態日誌並重新嘗試獲取一個連接(避免在誤配置的情況下一直安靜的失敗),默認值20000毫秒(即20秒)。
- poolPingQuery -- 發送到數據庫的偵測查詢,用來檢驗連接是否處在正常的工作秩序中,並且準備接受請求。默認是"NOT PING QUERY SET",這會導致多數數據庫連接失敗時帶有一個恰當的錯誤信息。
- poolPingEnabled -- 是否啓用偵測。若開啓,也必須使用一個可執行的SQL語句設置poolPingQuery屬性(最好是一個非常快的SQL),默認值:false。
- poolPingConnectionsNotUsedFor -- 配置poolPingQuery使用的頻度。這可以被設置成匹配具體的數據庫連接超時時間,來避免不必要的偵測,默認值:0(即所有連接每一時刻都被偵測 -- 當然僅當 poolPingEnabled爲true時適用)。
- initial_context -- 這個屬性用來在InitialContext中尋找上下文(即,initialContext.lookup(initial_context))。這是個可選屬性,如果忽略,那麼data_source屬性將會直接從InitialContext中尋找。
- data_source -- 這是引用數據源實例位置的上下文的路徑。提供了 initial_context配置時會在其返回的上下文中進行查找,沒有提供時則直接在InitialContext中查找。
- env.encoding=UTF-8