Mybatis 简明教程（二）

1.MyBatis几个重要类的范围和生命周期

SqlSessionFactoryBuilder

用于创建SqlSessionFactory，创建完毕之后，就不再需要使用它。因此 SqlSessionFactoryBuilder 实例的最佳范围是方法范围 (也就是本地方法变量)。

可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例。

// 实例化builder
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();	
// 使用builder创建第一个SqlSessionFactory
SqlSessionFactory sqlMapper = builder.build(reader1);		
		
// 使用同一个builder创建另外一个SqlSessionFactory
SqlSessionFactory sqlMapper2 = builder.build(reader2);

SqlSessionFactory

一旦被创建,SqlSessionFactory 应该在整个应用程序执行期间都存在，没有理由来处理或重新创建它。使用 SqlSessionFactory 的最佳实践范围应用范围。

重复创建 SqlSessionFactory 是非常糟糕的，最简单的就是使用单例模式或者静态单例模式创建SqlSessionFactory 。

/**
 * 单例模式创建唯一的SqlSessionFactory
 * @author yli
 *
 */
class SessionFactory {
	
	private static SqlSessionFactory factory = null;
	
	public static SqlSessionFactory instanceFactory(){
		if(null == factory) {
			factory = newFactory();
		}
		return factory;
	}
	
	private static SqlSessionFactory newFactory(){
		String resource = "config/mybatis.xml";
		Reader reader;
		try {
			reader = Resources.getResourceAsReader(resource);
			SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
			factory = builder.build(reader);
			return factory;
		} catch (IOException e) {
			e.printStackTrace();
			return null;
		}
	}
}

SqlSession

每个线程都应该有独立的 SqlSession 实例。SqlSession 的实例不能被共享，也是线程不安全的。因此最佳的范围是请求或方法范围。

绝对不能将 SqlSession 实例的引用放在一个类的静态字段甚至是实例字段中。也不能将 SqlSession 实例的引用放在任何类型的管理范围中，比如 Serlvet 架构中的 HttpSession。

如果你现在正用任意的 Web 框架, 要考虑 SqlSession 放在一个和 HTTP 请求对象相似的范围内。

换句话说，基于收到的 HTTP 请求,你可以打开了一个 SqlSession,然后返回响应，就可以关闭它了。

关闭 Session 很重要，你应该确保使用 finally 块来关闭它。

SqlSession session = factory.openSession();
try {
  // do something
} finally {
  session.close();
}

2.SqlSessionFactoryBuilder创建SqlSessionFactory的过程

(1) 使用构造函数创建SqlSessionFactory，其中环境 environment 和属性 properties 可以为null

public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      return buildparser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        reader.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
}

(2) 构造 XMLConfigBuilder

 public XMLConfigBuilder(Reader reader, String environment, Properties props) {
    this(new XPathParser(reader, 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;
  }

(3) 使用 XMLConfigBuilder 加载MyBatis的配置文件

  public Configuration parse() {
    if (parsed) {
      throw new BuilderException("Each MapperConfigParser can only be used once.");
    }
    parsed = true;
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
  }

  private void parseConfiguration(XNode root) {
    try {
      propertiesElement(root.evalNode("properties")); //issue #117 read properties first
      typeAliasesElement(root.evalNode("typeAliases"));
      pluginElement(root.evalNode("plugins"));
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      settingsElement(root.evalNode("settings"));
      environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
      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);
    }
  }

从源代码可以看出MyBatis加载各项配置的顺序

• configuration
• properties
• typeAliases
• plugins
• objectFactory
• settings
• environments
• environment
• databaseIdProvider
• typeHandlers
• mappers

(4) 选取properties节点的加载说明

  private void propertiesElement(XNode context) throws Exception {
    if (context != null) {
      Properties defaults = context.getChildrenAsProperties();
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");
      if (resource != null && url != null) {
        throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
      }
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {
        defaults.putAll(Resources.getUrlAsProperties(url));
      }
      Properties vars = configuration.getVariables();
      if (vars != null) {
        defaults.putAll(vars);
      }
      parser.setVariables(defaults);
      configuration.setVariables(defaults);
    }
  }

  properties节点有3种配置方式
  1.在properties节点下加入property子节点
  2.在properties节点配置resource或者url引入资源文件：二者不能同时配置
  3.构造SqlSessionFactory时传入Properties：SqlSessionFactory build(Reader reader, Properties properties)

  从加载properties的顺序来看，优先级为：  3 > 2 > 1
  也就是说，当出现重复的key值时：3会覆盖2的配置;2会覆盖1的配置