MyBatis全局配置文件

配置properties

可以在全局配置文件中配置properties標簽來進行外部配置

設置屬性的方式有三種

• 在properties的屬性節點resource或url所指定的資源文件中配置
• 在properties的子節點property中配置
• 在構建SqlSessionFactory時通過方法傳入參數

外部配置文件引入

jdbc.driver=com.MySQL.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=123456

<!-- 使用 properties來引入外部配置文件內容-->
<!-- resource  引入類路徑下的資源
     url  引入網路或磁盤路徑下的資源
 -->
<properties resource="jdbc.properties">
</properties>
<!-- 數據庫配置 -->
<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <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>
    </environment>
</environments>

property子節點配置

<!-- 也可以使用property子節點來進行配置 -->
<properties resource="jdbc.properties">
    <property name="jdbc.password" value="123456"/>
    <!-- 啟用默認值特性 -->
    <property name="org.Apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
    <!-- 修改默認值的分隔符 -->
    <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
</properties>
<!-- 數據庫配置 -->
<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <!-- 可以使用:來為占位符設置默認值，如果沒有讀取到該屬性的值，會使用該默認值
             該特性默認關閉，需要配置        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
             如果開啟該特性，默認使用:分隔
             可以使用         <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
             來修改默認分隔符
             -->
            <property name="password" value="${jdbc.password?:123456}"/>
        </dataSource>
    </environment>
</environments>

實例化時方法傳參

public static SqlSessionFactory createFactory(){
    // 獲取到mybatis-config.xml配置文件，進而構建SqlSessionFactory
    InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream("mybatis-config.xml");
    Properties props = new Properties();
    props.put("jdbc.password","123456");
    return new SqlSessionFactoryBuilder().build(is,props);
}

三種方式的順序

• 首先讀取property子節點中指定的屬性
• 再讀取使用resources或url引入的外部配置文件中屬性，并覆蓋之前的同名屬性
• 最后讀取作為方法傳遞的參數，并覆蓋之前的同名屬性

配置settings

進行mybatis的自定義設置

配置typeAliases類型別名

類型別名可以為java類型設置別名，之后使用全類名時可以使用別名

<typeAliases>
    <!-- typeAlias為某個類起別名 -->
    <typeAlias type="com.zhanghe.study.mybatis.model.User" alias="User"/>

    <!-- 為某個包下所有類批量起別名
        默認值為類名首字母小寫
     -->
    <package name="com.zhanghe.study.mybatis.model"/>
</typeAliases>

也可以在類上使用@Alias注解來設置該類的別名

配置類型處理器typeHandlers

數據庫類型和java類型進行轉換

實現 org.apache.ibatis.type.TypeHandler 接口， 或繼承 org.apache.ibatis.type.BaseTypeHandler， 并且可以將它映射到一個 JDBC 類型

@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler extends BaseTypeHandler<String> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}

<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

配置插件plugins

mybatis可以使用插件來在映射語句執行過程中的某一點進行攔截調用，包括

• Executor (update、query、flushStatements、commit、rollback、getTransaction、close、isClose)
• ParameterHandler (getParameterObject、setParameters)
• ResultSetHandler (handleResultSets、handleOutputParameters)
• StatementHandler (prepare、parameterize、batch、update、query)

需要實現Interceptor接口，并指定想要攔截的方法簽名來使用插件

Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  private Properties properties = new Properties();
  public Object intercept(Invocation invocation) throws Throwable {
    // implement pre processing if need
    Object returnObject = invocation.proceed();
    // implement post processing if need
    return returnObject;
  }
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
}

<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

注意：如果有多個插件攔截相同方法的時候，會按照配置的先后順序來進行包裝代理，在執行時會執行最外層的插件，也就是逆向執行

配置環境environments

mybatis可以配置多個環境，可以連接多個數據庫，但是每個SqlSessionFactory實例只可以選擇一種環境

在構建sqlSessionFactory的時候可以指定選擇創建哪個環境

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);

