現今 Swift 包中的二進制目標

作者：Swift君 2022-07-18 09:01:15

為了充分理解 Apple 的 Swift 團隊在二進制目標和他們引入的一些新 API 方面采取的一些步驟，我們需要理解它們從何而來。

文章目錄

理解二進制在 Swift 中的演變。
命令行工具相關。
結論。

在 iOS 和 macOS 開發中， Swift 包現在變得越來越重要。Apple 已經努力推動橋接那些縫隙，并且修復那些阻礙開發者的問題，例如阻礙開發者將他們的庫和依賴由其他諸如 Carthage[1] 或 CocoaPods[2] 依賴管理工具遷移到 Swift 包依賴管理工具的問題，例如沒有能力添加構建步驟的問題。這對任何依賴一些代碼生成的庫來說都是破壞者，比如，協議和 Swift 生成。

理解二進制在 Swift 中的演變

為了充分理解 Apple 的 Swift 團隊在二進制目標和他們引入的一些新 API 方面采取的一些步驟，我們需要理解它們從何而來。在后續的部分中，我們將調研 Apple 架構的演變，以及為什么二進制目標的 API 在過去幾年中逐漸形成的，特別是自 Apple 發布了自己的硅芯片之后。

胖二進制和 Frameworks 框架

如果你曾必須處理二進制依賴，或者你曾創建一個屬于你自己的可執行文件，你將會對 胖二進制 這個術語感到熟悉。這些被擴展（或增大）的可執行文件，是包含了為多個不同架構原生構建的切片。這允許庫的所有者分發一個運行在所有預期的目標架構上的單獨的二進制。

當源碼不能被暴露或當處理非常龐大的代碼倉庫時，預編譯庫成為可執行文件非常有意義，因為預編譯源碼以及以二進制文件分發他們，將節省構建程序在他們的應用上的構建時間。

Pods[3] 是一個非常好的例子，當開發者發現他們自己沒必要構建那些非常少改動的依賴。這是一個很共通的問題，它激發了諸如 cocoapods-binary[4] 之類的項目，該項目預編譯了 pod 依賴項以減少客戶端的構建時間。

Frameworks 框架

嵌入靜態二進制文件可能對應用程序來說已經足夠了，但如果需要某些資源（如 assets 或頭文件），則需要將這些資源與包含所有切片的胖二進制文件捆綁在一起，形成所謂的 frameworks 文件。

這就是諸如 Google Cast[5] 之類的預編譯庫在過渡到使用 xcframework 進行分發之前所做的事情 —— 下一節將詳細介紹這種過渡的原因。

到目前為止，一切都很好。如果我們要為分發預編譯一個庫，那么胖二進制文件聽起來很理想，對吧？并且，如果我們需要捆綁一些其他資源，我們可以只使用一個 frameworks。一個二進制來統治他們所有！

XCFrameworks 框架

好吧，不完全是。胖二進制文件有一個大問題，那就是你不能有兩個架構相同但命令/指令不同的切片。這曾經很好，因為設備和模擬器的架構總是不同的，但是隨著 Apple Silicon 計算機 (M1) 的推出，模擬器和設備共享相同的架構 (arm64)，但具有不同的加載器命令。這與面向未來的二進制目標相結合，正是 Apple 引入 XCFrameworks[6] 的原因。

你可以在 Bogo Giertler 撰寫的這篇精彩文章中詳細了解為 iOS 設備構建的 arm64 切片和為 M1 mac 的 iOS 模擬器構建的 arm64 切片之間的區別。

?XCFrameworks[7] 現在允許將多個二進制文件捆綁在一起，解決了 M1 Mac 引入的設備和模擬器沖突架構問題，因為我們現在可以為每個用例提供包含相關切片的二進制文件。事實上，如果我們需要，我們可以走得更遠，例如，在同一個 xcframework 中捆綁一個包含 iOS 目標的 UIKit? 接口的二進制文件和一個包含 macOS 的 AppKit 接口的二進制文件，然后讓 Xcode 基于期望的目標架構決定使用哪一個。

