Mybatis的核心配置

之前了解了Mybatis的基本用法，現在學習一下Mybatis框架中的核心對象以及映射文件和配置文件，來深入的了解這個框架。

1.Mybatis的核心對象

使用MyBatis框架時，主要涉及兩個核心對象：SqlSessionFactory和SqlSession。

1.1.1 SqlSessionFactory

SqlSessionFactory是MyBatis框架中十分重要的對象，它是單個數據庫映射關系經過編譯后的內存鏡像，其主要作用是創建SqlSession。
SqlSessionFactory對象的實例可以通過SqlSessionFactoryBuilder對象來構建，而SqlSessionFactoryBuilder則可以通過XML配置文件或一個預先定義好的Configuration實例構建出SqlSessionFactory的實例。

• 通過XML配置文件構建出的SqlSessionFactory實例現代碼如下：

InputStream inputStream = Resources.getResourceAsStream("配置文件位置");
SqlSessionFactory sqlSessionFactory = 
                              new SqlSessionFactoryBuilder().build(inputStream);

• SqlSessionFactory對象是線程安全的，它一旦被創建，在整個應用執行期間都會存在。如果我們多次的創建同一個數據庫的SqlSessionFactory，那么此數據庫的資源將很容易被耗盡。
  為此，通常每一個數據庫都會只對應一個SqlSessionFactory，所以在構建SqlSessionFactory實例時，建議使用單列模式。

1.1.2 SqlSession

SqlSession是MyBatis框架中另一個重要的對象，它是應用程序與持久層之間執行交互操作的一個單線程對象，其主要作用是執行持久化操作。
每一個線程都應該有一個自己的SqlSession實例，並且該實例是不能被共享的。同時，SqlSession實例也是線程不安全的，因此其使用范圍最好在一次請求或一個方法中，
絕不能將其放在一個類的靜態字段、實例字段或任何類型的管理范圍（如Servlet的HttpSession）中使用。
使用完SqlSession對象后要及時關閉，通常可以將其放在finally塊中關閉。

    SqlSession sqlSession = sqlSessionFactory.openSession();
    try {
           // 此處執行持久化操作
    } finally {
          sqlSession.close();
    }

SqlSession 中常用的方法
查詢方法：

• <T> T selectOne(String statement);參數statement是在配置文件中定義的<select> 元素的id。使用該方法會返回查詢結果的一條泛型對象。

• <T> T selectOne(String statement, Object parameter);參數statement是在配置文件中定義的<select> 元素的id，parameter是查詢所需的參數。使用該方法會返回查詢結果的一條泛型對象。

• <E> List<E> selectList(String statement);參數statement是在配置文件中定義的<select> 元素的id。使用該方法，會返回查詢結果的泛型對象的集合。

• <E> List<E> selectList(String statement, Object parameter);參數statement是在配置文件中定義的<select> 元素的id，parameter是查詢所需的參數。使用該方法，會返回查詢結果的泛型對象的集合。

• <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds);參數statement是在配置文件中定義的<select> 元素的id，parameter是查詢所需的參數，rowBounds是用於分頁的參數對象。
  使用該方法，會返回查詢結果的泛型對象的集合。

• void select(String statement, Object parameter, ResultHandler handler);參數statement是在配置文件中定義的<select> 元素的id，parameter是查詢所需的參數，ResultHandler 是用於處理查詢返回的復雜結果集，通常用於多表查詢。

插入、更新和刪除方法：

• int insert(String statement);參數statement是在配置文件中定義的 元素的id，返回SQL語句所影響的行數。

• int insert(String statement, Object parameter);參數statement是在配置文件中定義的<insert> 元素的id，parameter是插入所需要參數。返回SQL語句所影響的行數。

• int update(String statement);參數statement是在配置文件中定義的 元素的id，返回SQL語句所影響的行數。

• int update(String statement, Object parameter);參數statement是在配置文件中定義的<update> 元素的id，parameter是更新所需要的參數。返回SQL語句所影響的行數。

