Distribute Binary Framework with Swift Package Manager

Transcript

1. Distribute Binary Framework with Swift Package Manager
2. Why Binary Framework • プロプライエタリ・ソフトウェアとして配布したいため • 要するにソースコードを開示したくない • SwiftではXCFrameworkという形式で配布
3. What is XCFramework? • Xcodeによって生成される配布可能なbinary package • マルチプラットフォーム対応 • iOS, macOS, tvOS etx… • あとsimulator対応も • Dynamic、Static、どちらの形式もあり
4. How to create • New>Project>Frameworkを選択 • なんかFrameworkがかばんのアイコンなのってなんで？
5. How to write source code • 右図の構成でプロジェクトが生成される • ここで注意すること • Resourcesってあるからいってその下にファイルを置かな い • 正確にはソースコードはtttフォルダ直下に配置 • （なんか本棚のアイコンの下においてはだめ） • そのフォルダ以下はビルド対象外になる • 多分画像とかそういうの置くところ • これに気づくまで半日かかった
6. Trap of build setting • Build Settingsの Build Library for DistributionをYESにすること • これしとかないとこける • 調べたけど何なのかはよくわからない • 文字通り受け取るならYESにしないと配布用のラ イブラリをビルドできない
7. How to write source code 2 • こんな感じでhoge.swiftファイルを作成 • いつもどおりビルド！ • 終わり！ • テストコードは可能な限り書きましょう • Frameworkなので毎回アプリに組み込むまで動作 が保証されないのはめんどくさいため • つまり自分のためです • みんなも動作が保証されて幸せになります • WinWin
8. How to create binary(XCFramework) • Shellスクリプトを叩く
9. 英語タイトル飽きた 何をやっているか • キモの部分 • xcodebuild archive〜 • 各プラットフォーム向けの.fraeworkの作成 • Xcodeuild –create-xcframework〜 • 上記で作成した.frameworkをまとめて.xcframeworkにする • 結合したものを作成するのではなく、単にまとめただけなのがポイント
10. XCFramework, Framework • 過去Frameworkでは各種platform向けのbinaryを生成した上で、1つの binaryにFrameworkとして出力 • XCFrameworkでは各種Platform向けbinary(framework)を生成し、そ れを1つのディレクトリにまとめている • binaryそのものを個別に用意できるようになった • 何がいいのか？ • Simulator向けアーキテクチャのbinaryとか入ってるとstoreにアップする際に蹴ら れたりする • なのでsimuator向けのbinaryがないFrameworkとかあった • 当然simulatorでビルドできないので困る • XCFrameworkだとアーキテクチャ別にbinaryがあるので、この問題が起きない
11. Swift Package Manager • Xcodeにデフォルトで用意されているライブラリ管理ツール • ようやくメジャーなライブラリがSPMに対応してきた • わりと便利 • 対抗 • CocoaPods • Carthage
12. SPMでの配布対応 • XCFrameworkとPackage.jsonを準備 • Package.jsonは配布のための諸々が書いてあるファイル
13. Package.swiftのキモ • .binaryTarget • Binary形式で配布することを示す • Nameはまんま、urlはgithub等のサーバーにアップしてあるzipファイル • Checksumは上記zipファイルのchecksum、DL時にXcodeが改変がないかを判定 するために利用 • 間違ってるとエラーが出て止めてくれる
14. まとめ • Frameworkとしてプロジェクトを作成 • ソースコードの作成 • Build Settingsの調整 • xcodebuildを使ってXCFrameworkを作成 • Package.swiftを作成 • 配布
15. ちょっとまって • 突然githubのURLとか出てきたけどなに？ • Framework配布のためのgithubリポジトリ • プロプライエタリなので、XCFrameworkとPackage.swiftだけがおいてある
16. つまり • ソースコード（Frameworkの中身）を管理するgithubリポジトリも必用 ソースコード修正＞PR作成＞マージ＞XCFrameworkビルドして出力＞ XCFrameworkをおいてあるgithubにXCFrameworkをアップ、 package.swiftを修正＞PR作成＞マージ＞リリースタグ作成
17. やることが、やることが多い……！（画像略） • CIを利用しましょう • ソースコード修正＞PRがマージされる＞CIが走る＞CIでXCFramework作成 ＞githubのプロジェクトにアップ くらいまでやれたらいいな
18. おわりに • いまなんでも自動化できるのでCIは積極的に活用していきましょう • どこまで(Package.swiftとかの出力も？）やるかは要相談 • 楽しいSPMの日々をお過ごしください