一租幕、Mybatis核心配置文件各標簽層級關(guān)系

image.png

二昵仅、properties標簽

properties標簽是用來加載Mybatis外部屬性的標簽隔崎，該標簽用來將內(nèi)部的配置外在化，即通過外部的配置來動態(tài)為內(nèi)部定義的屬性賦值挺身。具體方式如下：

1、使用配置文件加載屬性的三種方式

• 使用resource加載相對路徑下配置文件中的屬性

<properties resource="jdbc.properties" ></properties>

• 使用url加載絕對路徑下配置文件的屬性

<properties url="file:///Users/yinyw/Documents/WorkSpace/MybatisDemo/src/main/resources/jdbc.properties" ></properties>

• 使用property加載屬性

<properties>
    <property name="jdbc.driver" value="com.mysql.jdbc.Driver"/>
    <property name="jdbc.url" value="jdbc:mysql://192.168.0.101:3306/mybatis?characterEncoding=utf8"/>
    <property name="username" value="root"/>
    <property name="password" value="root"/>
</properties>

2锌仅、在配置文件中使用屬性

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

3章钾、在JAVA代碼中使用屬性

@Test
public void getProperty() throws IOException {
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlConfiguration.xml");
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    Configuration configuration = sqlSessionFactory.getConfiguration();
    Properties properties = configuration.getVariables();
    String property = properties.getProperty("jdbc.driver");
    System.out.printf("jdbc.driver:" + property);
}

4墙贱、使用時的注意事項

• resource和url不能同時使用，但是resource和property或者url和property能同時使用贱傀。
• 如果同時使用了resource和property或者是url和property惨撇，并且兩者存在重復(fù)的屬性，那么以resource或url中的屬性為準府寒，因為mybatis在加載配置的屬性時魁衙，先加載property中的屬性，后加載resource或url中的屬性株搔，所以在加載后者時剖淀，前者的屬性就會被覆蓋。
• 除了上述在xml文件中配置屬性之外纤房，還可以在JAVA代碼中為mybatis配置屬性纵隔，并且這種方式配置的屬性優(yōu)先級最高，也就是說如果配置文件中配置的屬性和下面JAVA代碼中配置的屬性重復(fù)了帆卓，那么以JAVA代碼中配置的屬性為準巨朦。具體使用如下所示：

@Test
public void getProperty() throws IOException {
    // 創(chuàng)建Properties對象，用來存放屬性
    Properties properties = new Properties();
    properties.setProperty("yinyw.mybatisDemo.port","9888");
    // 在mybatis構(gòu)建SqlSessionFactory時將Properties對象作為參數(shù)傳入進去
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlConfiguration.xml");
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream,properties);
}

• 屬性命名建議：項目名.模塊名.屬性名剑令。這樣做的好處在于易識別糊啡。

三、settings標簽

settings標簽主要用于改變MyBatis運行時的行為吁津。例如開啟二級緩存棚蓄、開啟延遲加載等。

1碍脏、配置參數(shù)如下表所示：

2、一份完整的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標簽

typeAliases標簽用于為映射配置文件中Java類型的參數(shù)和返回值設(shè)置一個簡短的名字逞壁，即設(shè)置別名流济。別名的設(shè)置與XML配置相關(guān)，其使用的意義在于減少全限定類名的冗余腌闯。

1绳瘟、mybatis默認支持的別名

2、自定義別名的兩種方式

• 使用typeAlias為單個的JAVA實體類定義別名姿骏，type屬性為JAVA實體類的全路徑糖声，alias為該實體類的別名。如果不寫alias屬性則默認為首字母小寫的JAVA實體類名分瘦。

<typeAliases>
    <typeAlias type="com.yinyw.china.pojo.Member" alias="member">
</typeAlias>

• 使用package批量為某個路徑下的JAVA實體類定義別名蘸泻，該路徑下所有JAVA實體類的別名為首字母小寫的JAVA實體類名。