• int delete(String statement);參數statement是在配置文件中定義的<delete> 元素的id，返回SQL語句所影響的行數。

• int delete(String statement, Object parameter);參數statement是在配置文件中定義的<delete> 元素的id，parameter是刪除所需要的參數。返回SQL語句所影響的行數。

其他方法：

• void commit(); 提交事務的方法。

• void rollback(); 回滾事務的方法。

• void close(); 關閉SqlSession對象。

• <T> T getMapper(Class<T> type); 返回Mapper接口的代理對象。

• Connection getConnection(); 獲取JDBC數據庫連接對象的方法。

2.配置文件

在MyBatis框架的核心配置文件中，<configuration>元素是配置文件的根元素，其他元素都要在<configuration>元素內配置。MyBatis配置文件中的主要元素如下圖所示：

2.1.1 <properties>元素

<properties>是一個配置屬性的元素，該元素通常用來將內部的配置外在化，即通過外部的配置來動態的替換內部定義的屬性。
例如，數據庫的連接等屬性，就可以通過典型的Java屬性文件中的配置來替換，具體方式如下：
1.編寫db.properties

jdbc.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
jdbc.url=jdbc:sqlserver://1localhost:1433;DatabaseName=mybatis
jdbc.username=sa
jdbc.password=123456

2.配置<properties>屬性

<properties resource="db.properties" />

3.修改配置文件中數據庫連接的信息

<dataSource type="POOLED">
    <!-- 數據庫驅動 -->
    <property name="driver" value="${jdbc.driver}" />
    <!-- 連接數據庫的url -->
    <property name="url" value="${jdbc.url}" />
    <!-- 連接數據庫的用戶名 -->
    <property name="username" value="${jdbc.username}" />
    <!-- 連接數據庫的密碼 -->
    <property name="password" value="${jdbc.password}" />
</dataSource>

2.1.2 <settings>元素

<settings>元素主要用於改變MyBatis運行時的行為，例如開啟二級緩存、開啟延遲加載等。這些配置只需要了解，有很多就不列出來了。

2.1.3 <typeAliases>元素

<typeAliases>元素用於為配置文件中的Java類型設置一個簡短的名字，即設置別名。別名的設置與XML配置相關，其使用的意義在於減少全限定類名的冗余。

1. 使用<typeAliases>元素配置別名的方法如下：

     <typeAliases>
             <typeAlias alias="user" type="com.itheima.po.User"/>
     </typeAliases>

2. 當POJO類過多時，可以通過自動掃描包的形式自定義別名，具體如下：

    <typeAliases>
             <package name="com.itheima.po"/>
     </typeAliases>

MyBatis框架默認為許多常見的Java類型提供了相應的類型別名，如下表所示。

2.1.4 <typeHandler>元素

typeHandler的作用就是將預處理語句中傳入的參數從javaType（Java類型）轉換為jdbcType（JDBC類型），或者從數據庫取出結果時將jdbcType轉換為javaType。
<typeHandler>元素可以在配置文件中注冊自定義的類型處理器，它的使用方式有兩種。
1.注冊一個類的類型處理器

     <typeHandlers> 
          <typeHandler handler="com.itheima.type.CustomtypeHandler" />
     </typeHandlers>

2.注冊一個包中所有的類型處理器

     <typeHandlers> 
          <package name="com.itheima.type" />
     </typeHandlers>

2.1.5<objectFactory>元素

MyBatis中默認的ObjectFactory的作用是實例化目標類，它既可以通過默認構造方法實例化，也可以在參數映射存在的時候通過參數構造方法來實例化。通常使用默認的ObjectFactory即可。
大部分場景下都不用配置和修改默認的ObjectFactory ，如果想覆蓋ObjectFactory的默認行為，可以通過自定義ObjectFactory來實現，具體如下：
1.自定義一個對象工廠