在 Swift 包中，那先能夠以 binaryTarget[8] 被包含進項目的，能夠在包中被引入任意其他目標。這相同的操作同樣適用于 frameworks。

命令行工具相關

由于 Swift 5.6 版本中引入了用于 Swift 包管理器的可擴展構建工具[9] ，因此可以在構建過程中的不同時間執行命令。

這是 iOS 社區長期以來一直強烈要求的事情，例如格式化源代碼、代碼生成甚至收集公制代碼庫的指標。Swift 5.6 中所有這些所謂的插件[10] 最終都需要調用可執行文件來執行特定任務。這是二進制文件再次在 Swift 包中參與的地方。

在大多數情況下，對于我們 iOS 開發人員來說，這些工具將來自同時支持 macOS 的不同架構切片 —— Apple Silicon 的 arm64 架構和 Intel Mac 的 x86_64 架構。開發者工具如， SwiftLint[11] 或 SwiftGen[12] 正是這種案例。在這種情況下，可以使用包含可執行文件（本地或遠程）的 .zip 文件的路徑創建新的二進制目標。

注意可執行文件必須在.zip文件的根目錄下，否則找不到。

Artifact Bundles

到目前為止，命令行工具所采用的方法僅適用于 macOS 架構。但我們不能忘記，Linux 機器也支持 Swift 包。這意味著如果要同時支持 M1 macs (arm64?) 和 Linux arm64? 機器，上面的胖二進制方法將不起作用 —— 請記住，二進制不能包含具有相同架構的多個切片。在這個階段可能有人會想，我們可以不只使用 xcframeworks 嗎？不，因為它們在 Linux 操作系統上不受支持！

Apple 已經考慮到這一點，除了引入可擴展構建工具[13] 之外，Artifact Bundles[14] 和對二進制目標的其他改進也作為 Swift 5.6 的一部分發布。

工件包(Artifact Bundles) 是包含工件的目錄。這些工件需要包含支持架構的所有不同二進制文件。二進制文件和支持的架構的路徑是使用清單文件 (info.json) 指定的，該文件位于 Artifact Bundle 目錄的根目錄中。你可以將此清單文件視為一個地圖或指南，以幫助 Swift 確定哪些可執行文件可用于哪種架構以及可以在哪里找到它們。

以 SwiftLint 為例

?SwiftLint[15] 在整個社區中被廣泛用作 Swift 代碼的靜態代碼分析工具。由于很多人都非常渴望讓這個插件在他們的 SwiftPM 項目中運行，我認為這將是一個很好的例子來展示我們如何將分發的可執行文件從他們的發布頁面變成一個與 macOS 架構和 Linux arm64 兼容的工件包。

讓我們從下載兩個可執行文件（macOS[16] 和 Linux[17]）開始。

至此，bundle的結構就可以創建好了。為此，創建一個名為 swiftlint.artifactbundle? 的目錄并在其根目錄添加一個空的 info.json：

mkdir swiftlint.artifactbundle
touch swiftlint.artifactbundle/info.json

現在可以使用 schemaVersion 填充清單文件，這可能會在未來版本的工件包和具有兩個變體的工件中發生變化，這將很快定義：

{
    "schemaVersion": "1.0",
    "artifacts": {
        "swiftlint": {
            "version": "0.47.0", # The version of SwiftLint being used
            "type": "executable",
            "variants": [
            ]
        },
    }
}

需要做的最后一件事是將二進制文件添加到包中，然后將它們作為變體添加到 info.json? 文件中。讓我們首先創建目錄并將二進制文件放入其中（macOS 的一個在 swiftlint-macos/swiftlint?，Linux 的一個在 swiftlint-linux/swiftlint）。

添加這些之后，可以在清單文件中變量：

