MyBatis配置文件详解-ObjectFactory配置分析

MyBatis 每次创建结果对象实例时,它使用一个 ObjectFactory 实例来完成。默认的ObjectFactory仅会按照配置结果类型的默认构造方法或者指定构造方法来创建对象实例。如果想重写默认的 ObjectFactory,你可以创建你自己的。比如:

// ExampleObjectFactory.java
//自定义的ObjectFactory
public class ExampleObjectFactory extends DefaultObjectFactory {
  //使用默认构造方法创建对象实例 
  public Object create(Class type) { 
    return super.create(type); 
  }

  //有构造参数列表和构造参数值列表的创建对象实例的方式 
  public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {
    return super.create(type, constructorArgTypes, constructorArgs); 
  }

  //为自定义ObjectFactory设置配置参数 
  public void setProperties(Properties properties) {
    super.setProperties(properties); 
  }
}

<!-- mybatis-config.xml -->
<objectFactory type="org.mybatis.example.ExampleObjectFactory"> 
<property name="someProperty" value="100"/>
</objectFactory>

ObjectFactory 接口很简单。它包含两个创建用的方法,一个是处理默认构造方法的,另外一个是处理带参数构造方法的。最终,setProperties 方法可以被用来配置 ObjectFactory。在 初 始化 你 的 ObjectFactory 实例 后 , objectFactory 元素 体 中定 义的 属 性会 被传 递 给setProperties 方法。

一个例子：

假设实体对象实现了自定义的InitialEntity接口，则在创建对象完成之后必须调用InitialEntity接口的init方法：

public interface InitialEntity { 
    void init();
}

假设有一个实体StockOutcomeBillItem对象用来记录销售出库单明细，该对象再设置完值后，需要调用count()方法来完成总金额的计算：

public class StockOutcomeBillItem { 
  private Long id; 
  private Product product; 
  private Integer number; 
  private BigDecimal price; 
  private BigDecimal totalAmount; 
  //getter & setter 
  public void count(){ 
    this.totalAmount=this.number*this.price; 
  } 
 }

该对象在实例化完成后需要调用count()方法来完成totalAmount属性的计算。要完成这个逻辑，只需要让该类实现定义的InitialEntity接口即可：

public class StockOutcomeBillItem implements InitialEntity{ 
    private Long id; 
    //other properties; 
    //getter & setter 
    public void init() { 
        this.count(); 
    } 
    private void count(){ 
        this.totalAmount=this.number*this.price; 
    } 
}

接下来，只需要完成能辨别InitialEntity接口的对象并调用其中的方法即可：

public class InitialObjectFactory extends DefaultObjectFactory {
    private static final long serialVersionUID = 1L;
     @Override 
    public <T> T create(Class<T> type) { 
        return super.create(type); 
    }  

    @Override
    //注意，在DefaultObjectFactory的create(Class type)方法中调用的是
    //create(Class,List<Class> constructorArgTypes,List<Object> constructorArgs)方法，
    //所以，只需要在这个方法中完成自定义初始化逻辑即可。 
    public <T> T create(Class<T> type, List<Class<?>> constructorArgTypes,List<Object> constructorArgs){ 
        T ret= super.create(type, constructorArgTypes, constructorArgs); 
        //判断接口类型和执行接口方法。
        if(InitialEntity.class.isAssignableFrom(type)){ 
            InitialEntity entity=(InitialEntity)ret; entity.init(); 
        } 
        return ret; 
    }
}

接下来只需要注册这个ObjectFactory即可：

<!-- mybatis-config.xml -->
<objectFactory type="org.mybatis.example.ExampleObjectFactory"/>