MyBatis快速入门（18）Mybatis API方法介绍

蔚落 2022-12-09 03:17 117阅读 0赞

我们已经讨论过如何配置 MyBatis 和创建映射文件了。MyBatis 的 Java API 就是你收获你所做的努力的地方。正如你即将看到的，和 JDBC 相比，MyBatis 很大程度简化了你的代码并保持代码简洁，容易理解并维护。MyBatis 3 已经引入了很多重要的改进来使得 SQL 映射更加优秀。

# SqlSessions #

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

注意 当 Mybatis 与一些依赖注入框架（如 Spring 或者 Guice）同时使用时，SqlSessions 将被依赖注入框架所创建，所以你不需要使用 SqlSessionFactoryBuilder 或者 SqlSessionFactory，可以直接看 下面的SqlSession 这部分。

# SqlSessionFactoryBuilder #

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

![3da717977d6e1663ba5ba1255926e502.png][]

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

![e61c6d43cb14fdca50a6c99530dae40e.png][]

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

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

回想一下，属性可以从 mybatis-config.xml 中被引用，或者直接指定它。因此理解优先级是很重要的。我们在文档前面已经提及它了，但是这里要再次重申，如果一个属性存在于这些位置，那么 MyBatis 将会按照下面的顺序来加载它们：

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

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

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

![d7e71129ed9868872e0c1f5704001032.png][]

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

![6a10548e32685023823583a89766e120.png][]

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

![e24e08bd491849d1581b3ac9027d8e87.png][]

通过上面的方法你就获得一个可以用来创建 SqlSession 实例的 SqlSessionFactory 了！

# SqlSessionFactory #

SqlSessionFactory 有六个方法创建 SqlSession 实例。通常来说，当你选择这些方法时你需要考虑以下几点：

> **事务处理**：我需要在 session 使用事务或者使用自动提交功能（auto-commit）吗？（通常意味着很多数据库和/或 JDBC 驱动没有事务）
> 
> **连接**：我需要依赖 MyBatis 获得来自数据源的配置吗？还是使用自己提供的配置？
> 
> **执行语句**：我需要 MyBatis 复用预处理语句和/或批量更新语句（包括插入和删除）吗？

基于以上需求，有下列已重载的多个 openSession() 方法供使用。

![3dd475468ecb91e12be45af4ab15b0f5.png][]

默认的 openSession()方法没有参数，它会创建有如下特性的 SqlSession：

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

这些方法大都是可读性强的。向 autoCommit 可选参数传递 true 值即可开启自动提交功能。若要使用自己的 Connection 实例，传递一个 Connection 实例给 connection 参数即可。注意并未覆写同时设置 Connection 和 autoCommit 两者的方法，因为 MyBatis 会使用正在使用中的、设置了 Connection 的环境。MyBatis 为事务隔离级别调用使用了一个 Java 枚举包装器，称为 TransactionIsolationLevel，若不使用它，将使用 JDBC 所支持五个隔离级（NONE、READ\_UNCOMMITTED、READ\_COMMITTED、REPEATABLE\_READ 和 SERIALIZABLE），并按它们预期的方式来工作。

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

> ExecutorType.SIMPLE：这个执行器类型不做特殊的事情。它为每个语句的执行创建一个新的预处理语句。
> 
> ExecutorType.REUSE：这个执行器类型会复用预处理语句。
> 
> ExecutorType.BATCH：这个执行器会批量执行所有更新语句，如果 SELECT 在它们中间执行，必要时请把它们区分开来以保证行为的易读性。

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

注意 如果你使用的是 MyBatis 之前的版本，你要重新调用 openSession，因为旧版本的 session、事务和批量操作是分离开来的。如果使用的是新版本，那么就不必这么做了，因为它们现在都包含在 session 的作用域内了。你不必再单独处理事务或批量操作就能得到想要的全部效果。

# SqlSession #

正如上面所提到的，SqlSession 实例在 MyBatis 中是非常强大的一个类。在这里你会看到所有执行语句、提交或回滚事务和获取映射器实例的方法。在 SqlSession 类中有超过 20 个方法，所以将它们组合成易于理解的分组。这些方法被用来执行定义在 SQL 映射的 XML 文件中的 SELECT、INSERT、UPDATE 和 DELETE 语句。它们都会自行解释，每一句都使用语句的 ID 属性和参数对象，参数可以是原生类型（自动装箱或包装类）、JavaBean、POJO 或 Map。

![aee1a0628317664eda001c540306b6cc.png][]

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

insert、update和delete方法返回的值就是受语句影响的行数。

![36d333a63d12f20029843e71c16e893a.png][]

光标提供与列表相同的结果，但它使用迭代器延迟获取数据。

![7874e2669771648798ab980ea7152188.png][]

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

![02f028e876d4b0050a5c0852e3e4f3c6.png][]

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

