MyBatis之ObjectFactory

關於在MyBatis中的ObjectFactory有什么用，在官方文檔中有這樣的描述（大多數網上的博客都是直接引用這一描述）：MyBatis 每次創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成。 默認的對象工廠需要做的僅僅是實例化目標類，要么通過默認構造方法，要么在參數映射存在的時候通過參數構造方法來實例化。 如果想覆蓋對象工廠的默認行為，則可以通過創建自己的對象工廠來實現。對於像我這種水平的來說，完全就是一臉蒙逼，這到底有啥用？可以說這個對象工廠就是用來創建實體類的，MyBatis有一個DefaultObjectFactory默認對象工廠類，就像上面所說的默認的對象工廠需要做的僅僅是實例化目標類，要么通過默認構造方法，要么在參數映射存在的時候通過參數構造方法來實例化。它不做其他任何的處理。如果我們想在創建實例化一個目標類的時候做點啥其他的動作，可以繼承DefaultObjectFactory，覆寫父類方法，並在mybatis-config.xml中注冊配置這個對象工廠類。

自己實現一個對象工廠如下所示：

package day_8_mybatis.util;

import java.util.Collection;
import java.util.Iterator;
import java.util.Properties;

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

import day_8_mybatis.pojo.People;

/**
 * @author turbo
 *
 * 2016年10月24日
 */
public class ExampleObjectFactory extends DefaultObjectFactory {

    @Override
    public Object create(Class type) {
        if (type.equals(People.class)){
            People p = (People)super.create(type);
            p.setAge(22);
            p.setName("keven");
            return p;
        }
        return super.create(type);
    }

    @Override
    public void setProperties(Properties properties) {
        Iterator iterator = properties.keySet().iterator();
        while (iterator.hasNext()){
            String keyValue = String.valueOf(iterator.next());
            System.out.println(properties.getProperty(keyValue));
        }
        super.setProperties(properties);
    }

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

}

我們可以先看下第30行這個setProperties方法，發現有一個Properties參數傳遞進來，這個參數在哪兒傳遞的呢？就是在我們的mybatis-config.xml的第18行。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration  
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
  
<configuration>
<!-- 注意configuration中各個屬性配置的順序應為：properties,settings,typeAliases,typeHandlers,objectFactory,objectWrapperFactory,reflectorFactory,plugins,environments,databaseIdProvider,mappers)-->
    <properties>
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/test"/>    
        <property name="username" value="root"/>
        <property name="password" value="0000"/>
    </properties>
    <typeHandlers>
        <typeHandler handler="day_8_mybatis.util.ExampleTypeHandler" javaType="java.util.Date" jdbcType="VARCHAR"/>
    </typeHandlers>
    <objectFactory type="day_8_mybatis.util.ExampleObjectFactory">
        <property name="someProperty" value="100"/>
    </objectFactory>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>            
        </environment>
    </environments> 
    <mappers>
        <mapper resource="day_8_mybatis/mapper/UserMapper.xml"/>
        <mapper resource="day_8_mybatis/mapper/NoteMapper.xml"/>
    </mappers>    
    
</configuration>

 

選擇性忽略14-16行的typeHandlers配置，那是在上一節將typeHandlers用到的配置。

我們就實現了這么個自定義對象工廠，在客戶端代碼中測試一下。

package day_8_mybatis;

import java.io.IOException;

import org.apache.ibatis.session.SqlSession;

import day_8_mybatis.util.SessionFactory;

/**
 * 客戶端
 * @author turbo
 *
 * 2016年9月11日
 */
public class Main {

    /**
     * @param args
     * @throws IOException 
     */
    public static void main(String[] args) throws Exception {
        String resource = "day_8_mybatis/mybatis-config.xml";        //獲取mybatis配置文件路徑
        SqlSession sqlSession = SessionFactory.getSqlSession(resource);    //通過SessionFactory工具類（此工具類為自己構造即util包中的SessionFactory）構造SqlSession

    }

}

會發現控制台會有一個100的輸出，那正是我們傳遞進去的參數。但似乎疑問在我們好像並沒有調用任何方法啊，其實不然，mybatis的配置文件就是mybatis初始化首先要做的。我們在第22、23行做的工作就是加載configuration配置文件初始化mybatis，用於我們配置了ObjectFactory中的property當然實際上也就調用了ExampleObjectFactory中的setProperties。很多很多框架做的第一件事就是加載配置文件，根據配置初始化各種類各種服務，當然這也可以用代碼來實現，不過框架的好處就是它已經為我們做了一些事情，使得我們僅僅需要通過一些配置就能實現我們想要的結果。那么至於create方法呢？我們可以上面說了對象工廠就是用來創建實例的，我們可以傳遞一個class類型的類，就可以通過對象工廠的create方法得到這個類的實例。

package day_8_mybatis;

import java.io.IOException;

import org.apache.ibatis.session.SqlSession;

import day_8_mybatis.pojo.People;
import day_8_mybatis.util.ExampleObjectFactory;
import day_8_mybatis.util.SessionFactory;

/**
 * 客戶端
 * @author turbo
 *
 * 2016年9月11日
 */
public class Main {

    /**
     * @param args
     * @throws IOException 
     */
    public static void main(String[] args) throws Exception {
        String resource = "day_8_mybatis/mybatis-config.xml";        //獲取mybatis配置文件路徑
        SqlSession sqlSession = SessionFactory.getSqlSession(resource);    //通過SessionFactory工具類（此工具類為自己構造即util包中的SessionFactory）構造SqlSession
        ExampleObjectFactory e = new ExampleObjectFactory();
        People p = (People) e.create(People.class);
        System.out.println(p.getName());
    }

}

最后記住上面提到的MyBatis初始化過程就是解析配置文件創建Configuration對象的過程。這也會為我們在了解MyBatis之后學習其源碼所要知道的一點。