Mybatis配置解析

余月七發表於2021-03-26

配置

MyBatis 的配置檔案包含了會深深影響 MyBatis 行為的設定和屬性資訊。配置文件的頂層結構如下：

configuration（配置）
- properties（屬性）
- settings（設定）
- typeAliases（型別別名）
- typeHandlers（型別處理器）
- objectFactory（物件工廠）
- plugins（外掛）
- environments（環境配置）
  - environment（環境變數）
    - transactionManager（事務管理器）
    - dataSource（資料來源）
- databaseIdProvider（資料庫廠商標識）
- mappers（對映器）

注意配置順序

紅線報錯：
The content of element type "configuration" must match
(properties?, 
settings?,
typeAliases?,
typeHandlers?, 
objectFactory?,  
objectWrapperFactory?,
reflectorFactory?,
plugins?,
environments?,
databaseIdProvider?,
mappers?).

屬性（properties）

這些屬性可以在外部進行配置，並可以進行動態替換。你既可以在典型的 Java 屬性檔案中配置這些屬性，也可以在 properties 元素的子元素中設定。例如：

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

如果兩個檔案使用同一個欄位，優先使用外部配置檔案

設定好的屬性可以在整個配置檔案中用來替換需要動態配置的屬性值。比如:

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

環境配置（environments）

MyBatis 可以配置成適應多種環境，這種機制有助於將 SQL 對映應用於多種資料庫之中，現實情況下有多種理由需要這麼做。

不過要記住：儘管可以配置多個環境，但每個 SqlSessionFactory 例項只能選擇一種環境。

所以，如果你想連線兩個資料庫，就需要建立兩個 SqlSessionFactory 例項，每個資料庫對應一個。而如果是三個資料庫，就需要三個例項，依此類推，記起來很簡單：

每個資料庫對應一個 SqlSessionFactory 例項

為了指定建立哪種環境，只要將它作為可選的引數傳遞給 SqlSessionFactoryBuilder 即可。可以接受環境配置的兩個方法簽名是：

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

如果忽略了環境引數，那麼將會載入預設環境，如下所示：

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

environments 元素定義瞭如何配置環境。

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

注意一些關鍵點:

預設使用的環境 ID（比如：default="development"）。
每個 environment 元素定義的環境 ID（比如：id="development"）。
事務管理器的配置（比如：type="JDBC"）。
資料來源的配置（比如：type="POOLED"）。

預設環境和環境 ID 顧名思義。環境可以隨意命名，但務必保證預設的環境 ID 要匹配其中一個環境 ID。

事務管理器（transactionManager）

在 MyBatis 中有兩種型別的事務管理器（也就是 type="[JDBC|MANAGED]"）：

JDBC – 這個配置直接使用了 JDBC 的提交和回滾設施，它依賴從資料來源獲得的連線來管理事務作用域。
MANAGED – 這個配置幾乎沒做什麼。它從不提交或回滾一個連線，而是讓容器來管理事務的整個生命週期（比如 JEE 應用伺服器的上下文）。預設情況下它會關閉連線。然而一些容器並不希望連線被關閉，因此需要將 closeConnection 屬性設定為 false 來阻止預設的關閉行為。例如:
```
<transactionManager type="MANAGED">
  <property name="closeConnection" value="false"/>
</transactionManager>
```

提示 如果你正在使用 Spring + MyBatis，則沒有必要配置事務管理器，因為 Spring 模組會使用自帶的管理器來覆蓋前面的配置。

這兩種事務管理器型別都不需要設定任何屬性。它們其實是型別別名，換句話說，你可以用 TransactionFactory 介面實現類的全限定名或型別別名代替它們。

public interface TransactionFactory {
  default void setProperties(Properties props) { // 從 3.5.2 開始，該方法為預設方法
    // 空實現
  }
  Transaction newTransaction(Connection conn);
  Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);
}

在事務管理器例項化後，所有在 XML 中配置的屬性將會被傳遞給 setProperties() 方法。你的實現還需要建立一個 Transaction 介面的實現類，這個介面也很簡單：

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

使用這兩個介面，你可以完全自定義 MyBatis 對事務的處理。