![edb6314a8b2318591e4366a5eec87452.png][]

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

ResultHandler 参数允许你按你喜欢的方式处理每一行。你可以将它添加到 List 中、创建 Map 和 Set，或者丢弃每个返回值都可以，它取代了仅保留执行语句过后的总结果列表的死板结果。你可以使用 ResultHandler 做很多事，并且这是 MyBatis 自身内部会使用的方法，以创建结果集列表。从3.4.6开始，传递给可调用语句的resultHandler将用于存储过程的每个refcursor输出参数（如果有）。它的接口很简单。

![ed61d320e148a18c792b7c9be1ade10d.png][]

ResultContext 参数允许你访问结果对象本身、被创建的对象数目、以及返回值为 Boolean 的 stop 方法，你可以使用此 stop 方法来停止 MyBatis 加载更多的结果。使用 ResultHandler 的时候需要注意以下两种限制：

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

有一个方法可以刷新（执行）存储在 JDBC 驱动类中的批量更新语句。当你将 ExecutorType.BATCH 作为 ExecutorType 使用时可以采用此方法。

> List<BatchResult> flushStatements()

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

![69bbbea81222c00606a409569dae3320.png][]

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

注意 MyBatis-Spring 和 MyBatis-Guice 提供了声明事务处理，所以如果你在使用 Mybatis 的同时使用了Spring 或者 Guice，那么请参考它们的手册以获取更多的内容。

# 本地缓存 #

Mybatis 使用到了两种缓存：本地缓存（local cache）和二级缓存（second level cache）。

每当一个新 session 被创建，MyBatis 就会创建一个与之相关联的本地缓存。任何在 session 执行过的查询语句本身都会被保存在本地缓存中，那么，相同的查询语句和相同的参数所产生的更改就不会二度影响数据库了。本地缓存会被增删改、提交事务、关闭事务以及关闭 session 所清空。

默认情况下，本地缓存数据可在整个 session 的周期内使用，这一缓存需要被用来解决循环引用错误和加快重复嵌套查询的速度，所以它可以不被禁用掉，但是你可以设置 localCacheScope=STATEMENT 表示缓存仅在语句执行时有效。

注意，如果 localCacheScope 被设置为 SESSION，那么 MyBatis 所返回的引用将传递给保存在本地缓存里的相同对象。对返回的对象（例如 list）做出任何更新将会影响本地缓存的内容，进而影响存活在 session 生命周期中的缓存所返回的值。因此，不要对 MyBatis 所返回的对象作出更改，以防后患。

你可以随时调用以下方法来清空本地缓存：

![e9e0869e03a2ca5163eae68af1bda879.png][]

使用完确保 SqlSession 被关闭

![b94186a9c7c95359fef0e5de6f1393c2.png][]

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

![c5151a9a4d0c4dba1faf6976dae47b7d.png][]

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

![0e7b427e7663aa7b280ab7d096e42932.png][]

也可以获取映射器实例：

![4a4fcb3b0f1a2359041d60f58d4344d7.png][]

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

因此，一个更通用的方式来执行映射语句是使用映射器类。一个映射器类就是一个仅需声明与 SqlSession 方法相匹配的方法的接口类。下面的示例展示了一些方法签名以及它们是如何映射到 SqlSession 上的。

![823a18494af3e71052be77f8c14e9308.png][]

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

此外，返回类型必须匹配期望的结果类型，单返回值时为所指定类的值，多返回值时为数组或集合。所有常用的类型都是支持的，包括：原生类 型、Map、POJO 和 JavaBean。

> 注意 映射器接口不需要去实现任何接口或继承自任何类。只要方法可以被唯一标识对应的映射语句就可以了。映射器接口可以继承自其他接口。当使用 XML 来构建映射器接口时要保证语句被包含在合适的命名空间中。而且，唯一的限制就是你不能在两个继承关系的接口中拥有相同的方法签名（潜在的危险做法不可取）。

你可以传递多个参数给一个映射器方法。如果你这样做了，默认情况下它们将会以 "param" 字符串紧跟着它们在参数列表中的位置来命名，比如：\#\{param1\}、\#\{param2\}等。如果你想改变参数的名称（只在多参数情况下），那么你可以在参数上使用 @Param("paramName") 注解。

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

# 映射器注解 #

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

注意 不幸的是，Java 注解的的表达力和灵活性十分有限。尽管很多时间都花在调查、设计和试验上，最强大的 MyBatis 映射并不能用注解来构建——并不是在开玩笑，的确是这样。比方说，C\#属性就没有这些限制，因此 MyBatis.NET 将会比 XML 有更丰富的选择。也就是说，基于 Java 注解的配置离不开它的特性。

**注解如下表所示：**

![093210fad1fcf313e24177db34bbbce7.png][]

这个例子展示了如何使用 @SelectKey 注解来在插入前读取数据库序列的值：

