Swiftパッケージとしてバイナリフレームワークを配布する

Swiftパッケージとしてバイナリフレームワークを配布する

Appにサードパーティのフレームワークを追加し、XcodeでSwiftパッケージを使い、それらを最新の状態に保つ方法をお伝えします。フレームワークを参照するパッケージの作成方法、バイナリターゲットおよびパッケージのマニフェストファイルでそれらを指定する方法をご説明します。また、正確なバイナリをクライアントが常に得られるようにチェックサムを計算する方法もお伝えします。フレームワークは、XCFrameworkフォーマットで配付されます。XCFrameworkの作成とバージョニングの詳細は、WWDC19の"Binary Frameworks in Swift”をご覧ください。

リソース
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC20
- Swiftの新機能
- Swiftパッケージ：リソースとローカリゼーション
WWDC19
- Swiftのバイナリフレームワーク
- Swiftパッケージを作成する
ダウンロード

こんにちは WWDCへようこそ
“Swiftパッケージとしてバイナリフレームワークを配布する” こんにちはボリスです今日のトークは― Swiftパッケージとしてのバイナリフレームワークの配布についてです Xcode 11でSwiftパッケージへのサポートを紹介しましたソースコードとしてライブラリを配布するための簡単なアプローチを提供しています XCFrameworkも紹介しましたクローズドソースバイナリフレームワークとライブラリを配布するためにより良い方法を提供しています Xcode 12では― ライブラリ配布用Swiftパッケージの利点をバイナリ依存関係のサポートを得てクローズドソースライブラリにももたらしていますこのビデオでカバーするのはまずアプリケーションでのバイナリ依存性の使い方です次にバイナリフレームワークの Swiftパッケージとしての― 配布方法をお話ししますそして最後に Xcodeでバイナリフレームワークの作り方を見てみますソースコードフォームには多くのライブラリがあります中にはライブラリのソースコードを使用可能にしないことを選択するデベロッパもいますその代わりにバイナリフォームに配布するのですこのようなバイナリ依存性を利用するのは― ソースベース依存性を追加するようなものですデモで見てみましょう
シンプルなiOSアプリケーションから始めます “File”“Swift Packages” “Add Package Dependency”を選択します
“BinaryEmoji”パッケージを選びます
バージョン 1.0 です
バイナリをアプリケーションにリンクします
ここでプロジェクトナビゲーターを見てみると新しいグループ “Referenced Binaries”があります XCFrameworkが含まれています
Finderで見てみましょう
たくさんのサブディレクトリがありそれぞれがターゲットトリプルで表されるプラットフォームや― ターゲット環境に対応しています
さらにその特定のトリプルのために対応するフレームワークがあります
Xcodeに戻りましょう
これで絵文字モジュールがインポートできます
私たちのアプリケーションのコードに入れます
“定義”までジャンプすると―
どのAPIがそれを提供するかが分かりますアプリケーションで使いたい “EmojiView”タイプがあります
プレビューをリフレッシュすると―
EmojiViewが使用されているのが分かりますバイナリ依存性を使うのはソースベース依存性と同じくらい役に立ちます Xcode 11からのXCFrameworkはもうよくご存じとか思いますがこれらは同じ方法で効果的にまるで― アプリケーションに直接追加されたかのように処理されます
同じライブラリをパッケージ依存性として使いたい場合― すでに慣れている方法で使えますパッケージマニフェストには依存関係の配列にエントリを追加できますそれはパッケージが使用するリポジトリを指し示していますそしてこの依存性のために選択したバージョン制限を定義します
他の誰かが書いたバイナリ依存性の使用方法を見てきました次にパッケージの作り方を見てみましょう自らバイナリフレームワークを配布するパッケージです Xcode 12は新パッケージマニフェストAPIを持つ新しいtools-version:5.3を提供します新しいターゲットタイプを追加します “binaryTarget”です名前はXCFrameworkのモジュール名に応答します
またはHTTPS URL そしてチェックサムのモジュール名ですそのためダウンロードされたアーカイブを検証できます
その他にXCFrameworkをパスで指し示すオプションもありますこれは開発用ですただし大きなXCFrameworkはやはり大きなバイナリファイルのように― Gitリポジトリにコミットすべきではないことにご注意くださいチェックアウトが遅くなるからです
製品はバイナリターゲットを参照してクライアントに― 通常のターゲットのように販売できます先ほど見たようにバイナリターゲットは XCFrameworkを使います Appleプラットフォームでのみサポートされパスがパッケージ内の― ファイルを指し示す事ができるHTTPS またはパスベースにすることができます HTTPSが選択された場合ご自身のパッケージのGitチェックアウトからバイナリアーティファクトは― 別々にダウンロードされますつまり大きなバイナリでリポジトリ履歴を汚染しませんそして同じダウンロード場所を他の用途にも使用できます例えばフレームワークを手動でダウンロードするような場合です
名前はモジュール名に対応します名前はグラフ全体で一意なため― 他の人のバイナリフレームワークをバンドルしないでくださいバイナリフレームワークごとに１つの正規パッケージが必要ですパッケージのバイナリターゲットを展開する時には― セマンティックバージョニングに従う必要がありますソースベースターゲットと同じように例えばメソッドやタイプの名称変更など XCFrameworkに変更を加えると― パッケージのメジャーバージョン増加につながります同様に自分のフレームワークにバージョンをつけたい場合フレームワークのInfo.plistにあるバンドルバージョンの文字列設定を使用しますバイナリフレームワークの進化についての詳細は― WWDC 2019のセッション“Binary Frameworks in Swift”でカバーしていますご視聴いただくことをお勧めしますそれではもう１つのデモでバイナリ依存性の作り方を見てみましょう
今回は“File”“New”“Swift Package”を用い新しいパッケージで始めます
“Emoji”と名づけます
テンプレートが追加したターゲットを除去し―
その代わりにバイナリターゲットを挿入します
名前はこちらも“Emoji”です XCFrameworkがあるローカルサーバーを指し示すURLを使用します
次はチェックサムが必要ですどうやって作るのでしょう？
バイナリフレームワークのチェックサムを計算するには― “swift package compute-checksum” コマンドを使いますこれは末端にチェックサムを出力しますそこでコピーしてご自分のパッケージマニフェストに貼り付けますパッケージが使用されている時 Xcodeはダウンロードされたファイルのチェックサムを計算しマニフェストに一致しなかった場合はそれを拒否しますこれによりクライアントはご希望の正しいバイナリを使用できますそれではそのチェックサムを挿入しパッケージを作ります
それによってXCFrameworkを Swiftパッケージにバンドルし― 配布することができます最後にバイナリフレームワーク自身の作り方を見てみましょう XCFrameworkはXcode 11で紹介されました異なるプラットフォーム用フレームワークの複数のバリアントをまとめましたそして動的および静的ライブラリ同様フレームワークをサポートし― 各XCFrameworkは単一のモジュールを含みます XCFrameworkを作成するには― “Build Libraries for Distribution”構築設定をセットします現存するフレームワークまたはライブラリターゲットにします “xcodebuild archive”コマンドを使用して各バリアントをアーカイブします “xcodebuild -create-xcframework” コマンドを使ってひとまとめにします
より詳しく知りたい方は― WWDC 2019のセッション“Binary Frameworks in Swift”をご視聴ください Xcodeでバイナリフレームワークを作成する前に見ることをお勧めしますさて最後を締めくくる前に― バイナリ依存関係を使用したトレードオフについてお話します毎回必ず考えていただきたいのはどのサードパーティコンポーネントを― ご自分のプロジェクトに追加するかです特にバイナリはデバッグがより難しくなり― 独自で修正を加えることは不可能になります
またプラットフォームも作成者がサポートするものに限定されますバイナリ依存性の再構築ができないためです新しいバイナリ依存関係を加える前にこれらのことをよく考えましょう最後になりますが現存するXCFrameworkを Swiftパッケージとして配布できますそれらに応じてソースベースパッケージと同じように機能しますご視聴ありがとうございました

2:37 - Adding a Package Dependency to the Package Manifest

// swift-tools-version:5.3

import PackageDescription

let package = Package(
    name: "package",
    products: [
        .library(
            name: "package",
            targets: ["package"]),
    ],
    dependencies: [
        .package(url: "https://github.com/JohnnyAppleseed2020/BinaryEmoji", from: "1.0.0"),
    ],
    targets: [
        .target(
            name: "package",
            dependencies: ["Emoji"]),
    ]
)

3:04 - Distributing Binary Frameworks as a Swift Package

// swift-tools-version:5.3

import PackageDescription

let package = Package(
    name: "Emoji",
    products: [
        .library(name: "Emoji", targets: ["Emoji"])
    ],
    dependencies: [
    ],
    targets: [
        .binaryTarget(
            name: "Emoji",
            url: "https://example.com/Emoji/Emoji-1.0.0.xcframework.zip",
            checksum: "6d988a1a27418674b4d7c31732f6d60e60734ceb11a0ce9b54d1871918d9c194"
        )
    ]
)

5:43 - Computing the Checksum

swift package compute-checksum Emoji-1.0.0.xcframework.zip

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC20

WWDC19