简答
addTaskUnlessCancelled 的优点在于:
- 如果组被取消,它甚至不会启动任务;和
- 如果组已被取消,它允许您添加提前退出。
如果您有兴趣,可以将addTask 的源代码与addTaskUnlessCancelled 的源代码进行比较,就在其下方。
长答案
我认为,如果我们更改任务组是随着时间的推移处理请求(例如,使用AsyncSequence),则问题是最好的例证。
考虑以下
func a() async {
await withTaskGroup(of: Void.self) { group in
for await i in tickSequence() {
group.addTask(operation: { await self.b() })
if i == 3 {
group.cancelAll()
}
}
}
}
func b() async {
let start = CACurrentMediaTime()
while CACurrentMediaTime() - start < 3 { }
}
func tickSequence() -> AsyncStream<Int> {
AsyncStream { continuation in
Task {
for i in 0 ..< 12 {
try await Task.sleep(nanoseconds: NSEC_PER_SEC / 2)
continuation.yield(i)
}
continuation.finish()
}
}
}
在此示例中,b 正在等待刻度序列事件,为每个事件调用 c。但是我们在添加第四个任务后取消该组。结果如下:
所以我们可以看到路标ⓢ,在添加第四个任务后,该组被取消了,但它没有受到影响。
但那是因为b 没有响应取消。所以假设你解决了这个问题:
func b() async {
let start = CACurrentMediaTime()
while CACurrentMediaTime() - start < 3 {
if Task.isCancelled { return }
}
}
您现在看到如下行为:
这更好,因为b 现在正在取消,但a 仍在尝试向组添加任务,即使它已被取消。并且可以看到b在反复运行(虽然至少现在是立即终止),而a发起的任务并没有及时完成。
但是,如果你使用group.addTaskUnlessCancelled,它不仅不会向组中添加新任务(即,它不依赖于任务的取消功能),而且还可以让你在组结束时退出取消。
func a() async {
await withTaskGroup(of: Void.self) { group in
for await i in tickSequence() {
guard group.addTaskUnlessCancelled(operation: { await self.b() })
else { break }
if i == 3 {
group.cancelAll()
}
}
}
}
这会导致所需的行为:
显然,这是一个相当人为的示例,明确构建以说明差异,但在许多情况下,addTask 和 addTaskUnlessCancelled 之间的差异不那么明显。但希望以上说明了差异。
最重要的是,如果您可能在向该组添加其他任务的过程中取消组,建议您使用addTaskUnlessCancelled。话虽如此,如果您不取消组(例如,取消任务比取消组更常见,恕我直言),并不完全清楚真正需要多久addTaskUnlessCancelled。
注意,在上面,我删除了所有 OSLog 和路标代码,以在 Xcode Instruments 中生成所有上述间隔和路标(因为我不想分散手头的问题)。但是,如果您有兴趣,这是实际的代码:
import os.log
private let log = OSLog(subsystem: "Test", category: .pointsOfInterest)
func a() async {
await withTaskGroup(of: Void.self) { group in
let id = log.begin(name: #function, "begin")
defer { log.end(name: #function, "end", id: id) }
for await i in tickSequence() {
guard group.addTaskUnlessCancelled(operation: { await self.b() }) else { break }
if i == 3 {
log.event(name: #function, "Cancel")
group.cancelAll()
}
}
}
}
func b() async {
let id = log.begin(name: #function, "begin")
defer { log.end(name: #function, "end", id: id) }
let start = CACurrentMediaTime()
while CACurrentMediaTime() - start < 3 {
if Task.isCancelled { return }
}
}
func tickSequence() -> AsyncStream<Int> {
AsyncStream { continuation in
Task {
for i in 0 ..< 12 {
try await Task.sleep(nanoseconds: NSEC_PER_SEC / 2)
continuation.yield(i)
}
continuation.finish()
}
}
}
有
extension OSLog {
func event(name: StaticString = "Points", _ string: String) {
os_signpost(.event, log: self, name: name, "%{public}@", string)
}
/// Manually begin an interval
func begin(name: StaticString = "Intervals", _ string: String) -> OSSignpostID {
let id = OSSignpostID(log: self)
os_signpost(.begin, log: self, name: name, signpostID: id, "%{public}@", string)
return id
}
/// Manually end an interval
func end(name: StaticString = "Intervals", _ string: String, id: OSSignpostID) {
os_signpost(.end, log: self, name: name, signpostID: id, "%{public}@", string)
}
func interval<T>(name: StaticString = "Intervals", _ string: String, block: () throws -> T) rethrows -> T {
let id = OSSignpostID(log: self)
os_signpost(.begin, log: self, name: name, signpostID: id, "%{public}@", string)
defer { os_signpost(.end, log: self, name: name, signpostID: id, "%{public}@", string) }
return try block()
}
}