Swift 并发 - Swift SDK

Realm 并发注意事项

当您在应用中实现并发功能时，请考虑以下有关 Realm 线程模型和 Swift 并发线程行为的注意事项。

异步/等待 API

许多涉及使用 Atlas App Services 应用或同步 Realm 的 Realm Swift API 都与 Swift 的 async/await 语法兼容。例如，请查看：

• 异步/等待登录

• 管理电子邮件/密码用户

• 关联用户身份 - 异步/等待

• 打开同步 Realm 或本地 Realm

• 等待来自其他 actor 的通知

• 管理灵活同步订阅

• 异步/等待调用无服务器函数

• 异步/等待查询 MongoDB

• 异步/等待 CRUD 操作

如果您有与 Swift 异步/等待 API 相关的特定功能请求，请查看Realm 的 MongoDB 反馈引擎。 Realm Swift SDK 团队计划根据社区反馈和 Swift 并发演进继续开发并发相关功能。

任务和任务组

Swift 并发提供 API 来管理 任务 和 任务组 。 Swift 并发文档 将任务定义为可以作为程序的一部分异步运行的工作单元。任务允许您具体定义异步工作单元。任务组允许您定义任务集合，作为父任务组下的一个单元执行。

任务和任务组可支持让线程去处理其他重要工作或取消可能会阻碍其他操作的长时间运行的任务。为了获得这些好处，您可能希望使用任务和任务组在后台管理 Realm 写入。

但是，上面使用 Await 暂停执行中描述的线程限制约束适用于任务上下文。如果您的任务包含await点，则后续代码可能会在不同的线程上运行或恢复，并违反 Realm 的线程限制。

您必须使用 @MainActor 对在任务上下文中运行的函数进行注释，以确保访问 Realm 的代码仅在主线程上运行。这抵消了使用任务的一些好处，并且可能意味着这对于使用 Realm 的应用程序来说不是一个好的设计选择，除非您仅将任务用于管理用户等网络活动。

Actor 隔离

Actor 隔离让人感觉就像是将 Realm 访问限制为专用 Actor，因此似乎是在异步上下文中管理 Realm 访问的安全方法。

不过，目前还不支持在非 @MainActor 异步函数中使用 Realm。

在 Swift 5.6 中，这通常是巧合。无论等待的任务在哪个线程上运行，await 之后的执行都会继续。在异步函数中使用 await Realm() 会导致其后的代码在主线程上运行，直到您下次调用与 actor 隔离的函数为止。

每当更改 actor 隔离上下文时，Swift 5.7 就会跳转线程。未隔离的异步函数始终在后台线程上运行。

如果你有使用 await Realm() 且在 5.6 版本中正常运行的代码，则将该函数标记为 @MainActor 将使其可以在 Swift 5.7 中正常运行。它将像在 5.6 版本中一样以非有意的方式运行。

与并发代码相关的错误

大多数情况下，您看到的与通过并发代码访问 Realm 相关的错误都是 Realm accessed from incorrect thread. ，这是由于本页所述的线程隔离问题造成的。

为了在使用 Swift 并发功能的代码中避免出现与线程相关的问题，请执行以下操作：

• 升级到支持 actor 隔离的 Realm 的 Realm Swift SDK 版本，并使用该版本作为手动管理线程的替代方法。有关更多信息，请参阅结合使用 Realm 与 Actor - Swift SDK。

• 请勿在访问 Realm 时更改执行上下文。如果您在主线程上打开一个 Realm 来为用户界面提供数据，请使用 @MainActor 注释异步访问该 Realm 的后续函数，以确保它始终在主线程上运行。请记住， await 标记了一个可以更改为其他线程的暂停点。

• 不使用 actor 隔离 Realm 的应用程序可以使用 writeAsync API 来执行后台写入。这以线程安全的方式管理 Realm 访问，而不需要您自己编写专门的代码来实现。这是一个特殊的 API，它将写入过程的各个方面外包（在安全的情况下）以在异步上下文中运行。除非您要写入 actor 隔离的 Realm，否则请勿将此方法与 Swift 的 async/await 语法结合使用。在代码中同步使用此方法。或者，在等待写入异步 Realm 时，您可以将 asyncWrite API 与 Swift 的 async/await 语法结合使用。

• 如果您想要显式编写非 actor 隔离的并发代码（即以线程安全的方式访问 Realm），您可以适时跨线程显式传递实例，以避免与线程相关的崩溃。这需要深入理解 Realm 的线程模型，并注意 Swift 并发线程行为。

符合 Sendable 协议、不符合 Sendable 协议和具有线程限制的类型

Realm Swift SDK 公共 API 中包含的类型分为以下三大类：

• 符合 Sendable 协议

• 不符合 Sendable 协议且不具有线程限制

• 线程限制

您可以在线程之间共享不符合 Sendable 协议且不受线程限制的类型，但必须对它们进行同步。

除非被冻结，否则具有线程限制的类型仅限于隔离上下文。即使使用同步，也无法在这些上下文之间传递它们。