1、Mybatis 是什麼 MyBatis 是一款優秀的持久層框架，它支持自定義 SQL、存儲過程以及高級映射。MyBatis 免除了幾乎所有的 JDBC 代碼以及設置參數和獲取結果集的工作。MyBatis 可以通過簡單的 XML 或註解來配置和映射原始類型、介面和 Java POJO（Plain ...
1、Mybatis 是什麼
MyBatis 是一款優秀的持久層框架，它支持自定義 SQL、存儲過程以及高級映射。MyBatis 免除了幾乎所有的 JDBC 代碼以及設置參數和獲取結果集的工作。MyBatis 可以通過簡單的 XML 或註解來配置和映射原始類型、介面和 Java POJO（Plain Old Java Objects，普通老式 Java 對象）為資料庫中的記錄。
2、Mybatis 配置
MyBatis 的配置文件包含了會深深影響 MyBatis 行為的設置和屬性信息。 配置文檔的頂層結構如下：
- configuration（配置）
- properties（屬性）
- settings（設置）
- typeAliases（類型別名）
- typeHandlers（類型處理器）
- objectFactory（對象工廠）
- plugins（插件）
- environments（環境配置）
- environment（環境變數）
- transactionManager（事務管理器）
- dataSource（數據源）
- environment（環境變數）
- databaseIdProvider（資料庫廠商標識）
- mappers（映射器）
2.1、屬性（properties）
這些屬性可以在外部進行配置，並可以進行動態替換。你既可以在典型的 Java 屬性文件中配置這些屬性，也可以在 properties 元素的子元素中設置。例如：
<properties resource="org/mybatis/example/config.properties"> <property name="username" value="root"/> <property name="password" value="123456"/> </properties>
設置好的屬性可以在整個配置文件中用來替換需要動態配置的屬性值。
如果一個屬性在不只一個地方進行了配置，那麼，MyBatis 將按照下麵的順序來載入：
- 首先讀取在 properties 元素體內指定的屬性。
- 然後根據 properties 元素中的 resource 屬性讀取類路徑下屬性文件，或根據 url 屬性指定的路徑讀取屬性文件，並覆蓋之前讀取過的同名屬性。
- 最後讀取作為方法參數傳遞的屬性，並覆蓋之前讀取過的同名屬性。
2.2、設置（settings）
這是 MyBatis 中極為重要的調整設置，它們會改變 MyBatis 的運行時行為。 下表描述了設置中各項設置的含義、預設值等。
| 設置名 | 描述 | 有效值 | 預設值 |
|---|---|---|---|
| cacheEnabled | 全局性地開啟或關閉所有映射器配置文件中已配置的任何緩存。 | true | false | true |
| lazyLoadingEnabled | 延遲載入的全局開關。當開啟時，所有關聯對象都會延遲載入。 特定關聯關係中可通過設置 fetchType 屬性來覆蓋該項的開關狀態。 |
true | false | false |
| aggressiveLazyLoading | 開啟時，任一方法的調用都會載入該對象的所有延遲載入屬性。 否則，每個延遲載入屬性會按需載入（參考 lazyLoadTriggerMethods)。 |
true | false | false （在 3.4.1 及之前的版本中預設為 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 |
| autoMappingUnknownColumnBehavior | 指定發現自動映射目標未知列（或未知屬性類型）的行為。
|
NONE, WARNING, FAILING | NONE |
| defaultExecutorType | 配置預設的執行器。SIMPLE 就是普通的執行器；REUSE 執行器會重用預處理語句（PreparedStatement）； BATCH 執行器不僅重用語句還會執行批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
| defaultStatementTimeout | 設置超時時間，它決定資料庫驅動等待資料庫響應的秒數。 | 任意正整數 | 未設置 (null) |
| defaultFetchSize | 為驅動的結果集獲取數量（fetchSize）設置一個建議值。此參數只可以在查詢設置中被覆蓋。 | 任意正整數 | 未設置 (null) |
| defaultResultSetType | 指定語句預設的滾動策略。（新增於 3.5.2） | FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT（等同於未設置） | 未設置 (null) |
| safeRowBoundsEnabled | 是否允許在嵌套語句中使用分頁（RowBounds）。如果允許使用則設置為 false。 | true | false | False |
| safeResultHandlerEnabled | 是否允許在嵌套語句中使用結果處理器（ResultHandler）。如果允許使用則設置為 false。 | true | false | True |
| mapUnderscoreToCamelCase | 是否開啟駝峰命名自動映射，即從經典資料庫列名 A_COLUMN 映射到經典 Java 屬性名 aColumn。 | true | false | False |
| localCacheScope | MyBatis 利用本地緩存機制（Local Cache）防止迴圈引用和加速重覆的嵌套查詢。 預設值為 SESSION，會緩存一個會話中執行的所有查詢。 若設置值為 STATEMENT，本地緩存將僅用於執行語句，對相同 SqlSession 的不同查詢將不會進行緩存。 | SESSION | STATEMENT | SESSION |
| jdbcTypeForNull | 當沒有為參數指定特定的 JDBC 類型時，空值的預設 JDBC 類型。 某些資料庫驅動需要指定列的 JDBC 類型，多數情況直接用一般類型即可，比如 NULL、VARCHAR 或 OTHER。 | JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。 | OTHER |
| lazyLoadTriggerMethods | 指定對象的哪些方法觸發一次延遲載入。 | 用逗號分隔的方法列表。 | equals,clone,hashCode,toString |
| defaultScriptingLanguage | 指定動態 SQL 生成使用的預設腳本語言。 | 一個類型別名或全限定類名。 | org.apache.ibatis.scripting.xmltags.XMLLanguageDriver |
| defaultEnumTypeHandler | 指定 Enum 使用的預設 TypeHandler 。（新增於 3.4.5） |
一個類型別名或全限定類名。 | org.apache.ibatis.type.EnumTypeHandler |
| callSettersOnNulls | 指定當結果集中值為 null 的時候是否調用映射對象的 setter（map 對象時為 put）方法，這在依賴於 Map.keySet() 或 null 值進行初始化時比較有用。註意基本類型（int、boolean 等）是不能設置成 null 的。 | true | false | false |
| returnInstanceForEmptyRow | 當返回行的所有列都是空時，MyBatis預設返回 null。 當開啟這個設置時，MyBatis會返回一個空實例。 請註意，它也適用於嵌套的結果集（如集合或關聯）。（新增於 3.4.2） |
true | false | false |
| logPrefix | 指定 MyBatis 增加到日誌名稱的首碼。 | 任何字元串 | 未設置 |
| logImpl | 指定 MyBatis 所用日誌的具體實現，未指定時將自動查找。 | SLF4J | LOG4J（3.5.9 起廢棄） | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未設置 |
| proxyFactory | 指定 Mybatis 創建可延遲載入對象所用到的代理工具。 | CGLIB （3.5.10 起廢棄） | JAVASSIST | JAVASSIST （MyBatis 3.3 以上） |
| vfsImpl | 指定 VFS 的實現 | 自定義 VFS 的實現的類全限定名，以逗號分隔。 | 未設置 |
| useActualParamName | 允許使用方法簽名中的名稱作為語句參數名稱。 為了使用該特性，你的項目必須採用 Java 8 編譯，並且加上 -parameters 選項。（新增於 3.4.1） |
true | false | true |
| configurationFactory | 指定一個提供 Configuration 實例的類。 這個被返回的 Configuration 實例用來載入被反序列化對象的延遲載入屬性值。 這個類必須包含一個簽名為static Configuration getConfiguration() 的方法。（新增於 3.2.3） |
一個類型別名或完全限定類名。 | 未設置 |
| shrinkWhitespacesInSql | 從SQL中刪除多餘的空格字元。請註意，這也會影響SQL中的文字字元串。 (新增於 3.5.5) | true | false | false |
| defaultSqlProviderType | 指定一個擁有 provider 方法的 sql provider 類 （新增於 3.5.6）. 這個類適用於指定 sql provider 註解上的type（或 value） 屬性（當這些屬性在註解中被忽略時）。 (e.g. @SelectProvider) |
類型別名或者全限定名 | 未設置 |
| nullableOnForEach | 為 'foreach' 標簽的 'nullable' 屬性指定預設值。（新增於 3.5.9） | true | false | false |
| argNameBasedConstructorAutoMapping | 當應用構造器自動映射時，參數名稱被用來搜索要映射的列，而不再依賴列的順序。（新增於 3.5.10） | true | false | false |
2.3、類型別名（typeAliases）
類型別名可為 Java 類型設置一個縮寫名字。 它僅用於 XML 配置，意在降低冗餘的全限定類名書寫。例如：
<typeAliases> <typeAlias alias="Author" type="domain.blog.Author"/> <typeAlias alias="Blog" type="domain.blog.Blog"/> </typeAliases>
2.4、類型處理器（typeHandlers）
MyBatis 在設置預處理語句（PreparedStatement）中的參數或從結果集中取出一個值時， 都會用類型處理器將獲取到的值以合適的方式轉換成 Java 類型。Mybatis 內置了預設的類型處理器，如果不滿足需求，還可以自定義類型處理器；具體做法為：實現 org.apache.ibatis.type.TypeHandler 介面， 或繼承一個很便利的類 org.apache.ibatis.type.BaseTypeHandler， 並且可以（可選地）將它映射到一個 JDBC 類型。
2.5、對象工廠（objectFactory）
每次 MyBatis 創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成實例化工作。 預設的對象工廠需要做的僅僅是實例化目標類，要麼通過預設無參構造方法，要麼通過存在的參數映射來調用帶有參數的構造方法。 如果想覆蓋對象工廠的預設行為，可以通過創建自己的對象工廠來實現；具體做法為：繼承 org.apache.ibatis.reflection.factory.DefaultObjectFactory 類並覆蓋相應的方法。
2.6、插件（plugins）
MyBatis 允許你在映射語句執行過程中的某一點進行攔截調用。預設情況下，MyBatis 允許使用插件來攔截的方法調用包括：
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
通過 MyBatis 提供的強大機制，使用插件是非常簡單的，只需實現 Interceptor 介面，並指定想要攔截的方法簽名即可。
2.7、環境配置（environments）
MyBatis 可以配置成適應多種環境，這種機制有助於將 SQL 映射應用於多種資料庫之中， 現實情況下有多種理由需要這麼做。例如，開發、測試和生產環境需要有不同的配置；或者想在具有相同 Schema 的多個生產資料庫中使用相同的 SQL 映射。還有許多類似的使用場景。
不過要記住：儘管可以配置多個環境，但每個 SqlSessionFactory 實例只能選擇一種環境。
所以，如果你想連接兩個資料庫，就需要創建兩個 SqlSessionFactory 實例，每個資料庫對應一個。
2.7.1、事務管理器（transactionManager）
在 MyBatis 中有兩種類型的事務管理器（也就是 type="[JDBC|MANAGED]"）：
- JDBC – 這個配置直接使用了 JDBC 的提交和回滾功能，它依賴從數據源獲得的連接來管理事務作用域。
- MANAGED – 這個配置幾乎沒做什麼。它從不提交或回滾一個連接，而是讓容器來管理事務的整個生命周期（比如 JEE 應用伺服器的上下文）。
註：如果你正在使用 Spring + MyBatis，則沒有必要配置事務管理器，因為 Spring 模塊會使用自帶的管理器來覆蓋前面的配置。
2.7.2、數據源（dataSource）
dataSource 元素使用標準的 JDBC 數據源介面來配置 JDBC 連接對象的資源。
有三種內建的數據源類型（也就是 type="[UNPOOLED|POOLED|JNDI]"）：
UNPOOLED– 這個數據源的實現會每次請求時打開和關閉連接。雖然有點慢，但對那些資料庫連接可用性要求不高的簡單應用程式來說，是一個很好的選擇。 性能表現則依賴於使用的資料庫，對某些資料庫來說，使用連接池並不重要，這個配置就很適合這種情形。
POOLED– 這種數據源的實現利用“池”的概念將 JDBC 連接對象組織起來，避免了創建新的連接實例時所必需的初始化和認證時間。 這種處理方式很流行，能使併發 Web 應用快速響應請求。
JNDI – 這個數據源實現是為了能在如 EJB 或應用伺服器這類容器中使用，容器可以集中或在外部配置數據源，然後放置一個 JNDI 上下文的數據源引用。
2.8、資料庫廠商標識（databaseIdProvider）
MyBatis 可以根據不同的資料庫廠商執行不同的語句，這種多廠商的支持是基於映射語句中的 databaseId 屬性。 MyBatis 會載入帶有匹配當前資料庫 databaseId 屬性和所有不帶 databaseId 屬性的語句。 如果同時找到帶有 databaseId 和不帶 databaseId 的相同語句，則後者會被捨棄。databaseIdProvider 對應的 DB_VENDOR 實現會將 databaseId 設置為 DatabaseMetaData#getDatabaseProductName() 返回的字元串。 由於通常情況下這些字元串都非常長，而且相同產品的不同版本會返回不同的值，你可能想通過設置屬性別名來使其變短：
<databaseIdProvider type="DB_VENDOR"> <property name="SQL Server" value="sqlserver"/> <property name="DB2" value="db2"/> <property name="Oracle" value="oracle" /> </databaseIdProvider>
2.9、映射器（mappers）
我們需要告訴 MyBatis 到哪裡去找SQL 映射語句。 在自動查找資源方面，Java 並沒有提供一個很好的解決方案，所以最好的辦法是直接告訴 MyBatis 到哪裡去找映射文件。 你可以使用相對於類路徑的資源引用，或完全限定資源定位符（包括 file:/// 形式的 URL），或類名和包名等。例如：
<!-- 使用相對於類路徑的資源引用 --> <mappers> <mapper resource="org/mybatis/builder/AuthorMapper.xml"/> <mapper resource="org/mybatis/builder/BlogMapper.xml"/> </mappers>
<!-- 使用完全限定資源定位符（URL） --> <mappers> <mapper url="file:///var/mappers/AuthorMapper.xml"/> <mapper url="file:///var/mappers/BlogMapper.xml"/> </mappers>
<!-- 使用映射器介面實現類的完全限定類名 --> <mappers> <mapper class="org.mybatis.builder.AuthorMapper"/> <mapper class="org.mybatis.builder.BlogMapper"/> </mappers>
<!-- 將包內的映射器介面全部註冊為映射器 --> <mappers> <package name="org.mybatis.builder"/> </mappers>
3、作用域（Scope）和生命周期
3.1、對象生命周期和依賴註入框架
依賴註入框架可以創建線程安全的、基於事務的 SqlSession 和映射器，並將它們直接註入到你的 bean 中，因此可以直接忽略它們的生命周期。 如果對如何通過依賴註入框架使用 MyBatis 感興趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 兩個子項目。
3.2、SqlSessionFactoryBuilder
這個類可以被實例化、使用和丟棄，一旦創建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 實例的最佳作用域是方法作用域（也就是局部方法變數）。 你可以重用 SqlSessionFactoryBuilder 來創建多個 SqlSessionFactory 實例，但最好還是不要一直保留著它，以保證所有的 XML 解析資源可以被釋放給更重要的事情。
3.2、SqlSessionFactory
SqlSessionFactory 一旦被創建就應該在應用的運行期間一直存在，沒有任何理由丟棄它或重新創建另一個實例。 使用 SqlSessionFactory 的最佳實踐是在應用運行期間不要重覆創建多次，多次重建 SqlSessionFactory 被視為一種代碼“壞習慣”。因此 SqlSessionFactory 的最佳作用域是應用作用域。 有很多方法可以做到，最簡單的就是使用單例模式或者靜態單例模式。
3.3、SqlSession
每個線程都應該有它自己的 SqlSession 實例。SqlSession 的實例不是線程安全的，因此是不能被共用的，所以它的最佳的作用域是請求或方法作用域。 絕對不能將 SqlSession 實例的引用放在一個類的靜態域，甚至一個類的實例變數也不行。 也絕不能將 SqlSession 實例的引用放在任何類型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你現在正在使用一種 Web 框架，考慮將 SqlSession 放在一個和 HTTP 請求相似的作用域中。 換句話說，每次收到 HTTP 請求，就可以打開一個 SqlSession，返回一個響應後，就關閉它。
3.4、映射器實例
映射器是一些綁定映射語句的介面。映射器介面的實例是從 SqlSession 中獲得的。雖然從技術層面上來講，任何映射器實例的最大作用域與請求它們的 SqlSession 相同。但方法作用域才是映射器實例的最合適的作用域。 也就是說，映射器實例應該在調用它們的方法中被獲取，使用完畢之後即可丟棄。 映射器實例並不需要被顯式地關閉。儘管在整個請求作用域保留映射器實例不會有什麼問題，但是你很快會發現，在這個作用域上管理太多像 SqlSession 的資源會讓你忙不過來。 因此，最好將映射器放在方法作用域內。
更多詳細說明請參考官網文檔：https://mybatis.org/mybatis-3/zh。