<typeAliases>
    <package name="com.yinyw.china.pojo"/>
</typeAliases>

3嘲玫、在映射文件中使用別名

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.yinyw.china.mapper.IMemberMapper">
    
    <insert id="saveMember" parameterType="member">
        INSERT INTO member (account,password,username) VALUES(#{account},#{password},#{username})
    </insert>
    
    <delete id="deleteMemberById" parameterType="java.lang.Integer">
        DELETE FROM member WHERE ID = #{id}
    </delete>

    <update id="updateMember" parameterType="member">
        UPDATE member SET account = #{account} , password = #{password} , username = #{username}
    </update>

    <select id="queryMember" parameterType="java.lang.Integer" resultType="member">
        SELECT id,account,password,username FROM member WHERE id = #{id}
    </select>
    
</mapper>

五蟋恬、typeHandlers標簽

六、objectFactory標簽

七趁冈、plugins標簽

八、environments標簽

environments標簽用于對Mybatis使用的環(huán)境進行配置拜马，環(huán)境配置實際上就是數(shù)據(jù)源的配置渗勘。MyBatis支持配置多個環(huán)境。例如俩莽，開發(fā)旺坠、測試和生產(chǎn)環(huán)境需要有不同的配置；或者想在具有相同 Schema 的多個生產(chǎn)數(shù)據(jù)庫中使用相同的 SQL 映射扮超。還有許多類似的使用場景在此就不一一例數(shù)了取刃。雖然mybatis支持配置多個環(huán)境，但是在使用時還是需要我們?yōu)閙ybatis指明使用哪個環(huán)境出刷，如果沒有指明使用哪個環(huán)境璧疗，mybatis就會使用我們配置的默認環(huán)境。

1馁龟、配置environments

<!-- 配置環(huán)境崩侠。default：默認使用的環(huán)境，配置的值必須為下面各環(huán)境id中的某一個 -->
<environments default="dev">
    <!-- 開發(fā)環(huán)境坷檩。id屬性：環(huán)境別名 -->
    <environment id="dev">
        <!-- 事務(wù)管理器 -->
        <transactionManager type="JDBC"></transactionManager>
        <!-- 數(shù)據(jù)源 -->
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.dev.driver}"/>
            <property name="url" value="${jdbc.dev.url}"/>
            <property name="username" value="${jdbc.dev.username}"/>
            <property name="password" value="${jdbc.dev.password}"/>
        </dataSource>
    </environment>
    <!-- 配置測試環(huán)境-->
    <environment id="sit">
        <transactionManager type="JDBC"></transactionManager>
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.sit.driver}"/>
            <property name="url" value="${jdbc.sit.url}"/>
            <property name="username" value="${jdbc.sit.username}"/>
            <property name="password" value="${jdbc.sit.password}"/>
        </dataSource>
    </environment>
</environments>

2却音、使用environments，下面是mybatis源碼中SqlSessionFactoryBuilder創(chuàng)建SqlSessionFactory提供的方法矢炼，我們通過調(diào)用下面的方法可以使用指定的環(huán)境或者是使用默認的環(huán)境

public class SqlSessionFactoryBuilder {
    public SqlSessionFactoryBuilder() {
    }

    // 使用默認的環(huán)境
    public SqlSessionFactory build(Reader reader) {
        return this.build((Reader)reader, (String)null, (Properties)null);
    }

    // 使用參數(shù)environment指定的環(huán)境
    public SqlSessionFactory build(Reader reader, String environment) {
        return this.build((Reader)reader, environment, (Properties)null);
    }

    // 使用默認的環(huán)境
    public SqlSessionFactory build(Reader reader, Properties properties) {
        return this.build((Reader)reader, (String)null, properties);
    }