<!-- 環境 default表示默認使用環境  -->
<environments default="development">
    <environment id="development">
        <!-- 事務管理器有兩種類型
            1、JDBC  該配置直接使用了JDBC的提交和回滾，依賴從數據源獲得的連接來管理事務作用域
            2、MANAGED 使用容器來管理事務的整個生命周期(spring會使用自帶的管理器，不需要配置mybatis的事務管理器)
         -->
        <transactionManager type="JDBC"/>
        <!-- 數據源有三種類型
            1、UNPOOLED  每次請求時打開和關閉連接
                額外屬性  - defaultTransactionIsolationLevel  默認的連接事務隔離級別
                         - defaultNetworkTimeout  等待數據庫操作完成的默認網絡超時時間
            2、POOLED  利用連接池的概念將JDBC連接對象組織起來，避免了創建新的連接實例
                額外屬性
                    - poolMaximumactiveConnections 在任意時間可存在的活動連接數，默認10
                    - poolMaximumIdleConnections  任意時間可能存在的空閑連接數
                    - poolMaximumCheckoutTime  在被強制返回之前，池中連接被檢出時間，默認20000毫秒
                    - poolTimeToWait  如果獲取連接花費了很長的時間，連接池會打印狀態日志并重新嘗試獲取一個連接，默認20000毫秒
                    - poolMaximumLocalBadConnectionTolerance  如果一個線程獲取到一個壞的連接，數據源允許這個線程嘗試重新獲取一個新的連接，
                                                              嘗試次數不應該超過poolMaximumIdleConnections與poolMaximumLocalBadConnectionTolerance之和，默認為3
                    - poolPingQuery  發送到數據庫的偵測查詢，用來檢驗連接是否正常工作   默認 NO PING QUERY SET
                    - poolPingEnabled  是否啟用偵測查詢  默認false
                    - poolPingConnectionsNotUsedFor  配置poolPingQuery的頻率(可以設置為和數據庫連接超時時間一樣，避免不必要的偵測)  默認0
            3、JNDI  在外部配置數據源，然后一個JNDI上下文數據源引用
                額外屬性
                    - initial_context  用來在InitialContext中尋找上下文
                    - data_source  引用數據源實例的上下文路徑
         -->
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <!-- 可以使用:來為占位符設置默認值，如果沒有讀取到該屬性的值，會使用該默認值
             該特性默認關閉，需要配置        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
             如果開啟該特性，默認使用:分隔
             可以使用         <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
             來修改默認分隔符
             -->
            <property name="password" value="${jdbc.password?:123456}"/>
        </dataSource>
    </environment>

也可以實現
org.apache.ibatis.datasource.DataSourceFactory接口來自定義數據源實現，然后進行配置

配置數據庫廠商標識 databaseIdProvider

mybatis可以根據不同的數據庫廠商執行不同的語句，基于映射語句中的databaseId屬性。mybatis會加載帶有匹配當前數據庫databaseId屬性個所有不帶databaseId屬性的語句。如果同時找到帶有databaseId的不帶databaseId的相同語句，后者會被舍棄

<!-- 數據庫廠商標識 -->
<databaseIdProvider type="DB_VENDOR">
  <!-- name為使用DatabaseMetaData#getDatabaseProductName()返回的廠商名稱
             value為所設置的別名,使用databaseId時使用別名即可 -->
  <property name="MySQL" value="mysql"/>
  <property name="Oracle" value="oracle"/>
</databaseIdProvider>

在mapper.xml中可以配置不同數據庫的sql語句

<!-- 查詢數據的方法 -->
<!-- mysql -->
<select id="selectUser" resultType="User" databaseId="mysql">
    select * from users where id = #{id}
</select>
<!-- oracle -->
<select id="selectUser" resultType="User" databaseId="oracle">
    select * from users where id = #{id}
</select>

可以實現
org.apache.ibatis.mapping.DatabaseIdProvider接口自定義DatabaseIdProvider

配置映射器mappers

將寫好的sql映射文件(mapper.xml)注冊到全局配置文件中

<!-- mapper配置 -->
<mappers>
    <!-- resource  引入類路徑下的資源  -->
    <mapper resource="mapper/UserMapper.xml"/>
    <!-- url  引入網絡或者磁盤路徑下的sql映射文件 -->
    <mapper url=""/>
    <!-- class  基于注解的方式，注冊類文件 -->
    <mapper class="com.zhanghe.study.mybatis.mapper.UserMapper"/>
    <!-- 批量注冊 注冊整個包下的-->
    <package name="com.zhanghe.study.mybatis.mapper"/>
</mappers>