mybatis源码解析SqlSessionFactory

看源码的时候入口方法很重要，现在很多都是用注解来代替配置文件，我们这里还是使用配置文件的方式，但万变不离其中，变来变去，其实最底层的东西还是不怎么变的，而且配置文件的方式启动，入口很简单。

	public static void main(String[] args) throws IOException {
		//读取配置文件 生成SqlSessionFactory
		InputStream inputStream = Resources.getResourceAsStream("configure-mybatis.xml");
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
	}

我们今天的重点就是SqlSessionFactory。

InputStream inputStream = Resources.getResourceAsStream("configure-mybatis.xml");

可以看到用Resources，将classpath路径下的configure-mybatis.xml变成了一个输入流

通过new SqlSessionFactoryBuilder().build(inputStream) 就可以得到SqlSessionFactory

  //SqlSessionFactoryBuilder
  public SqlSessionFactory build(InputStream inputStream) {
    return build(inputStream, null, null);
  }

 //SqlSessionFactoryBuilder
  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
    	//初始化XMLConfigBuilder
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      //parser.parse() 把xml文件转化为对象
      //解析xml生成Configuration对象
      //再生成DefaultSqlSessionFactory
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        inputStream.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
  }

我们来看看XMLConfigBuilder相关的UML类图

new XMLConfigBuilder(inputStream, environment, properties)，具体生成XMLConfigBuilder的源码这里我就不贴了，读者可以自己看看，主要的流程就是初始化自己的属性XPathParser，而XPathParser会将传入的InputStream，转成Document对象作为自己的属性。

parser.parse()，解析文档生成Configuration对象。

  //XMLConfigBuilder
  public Configuration parse() {
    if (parsed) {//如果已经解析过了 就抛出异常
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    //parser.evalNode("/configuration") 获取到configuration节点
    //parseConfiguration 解析configuration节点
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
  }

  //XMLConfigBuilder
  //对configuration节点下的所有子节点进行解析 对应的内容是configure-mybatis.xml
  private void parseConfiguration(XNode root) {//configuration节点
    try {
      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"));
      reflectionFactoryElement(root.evalNode("reflectionFactory"));
      settingsElement(settings);
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      //重点  解析mappers节点
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

我们重点关注一下解析mappers

 //XMLConfigBuilder
  //对mappers节点的属性进行解析
  private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        if ("package".equals(child.getName())) {//解析包下的所有mapper
          String mapperPackage = child.getStringAttribute("name");
          //最终执行的和configuration.addMapper(mapperInterface)是一样的
          configuration.addMappers(mapperPackage);
        } else {
        	//使用相对于类路径的资源引用
          String resource = child.getStringAttribute("resource");
          //使用完全限定资源定位符（URL）
          String url = child.getStringAttribute("url");
          // 使用映射器接口实现类的完全限定类名
          String mapperClass = child.getStringAttribute("class");
          if (resource != null && url == null && mapperClass == null) {
            ErrorContext.instance().resource(resource);
            InputStream inputStream = Resources.getResourceAsStream(resource);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url != null && mapperClass == null) {
            ErrorContext.instance().resource(url);
            InputStream inputStream = Resources.getUrlAsStream(url);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url == null && mapperClass != null) {//重点看这个
        	//根据全限定名获取类信息
            Class<?> mapperInterface = Resources.classForName(mapperClass);
            //Map<Class<?>, MapperProxyFactory<?>> knownMappers
            //里面都是把信息存到MapperRegistry对象的属性knownMappers中
            //MapperRegistry对象则是configuration中的属性
            //最后都是会走这个方法
            configuration.addMapper(mapperInterface);
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }

继续玩下走，都会走到这里

 //MapperRegistry
  //每个mapper生成对应的MapperProxyFactory 放入HashMap
  public <T> void addMapper(Class<T> type) {
    if (type.isInterface()) {
      if (hasMapper(type)) {
        throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
      }
      boolean loadCompleted = false;
      try {
        knownMappers.put(type, new MapperProxyFactory<T>(type));
        //解析mapper中的使用了注解的sql语句
        MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
        parser.parse();
        loadCompleted = true;
      } finally {
        if (!loadCompleted) {
          knownMappers.remove(type);
        }
      }
    }
  }

走到这里对xml的解析也结束了，我们来看一张UML
configure-mybatis.xml配置详情可以点这里查看，对应的每个节点解析的信息配置都是放到了Configuration中集中管理，解析完成我们就得到了Configuration，每个mapper都被包装成了MapperProxyFactory注册到了MepperRegistry中，获取mapper实例的时候，是使用JDK动态代理的方式生成代理对象。
得到了Configuration对象后

  //SqlSessionFactoryBuilder
  public SqlSessionFactory build(Configuration config) {
	//默认获取是的SqlSessionFactory是DefaultSqlSessionFactory
    return new DefaultSqlSessionFactory(config);
  }

可以看到这里是直接得到的SqlSessionFactory是DefaultSqlSessionFactory
我们再来看看SqlSessionFactory相关的UML类型，这里是工厂方法典型的引用

这张图我们可以很明显的看出，DefaultSqlSessionFactory是为了生产DefaultSqlSession，获取SqlSession是我们下一篇文章要分析的内容。