MyBatis接口SqlSessions

SqlSessions

使用MyBatis的主要Java接口就是SqlSession。尽管你可以使用这个接口执行命令，获取映射器和管理事务。我们会讨论SqlSession本身更多，但是首先我们还是要了解如果获取一个SqlSession实例。SqlSessions是由SqlSessionFactory实例创建的。SqlSessionFactory对象包含创建SqlSession实例的所有方法。而SqlSessionFactory本身是由SqlSessionFactoryBuilder创建的，它可以从XML配置，注解或手动配置Java来创建SqlSessionFactory。

 

SqlSessionFactoryBuilder

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

SqlSessionFactory build(Reader reader)

SqlSessionFactory build(Reader reader, String environment)

SqlSessionFactory build(Reader reader, Properties properties)

SqlSessionFactory build(Reader reader, String env, Properties props)

SqlSessionFactory build(Configuration config)

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

<environments default="development">

<environment id="development">

<transactionManager type="JDBC">

…

<dataSource type="POOLED">

…

</environment>

<environment id="production">

<transactionManager type="EXTERNAL">

…

<dataSource type="JNDI">

…

</environment>

</environments>

如果你调用了一个使用environment参数的build方法，那么MyBatis将会使用configuration对象来配置这个environment。当然，如果你指定了一个不合法的environment，你会得到错误提示。如果你调用了其中之一没有environment参数的build方法，那么就使用默认的environment（在上面的示例中就会指定为default=”development”）。

如果你调用了使用properties实例的方法，那么MyBatis就会加载那些properties（属性配置文件），并你在你配置中可使用它们。那些属性可以用${propName}语法形式多次用在配置文件中。

 

 

总结一下，前四个方法很大程度上是相同的，但是由于可以覆盖，就允许你可选地指定environment和/或properties。这里给出一个从SqlMapConfig.xml文件创建SqlSessionFactory的示例：

String resource = "org/mybatis/builder/MapperConfig.xml";

Reader reader = Resources.getResourceAsReader(resource);

SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();

SqlSessionFactory factory = builder.build(reader);

注意这里我们使用了Resources工具类，这个类在org.mybatis.io包中。Resources类正如其名，会帮助你从类路径下，文件系统或一个web URL加载资源文件。看一下这个类的源代码或者通过你的IDE来查看，就会看到一整套有用的方法。这里给出一个简表：

URL getResourceURL(String resource)

URL getResourceURL(ClassLoader loader, String resource)

InputStream getResourceAsStream(String resource)

InputStream getResourceAsStream(ClassLoader loader, String resource)

Properties getResourceAsProperties(String resource)

Properties getResourceAsProperties(ClassLoader loader, String resource)

Reader getResourceAsReader(String resource)

Reader getResourceAsReader(ClassLoader loader, String resource)

File getResourceAsFile(String resource)

File getResourceAsFile(ClassLoader loader, String resource)

InputStream getUrlAsStream(String urlString)

Reader getUrlAsReader(String urlString)

Properties getUrlAsProperties(String urlString)

Class classForName(String className)

最后一个build方法使用了一个Configuration实例。configuration类包含你可能需要了解SqlSessionFactory实例的所有内容。Configuration类对于配置的自查很有用，包含查找和操作SQL映射（不推荐使用，因为应用正接收请求）。configuration类有所有配置的开关，这些你已经了解了，只在Java API中露出来。这里有一个简单的示例，如何手动配置configuration实例，然后将它传递给build()方法来创建SqlSessionFactory。

DataSource dataSource = BaseDataTest.createBlogDataSource();

TransactionFactory transactionFactory = new JdbcTransactionFactory();

Environment environment =new Environment("development", transactionFactory, dataSource);

Configuration configuration = new Configuration(environment);

configuration.setLazyLoadingEnabled(true);

configuration.setEnhancementEnabled(true);

configuration.getTypeAliasRegistry().registerAlias(Blog.class);

configuration.getTypeAliasRegistry().registerAlias(Post.class);

configuration.getTypeAliasRegistry().registerAlias(Author.class);

configuration.addMapper(BoundBlogMapper.class);

configuration.addMapper(BoundAuthorMapper.class);

SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();

SqlSessionFactory factory = builder.build(configuration);

现在你有一个SqlSessionFactory，可以用来创建SqlSession实例。

 

 

SqlSessionFactory

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：

 将会开启一个事务（也就是不自动提交）范围

 连接对象会从由活动环境配置的数据源实例中得到。

 事务隔离级别将会使用驱动或数据源的默认设置。

 预处理语句不会被复用，也不会批量处理更新。

这些方法大都可以自我解释的。开启自动提交，传递“true”给可选的autoCommit参数。提供自定义的连接，传递一个Connection实例给connection参数。注意没有覆盖同时设置Connection和autoCommit两者的方法，因为MyBatis会使用当前connection对象提供的设置。MyBatis为事务隔离级别调用使用一个Java枚举包装器，称为TransactionIsolationLevel，否则它们按预期的方式来工作，并有JDBC支持的5级

（NONE,READ_UNCOMMITTED,READ_COMMITTED,REPEATABLE_READ,SERIALIZABLE）

还有一个可能对你来说是新见到的参数，就是ExecutorType。这个枚举类型定义了3个值：

ExecutorType.SIMPLE

这个执行器类型不做特殊的事情。它为每个语句的执行创建一个新的预处理语句。

ExecutorType.REUSE

这个执行器类型会复用预处理语句。