public class MyObjectFactory extends DefaultObjectFactory {
            private static final long serialVersionUID = -4114845625429965832L;
            public <T> T create(Class<T> type) {
	return super.create(type);
            }
            public <T> T create(Class<T> type, List<Class<?>> constructorArgTypes, 
                         List<Object> constructorArgs) {
	return super.create(type, constructorArgTypes, constructorArgs);
            }
            public void setProperties(Properties properties) {
	super.setProperties(properties);
            }
            public <T> boolean isCollection(Class<T> type) {
	return Collection.class.isAssignableFrom(type);
            }
    }

2.在配置文件中使用<objectFactory>元素配置自定義的ObjectFactory

<objectFactory type="com.itheima.factory.MyObjectFactory">
     <property name="name" value="MyObjectFactory"/>
</objectFactory>

注意：由於自定義ObjectFactory在實際開發時不經常使用，這里讀者只需要了解即可。

2.1.6<plugins>元素

MyBatis允許在已映射語句執行過程中的某一點進行攔截調用，這種攔截調用是通過插件來實現的。 元素的作用就是配置用戶所開發的插件。
如果用戶想要進行插件開發，必須要先了解其內部運行原理，因為在試圖修改或重寫已有方法的行為時，很可能會破壞MyBatis原有的核心模塊。
只需了解 元素的作用即可，有興趣的讀者可以查找官方文檔等資料自行學習。

2.1.7 <environments>元素

<environments>元素用於對環境進行配置。MyBatis的環境配置實際上就是數據源的配置，我們可以通過 元素配置多種數據源，即配置多種數據庫。
使用<environments>元素進行環境配置的示例如下：

      <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>

<transactionManager>元素用於配置事務管理，它的type屬性用於指定事務管理的方式，即使用哪種事務管理器；<dataSource>元素用於配置數據源，它的type屬性用於指定使用哪種數據源。
在MyBatis中，可以配置兩種類型的事務管理器，分別是JDBC和MANAGED。關於這兩個事務管理器的描述如下：

• JDBC：此配置直接使用了JDBC的提交和回滾設置，它依賴於從數據源得到的連接來管理事務的作用域。

• MANAGED：此配置從來不提交或回滾一個連接，而是讓容器來管理事務的整個生命周期。默認情況下，它會關閉連接，但一些容器並不希望這樣，為此可以將closeConnection屬性設置為false來阻止它默認的關閉行為。

注意：如果項目中使用的是Spring+ MyBatis，則沒有必要在MyBatis中配置事務管理器，因為實際開發中，會使用Spring自帶的管理器來實現事務管理。

對於數據源的配置，MyBatis提供了UNPOOLED、POOLED、JNDI三種數據源類型。

1. UNPOOLED
   配置此數據源類型后，在每次被請求時會打開和關閉連接。它對沒有性能要求的簡單應用程序是一個很好的選擇。在使用時，需要配置5種屬性。
   

2.POOLED
此數據源利用“池”的概念將JDBC連接對象組織起來，避免了在創建新的連接實例時所需要初始化和認證的時間。這種方式使得並發Web應用可以快速的響應請求，是當前流行的處理方式。在使用時，可以配置更多的屬性。

3.JNDI
可以在EJB或應用服務器等容器中使用。容器可以集中或在外部配置數據源，然后放置一個JNDI上下文的引用。在使用時，需要配置2個屬性。

2.1.9 <mappers>元素

<mappers>元素用於指定MyBatis映射文件的位置，一般可以使用以下4種方法引入映射器文件，具體如下。
1.使用類路徑引入

<mappers>
    <mapper resource="com/itheima/mapper/UserMapper.xml"/>
</mappers>

2.使用本地文件路徑引入

<mappers>
    <mapper url="file:///D:/com/itheima/mapper/UserMapper.xml"/>
</mappers>

3.使用接口類引入

<mappers>
    <mapper class="com.itheima.mapper.UserMapper"/>
</mappers>

4.使用包名引入

<mappers>
    <package name="com.itheima.mapper"/>
</mappers>

這幾種方式，可以根據你的需要選取使用。

3.映射文件

3.1.1 主要元素

在映射文件中，<mapper>元素是映射文件的根元素，其他元素都是它的子元素。 如下圖：