    // 使用參數(shù)environment指定的環(huán)境
    public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
        SqlSessionFactory var5;
        try {
            XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
            var5 = this.build(parser.parse());
        } catch (Exception var14) {
            throw ExceptionFactory.wrapException("Error building SqlSession.", var14);
        } finally {
            ErrorContext.instance().reset();

            try {
                reader.close();
            } catch (IOException var13) {
            }

        }

        return var5;
    }

    // 使用默認的環(huán)境
    public SqlSessionFactory build(InputStream inputStream) {
        return this.build((InputStream)inputStream, (String)null, (Properties)null);
    }

    // 使用參數(shù)environment指定的環(huán)境
    public SqlSessionFactory build(InputStream inputStream, String environment) {
        return this.build((InputStream)inputStream, environment, (Properties)null);
    }

    // 使用默認的環(huán)境
    public SqlSessionFactory build(InputStream inputStream, Properties properties) {
        return this.build((InputStream)inputStream, (String)null, properties);
    }

    // 使用參數(shù)environment指定的環(huán)境
    public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
        SqlSessionFactory var5;
        try {
            XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
            var5 = this.build(parser.parse());
        } catch (Exception var14) {
            throw ExceptionFactory.wrapException("Error building SqlSession.", var14);
        } finally {
            ErrorContext.instance().reset();

            try {
                inputStream.close();
            } catch (IOException var13) {
            }

        }

        return var5;
    }

    public SqlSessionFactory build(Configuration config) {
        return new DefaultSqlSessionFactory(config);
    }
}

3系瓢、transactionManager

transactionManager標簽通過type屬性來配置使用哪種事務(wù)管理器來管理Mybatis事務(wù)。type屬性支持如下兩種屬性值：

• JDBC：這個配置就是直接使用了JDBC 的提交和回滾設(shè)置句灌，它依賴于從數(shù)據(jù)源得到的連接來管理事務(wù)作用域夷陋。配置方式如下：

<transactionManager type="JDBC"></transactionManager>

• MANAGED：這個配置幾乎沒做什么。它從來不提交或回滾一個連接，而是讓容器來管理事務(wù)的整個生命周期（比如 JEE 應(yīng)用服務(wù)器的上下文）肌稻。默認情況下它會關(guān)閉連接清蚀，然而一些容器并不希望這樣，因此需要將closeConnection屬性設(shè)置為 false 來阻止它默認的關(guān)閉行為爹谭。

<transactionManager type="MANAGED">
    <property name="closeConnection" value="false"/>
</transactionManager>

4枷邪、dataSource

dataSource標簽通過type屬性來配置Mybatis如何連接數(shù)據(jù)庫。type屬性支持如下三種屬性值：

• UNPOOLED：這個數(shù)據(jù)源的實現(xiàn)只是每次被請求時打開和關(guān)閉連接诺凡。配置方式如下：

<dataSource type="UNPOOLED">
    <!-- 這是JDBC驅(qū)動的Java類全限定名 -->
    <property name="driver" value="com.mysql.jdbc.Driver"/>
    <!-- 這是數(shù)據(jù)庫的 JDBC URL 地址东揣。 -->
    <property name="url" value="jdbc:mysql://192.168.0.101:3306/mybatis?characterEncoding=utf8"/>
    <!-- 登錄數(shù)據(jù)庫的用戶名 -->
    <property name="username" value="root"/>
    <!-- 登錄數(shù)據(jù)庫的密碼 -->
    <property name="password" value="root"/>
    <!-- 默認的連接事務(wù)隔離級別 -->
    <property name="defaultTransactionIsolationLevel" value=""/>
    <!-- 等待數(shù)據(jù)庫操作完成的默認網(wǎng)絡(luò)超時時間（單位：毫秒） -->
    <property name="defaultNetworkTimeout" value=""/>
</dataSource>

• POOLED：這種數(shù)據(jù)源的實現(xiàn)利用“池”的概念將 JDBC 連接對象組織起來。配置方式如下：

