MyBatis Java API 使用

• MyBatis 很大程度简化了了代码，MyBatis 3 引入了很多重要的改进使得SQL映射更加优秀。

SqlSession

• 使用MyBatis 的主要接口就是 SqlSession。通过这个接口来执行命令，获取映射器和管理实务。SqlSession 是由 SqlSessionFactory 实例创建的。 SqlSessionFactory 对象包含创建 SqlSession 实例所有方法。 而SqlSessionFactory 本身是由SqlSessionFactoryBuilder创建的。它可以从 XML、注解或手动配置Java 代码来创建SqlSessionFactory。

• **当MyBatis与一些依赖注入框架（如 Spring 或者 Guice）同时使用的时候， SqlSession 将被依赖注入框架所创建，就不需要适应SqlSessionFactory 和 SqlSessionFatoryBuilder**

SqlSessionFactoryBuilder

• SqlSessionFactoryBuilder 有五个 build() 方法，每一种都允许你从不同的资源中创建一个 SqlSessionFactory 实例。

SqlSessionFactory build(InputStream inputStream)
SqlSessionFactory build(InputStream inputStream, String environment)
SqlSessionFactory build(InputStream inputStream, Properties properties)
SqlSessionFactory build(InputStream inputStream, String env, Properties props)
SqlSessionFactory build(Configuration config)

• 第一种方法是最常用的，它使用了一个参照了 XML 文档或上面讨论过的更特定的 mybatis-config.xml 文件的 Reader 实例。可选的参数是 environment 和 properties。environment 决定加载哪种环境，包括数据源和事务管理器。比如：

<!-- 配置环境 -->
<environments default="development">
    <!-- 配置 development 环境信息 -->
    <environment id="development">
        <!-- 配置事务类型 -->
        <transactionManager type="JDBC"/>
        <!-- 配置数据源（连接池） -->
        <dataSource type="POOLED">
            <!-- 配置数据库的4个基本信息 -->
            <property name="driver" value="${driver}"/>
            <property name="url" value="${url}"/>
            <property name="username" value="${username}"/>
            <property name="password" value="${password}"/>
        </dataSource>
    </environment>
</environments>

• 以上参数配置都有注释下文不再赘述。

• MyBatis 加载 properties 的执行顺序：

• 首先读取在 properties 元素体中指定属性。
• 其次，从 properties 元素的类路径 resource 或 url 指定的属性，且会覆盖已经指定了的属性
• 最后，读取作为方法参数传递的属性，，且会覆盖已经从 properties 元素体和 resource 或 url 属性中加载了的重复属性。

• 因此，通过方法参数传递的属性的优先级最高， resource 或 url 指定的属性次之， 在properties 元素体中指定属性优先级最低。

• 以下是一个创建 SqlSessionFacatory 的一个示例：

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

SqlSessionFactory

• SqlSession 有6个方法创建SqlSession示例。通常来说，当你选择这些方法需要考虑一下的几个问题

• 事务处理: 需要session 使用事务或者使用自动提交功能？
• 连接: 需要获取数据源的配置？自己使用自己提供的配置？
• 执行语句: 需要复用预处理语句或批量更新语句？

• MyBatis 提供了多个重载方法

SqlSession openSession()
SqlSession openSession(boolean autoCommit)
SqlSession openSession(Connection connection)
SqlSession openSession(TransactionIsolationLevel level)
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
SqlSession openSession(ExecutorType execType)
SqlSession openSession(ExecutorType execType, boolean autoCommit)
SqlSession openSession(ExecutorType execType, Connection connection)
Configuration getConfiguration();

• 默认的 openSession() 没有参数，它会创建一个有如下特征的 SqlSession。

• 会开启一个事务，默认不是自动提交
• 将从当前环境配置的 DataSource 实例中获取 Connection 对象。
• 事务隔离级别将会使用驱动或从数据源的默认配置
• 预处理语句不会被服用，也不会批量处理更新

SqlSession

• SqlSession 实例是一个非常强大的类。它可以执行语句、提交或者虎丘映射器的实例方法。

• 在 SqlSession 类中有超过20个犯法， 所以它们组合成易于理解的分组。

执行语句方法

• 这些方法用来指定定义在SQL映射的XML文件中的 SELECT、INSERT 、UPDATE 和 DELETE语句。他们都会自行解释。每一句都是使用语句的ID 和参数对象，参数可以是原生类型（自动装箱或包装类）、JavaBean、POJO 或 Map.

<T> T selectOne(String statement, Object parameter)
<E> List<E> selectList(String statement, Object parameter)
<T> Cursor<T> selectCursor(String statement, Object parameter)
<K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey)
int insert(String statement, Object parameter)
int update(String statement, Object parameter)
int delete(String statement, Object parameter)

• selectOne 和 selectList 的不同仅仅是 selectOne 必须返回一个对象或 null 值。如果返回值多于一个，那么就会抛出异常。如果你不知道返回对象的数量，请使用 selectList。如果需要查看返回对象是否存在，可行的方案是返回一个值即可（0 或 1）。selectMap 稍微特殊一点，因为它会将返回的对象的其中一个属性作为 key 值，将对象作为 value 值，从而将多结果集转为 Map 类型值。因为并不是所有语句都需要参数，所以这些方法都重载成不需要参数的形式。

• 最后，还有 select 方法的三个高级版本，它们允许你限制返回行数的范围，或者提供自定义结果控制逻辑，这通常在数据集合庞大的情形下使用。

<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)
<T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds)
<K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowbounds)
void select (String statement, Object parameter, ResultHandler<T> handler)
void select (String statement, Object parameter, RowBounds rowBounds, ResultHandler<T> handler)

• RowBounds 参数会告诉 MyBatis 略过指定数量的记录，还有限制返回结果的数量。RowBounds 类有一个构造方法来接收 offset 和 limit，另外，它们是不可二次赋值的。

int offset = 100;
int limit = 25;
RowBounds rowBounds = new RowBounds(offset, limit);

• 所以在这方面，不同的驱动能够取得不同级别的高效率。为了取得最佳的表现，请使用结果集的 SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 的类型(换句话说：不用 FORWARD_ONLY)。

• ResultHandler 参数允许你按你喜欢的方式处理每一行。你可以将它添加到 List 中、创建 Map 和 Set，或者丢弃每个返回值都可以，它取代了仅保留执行语句过后的总结果列表的死板结果。你可以使用 ResultHandler 做很多事，并且这是 MyBatis 自身内部会使用的方法，以创建结果集列表。

• 从3.4.6开始，传递给可调用语句的ResultHandler将用于存储过程的每个REFCURSOR输出参数（如果有）。

package org.apache.ibatis.session;
public interface ResultHandler<T> {
  void handleResult(ResultContext<? extends T> context);
}

• ResultContext 参数允许你访问结果对象本身、被创建的对象数目、以及返回值为 Boolean 的 stop 方法，你可以使用此 stop 方法来停止 MyBatis 加载更多的结果。

• 使用 ResultHandler 的时候需要注意以下两种限制：

• 从被 ResultHandler 调用的方法返回的数据不会被缓存。
• 当使用结果映射集（resultMap）时，MyBatis 大多数情况下需要数行结果来构造外键对象。如果你正在使用 ResultHandler，你可以给出外键（association）或者集合（collection）尚未赋值的对象。