資料來源（dataSource）

dataSource 元素使用標準的 JDBC 資料來源介面來配置 JDBC 連線物件的資源。

大多數 MyBatis 應用程式會按示例中的例子來配置資料來源。雖然資料來源配置是可選的，但如果要啟用延遲載入特性，就必須配置資料來源。

有三種內建的資料來源型別（也就是 type="[UNPOOLED|POOLED|JNDI]"）：

UNPOOLED– 這個資料來源的實現會每次請求時開啟和關閉連線。雖然有點慢，但對那些資料庫連線可用性要求不高的簡單應用程式來說，是一個很好的選擇。效能表現則依賴於使用的資料庫，對某些資料庫來說，使用連線池並不重要，這個配置就很適合這種情形。UNPOOLED 型別的資料來源僅僅需要配置以下 5 種屬性：

driver – 這是 JDBC 驅動的 Java 類全限定名（並不是 JDBC 驅動中可能包含的資料來源類）。
url – 這是資料庫的 JDBC URL 地址。
username – 登入資料庫的使用者名稱。
password – 登入資料庫的密碼。
defaultTransactionIsolationLevel – 預設的連線事務隔離級別。
defaultNetworkTimeout – 等待資料庫操作完成的預設網路超時時間（單位：毫秒）。檢視 java.sql.Connection#setNetworkTimeout() 的 API 文件以獲取更多資訊。

作為可選項，你也可以傳遞屬性給資料庫驅動。只需在屬性名加上“driver.”字首即可，例如：

driver.encoding=UTF8

這將通過 DriverManager.getConnection(url, driverProperties) 方法傳遞值為 UTF8 的 encoding 屬性給資料庫驅動。

POOLED– 這種資料來源的實現利用“池”的概念將 JDBC 連線物件組織起來，避免了建立新的連線例項時所必需的初始化和認證時間。這種處理方式很流行，能使併發 Web 應用快速響應請求。

型別別名（typeAliases）

型別別名可為 Java 型別設定一個縮寫名字。它僅用於 XML 配置，意在降低冗餘的全限定類名書寫。例如：

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

當這樣配置時，Blog 可以用在任何使用 domain.blog.Blog 的地方。

也可以指定一個包名，MyBatis 會在包名下面搜尋需要的 Java Bean，比如：

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

每一個在包 domain.blog 中的 Java Bean，在沒有註解的情況下，會使用 Bean 的首字母小寫的非限定類名來作為它的別名。比如 domain.blog.Author 的別名為 author**；若有註解，則別名為其註解值**。見下面的例子：

@Alias("author")
public class 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

設定（settings）

這是 MyBatis 中極為重要的調整設定，它們會改變 MyBatis 的執行時行為。下表描述了設定中各項設定的含義、預設值等。

設定名	描述	有效值	預設值
cacheEnabled	全域性性地開啟或關閉所有對映器配置檔案中已配置的任何快取。	true \| false	true
lazyLoadingEnabled	延遲載入的全域性開關。當開啟時，所有關聯物件都會延遲載入。特定關聯關係中可通過設定 `fetchType` 屬性來覆蓋該項的開關狀態。	true \| false	false

useGeneratedKeys	允許 JDBC 支援自動生成主鍵，需要資料庫驅動支援。如果設定為 true，將強制使用自動生成主鍵。儘管一些資料庫驅動不支援此特性，但仍可正常工作（如 Derby）。	true \| false	False
mapUnderscoreToCamelCase	是否開啟駝峰命名自動對映，即從經典資料庫列名 A_COLUMN 對映到經典 Java 屬性名 aColumn。	true \| false	False

logImpl	指定 MyBatis 所用日誌的具體實現，未指定時將自動查詢。	SLF4J \| LOG4J \| LOG4J2 \| JDK_LOGGING \| COMMONS_LOGGING \| STDOUT_LOGGING \| NO_LOGGING	未設定

對映器（mappers）

我們需要告訴 MyBatis 到哪裡去找到這些語句。

在自動查詢資源方面，Java 並沒有提供一個很好的解決方案

