看完这专栏带你入门MyBatis框架（五）---MyBatis Java API

1.Java API

       既然你已经知道如何配置MyBatis和创建映射文件，你就已经准备好来提升技能了。MyBatis的Java API就是你收获你所做的努力的地方。正如你即将看到的，和JDBC相比，MyBatis很大程度简化了你的代码而且保持简洁，很容易理解和维护。还记得第一篇博客嘛，如下图，那些一连串的对象创建是不是看得头都晕了，但其实不多，因为你只需要将这些代码封装，之后再调用操作数据库的方法时，只要两行代码就够了。下面一起来分析一下这些对象。

1.1SqlSessions
       使用MyBatis的主要Java接口就是SqlSession。首先我们了解一下如何获取一个SqlSession实例。

SqlSession<----SqlSessionFactory<----SqlSessionFactoryBuilder<----XML配置、注解

SqlSessions是由 SqlSessionFactory 实例创建的。SqlSessionFactory 对 象 包 含 创 建 SqlSession 实 例 的 所 有 方 法 。 而 SqlSessionFactory 本 身 是 由 SqlSessionFactoryBuilder 创建的,它可以从 XML 配置,注解或手动配置 Java 来创建 SqlSessionFactory。
1.2SqlSessionFactoryBuilder
       SqlSessionFactoryBuilder 有五个 build()方法,每一种都允许你从不同的资源中创建一个 SqlSession 实例。

    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 实例。

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
        ...
    <dataSource type="POOLED">
        ...
  </environment>
  <environment id="production">
    <transactionManager type="MANAGED">
        ...
    <dataSource type="JNDI">
        ...
  </environment>
</environments>

如果你调用了 一个使用 environment 参数 方 式的 build 方法, 那么 MyBatis 将会使用 configuration 对象来配置这个 environment。 当然, 如果你指定了一个不合法的 environment, 你会得到错误提示。 如果你调用了其中之一没有 environment 参数的 build 方法, 那么就使用 默认的 environment(在上面的示例中就会指定为 default=“development”)。
1.3SqlSessionFactory
       SqlSessionFactory 有六个方法可以用来创建 SqlSession 实例。通常来说,如何决定是你 选择下面这些方法时:

• Transaction (事务): 你想为 session 使用事务或者使用自动提交(通常意味着很多 数据库和/或 JDBC 驱动没有事务)?
• Connection (连接): 你想 MyBatis 获得来自配置的数据源的连接还是提供你自己
• Execution (执行): 你想 MyBatis 复用预处理语句和/或批量更新语句(包括插入和 删除)?
  重载的 openSession()方法签名设置允许你选择这些可选中的任何一个组合。

    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:

• 会开启一个事务(也就是不自动提交)
• 连接对象会从由活动环境配置的数据源实例中得到。
• 事务隔离级别将会使用驱动或数据源的默认设置。
• 预处理语句不会被复用,也不会批量处理更新。
  1.4SqlSession
         如上面所提到的,SqlSession 实例在 MyBatis 中是非常强大的一个类。在这里你会发现 所有执行语句的方法,提交或回滚事务,还有获取映射器实例。在 SqlSession 类中有超过 20 个方法,所以将它们分开成易于理解的组合。
  1.4.1语句执行方法
         这些方法被用来执行定义在SQL映射的XML文件中的SELECT、INSERT、UPDATE和DELETE语句。它们都会自行解释，每一句都使用语句的ID属性和参数对象，参数可以是原生类型（自动装箱或包装类)、JavaBean、POJO或Map。

     T selectOne(String statement, Object parameter)
     List selectList(String statement, Object parameter)
     Map 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）。因为并不是所有语句都需要参数，这些方法都是有不同重载版本的，它们可以不需要参数对象。

     T selectOne(String statement)
     List selectList(String statement)
     Map selectMap(String statement, String mapKey)
    int insert(String statement)
    int update(String statement)
    int delete(String statement)

最后,还有查询方法的三个高级版本,它们允许你限制返回行数的范围,或者提供自定 义结果控制逻辑,这通常用于大量的数据集合。

<E> List<E> selectList (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);

当然，要确保SqlSesion被关闭。你必须保证的最重要的事情是你要关闭所打开的任何session。

1.5使用映射器

T getMapper(Class type)

       上述的各个insert,update,delete和select方法都很强大，但也有些繁琐，没有类型安全，对于你的IDE也没有帮助，还有可能的单元测试。在上面的入门章节我们已经看到了一个使用映射器的实例，如下图所示。因此，一个更通用的方式来执行映射语句是使用映射器类。一个映射器类就是一个简单的接口，其中的方法定义匹配于SqlSession方法。下面的示例展示了一些方法签名和它们是如何映射到SqlSession的。

       总之, 每个映射器方法签名应该匹配相关联的 SqlSession 方法, 而没有字符串参数 ID。 相反,方法名必须匹配映射语句的 ID。此外,返回类型必须匹配期望的结果类型。所有常用的类型都是支持的,包括:原生类 型,Map,POJO 和 JavaBean。映射器接口不需要去实现任何接口或扩展任何类。 只要方法前面可以被用来唯一标识对 应的映射语句就可以了。
       你可以传递多个参数给一个映射器方法。如果你这样做了，默认情况下它们会以它们在参数列表中的位置来命名，比如：#{param1},#{param2}等。如果你想改变参数的名称（只在多参数情况下），那么你可以在参数上使用@Param(“paramName”)注解，如上图所示。