当遵守协议或重写超类方法时,您可能无法将方法更改为 be async
,但您可能仍想调用一些async
代码。例如,当我正在重写一个要根据 Swift 的新结构化并发编写的程序时,我想通过覆盖定义的 on 来在async
测试套件的开头调用一些设置代码。我希望我的设置代码在任何测试运行之前完成,因此使用or是不合适的。class func setUp()
XCTestCase
Task.detached
async { ... }
最初,我写了一个这样的解决方案:
final class MyTests: XCTestCase {
override class func setUp() {
super.setUp()
unsafeWaitFor {
try! await doSomeSetup()
}
}
}
func unsafeWaitFor(_ f: @escaping () async -> ()) {
let sema = DispatchSemaphore(value: 0)
async {
await f()
sema.signal()
}
sema.wait()
}
这似乎工作得很好。然而,在Swift 并发:在幕后,运行时工程师 Rokhini Prabhu 指出
信号量和条件变量等原语在 Swift 并发中使用是不安全的。这是因为它们对 Swift 运行时隐藏了依赖关系信息,但在代码的执行中引入了依赖关系……这违反了线程向前推进的运行时契约。
她还包括了这样一个不安全的代码模式的代码片段
func updateDatabase(_ asyncUpdateDatabase: @Sendable @escaping () async -> Void) {
let semaphore = DispatchSemaphore(value: 0)
async {
await asyncUpdateDatabase()
semaphore.signal()
}
semaphore.wait()
}
这尤其是我想出的确切模式(我发现我想出的代码正是规范的不正确代码模重命名非常有趣)。
不幸的是,我无法找到任何其他方法来等待异步代码从同步函数完成。此外,我还没有找到任何方法来获取同步函数中异步函数的返回值。我在互联网上找到的唯一解决方案似乎和我的一样不正确,例如这篇The Swift Dev 文章说
为了在同步方法中调用异步方法,您必须使用新的分离函数,并且您仍然必须使用调度 API 等待异步函数完成。
我认为这是不正确的或至少是不安全的。
什么是等待async
同步函数中的函数与现有同步类或协议要求一起工作的正确、安全的方法,而不是特定于测试或 XCTest?或者,我在哪里可以找到说明Swift 中async
/await
与现有同步原语(如 )之间交互的文档DispatchSemaphore
?它们永远不安全,还是我可以在特殊情况下使用它们?
更新:
根据@TallChuck 的回答,它注意到它setUp()
总是在主线程上运行,我发现我可以通过调用任何@MainActor
函数来故意死锁我的程序。这是应尽快更换我的解决方法的极好证据。
明确地说,这是一个挂起的测试。
import XCTest
@testable import Test
final class TestTests: XCTestCase {
func testExample() throws {}
override class func setUp() {
super.setUp()
unsafeWaitFor {
try! await doSomeSetup()
}
}
}
func doSomeSetup() async throws {
print("Starting setup...")
await doSomeSubWork()
print("Finished setup!")
}
@MainActor
func doSomeSubWork() {
print("Doing work...")
}
func unsafeWaitFor(_ f: @escaping () async -> ()) {
let sema = DispatchSemaphore(value: 0)
async {
await f()
sema.signal()
}
sema.wait()
}
@MainActor
但是,如果被注释掉,它不会挂起。我担心的一个问题是,如果我调用库代码(Apple 或其他),@MainActor
即使函数本身没有标记,也无法知道它是否最终会调用函数@MainActor
。
我的第二个担心是,即使没有@MainActor
,我仍然不知道我能保证这是安全的。在我的电脑上,这挂起。
import XCTest
@testable import Test
final class TestTests: XCTestCase {
func testExample() throws {}
override class func setUp() {
super.setUp()
unsafeWaitFor {
unsafeWaitFor {
unsafeWaitFor {
unsafeWaitFor {
unsafeWaitFor {
unsafeWaitFor {
print("Hello")
}
}
}
}
}
}
}
}
func unsafeWaitFor(_ f: @escaping () async -> ()) {
let sema = DispatchSemaphore(value: 0)
async {
await f()
sema.signal()
}
sema.wait()
}
如果这不适合您,请尝试添加更多unsafeWaitFor
s. 我的开发虚拟机有 5 个核心,这是 6unsafeWaitFor
秒。5对我来说很好。这与 GCD 明显不同。这是 GCD 中的一个等价物,它不会挂在我的机器上。
final class TestTests: XCTestCase {
func testExample() throws {}
override class func setUp() {
super.setUp()
safeWaitFor { callback in
safeWaitFor { callback in
safeWaitFor { callback in
safeWaitFor { callback in
safeWaitFor { callback in
safeWaitFor { callback in
print("Hello")
callback()
}
callback()
}
callback()
}
callback()
}
callback()
}
callback()
}
}
}
func safeWaitFor(_ f: @escaping (() -> ()) -> ()) {
let sema = DispatchSemaphore(value: 0)
DispatchQueue(label: UUID().uuidString).async {
f({ sema.signal() })
}
sema.wait()
}
这很好,因为 GCD 很乐意生成比 CPU 更多的线程。因此,也许建议是“只使用与unsafeWaitFor
CPU 一样多的 s”,但如果是这种情况,我希望在某个地方看到 Apple 明确说明了这一点。在一个更复杂的程序中,我是否真的可以确定我的代码可以访问机器上的所有内核,或者我的程序的其他部分是否可能正在使用其他内核,因此请求的工作unsafeWaitFor
将永远不会预定?
当然,我的问题中的示例是关于测试的,因此在这种情况下,很容易说“建议是什么并不重要:如果它有效,它就有效,如果它不起作用,那么测试失败,你会修复它,”但我的问题不仅仅是关于测试;这只是一个例子。
使用 GCD,我对自己能够在DispatchQueue
不耗尽可用线程总数的情况下将异步代码与信号量(在我自己控制的,而不是主线程上)同步的能力充满信心。我希望能够在 Swift 5.5 中将async
同步函数中的代码与async
/同步。await
如果这样的事情是不可能的,我也会接受来自 Apple 的文档,其中详细说明了在哪些情况下我可以安全地使用unsafeWaitFor
或类似的同步技术。