![87313464eb694f2d5f1a5ef23895a5e1.png][]

这个例子展示了如何使用 @SelectKey 注解来在插入后读取数据库识别列的值：

![666f70e8f9675d9cf56651ef9142f639.png][]

这个例子展示了如何使用 @Flush 注解去调用 SqlSession\#flushStatements()：

![d29649ea16007cb6977f2dfed3ee6070.png][]

这些例子展示了如何通过指定 @Result 的 id 属性来命名结果集：

![d169f712dda5a42649406b14d33048a6.png][]

这个例子展示了单一参数使用 @SqlProvider 注解：

![a5646d1effa876d04e6d6f32f0c069fa.png][]

这个例子展示了多参数使用 @SqlProvider 注解：

![981ff6405ca50457960509237f7be1c9.png][]

此示例显示providerMethodResolver的默认实现的用法（自mybatis 3.5.1或更高版本以后可用）：

![ffb18d8b59a5223ef0746bbb0ed2615f.png][]

[3da717977d6e1663ba5ba1255926e502.png]: /images/20221123/f9a13ce6c16e44df9d8c81e63df1772e.png
[e61c6d43cb14fdca50a6c99530dae40e.png]: /images/20221123/2bc7197bf4b3413d99058b8a81219c5c.png
[d7e71129ed9868872e0c1f5704001032.png]: /images/20221123/f649e00d78154a5288c060f11bc17d9d.png
[6a10548e32685023823583a89766e120.png]: /images/20221123/a86a1df7076246b29f3d35f1d7f191c5.png
[e24e08bd491849d1581b3ac9027d8e87.png]: /images/20221123/790eb1c560204dfdae83c64a3c6b156a.png
[3dd475468ecb91e12be45af4ab15b0f5.png]: /images/20221123/71cde9ec4a6e4a129c141774cc951b69.png
[aee1a0628317664eda001c540306b6cc.png]: /images/20221123/f5d06f4f6f7c454391b0cbf75b8d83f1.png
[36d333a63d12f20029843e71c16e893a.png]: /images/20221123/3001f03f17c946529b00768089234281.png
[7874e2669771648798ab980ea7152188.png]: /images/20221123/9aafc40eb0804109b9536de17ea0d349.png
[02f028e876d4b0050a5c0852e3e4f3c6.png]: /images/20221123/8a4aeefd5ba04ae783461ce7c08369d1.png
[edb6314a8b2318591e4366a5eec87452.png]: /images/20221123/cf5114953d0c48008736308e2a62c4ef.png
[ed61d320e148a18c792b7c9be1ade10d.png]: /images/20221123/dab4f842f2f74ba5bd76c1820cb78522.png
[69bbbea81222c00606a409569dae3320.png]: /images/20221123/b47d4eee20b24d7cadf3de5b3a7b3c8e.png
[e9e0869e03a2ca5163eae68af1bda879.png]: /images/20221123/53d828e160944294ab00cdfd6be0f21a.png
[b94186a9c7c95359fef0e5de6f1393c2.png]: /images/20221123/c938cb9abe2842668354fb1d7d89b6f2.png
[c5151a9a4d0c4dba1faf6976dae47b7d.png]: /images/20221123/a0339b8687ac451eab2391eb4d58e132.png
[0e7b427e7663aa7b280ab7d096e42932.png]: /images/20221123/7535027d364947678fc9411db63c59da.png
[4a4fcb3b0f1a2359041d60f58d4344d7.png]: /images/20221123/c85ab7e5c654405f84cf2d986d9ba315.png
[823a18494af3e71052be77f8c14e9308.png]: /images/20221123/248230a1c23a4b2ead6689c8ee45150e.png
[093210fad1fcf313e24177db34bbbce7.png]: /images/20221123/4333b633ac7f4cee8b8f6f31cf4986cc.png
[87313464eb694f2d5f1a5ef23895a5e1.png]: /images/20221123/002230ddf2b74c698b819caa2974a5cb.png
[666f70e8f9675d9cf56651ef9142f639.png]: /images/20221123/5f779bd6e3f942f59b1136ef175f36bd.png
[d29649ea16007cb6977f2dfed3ee6070.png]: /images/20221123/501d36bf1fd34dc3955b45ac0ac46892.png
[d169f712dda5a42649406b14d33048a6.png]: /images/20221123/1d4abecc88c84ed992e3f4d97ee473d2.png
[a5646d1effa876d04e6d6f32f0c069fa.png]: /images/20221123/8d3e274108624d889aea663510f60407.png
[981ff6405ca50457960509237f7be1c9.png]: /images/20221123/1086ad32dcb84a1f91063e832ca2c620.png
[ffb18d8b59a5223ef0746bbb0ed2615f.png]: /images/20221123/87a9df294e37450fa4359dd4397bfa41.png