MyBatis配置文件(五)－－objectFactory對象工廠

我們在使用MyBatis執行查詢語句的時候，通常都會有一個返回類型，這個是在mapper文件中給sql增加一個resultType(或resultMap)屬性進行控制。resultType和resultMap都能控制返回類型，只要定義了這個配置就能自動返回我想要的結果，於是我就很納悶這個自動過程的實現原理，想必大多數人剛開始的時候應該也有和我一樣的困惑和好奇，那么今天我就把自己的研究分享一下。在JDBC中查詢的結果會保存在一個結果集中，其實MyBatis也是這個原理，只不過MyBatis在創建結果集的時候，會使用其定義的對象工廠DefaultObjectFactory來完成對應的工作，下面來看一下其源代碼：

一、默認對象工廠DefaultObjectFactory.java

/**
 * @author Clinton Begin
 */
public class DefaultObjectFactory implements ObjectFactory, Serializable {

  private static final long serialVersionUID = -8855120656740914948L;

  @Override
  public <T> T create(Class<T> type) {
    return create(type, null, null);
  }

  @SuppressWarnings("unchecked")
  @Override
  public <T> T create(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs) {
    Class<?> classToCreate = resolveInterface(type);
    // we know types are assignable
    return (T) instantiateClass(classToCreate, constructorArgTypes, constructorArgs);
  }

  @Override
  public void setProperties(Properties properties) {
    // no props for default
  }

  private  <T> T instantiateClass(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs) {
    try {
      Constructor<T> constructor;
      if (constructorArgTypes == null || constructorArgs == null) {
        constructor = type.getDeclaredConstructor();
        if (!constructor.isAccessible()) {
          constructor.setAccessible(true);
        }
        return constructor.newInstance();
      }
      constructor = type.getDeclaredConstructor(constructorArgTypes.toArray(new Class[constructorArgTypes.size()]));
      if (!constructor.isAccessible()) {
        constructor.setAccessible(true);
      }
      return constructor.newInstance(constructorArgs.toArray(new Object[constructorArgs.size()]));
    } catch (Exception e) {
      StringBuilder argTypes = new StringBuilder();
      if (constructorArgTypes != null && !constructorArgTypes.isEmpty()) {
        for (Class<?> argType : constructorArgTypes) {
          argTypes.append(argType.getSimpleName());
          argTypes.append(",");
        }
        argTypes.deleteCharAt(argTypes.length() - 1); // remove trailing ,
      }
      StringBuilder argValues = new StringBuilder();
      if (constructorArgs != null && !constructorArgs.isEmpty()) {
        for (Object argValue : constructorArgs) {
          argValues.append(String.valueOf(argValue));
          argValues.append(",");
        }
        argValues.deleteCharAt(argValues.length() - 1); // remove trailing ,
      }
      throw new ReflectionException("Error instantiating " + type + " with invalid types (" + argTypes + ") or values (" + argValues + "). Cause: " + e, e);
    }
  }

  protected Class<?> resolveInterface(Class<?> type) {
    Class<?> classToCreate;
    if (type == List.class || type == Collection.class || type == Iterable.class) {
      classToCreate = ArrayList.class;
    } else if (type == Map.class) {
      classToCreate = HashMap.class;
    } else if (type == SortedSet.class) { // issue #510 Collections Support
      classToCreate = TreeSet.class;
    } else if (type == Set.class) {
      classToCreate = HashSet.class;
    } else {
      classToCreate = type;
    }
    return classToCreate;
  }

  @Override
  public <T> boolean isCollection(Class<T> type) {
    return Collection.class.isAssignableFrom(type);
  }

}

 在這個類中有6個方法：

1⃣️create(Class<T> type)：這個方法我認為是創建結果集的方法，但它其實是直接調用了第二個create方法，只不過后兩個參數傳的是null，所以直接看下面的方法；