ExecutorType.BATCH

这个执行器会批量执行所有更新语句，如果SELECT在它们中间执行还会标定它们是必须的，来保证一个简单并易于理解的行为。

注意：在SqlSessionFactory中还有一个方法我们没有提及，就是getConfiguration()。这个方法会返回一个Configuration实例，在运行时你可以使用它来自检MyBatis的配置。

 

SqlSession

如上面所提到的，SqlSession实例在MyBatis中是非常强大的一个类。在这里你会发现所有执行语句的方法，提交或回滚事务，还有获取映射器实例。

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

语句执行方法

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

Object selectOne(String statement, Object parameter)

List selectList(String statement, Object parameter)

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）。因为并不是所有语句都需要参数，这些方法都是有不同重载版本的，它们可以不需要参数对象。

Object selectOne(String statement)

List selectList(String statement)

int insert(String statement)

int update(String statement)

int delete(String statement)

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

List selectList

(String statement, Object parameter, RowBounds rowBounds)

 

void select

(String statement, Object parameter, ResultHandler handler)

void select

(String statement, Object parameter, RowBounds rowBounds,

ResultHandler 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内部创建结果集列表。

它的接口很简单。

package org.mybatis.executor.result;

public interface ResultHandler {

void handleResult(ResultContext context);

}

ResultContext参数给你访问结果对象本身的方法，大量结果对象被创建，你可以使用布尔返回值的stop()方法来停止MyBatis加载更多的结果。

事务控制方法

控制事务范围有四个方法。当然，如果你已经选择了自动提交或你正在使用外部事务管理器，这就没有任何效果了。然而，如果你正在使用JDBC事务管理员，由Connection实例来控制，那么这四个方法就会派上用场：

void commit()

void commit(boolean force)

void rollback()

void rollback(boolean force)

默认情况下MyBatis不会自动提交事务，除非它侦测到有插入，更新或删除操作改变了数据库。如果你已经做出了一些改变而没有使用这些方法，那么你可以传递true到commit和rollback方法来保证它会被提交（注意，你不能在自动提交模式下强制session，或者使用了外部事务管理器时）。很多时候你不用调用rollback()，因为如果你没有调用commit时MyBatis会替你完成。然而，如果你需要更多对多提交和回滚都可能的session的细粒度控制，你可以使用回滚选择来使它成为可能。

清理Session级的缓存

void clearCache()

SqlSession实例有一个本地缓存在执行update，commit，rollback和close时被清理。要明确地关闭它（获取打算做更多的工作），你可以调用clearCache()。

确保SqlSession被关闭

void close()

你必须保证的最重要的事情是你要关闭所打开的任何session。保证做到这点的最佳方式是下面的工作模式：

SqlSession session = sqlSessionFactory.openSession();

try {

// 下面3行pseudocod来做一些工作

session.insert(…);

session.update(…);

session.delete(…);

session.commit();

} finally {

session.close();

}

注意：就像SqlSessionFactory，你可以通过调用getConfiguration()方法获得SqlSession使用的Configuration实例

Configuration getConfiguration()

使用映射器

<T> T getMapper(Class<T> type)

上述的各个insert，update，delete和select方法都很强大，但也有些繁琐，没有类型安全，对于你的IDE也没有帮助，还有可能的单元测试。在上面的入门章节中我们已经看到了一个使用映射器的示例。

因此，一个更通用的方式来执行映射语句是使用映射器类。一个映射器类就是一个简单的接口，其中的方法定义匹配于SqlSession方法。下面的示例展示了一些方法签名和它们是如何映射到SqlSession的。

public interface AuthorMapper {

// (Author) selectOne(“selectAuthor”,5);

Author selectAuthor(int id);

// (List<Author>) selectList(“selectAuthors”)

List<Author> selectAuthors();

// insert(“insertAuthor”, author)

void insertAuthor(Author author);

// updateAuthor(“updateAuhor”, author)

void updateAuthor(Author author);

// delete(“deleteAuthor”,5)

void deleteAuthor(int id);

}

总之，每个映射器方法签名应该匹配相关联的SqlSession方法，而没有字符串参数ID。相反，方法名必须匹配映射语句的ID。

此外，返回类型必须匹配期望的结果类型。所有常用的类型都是支持的，包括：原生类型，Map，POJO和JavaBean。

映射器接口不需要去实现任何接口或扩展任何类。只要方法前面可以被用来唯一标识对应的映射语句就可以了。

映射器接口可以扩展其他接口。当使用XML来构建映射器接口时要保证在合适的命名空间中有语句。而且，唯一的限制就是你不能在两个继承关系的接口中有相同的方法签名（这也是不好的想法）。

你可以传递多个参数给一个映射器方法。如果你这样做了，默认情况下它们将会以它们在参数列表中的位置来命名，比如：#{1},#{2}等。如果你想改变参数的名称（只在多参数

 

情况下），那么你可以在参数上使用@Param(“paramName”)注解。

你也可以给方法传递一个RowBounds实例来限制查询结果。

映射器注解

因为最初设计时，MyBatis是一个XML驱动的框架。配置信息是基于XML的，而且映射语句也是定义在XML中的。而到了MyBatis 3，有新的可用的选择了。MyBatis 3构建在基于全面而且强大的Java配置API之上。这个配置API是基于XML的MyBatis配置的基础，也是新的基于注解配置的基础。注解提供了一种简单的方式来实现简单映射语句，而不会引入大量的开销。