{
    "schemaVersion": "1.0",
    "artifacts": {
        "swiftlint": {
            "version": "0.47.0", # The version of SwiftLint being used
            "type": "executable",
            "variants": [
             {
                    "path": "swiftlint-macos/swiftlint",
                    "supportedTriples": ["x86_64-apple-macosx", "arm64-apple-macosx"]
                },
               {
                    "path": "swiftlint-linux/swiftlint",
                    "supportedTriples": ["x86_64-unknown-linux-gnu"]
                },
            ]
        },
    }
}

為此，需要為每個變量指定二進制文件的相對路徑（從工件包目錄的根目錄）和支持的三元組。如果您不熟悉目標三元組[18]，它們是一種選擇構建二進制文件的架構的方法。請注意，這不是主機（構建可執行文件的機器）的體系結構，而是目標機器（應該運行所述可執行文件的機器）。

這些三元組具有以下格式： ----? 并非所有字段都是必需的，如果其中一個字段未知并且要使用默認值，則可以省略或替換為 unknown 關鍵字。

可執行文件的架構切片可以通過運行 file 找到，這將打印捆綁的任何切片的供應商、系統和架構。在這種情況下，為這兩個命令運行它會顯示：

swiftlint-macos/swiftlint

swiftlint: Mach-O universal binary with 2 architectures: [x86_64:Mach-O 64-bit executable x86_64] [arm64]
swiftlint (for architecture x86_64): Mach-O 64-bit executable x86_64
swiftlint (for architecture arm64): Mach-O 64-bit executable arm64

swiftlint-linux/swiftlint

-> file swiftlint
swiftlint: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 3.2.0, with debug_info, not stripped

這帶來了上面顯示的 macOS 支持的兩個三元組（x86_64-apple-macosx、arm64-apple-macosx?）和 Linux 支持的一個三元組（x86_64-unknown-linux-gnu）。

與 XCFrameworks 類似，工件包也可以通過使用 binaryTarget 包含在 Swift 包中。

結論

簡而言之，我們可以總結 2022 年如何在 Swift 包中使用二進制文件的最佳實踐，如下所示：

如果你需要為你的 iOS/macOS 項目添加預編譯庫或可執行文件，您應該使用XCFramework，并為每個用例（iOS 設備、macOS 設備和 iOS 模擬器）包含單獨的二進制文件。
如果你需要創建一個插件并運行一個可執行文件，你應該將其嵌入為一個工件包，其中包含適用于不同支持架構的二進制文件。

參考資料

[1] Carthage: https://github.com/Carthage/Carthage。

[2] CocoaPods: https://github.com/CocoaPods/CocoaPods。

[3] Pods: https://cocoapods.org/。

[4] cocoapods-binary: https://github.com/leavez/cocoapods-binary。

[5] Google: https://developers.google.com/cast/docs/ios_sender#manual_setup。

[6] XCFrameworks: https://developer.apple.com/videos/play/wwdc2019/416/。

[7] XCFrameworks: https://help.apple.com/xcode/mac/11.4/#/dev6f6ac218b。

[8] binaryTarget: https://developer.apple.com/documentation/swift_packages/distributing_binary_frameworks_as_swift_packages。

[9] Extensible Build Tools: https://github.com/apple/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md。

[10] Plugins: https://github.com/apple/swift-evolution/blob/main/proposals/0303-swiftpm-exte""nsible-build-tools.md#plugin-api。

[11] SwiftLint: https://github.com/realm/SwiftLint。

[12] SwiftGen: https://github.com/SwiftGen/SwiftGen。

[13] Extensible Build Tools: https://github.com/apple/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md。

[14] Artifact Bundles: https://github.com/apple/swift-evolution/blob/main/proposals/0305-swiftpm-binary-target-improvements.md。

[15] SwiftLint: https://github.com/realm/SwiftLint。

[16] macOS: https://github.com/realm/SwiftLint/releases/download/0.47.0/portable_swiftlint.zip。

[17] Linux: https://github.com/realm/SwiftLint/releases/download/0.47.0/swiftlint_linux.zip。

[18] target-triples: https://clang.llvm.org/docs/CrossCompilation.html#target-triples。

責任編輯：姜華來源： Swift社區