mybatis源码学习（八）

mybatis加载objectFactory配置

上一篇文章讲解了，mybatis加载plugins的过程，在mybatis里，做插件是非常简单的，只要实现了mybatis的interceptor接口，并在类文件里加上签名，确认拦截哪个方法就可以了。在解析配置文件的阶段，mybatis只是实例化配置文件里面的插件类，然后把插件类添加到configuration对象里面。
接着，mybatis加载objectFactory配置信息，在mybatis中，select查询中都带有一个resultType，查询出来的结果在jdbc中返回的是resultset，mybatis在解析resultset的时候通过objectFactory工厂对象来创建新的实例，在没有进行自定义配置objectFactory的情况下，mybatis是通过DefaultObjectFactory对象去解析resultset的。用户在用自定义objectFactory的时候，只需要继承DefaultObjectFactory，并在mybatis的核心配置文件里面加上objectFactory即可。下面是应用objectFactory的例子。

1. 自定义objectFactory类，继承DefaultObjectFactory类

public class MyObjectFactory extends DefaultObjectFactory {

    private Object ret;

    @Override
    public <T> T create(Class<T> type) {
        T result = super.create(type);
        System.out.println("对象是否一样:"+result.equals(ret));
        return  result;
    }

    @SuppressWarnings("unchecked")
    @Override
    public <T> T create(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs) {
        T result = super.create(type,constructorArgTypes,constructorArgs);
        ret = result;
        if(ModelCreateInterface.class.isAssignableFrom(type)){
            ModelCreateInterface model = (ModelCreateInterface) result;
            model.create();
        }
        return result;
    }

}

2. 在mybatis核心文件里配置相关objectFactory标签，这里要注意的是，objectFactory标签必须在typeHandlers之后，objectWrapperFactory之前因为mybatis的标签有严格的先后顺序的，它的顺序是properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?

<objectFactory type="com.gzwx.objectfactory.MyObjectFactory" />

4. 写model的接口

public interface ModelCreateInterface {
    public void create();
}

5. 需要扩展的model都要实现这个接口

public class Leave implements ModelCreateInterface {
    private String currentUser;

    private Date currentDate;
    
    public void create() {
        this.currentDate = new Date();
        this.currentUser = "zzw";
    }

通过上面代码实现了自定义的对象工厂，对于所有实现了ModelCreateInterface的类，在进行select查询的时候，都会由mybatis本身自动执行create()方法。在MyObjectFactory中，我们定义了ret变量，并在第二个create里把result赋值给ret变量，然后在第一个create判断一下两个变量是否一样，测试结果是，两个对象的地址是一样的。从这里面看到，mybatis先是执行了第二个create创建对象，然后执行第一个create。

下面是在解析mybatis核心配置文件的时候加载objectFactory的分析。在XMLConfigBuilder的parseConfiguration方法里面，通过读取核心配置文件configuration标签下面的objectFactory标签的内容，并执行objectFactoryElement方法解析该标签内容

private void parseConfiguration(XNode root) {
    try {
      //issue #117 read properties first
      propertiesElement(root.evalNode("properties"));
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      typeAliasesElement(root.evalNode("typeAliases"));
      pluginElement(root.evalNode("plugins"));
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      // read it after objectFactory and objectWrapperFactory issue #631
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

再看看objectFactoryElement方法源码

  private void objectFactoryElement(XNode context) throws Exception {
    if (context != null) {
      //objectFactory标签的type属性就是自定义继承了DefaultObjectFactory的类
      String type = context.getStringAttribute("type");
      Properties properties = context.getChildrenAsProperties();
      //在别名那里找是否存在该别名，如果没有，那么直接拿type里面的值实例化这个自定义的类
      ObjectFactory factory = (ObjectFactory) resolveClass(type).newInstance();
      //这个方法没什么用，源码里面这个方法是空的
      factory.setProperties(properties);
      //设置进configuration的objectFactory变量里面
      configuration.setObjectFactory(factory);
    }
  }

这里面要注意的是，对于mybatis核心配置文件里面，只允许配置一个objectFactory标签，配置多个该标签会直接报错。