mybatis源碼解析3---XMLConfigBuilder解析

1.XMLConfigBuilder

XMLConfigBuilder類位於Mybatis包的org.apache.ibatis.builder.xml目錄下，繼承於BaseBuilder類，關於BaseBuilder類后續再看。

XMLConfigBuilder看名字能猜到是關於mybatis的XML配置的構造類，負責構造mybatis的XML配置的。

XMLConfigBuilder共有四個屬性，代碼如下：

private boolean parsed;//解析標識,因為Configuration是全局變量，只需要解析創建一次即可，true表示已經解析創建過,false則表示沒有
private XPathParser parser;
private String environment;//環境參數
private ReflectorFactory localReflectorFactory = new DefaultReflectorFactory();

XMLConfigBuilder共有6個public構造方法和一個private的構造方法，如下：

 public XMLConfigBuilder(Reader reader) {
    this(reader, null, null);
  }

  public XMLConfigBuilder(Reader reader, String environment) {
    this(reader, environment, null);
  }

  public XMLConfigBuilder(Reader reader, String environment, Properties props) {
    this(new XPathParser(reader, true, props, new XMLMapperEntityResolver()), environment, props);
  }

  public XMLConfigBuilder(InputStream inputStream) {
    this(inputStream, null, null);
  }

  public XMLConfigBuilder(InputStream inputStream, String environment) {
    this(inputStream, environment, null);
  }

  public XMLConfigBuilder(InputStream inputStream, String environment, Properties props) {
    this(new XPathParser(inputStream, true, props, new XMLMapperEntityResolver()), environment, props);
  }

  private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
    super(new Configuration());//調用父類的構造方法
    ErrorContext.instance().resource("SQL Mapper Configuration");
    this.configuration.setVariables(props);
    this.parsed = false;
    this.environment = environment;
    this.parser = parser;
  }

很顯然6個public的構造方法都是根據mybatis的配置文件流創建一個XPathParser對象，然后最終都調用了私有的構造方法，而私有的構造方法先是調用了父類BaseBuilder的構造方法，然后分別根據參數給四個屬性賦值。

而上一篇文章提到了SqlSessionFactoryBuilder中是通過創建一個XMLConfigBuilder對象，然后調用了對象的parse()方法獲取到一個Configuration對象。接下來就先看看XMLConfigBuilder的parse方法，如下：、

 

public Configuration parse() {
    if (parsed) {//判斷Configuration是否解析過，Configuration是全局變量，只需要解析創建一次即可
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    parseConfiguration(parser.evalNode("/configuration"));//調用下面的方法,parser.evalNode("/configuration")解析XML配置的configuration節點的內容，得到XNode對象
    return configuration;
  }
  //根據root中存儲的是configuration節點的內容
  private void parseConfiguration(XNode root) {
    try {
      Properties settings = settingsAsPropertiess(root.evalNode("settings"));//設置settings配置
      //issue #117 read properties first
      propertiesElement(root.evalNode("properties"));//設置properties配置
      loadCustomVfs(settings);
      typeAliasesElement(root.evalNode("typeAliases"));//設置typeAliases配置
      pluginElement(root.evalNode("plugins"));//設置plugins配置
      objectFactoryElement(root.evalNode("objectFactory"));//設置objectFactory配置
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));//設置objectWrapperFactory配置
      reflectorFactoryElement(root.evalNode("reflectorFactory"));//設置reflectFactory配置
      settingsElement(settings);
      // read it after objectFactory and objectWrapperFactory issue #631
      environmentsElement(root.evalNode("environments"));//設置environments配置
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));//設置databaseIdProvider配置
      typeHandlerElement(root.evalNode("typeHandlers"));//設置typeHandlers配置
      mapperElement(root.evalNode("mappers"));//設置mappers配置
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

 

可以看出parse的作用是解析mybatis-config.xml的configuration節點的內容，然后挨個賦值給configuration對象的屬性；

而XMLConfigBuilder的其他私有方法都是給根據XNode對象（XML配置的configuration節點內容）來給全局配置變量configuration的屬性進行賦值，關於Configuration類的解析下一章會解析

 

總結:XMLConfigBuilder類的作用是根據全局配置文件mybatis-config.xml的流文件進行解析,解析xml中的各個節點，然后創建一個Configuration對象，並將xml中的節點屬性賦值給Configuration對象