<dataSource type="POOLED">
    <!-- 這是JDBC驅(qū)動的Java類全限定名 -->
    <property name="driver" value="com.mysql.jdbc.Driver"/>
    <!-- 這是數(shù)據(jù)庫的 JDBC URL 地址腹泌。 -->
    <property name="url" value="jdbc:mysql://192.168.0.101:3306/mybatis?characterEncoding=utf8"/>
    <!-- 登錄數(shù)據(jù)庫的用戶名 -->
    <property name="username" value="root"/>
    <!-- 登錄數(shù)據(jù)庫的密碼 -->
    <property name="password" value="root"/>
    <!-- 默認的連接事務(wù)隔離級別 -->
    <property name="defaultTransactionIsolationLevel" value=""/>
    <!-- 等待數(shù)據(jù)庫操作完成的默認網(wǎng)絡(luò)超時時間（單位：毫秒） -->
    <property name="defaultNetworkTimeout" value=""/>
    <!-- 在任意時間可存在的活動（正在使用）連接數(shù)量嘶卧，默認值：10 -->
    <property name="poolMaximumActiveConnections" value=""/>
    <!-- 任意時間可能存在的空閑連接數(shù) -->
    <property name="poolMaximumIdleConnections" value=""/>
    <!-- 在被強制返回之前，池中連接被檢出（checked out）時間凉袱，默認值：20000 毫秒（即 20 秒） -->
    <property name="poolMaximumCheckoutTime" value=""/>
    <!-- 這是一個底層設(shè)置芥吟，如果獲取連接花費了相當長的時間，連接池會打印狀態(tài)日志并重新嘗試獲取一個連接（避免在誤配置的情況下一直失敗且不打印日志）专甩，默認值：20000 毫秒（即 20 秒） -->
    <property name="poolTimeToWait" value=""/>
    <!-- 這是一個關(guān)于壞連接容忍度的底層設(shè)置钟鸵， 作用于每一個嘗試從緩存池獲取連接的線程。 如果這個線程獲取到的是一個壞的連接涤躲，那么這個數(shù)據(jù)源允許這個線程嘗試重新獲取一個新的連接棺耍，但是這個重新嘗試的次數(shù)不應(yīng)該超過 poolMaximumIdleConnections 與 poolMaximumLocalBadConnectionTolerance 之和。 默認值：3（新增于 3.4.5） -->
    <property name="poolMaximumLocalBadConnectionTolerance" value=""/>
    <!-- 發(fā)送到數(shù)據(jù)庫的偵測查詢种樱，用來檢驗連接是否正常工作并準備接受請求蒙袍。默認是“NO PING QUERY SET”，這會導(dǎo)致多數(shù)數(shù)據(jù)庫驅(qū)動出錯時返回恰當?shù)腻e誤消息 -->
    <property name="poolPingQuery" value=""/>
    <!-- 是否啟用偵測查詢嫩挤。若開啟害幅，需要設(shè)置 poolPingQuery 屬性為一個可執(zhí)行的 SQL 語句（最好是一個速度非常快的 SQL 語句）俐镐，默認值：false -->
    <property name="poolPingEnabled" value=""/>
    <!-- 配置 poolPingQuery 的頻率矫限。可以被設(shè)置為和數(shù)據(jù)庫連接超時時間一樣佩抹，來避免不必要的偵測叼风，默認值：0（即所有連接每一時刻都被偵測 — 當然僅當 poolPingEnabled 為 true 時適用） -->
    <property name="poolPingConnectionsNotUsedFor" value=""/>
</dataSource>

• JNDI：這個數(shù)據(jù)源的實現(xiàn)是為了能在如 EJB 或應(yīng)用服務(wù)器這類容器中使用，容器可以集中或在外部配置數(shù)據(jù)源棍苹，然后放置一個 JNDI 上下文的引用无宿。配置方式如下:

<!-- 1、在Tomcat的安裝目錄下的conf/目錄中找到context.xml文件枢里，打開孽鸡，在里添加如下代碼： -->
<Resource
    name="jndi/mybatis" 數(shù)據(jù)源的名稱
    auth="Container" 數(shù)據(jù)源提供者
    type="javax.sql.DataSource" 數(shù)據(jù)源類型
    driverClassName="com.mysql.jdbc.Driver" 驅(qū)動類
    url="jdbc:mysql://192.168.0.101:3306/mybatis?characterEncoding=utf8" 連接url字符串
    username="root" 用戶名
    password="root" 密碼
    maxActive="20" 最大活動數(shù)
    maxIdle="10" 最大空閑數(shù)
    maxWait="10000" 最大等待時間/>

<!-- 2蹂午、在mybatis核心配置文件中配置dataSource的第一種寫法 -->
<dataSource type="JNDI">
    <!-- 不同的容器該值不同，java:/comp/env為tomcat容器的寫法 -->
    <property name="initial_context" value="java:/comp/env"/>
    <!-- 容器中配置jndi數(shù)據(jù)源的名稱 -->
    <property name="data_source" value="jdbc/mybatis"/>
</dataSource>

<!-- 3彬碱、在mybatis核心配置文件中配置dataSource的第二種寫法 -->
<dataSource type="JNDI">
    <property name="data_source" value="java:/comp/env/jdbc/mybatis"/>
</dataSource>

九豆胸、databaseIdProvider標簽

databaseIdProvider標簽為MyBatis支持多廠商SQL語句的執(zhí)行提供支持。MyBatis 可以根據(jù)不同的數(shù)據(jù)庫廠商執(zhí)行不同的語句巷疼，這種多廠商的支持是基于映射語句中的 databaseId 屬性晚胡。 MyBatis 會加載不帶 databaseId 屬性和帶有匹配當前數(shù)據(jù)庫 databaseId 屬性的所有語句。如果同時找到帶有 databaseId 和不帶 databaseId 的相同語句嚼沿，則后者會被舍棄估盘。 配置方式如下：

• 在核心配置文件中配置數(shù)據(jù)庫廠商標志

<databaseIdProvider type="DB_VENDOR">
    <!-- name：數(shù)據(jù)庫廠商標志   value：別名 -->
    <property name="SQL Server" value="sqlserver" />
    <property name="MySQL" value="mysql" />
    <property name="DB2" value="db2" />
    <property name="Oracle" value="oracle" />
  </databaseIdProvider>

• 在映射語句中添加數(shù)據(jù)庫廠商標志

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.yinyw.china.mapper.IMemberMapper">

    <select id="queryMember" parameterType="java.lang.Integer" resultType="member" databaseId="oracle">
        SELECT id,account,password,username FROM member WHERE id = #{id}
    </select>

    <select id="queryMember" parameterType="java.lang.Integer" resultType="member" databaseId="mysql">
        SELECT id,account,password,username FROM member WHERE id = #{id}
    </select>
    
</mapper>

十、mappers標簽

mappers標簽用于指定MyBatis映射文件的位置骡尽。mappers有如下四種配置方式：

• 如果使用xml方式配置的映射遣妥，可以使用相對路徑來一個一個的指定映射文件的位置

<mappers>
    <mapper resource="mappers/MemberMapper.xml"></mapper>
</mappers>

• 如果使用xml方式配置的映射，也可以使用絕對路徑來一個一個的指定映射文件的位置

<mappers>
    <mapper url="file:///Users/yinyw/Documents/WorkSpace/MybatisDemo/src/main/resources/mappers/MemberMapper.xml"></mapper>
</mappers>

• 如果使用注解方式配置的映射攀细，則可以使用接口類的全路徑來一個一個的指定映射文件的位置

<mappers>
  <mapper class="com.yinyw.china.mapper.IMemberMapper"></mapper>
</mappers>

• 不論使用xml還是注解的方式箫踩，都可以使用package來批量指定映射文件的路徑

<mappers>
    <package name="com.yinyw.china.mapper"/>
</mappers>