所以最好的辦法是直接告訴 MyBatis 到哪裡去找對映檔案。

你可以使用相對於類路徑的資源引用，或完全限定資源定位符（包括 file:/// 形式的 URL），或類名和包名等。

例如：

<!-- 使用相對於類路徑的資源引用 -->
<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 class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

注意：使用class檔案繫結註冊的時候
1.介面要和它的mapper配置檔案必須同名
2.介面和它的mapper配置檔案必須在同一包下

************************************************************************
以下兩個不常用
<!-- 將包內的對映器介面實現全部註冊為對映器 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>
<!-- 使用完全限定資源定位符（URL） -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

MyBatis 配置解析
2020-06-19
MyBatis
深入Mybatis原始碼——配置解析
2020-07-07
MyBatis原始碼
Mybatis深入解析之日誌配置
2020-12-03
MyBatis
Mybatis：CRUD操作及配置解析
2020-09-28
MyBatis
MyBatis第四章：專案案例mybatis主要配置解析
2020-12-20
MyBatis
一文解析 MyBatis Generator 的使用及配置
2020-04-06
MyBatis
MyBatis 配置
2020-02-16
MyBatis
mybatis原始碼配置檔案解析之五：解析mappers標籤流程圖
2020-06-29
MyBatis原始碼APP流程圖
mybatis原始碼配置檔案解析之五：解析mappers標籤（解析XML對映檔案）
2020-06-29
MyBatis原始碼APPXML
MyBatis原始碼解析
2020-11-15
MyBatis原始碼
MyBatis原理解析
2024-03-14
MyBatis
mybatis的全域性配置檔案SqlMapConfig.xml解析
2019-02-27
MyBatisSQLXML
mybatis的配置
2020-05-28
MyBatis
MyBatis generator配置
2024-03-21
MyBatis
【MyBatis原始碼解析】MyBatis一二級快取
2017-06-12
MyBatis原始碼快取
Mybatis基礎：Mybatis對映配置檔案，Mybatis核心配置檔案，Mybatis傳統方式開發
2021-02-14
MyBatis
mybatis mapper解析（4）
2018-07-18
MyBatisAPP
mybatis plugin原始碼解析
2024-04-10
MyBatisPlugin原始碼
「Mybatis系列」Mybatis開發方式和配置
2020-02-20
MyBatis
深入淺出MyBatis：MyBatis的所有配置
2018-03-26
MyBatis
MyBatis 配置詳解
2023-05-05
MyBatis
MyBatis Generator配置使用
2017-02-14
MyBatis
深入淺出MyBatis：MyBatis解析和執行原理
2018-03-29
MyBatis
MyBatis學習之四、MyBatis配置檔案
2013-08-01
MyBatis
Spring Boot + Mybatis + Spring MVC環境配置（二）：Mybatis Generator配置
2018-08-18
Spring BootMyBatisMVC
Mybatis原始碼解析4——SqlSession
2021-09-08
MyBatis原始碼SQLSession
Mybatis的基礎配置
2020-11-06
MyBatis
MyBatis Spring SqlSessionFactoryBean 配置
2018-03-15
MyBatisSpringSQLSessionBean
MyBatis原始碼窺探(一):MyBatis整體架構解析
2018-12-12
MyBatis原始碼架構
全程解析，MyBatis在SpringBoot中的動態多資料來源配置
2020-12-07
MyBatisSpring Boot
mybatis入門基礎(三)----SqlMapConfig.xml全域性配置檔案解析
2015-06-29
MyBatisSQLXML
myBatis原始碼解析-反射篇（4）
2020-08-11
MyBatis原始碼反射
Mybatis N+1問題解析
2019-01-19
MyBatis
MyBatis詳細原始碼解析（上篇）
2020-12-15
MyBatis原始碼
MyBatis的解析和執行原理
2018-01-08
MyBatis
MyBatis學習之一、MyBatis簡介與配置MyBatis+Spring+MySql
2013-08-01
MyBatisSpringMySql
MyBatis載入配置檔案
2020-07-24
MyBatis
MyBatis Generator 超詳細配置
2019-10-28
MyBatis