2⃣️create(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs)：這個方法中傳了三個參數，分別應該是返回的結果集類型、此類構造函數參數類型、此類構造函數參數值。從它的內部實現來看，首先調用了下面的resolveInterface方法獲取返回類型，其次調用instantiateClass方法實例化出我們所需的結果集；

3⃣️setProperties(Properties properties)：這個方法是用來設置一些配置信息，比如我們給objectFactory定義一個property子元素時，就是通過這個方法進行配置的；

4⃣️instantiateClass(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs)：此方法是用來實例化一個類，需要實例化的類型是通過下面的resolveInterface方法決定，從內部實現來看，這個實例化過程是通過反射實現的；

5⃣️resolveInterface(Class<?> type）：此方法是用來對集合類型進行處理，即如果我們定義一個resultType為集合類型，那么它就會根據這個類型決定出即將創建的結果集類型；

6⃣️isCollection(Class<T> type)：這個方法是用來判斷我們配置的類型是不是一個集合。比如如果返回多條數據，但是我們配置resultType是個普通類，那么在執行過程中就會報錯；

以上就是MyBatis默認objectFactory中的具體實現，通過它來創建我們配置的結果集，一般情況下都會使用默認的對象工廠，但是我們也可以自定義一個，只要繼承DefaultObjectFactory.java即可。 

二、自定義一個對象工廠MyObjectFactory.java

package com.daily.objectfactory;

import java.util.List;
import java.util.Properties;

import org.apache.ibatis.reflection.factory.DefaultObjectFactory;

public class MyObjectFactory extends DefaultObjectFactory{

    private static final long serialVersionUID = 1L;
    
    @Override
    public void setProperties(Properties properties) {
        super.setProperties(properties);
        System.out.println("初始化參數：［"+properties.toString()+"]");
    }
    
    
    @Override
    public <T> T create(Class<T> type,List<Class<?>> constructorArgTypes,List<Object> constructorArgs) {
        T result = super.create(type, constructorArgTypes, constructorArgs);
        System.out.println("創建對象方法："+result.getClass().getSimpleName());
        return result;
    }
    
    @Override
    public <T> boolean isCollection(Class<T> type) {
        return super.isCollection(type);
    }

}

其實我們自定義的時候只要重寫其中的create方法就可以，至於選擇哪個，其實兩個都行，因為第一個方法內部還是調用了第二個，我在這里調用了第二個，還重寫了setProperties方法，用來查看其作用。

下面據一個例子來查看怎么使用自定義的objectFactory

第一步：配置

在mybatis-config.xml中做如下配置，並自定義一個property子元素，設置其name和value

<!--對象工廠 -->
    <objectFactory type="com.daily.objectfactory.MyObjectFactory">
        <property name="prop1" value="value1"/>
    </objectFactory>

第二步：配置查詢映射器接口和sql

接口：

//獲取所有的產品
public List<Product> getAllProduct();

 sql:

<select id="getAllProduct"resultMap="BaseResultMap">
        SELECT * FROM product
3 </select>

在上面的代碼中，接口返回的是一個List，而其中的元素是Product類，sql定義返回的結果集是一個BaseResultMap，其定義如下：

<resultMap id="BaseResultMap" type="com.daily.pojo.Product">
        <id column="id" jdbcType="VARCHAR" property="id" />
        <result column="product_name" jdbcType="VARCHAR" property="productName" />
        <result column="product_price" jdbcType="VARCHAR" property="productPrice" />
        <result column="product_type" jdbcType="VARCHAR" property="productType" />
</resultMap>

它們都在同一個mapper.xml文件中.

第三步：打印查詢結果

// 獲取商品列表
    public void getProductList() {
        List<Product> productList = productService.getProductList();
        for (Product product : productList) {
            System.out.println(product.getProductName());
        }
    }

獲取到商品列表之后進行遍歷並打印名稱

第四步：查詢結果

初始化參數：［{prop1=value1}]
創建對象方法：ArrayList
創建對象方法：Product
創建對象方法：Product
創建對象方法：Product
創建對象方法：Product
襯衫
衛衣
連衣裙
連衣裙

