Mybatis 配置解析
阿新 • • 發佈:2020-12-29
Mybatis 配置解析
核心配置檔案
mybatis-config.xml
MyBatis 的配置檔案包含了會深深影響 MyBatis 行為的設定和屬性資訊。 配置文件的頂層結構如下:
configuration(配置)
- properties(屬性)
- settings(設定)
- typeAliases(類型別名)
- typeHandlers(型別處理器)
- objectFactory(物件工廠)
- plugins(外掛)
- environments(環境配置)
- environment(環境變數)
- transactionManager(事務管理器)
- dataSource(資料來源)
- environment(環境變數)
- databaseIdProvider(資料庫廠商標識)
- mappers(對映器)
properties(屬性):
我們可以通過properties屬性來引用配置檔案
先寫一個配置檔案:
db.properties
url = jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&autoReconnect=true&failOverReadOnly=false name = root password = 1234
在核心配置檔案中引用寫好的配置檔案 並使用裡面的元素:
<!-- 引入一個外部配置檔案--> <properties resource="db.properties"/> <environments default="development"> <environment id="test"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="${url}"/> <!-- 拿取外部配置檔案的url屬性--> <property name="username" value="${name}"/> <!-- 拿取外部配置檔案的name屬性--> <property name="password" value="${password}"/><!-- 拿取外部配置檔案的password屬性--> </dataSource> </environment> </environments>
這些屬性可以在外部進行配置,並可以進行動態替換。你既可以在典型的 Java 屬性檔案中配置這些屬性,也可以在 properties 元素的子元素中設定。例如:
<properties resource="db.properties"> <property name="username" value="dev_user"/> <property name="password" value="F2Fa3!33TYyg"/> </properties>
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 | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未設定 |
proxyFactory | 指定 Mybatis 建立可延遲載入物件所用到的代理工具。 | CGLIB | 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 | Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to thetype (orvalue ) attribute on sql provider annotation(e.g.@SelectProvider ), when these attribute was omitted. |
A type alias or fully qualified class name | Not set |
一個配置完整的 settings 元素的示例如下:
<settings> <setting name="cacheEnabled" value="true"/> <setting name="lazyLoadingEnabled" value="true"/> <setting name="multipleResultSetsEnabled" value="true"/> <setting name="useColumnLabel" value="true"/> <setting name="useGeneratedKeys" value="false"/> <setting name="autoMappingBehavior" value="PARTIAL"/> <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/> <setting name="defaultExecutorType" value="SIMPLE"/> <setting name="defaultStatementTimeout" value="25"/> <setting name="defaultFetchSize" value="100"/> <setting name="safeRowBoundsEnabled" value="false"/> <setting name="mapUnderscoreToCamelCase" value="false"/> <setting name="localCacheScope" value="SESSION"/> <setting name="jdbcTypeForNull" value="OTHER"/> <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/> </settings>
typeAliases(類型別名)
類型別名可為 Java 型別設定一個縮寫名字。 它僅用於 XML 配置,意在降低冗餘的全限定類名書寫
<typeAliases> <!-- 我們給實體類取一個別名 User--> <typeAlias alias="User" type="com.xiaofu.pojo.User"/> </typeAliases>
這樣就可以在 mapper中直接用她了就不用在寫全部路徑了
也可以指定一個包名:
<typeAliases> <!-- 給一個包取別名 下面的類將被我們掃描--> <package name="com.xiaofu.pojo"/> </typeAliases>
在沒有註解的情況下 預設 以首字母小寫的形式 起的別名
現在pojo下有一個User類
在實體類較少的時候可以使用第一種形式取別名 如果實體類別較多建立使用第二種。
區別:第一種可以自定義別名 第二種則不行
如果非要讓第二種自定義別名可以 在類上使用註解 如:
@Alias("author") public class Author { ... }
environments(環境配置):
<environments default="development"> <!--default預設選擇的資料庫環境 對應下面的id--> <environment id="development"> <!--id 區分環境的標識 --> <transactionManager type="JDBC"/><!--transactionManager type 事物管理器(有jdbc和managed) --> <dataSource type="POOLED"><!-- dataSource資料來源 type 選擇池子 (POOLED池子 UNPOOLED沒有池子 JNDI正常連線)--> <property name="driver" value="com.mysql.jdbc.Driver"/> <!--資料庫驅動配置--> <!--資料庫連線url配置 之前jdbc的& 符號這裡是不能直接使用的 需要 & 進行轉義--> <property name="url" value="jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&autoReconnect=true&failOverReadOnly=false"/> <property name="username" value="root"/> <!--資料庫使用者名稱--> <property name="password" value="1234"/> <!--資料庫密碼--> </dataSource> </environment> <environment id="test"> <transactionManager type="JDBC"/> <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>
對映器(mappers):
註冊繫結我們的mapper.xml檔案
第一種:直接找mapper.xml檔案來註冊(推薦使用)
<!-- 每一個 mapper.xml 都需要在mybatis核心配置檔案中註冊 --> <mappers> <mapper resource="com/xiaofu/dao/UserMapper.xml"/> </mappers>
第二種:通過類註冊
<!-- 每一個 mapper.xml 都需要在mybatis核心配置檔案中註冊 --> <mappers> <mapper class="com.xiaofu.dao.UserMapper"/> </mappers>
通過類註冊需要注意兩個問題:
- 介面和他的Mapper配置檔案必須同名!
- 介面和他的Mapper配置檔案必須在同一個包下!
第三種:通過包註冊(包下的mapper都會被註冊)
<mappers> <!--這個包下的mapper都會被註冊--> <package name="com.xiaofu.dao"/> </mappers>
通過包註冊需要注意兩個問題:
- 介面和他的Mapper配置檔案必須同名!
- 介面和他的Mapper配置檔案必須在同一個包下!