3.1.2 <select>元素

使用<select>元素執行查詢操作非常簡單，其示例如下：

<select id="findCustomerById" parameterType="Integer"
            resultType="com.itheima.po.Customer">
            select * from t_customer where id = #{id}
</select>

<select>元素的常用屬性：

3.1.3 <insert>元素

<insert>元素用於映射插入語句，在執行完元素中定義的SQL語句后，會返回一個表示插入記錄數的整數。
<insert>元素的配置示例如下：

<insert
      id="addCustomer"
      parameterType="com.itheima.po.Customer"
      flushCache="true"
      statementType="PREPARED"
      keyProperty=""
      keyColumn=""
      useGeneratedKeys=""
      timeout="20">

<insert>元素的屬性：
<insert>元素的屬性與<select>元素的屬性大部分相同，但還包含了3個特有屬性，這3個屬性的描述如下所示。

執行插入操作后，很多時候需要返回插入成功的數據生成的主鍵值，此時就可以通過上面講解的3個屬性來實現。
1.對於支持主鍵自助增長的數據庫（如MySQL），可以通過如下配置實現：

<insert id="addCustomer" parameterType="com.itheima.po.Customer"
            keyProperty="id" useGeneratedKeys="true" >
      insert into t_customer(username,jobs,phone)
      values(#{username},#{jobs},#{phone})
</insert>

2.對於不支持主鍵自助增長的數據庫(如Oracle)，可以通過如下配置實現：

<insert id="insertCustomer" parameterType="com.itheima.po.Customer">
      <selectKey keyProperty="id" resultType="Integer" order="BEFORE">
            select if(max(id) is null, 1, max(id) +1) as newId from t_customer
      </selectKey>	        
      insert into t_customer(id,username,jobs,phone)
      values(#{id},#{username},#{jobs},#{phone})
</insert>

3.1.4 <update>和<delete>元素

<update>和<delete>元素的使用比較簡單，它們的屬性配置也基本相同。
1.<update>和<delete>元素的常用屬性如下：

<update
      id="updateCustomer"
      parameterType="com.itheima.po.Customer"
      flushCache="true"
      statementType="PREPARED"
      timeout="20">
<delete
      id="deleteCustomer"
      parameterType="com.itheima.po.Customer"
      flushCache="true"
      statementType="PREPARED"
      timeout="20">

2.<update>和<delete>元素的使用示例如下：

<update id="updateCustomer" parameterType="com.itheima.po.Customer">
       update t_customer 
       set username=#{username},jobs=#{jobs},phone=#{phone}
       where id=#{id}
</update>

<delete id="deleteCustomer" parameterType="Integer">
        delete from t_customer where id=#{id}
</delete>

3.1.5 <sql>元素

在一個映射文件中，通常需要定義多條SQL語句，這些SQL語句的組成可能有一部分是相同的（如多條select語句中都查詢相同的id、username、jobs字段），
如果每一個SQL語句都重寫一遍相同的部分，勢必會增加代碼量，導致映射文件過於臃腫。那么有沒有什么辦法將這些SQL語句中相同的組成部分抽取出來，然后在需要的地方引用呢？
<sql>元素的作用就是定義可重用的SQL代碼片段，然后在其他語句中引用這一代碼片段。就好像java中，把重復的代碼封裝起來，方便使用是一樣的。
定義一個包含id、username、jobs和phone字段的代碼片段如下：

<sql id="customerColumns">id,username,jobs,phone</sql>

上述代碼片段可以包含在其他語句中使用，具體如下：

<select id="findCustomerById" parameterType="Integer"
            resultType="com.itheima.po.Customer">
    select <include refid="customerColumns"/>
    from t_customer 
    where id = #{id}
</select>

定義sql片段，通過<include>元素的refid屬性引用id為someinclude的代碼片段，先加入from,再通過獲取<property>元素的值來組成表名

<!--定義表的前綴名 -->
<sql id="tablename">
    ${prefix}customer
</sql>
<!--定義要查詢的表 -->
<sql id="someinclude">
    from
    <include refid="${include_target}" />		
</sql>
<!--定義查詢列 -->
<sql id="customerColumns">
   id,username,jobs,phone
</sql>
<select id="findCustomerById" parameterType="Integer" 
         resultType="com.itheima.po.Customer">
    select 
    <include refid="customerColumns"/>
    <include refid="someinclude">
        <property name="prefix" value="t_" />
        <property name="include_target" value="tablename" />
    </include>
<!--加入where子句-->
    where id = #{id}
</select>

3.1.6 <resultMap>元素

<resultMap>元素表示結果映射集，是MyBatis中最重要也是最強大的元素。它的主要作用是定義映射規則、級聯的更新以及定義類型轉化器等。
<resultMap>元素中包含了一些子元素，它的元素結構如下所示：

<resultMap type="" id="">
       <constructor>    <!-- 類在實例化時,用來注入結果到構造方法中-->
             <idArg/>      <!-- ID參數;標記結果作為ID-->
             <arg/>          <!-- 注入到構造方法的一個普通結果-->
       </constructor>  
       <id/>                 <!-- 用於表示哪個列是主鍵-->
       <result/>           <!-- 注入到字段或JavaBean屬性的普通結果-->
       <association property="" />        <!-- 用於一對一關聯 -->
       <collection property="" />          <!-- 用於一對多關聯 -->
       <discriminator javaType="">      <!-- 使用結果值來決定使用哪個結果映射-->
            <case value="" />                   <!-- 基於某些值的結果映射 -->
       </discriminator>	
</resultMap>

<resultMap>元素使用案例：
1.新建數據表t_user，插入測試數據。

use mybatis
create table t_user(
            t_id int  identity(1,1) PRIMARY key,
            t_name varchar(50),
            t_age int
)
insert into t_user values ('lulu','23');
insert into t_user values ('lili','25');
insert into t_user values ('jiji','18');

2.新建持久化類User，並定義屬性。

/**
 * @author mz
 * @version V1.0
 * @Description: 用戶實體類
 * @create 2017-11-01 14:13
 */
public class User {
    private Integer id;
    private String name;
    private Integer age;
    //省略setter和getter方法
}

3.創建UserMapper.xml，編寫映射查詢語句。

<?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.itheima.mapper.UserMapper">
    
<resultMap id="resultMap" type="com.itheima.po.User">
    <!--<id>和<result>的property屬性表示User類的屬性名，column屬性表示數據表t_user的列名。-->
    <id property="id" column="t_id"/>
    <result property="name" column="t_name"/>
    <result property="age" column="t_age"/>
</resultMap>
<select id="findAllUser" resultMap="resultMap">
    <!--<select>元素的resultMap屬性表示引用上面定義的resultMap-->
    select * from t_user
</select>
</mapper>

4.在配置文件mybatis-config中，引入UserMapper.xml，並編寫測試方法

<!--配置mapper的位置-->
        <mappers>
            <mapper resource="com/itheima/mapper/CustomerMapper.xml"/>
            <mapper resource="com/itheima/mapper/UserMapper.xml"/>
        </mappers>

@Test
    public void findAllUserTest() {
        //獲取SqlSession
        SqlSession sqlSession = MybatisUtils.getSession();
        //執行映射文件中定義的SQL，並返回結果
        List<User> list = sqlSession.selectList("com.itheima.mapper.UserMapper.findAllUser");
        for (User user : list) {
            System.out.println(user);
        }
        //關閉SqlSession
        sqlSession.close();
    }

運行結果如下圖所示：

從結果可以看出，t_user表的列名和User對象的屬性名完全不一樣，但查詢出的數據還是正常的封裝到了User對象中。

總結

首先學習了MyBatis中的兩個重要核心對象SqlSessionFactory和SqlSession；然后是配置文件中的元素及其使用；最后對映射文件中的幾個主要元素進行了詳細的了解。
以上內容是根據Java EE企業級應用開發教程（Spring+Spring MVC+MyBatis）做的一些筆記和總結。