Springboot中以配置類方式自定義Mybatis的配置規則（如開啟駝峰映射等）

什么是自定義Mybatis的配置規則？

答：即原來在mybatis配置文件中中我們配置到<settings>標簽中的內容，如下第6-10行內容：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>  7 <setting name="lazyLoadingEnabled" value="true"/>  8 <setting name="aggressiveLazyLoading" value="false"/>  9 <setting name="logImpl" value="LOG4J"/> 10 </settings>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://localhost:3306/ssm?useSSL=true&amp;serverTimezone=Asia/Shanghai&amp;useUnicode=true&amp;characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <!--<mapper resource="com/xj/mapper/UserMapper.xml"/>-->
        <mapper class="com.xj.mapper.UserMapper"/>
        <mapper class="com.xj.mapper.AccountMapper"/>

    </mappers>
</configuration>

 

 

在springboot我們不用編寫xml配置文件，那么我們該怎么來配置這些設置呢？

答：編寫一個配置類，然后通過@Bean注解給容器中添加一個ConfigurationCustomizer類型的組件即可。如下例子所示：

@Configuration
public class MybatisConfig {

    @Bean
    public ConfigurationCustomizer configurationCustomizer(){
        return new ConfigurationCustomizer() {
            @Override
            public void customize(org.apache.ibatis.session.Configuration configuration) {
                configuration.setLazyLoadingEnabled(true);
                configuration.setMapUnderscoreToCamelCase(true);
                configuration.setLogImpl(Log4jImpl.class);
            }
        };
    }
}

 

 

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: 輸出警告日志（'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等級必須設置為 WARN） FAILING: 映射失敗 (拋出 SqlSessionException)	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	Removes extra whitespace characters from the SQL. Note that this also affects literal strings in SQL. (Since 3.5.5)	true | false	false