MyBatis主配置文件

• 2020 年 6 月 1 日
• 筆記
• mybatis

MyBatis的使用非常簡單，使用流程整體可以分成以下四步：

public class UserDaoTest {

    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void setUp() throws Exception{
        ClassPathResource resource = new ClassPathResource("mybatis-config.xml");
        InputStream inputStream = resource.getInputStream();
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }

    @Test
    public void selectUserTest(){
        String id = "{0003CCCA-AEA9-4A1E-A3CC-06D884BA3906}";
        SqlSession sqlSession = sqlSessionFactory.openSession();
        CbondissuerMapper cbondissuerMapper = sqlSession.getMapper(CbondissuerMapper.class);
        Cbondissuer cbondissuer = cbondissuerMapper.selectByPrimaryKey(id);
        System.out.println(cbondissuer);
        sqlSession.close();
    }

}

• step1：根據主配置文件生成SqlSessionFactory；
• step2：從SqlSessionFactory獲取SqlSession;
• step3：利用SqlSession根據Mapper文件進行增刪改查；
• step4：關閉SqlSession。

上面的流程中涉及兩種配置文件：

• MyBatis主配置文件：MyBatis的主要行為屬性都是通過這個配置文件配置的，包括屬性配置、類型轉換配置、插件配置等，上面代碼中的mybatis-config.xml文件就是MyBatis的主配置文件；
• Mapper映射文件：SQL映射文件，將MyBatis的接口映射成具體的SQL語句，是我們開發時主要配置的文件。

今天我們就先來介紹下MyBatis的主配置文件，看看這個配置文件能配置MyBatis的哪些行為屬性。

一個主配置文件的列子

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "//mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <!--configuration中的這些屬性是有順序的，最好按照本列子中的順序配置-->

    <!--通過properties配置的屬性，我們可以在其他的配置中使用${}使用-->
    <!--在這邊配置的屬性，我們還能在Mapper.xml中使用${}形式使用-->
    
    <!--可以在多個地方進行屬性配置-->
    <!--通過方法參數傳遞的屬性具有最高優先級，
        resource/url 屬性中指定的配置文件次之，
        最低優先級的則是 properties 元素中指定的屬性。-->
    <properties resource="./app.properties">
        <property name="username" value="username1"/>
        <property name="password" value="password1"/>
        <!--MyBatis支持默認值，假如某些屬性沒取到值就取默認值-->
        <!--開啟默認值功能-->
        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
        <!--設置分隔符為-->
        <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="？:"/>
        <!-- 經過上面的配置，就可以像如下方式使用-->
        <!-- 如果配置了username屬性就使用這個配置，如果沒配置就使用ut_user這個默認值-->
        <!-- <property name="username" value="${db:username?:ut_user}"/>-->
    </properties>

    <!--一些重要的全局配置-->
    <!--關於配置的含義，請看下面的注釋-->
    <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="STATEMENT"/>
        <setting name="jdbcTypeForNull" value="OTHER"/>
        <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>

    <!--類型別名，指定了類型別名後就可以使用別名來代替全限定名-->
    <typeAliases>
        <typeAlias alias="Cbondissuer" type="com.csx.demo.spring.boot.entity.Cbondissuer"/>
        <!--為一個包下面的所有類設定別名，此時會使用 Bean 的首字母小寫的非限定類名來作為它的別名-->
        <package name="domain.blog"/>
    </typeAliases>

    <!--每次 MyBatis 創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成實例化工作。 
        默認的對象工廠需要做的僅僅是實例化目標類，要麼通過默認無參構造方法，要麼通過存在的參數映射來調用帶有
        參數的構造方法。 如果想覆蓋對象工廠的默認行為，可以通過創建自己的對象工廠來實現。-->
    <objectFactory type="org.mybatis.example.ExampleObjectFactory">
        <property name="someProperty" value="100"/>
    </objectFactory>

    <!--設置插件-->
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!--&lt;!&ndash;默認值為 false，當該參數設置為 true 時，如果 pageSize=0 或者 RowBounds.limit = 0 就會查詢出全部的結果&ndash;&gt;-->
            <!--如果某些查詢數據量非常大，不應該允許查出所有數據-->
            <property name="pageSizeZero" value="true"/>
        </plugin>
    </plugins>

    <!--可以配置多個數據源，通過default屬性設置哪個生效-->
    <environments default="dev">
        <environment id="dev">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://xx.xx.xx.xx:3308/xx"/>
                <property name="username" value="${username:ut_user}"/>
                <property name="password" value="${password}"/>
                <property name="poolMaximumIdleConnections" value="10"/>
            </dataSource>
        </environment>
        <environment id="stg">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://xx.xx.xx.xx:3308/xx"/>
                <property name="username" value="${username:ut_user}"/>
                <property name="password" value="${password}"/>
                <property name="poolMaximumIdleConnections" value="10"/>
            </dataSource>
        </environment>
    </environments>

    <!--MyBatis 可以根據不同的數據庫廠商執行不同的語句，這種多廠商的支持是基於映射語句中的 databaseId 屬性。 
        MyBatis 會加載不帶 databaseId 屬性和帶有匹配當前數據庫 databaseId 屬性的所有語句。 如果同時找到
        帶有 databaseId 和不帶 databaseId 的相同語句，則後者會被捨棄。 -->
    <databaseIdProvider type="DB_VENDOR">
        <!--開啟MySQL，加入此時在Mapper文件中有兩個id一樣的查詢語句，但是一條的databaseId是mysql，
            另一條的databaseId是oracle，那麼databaseId是mysql的將被執行-->
        <property name="MySQL" value="mysql" />
        <!--<property name="Oracle" value="oracle" />-->
    </databaseIdProvider>

    <mappers>
        <!--這邊可以使用package和resource兩種方式加載mapper-->
        <!--推薦使用resource這種-->
        <mapper resource="./mappers/CbondissuerMapper.xml"/>
    </mappers>

</configuration>

Setting配置項的含義

MyBatis內置別名

參考

• MyBatis官方文檔