從執行結果來看，創建結果集的步驟如下：

1⃣️首先進行初始化參數，也就是根據objectFactory中的配置；

2⃣️然后創建了一個ArrayList對象；

3⃣️再創建四個Product對象（注意：查詢結果有幾條就創建幾個 ）；

4⃣️將四個對象設置到ArrayList中封裝成我們需要的返回類型List；

按照我的理解，mybatis創建結果集的過程是這樣的：首先根據sql執行的結果，即返回條數判斷是不是一個集合類型，然后將每條結果實例化成一個對象，如果前面判斷返回的是多條，則將這些對象設置到一個List中，否則就是一個單獨的對象，然后根據我們在映射器接口中定義的返回類型進行適配，如果接口定義返回List就返回List，如果接口定義返回一個單獨的類型，則返回實例化的對象。后來仔細一想不對呀，這樣的話如果查詢結果是一條，但是我在接口中定義的返回類型是List，那豈不是沖突了？為了研究這個創建過程，我又寫了兩個查詢接口，一個只返回一個對象，一個查詢所有但返回一個對象（這個按理說是不對的，主要看看mybatis會報什么錯），然后在DefaultObjectFactory中打斷點進行調試，下面介紹我的實驗過程：

第一步：再創建兩個查詢接口

1⃣️根據ID查詢

//查詢接口
public Product selectById(String id);

sql配置

<select id="selectById" parameterType="String" resultType="product">
        SELECT * FROM product p WHERE p.id = #{id,jdbcType=VARCHAR}
</select>

這個是根據ID查詢，返回類型是Product

2⃣️查詢所有

public Product getAllProducts();

sql配置

<select id="getAllProducts" resultType="product">
        SELECT * FROM product
</select>

這個是查詢所有，但返回類型是Product，即一個對象

第二步：對三種情況打斷點進行調試

在調試過程中我發現以下幾點：

1、在獲取SQL session對象的過程中就已經調用了DefaultObjectFactory中的setProperties方法，其實這個不難理解，畢竟在獲取SQL session之前就已經加載了mybatis的配置文件，首先當然要進行配置；

2、然后會進入到DefaultObjectFactory中的isCollection方法，而傳給它的參數類型就是我在映射器接口中定義的返回類型；

3、不管查詢出多少條數據，也不管返回類型是什么，首先都會調用create方法創建一個ArrayList對象；

4、查詢出多少條數據，就會調用多少次create方法，將一條數據封裝成一個類並進行實例化；

以上是三種不同的查詢結果都會執行的步驟，其他的中間還有很復雜的創建過程，根據我有限的理解，推斷出mybatis在創建結果集的過程如下：

1⃣️先判斷接口返回的類型是一個單獨的類還是一個集合；

2⃣️創建一個ArrayList對象；

3⃣️將每個查詢結果實例化成一個對象，然后設置到ArrayList對象中；

4⃣️如果在第一步中接口返回的是單獨的類，此時查看第三步封裝的結果，如果只有一條數據，則獲取對象並返回；如果有多條，則報錯；

    如果在第一步中接口返回的是一個集合，則直接返回第三步封裝的結果；

其實所謂結果集，必定是個集合，所以才會有創建ArrayList並將實例化的對象添加在其中這一步，至於怎么返回就要看接口中的定義了，如果mybatis能根據接口定義返回指定類型，則沒有任何問題，否則就會報錯，就像上面的第三種情況，封裝的結果集是個含多個product對象的集合，但是接口中定義只要一個對象，那這時候mybatis就不知道給哪個合適，所以只能報錯了。

以上就是我對objectFactory這個配置項的理解，不正確的地方希望看到文章的你能給予指正，謝了～～