深入理解MyBatis框架——SqlSession

MyBatis学习笔记

---

SqlSession如何生成

• SqlSessions 是由 SqlSessionFactory 实例创建的。
• SqlSessionFactory 对 象 包 含 创 建 SqlSession 实 例 的 所 有 方 法 。
• SqlSessionFactory 本 身 是 由 SqlSessionFactoryBuilder 创建的,它可以从 XML 配置,注解或手动配置 Java 来创建 SqlSessionFactory。

SqlSessionFactoryBuilder

SqlSession产生的第一步就是要利用SqlSessionFactoryBuilder获取SqlSessionFactory，再获得SqlSession。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)

以上五种 build()方法中，第一种是最常用的一种，在这里就不进行讲解。

SqlSessionFactory

SqlSessionFactory 有六个方法可以用来创建 SqlSession 实例，在选择创建的方法时需要考虑以下三个因素:
1、Transaction (事务): 你想为 session 使用事务或者使用自动提交(通常意味着很多 数据库和/或 JDBC 驱动没有事务)?
2、Connection (连接): 你想 MyBatis 获得来自配置的数据源的连接还是提供你自己
3、Execution (执行): 你想 MyBatis 复用预处理语句和/或批量更新语句(包括插入和 删除)?

创建SqlSession实例的方法：

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、autoCommit：true 为生成一个自动提交事务的SqlSession。
2、connection： 提供自定义的连接对象，MyBatis会使用该连接对象进行操作。
3、level：事务隔离级别（TransactionIsolationLevel）。
4、execType：该参数有三个值可选
①ExecutorType.SIMPLE: 这个执行器类型不做特殊的事情。它为每个语句的执行创建一个新的预处理语句。
②ExecutorType.REUSE: 这个执行器类型会复用预处理语句。
③ExecutorType.BATCH: 这个执行器会批量执行所有更新语句,如果 SELECT 在它们中间执行还会标定它们是 必须的,来保证一个简单并易于理解的行为。

SqlSession

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

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

1、语句执行方法

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

<T> T selectOne(String statement, Object parameter)
<E> List<E> selectList(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。

在SqlSession中这些方法都有重载，可以根据具体情况进行选择调用。下面是查询方法的三个高级版本,它们允许你限制返回行数的范围,或者提供自定 义结果控制逻辑,这通常用于大量的数据集合。

<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)

还有很多执行方法可以通过查看API文档了解一下。

2、事务控制方法

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

void commit()
void commit(boolean force)
void rollback()
void rollback(boolean force)

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

3、清理 Session 级的缓存

void clearCache()

4、确保 SqlSession 被关闭

void close()

在使用MyBatis时，必须要保证在使用完session后关闭所打开的 session。保证做到这点的最佳方式是下面的工作模式（参考MyBatis文档）:

SqlSession session = sqlSessionFactory.openSession();
try {
    // following 3 lines pseudocod for "doing some work"
    session.insert(...);
    session.update(...);
    session.delete(...);
    session.commit();
} finally {
    session.close();
}

5、使用映射器

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

上述的各个 insert,update,delete 和 select 方法都很强大,但也有些繁琐。因此, 一个更通用、更简便的方式来执行映射语句是使用映射器类。 一个映射器类就是一个简单的接口,其中的方法定义匹配于 SqlSession 方法。下面的示例展示了一些方法签名和它们是 如何映射到 SqlSession 的。

public interface AuthorMapper {
  // (Author) selectOne("selectAuthor",5);
  Author selectAuthor(int id); 
  // (List<Author>) selectList(“selectAuthors”)
  List<Author> selectAuthors();
  // (Map<Integer,Author>) selectMap("selectAuthors", "id")
  @MapKey("id")
  Map<Integer, Author> selectAuthors();
  // insert("insertAuthor", author)
  int insertAuthor(Author author);
  // updateAuthor("updateAuthor", author)
  int updateAuthor(Author author);
  // delete("deleteAuthor",5)
  int deleteAuthor(int id);
}

1、映射器接口不需要去实现任何接口或扩展任何类。 只要方法前面可以被用来唯一标识对 应的映射语句就可以了。
2、映射器接口可以扩展其他接口。当使用 XML 来构建映射器接口时要保证在合适的命名空间中有语句。 而且, 唯一的限制就是你不能在两个继承关系的接口中有相同的方法签名。
3、可以传递多个参数给一个映射器方法。 如果这样做, 默认情况下MyBatis将会以它们在参数列表中的位置来命名,比如:#{param1},#{param2}等。如果想改变参数的名称(只在多参数情况下)，那么可以在参数上使用@Param(“paramName”)注解。

---

更多关于注解的内容请查询文档

目录

---