Swift 中的 Sendable 和 @Sendable 閉包 Sendable 和 @Sendable 閉包 —— 代碼實例詳解

Sendable 和 @Sendable 閉包 —— 代碼實例詳解

Sendable 和 @Sendable 是 Swift 5.5 中的併發修改的一部分，解決了結構化的併發結構體和執行者消息之間傳遞的類型檢查的挑戰性問題。

在深入探討Sendable的話題之前，我鼓勵你閱讀我圍繞 async/await、actors 和 actor isolation 的文章。這些文章涵蓋了新的併發性變化的基礎知識，它們與本文所解釋的技術直接相關。

我應該在什麼時候使用 Sendable？

Sendable協議和閉包表明那些傳遞的值的公共API是否線程安全的向編譯器傳遞了值。當沒有公共修改器、有內部鎖定系統或修改器實現了與值類型一樣的複製寫入時，公共API可以安全地跨併發域使用。

標準庫中的許多類型已經支持了Sendable協議，消除了對許多類型添加一致性的要求。由於標準庫的支持，編譯器可以爲你的自定義類型創建隱式一致性。

例如，整型支持該協議：

extension Int: Sendable {}

一旦我們創建了一個具有Int類型的單一屬性的值類型結構體，我們就隱式地得到了對Sendable協議的支持。

// 隱式地遵守了 Sendable 協議
struct Article {
    var views: Int
}

與此同時，同樣的Article內容的類，將不會有隱式遵守該協議：

// 不會隱式的遵守 Sendable 協議
class Article {
    var views: Int
}

類不符合要求，因爲它是一個引用類型，因此可以從其他併發域變異。換句話說，該類文章(Article)的傳遞不是線程安全的，所以編譯器不能隱式地將其標記爲遵守Sendable協議。

使用泛型和枚舉時的隱式一致性

很好理解的是，如果泛型不符合Sendable協議，編譯器就不會爲泛型添加隱式的一致性。

// 因爲 Value 沒有遵守 Sendable 協議，所以 Container 也不會自動的隱式遵守該協議
struct Container<Value> {
    var child: Value
}

然而，如果我們將協議要求添加到我們的泛型中，我們將得到隱式支持:

// Container 隱式地符合 Sendable，因爲它的所有公共屬性也是如此。
struct Container<Value: Sendable> {
    var child: Value
}

對於有關聯值的枚舉也是如此：

你可以看到，我們自動從編譯器中得到一個錯誤：

Associated value ‘loggedIn(name:)’ of ‘Sendable’-conforming enum ‘State’ has non-sendable type ‘(name: NSAttributedString)’

我們可以通過使用一個值類型String來解決這個錯誤，因爲它已經符合Sendable。

enum State: Sendable {
    case loggedOut
    case loggedIn(name: String)
}

從線程安全的實例中拋出錯誤

同樣的規則適用於想要符合Sendable的錯誤類型。

struct ArticleSavingError: Error {
    var author: NonFinalAuthor
}

extension ArticleSavingError: Sendable { }

由於作者不是不變的（non-final），而且不是線程安全的（後面會詳細介紹），我們會遇到以下錯誤：

Stored property ‘author’ of ‘Sendable’-conforming struct ‘ArticleSavingError’ has non-sendable type ‘NonFinalAuthor’

你可以通過確保ArticleSavingError的所有成員都符合Sendable協議來解決這個錯誤。

如何使用Sendable協議

隱式一致性消除了很多我們需要自己爲Sendable協議添加一致性的情況。然而，在有些情況下，我們知道我們的類型是線程安全的，但是編譯器並沒有爲我們添加隱式一致性。

常見的例子是被標記爲不可變和內部具有鎖定機制的類：

/// User 是不可改變的，因此是線程安全的，所以可以遵守 Sendable 協議
final class User: Sendable {
    let name: String

    init(name: String) { self.name = name }
}

你需要用@unchecked屬性來標記可變類，以表明我們的類由於內部鎖定機制所以是線程安全的：

extension DispatchQueue {
    static let userMutatingLock = DispatchQueue(label: "person.lock.queue")
}

final class MutableUser: @unchecked Sendable {
    private var name: String = ""

    func updateName(_ name: String) {
        DispatchQueue.userMutatingLock.sync {
            self.name = name
        }
    }
}

要在同一源文件中遵守 Sendable的限制

Sendable協議的一致性必鬚髮生在同一個源文件中，以確保編譯器檢查所有可見成員的線程安全。

例如，你可以在例如 Swift package這樣的模塊中定義以下類型：

public struct Article {
    internal var title: String
}

Article 是公開的，而標題title是內部的，在模塊外不可見。因此，編譯器不能在源文件之外應用Sendable一致性，因爲它對標題屬性不可見，即使標題使用的是遵守Sendable協議的String類型。

同樣的問題發生在我們想要使一個可變的非最終類遵守Sendable協議時：

由於該類是非最終的，我們無法符合Sendable協議的要求，因爲我們不確定其他類是否會繼承User的非Sendable成員。因此，我們會遇到以下錯誤:

Non-final class ‘User’ cannot conform to Sendable; use @unchecked Sendable

正如你所看到的，編譯器建議使用@unchecked Sendable。我們可以把這個屬性添加到我們的User類中，並擺脫這個錯誤:

class User: @unchecked Sendable {
    let name: String

    init(name: String) { self.name = name }
}

然而，這確實要求我們無論何時從User繼承，都要確保它是線程安全的。由於我們給自己和同事增加了額外的責任，我不鼓勵使用這個屬性，建議使用組合、最終類或值類型來實現我們的目的。

如何使用 @Sendabele

函數可以跨併發域傳遞，因此也需要可發送的一致性。然而，函數不能符合協議，所以Swift引入了@Sendable屬性。你可以傳遞的函數的例子是全局函數聲明、閉包和訪問器，如getters和setters。

SE-302的部分動機是執行儘可能少的同步

我們希望這樣一個系統中的絕大多數代碼都是無同步的。

使用@Sendable屬性，我們將告訴編譯器，他不需要額外的同步，因爲閉包中所有捕獲的值都是線程安全的。一個典型的例子是在Actor isolation中使用閉包。

actor ArticlesList {
    func filteredArticles(_ isIncluded: @Sendable (Article) -> Bool) async -> [Article] {
        // ...
    }
}

如果你用非 Sendabel 類型的閉包，我們會遇到一個錯誤:

let listOfArticles = ArticlesList()
var searchKeyword: NSAttributedString? = NSAttributedString(string: "keyword")
let filteredArticles = await listOfArticles.filteredArticles { article in
 
    // Error: Reference to captured var 'searchKeyword' in concurrently-executing code
    guard let searchKeyword = searchKeyword else { return false }
    return article.title == searchKeyword.string
}

當然，我們可以通過使用一個普通的String來快速解決這種情況，但它展示了編譯器如何幫助我們執行線程安全。

Swift 6: 爲你的代碼啓用嚴格的併發性檢查

Xcode 14 允許您通過 SWIFT_STRICT_CONCURRENCY 構建設置啓用嚴格的併發性檢查。

這個構建設置控制編譯器對Sendable和actor-isolation檢查的執行水平:

• Minimal : 編譯器將只診斷明確標有Sendable一致性的實例，並等同於Swift 5.5和5.6的行爲。不會有任何警告或錯誤。
• Targeted: 強制執行Sendable約束，並對你所有采用async/await等併發的代碼進行actor-isolation檢查。編譯器還將檢查明確採用Sendable的實例。這種模式試圖在與現有代碼的兼容性和捕捉潛在的數據競賽之間取得平衡。
• Complete: 匹配預期的 Swift 6語義，以檢查和消除數據競賽。這種模式檢查其他兩種模式所做的一切，並對你項目中的所有代碼進行這些檢查。

嚴格的併發檢查構建設置有助於 Swift 向數據競賽安全邁進。與此構建設置相關的每一個觸發的警告都可能表明你的代碼中存在潛在的數據競賽。因此，必須考慮啓用嚴格併發檢查來驗證你的代碼。

Enabling strict concurrency in Xcode 14

你會得到的警告數量取決於你在項目中使用併發的頻率。對於Stock Analyzer，我有大約17個警告需要解決：

這些警告可能讓人望而生畏，但利用本文的知識，你應該能夠擺脫大部分警告，防止數據競賽的發生。然而，有些警告是你無法控制的，因爲是外部模塊觸發了它們。在我的例子中，我有一個與SWHighlight有關的警告，它不符合Sendable，而蘋果在他們的SharedWithYou框架中定義了它。

在上述SharedWithYou框架的例子中，最好是等待庫的所有者添加Sendable支持。在這種情況下，這就意味着要等待蘋果公司爲SWHighlight實例指明Sendable的一致性。對於這些庫，你可以通過使用@preconcurrency屬性來暫時禁用Sendable警告:

@preconcurrency import SharedWithYou

重要的是要明白，我們並沒有解決這些警告，而只是禁用了它們。來自這些庫的代碼仍然有可能發生數據競賽。如果你正在使用這些框架的實例，你需要考慮實例是否真的是線程安全的。一旦你使用的框架被更新爲Sendable的一致性，你可以刪除@preconcurrency屬性，並修復可能觸發的警告。

繼續您的 Swift 併發之旅

併發更改不僅僅是 async-await，還包括許多您可以在代碼中受益的新功能。所以當你在做的時候，爲什麼不深入研究其他併發特性呢？

• Swift 中的 async/await
• Swift 中的 async let
• Swift 中的 Task
• Swift 中的 Actors 使用以如何及防止數據競爭
• Swift 中的 MainActor 使用和主線程調度
• 理解 Swift Actor 隔離關鍵字：nonisolated 和 isolated
• Swift 中的 Sendable 和 @Sendable 閉包
• Swift 中的 AsyncThrowingStream 和 AsyncStream
• Swift 中的 AsyncSequence

轉自 Sendable and @Sendable closures explained with code examples