TL;DR
- 現時点でCatalyst対応はかなり厳しい
- Firebaseはプッシュ通知が対応していないがRealtime Databaseが使える
- Cocoapodsを使っている場合はAssetsLibraryを手動で依存から外す必要がある
弊社で提供しているCASTというサービスはスマートフォン向けにアプリを提供しているためPC向けのアプリは提供していませんが、Catalystに対応のためにどういった作業が必要なのか興味がありやってみることにしました。
環境
- macOS Catalina 10.15
- Xcode 11.1
- iOS Development Version 11.0
- Cocoapods 1.8.3
プロジェクトのCatalyst対応
Catalyst対応は驚くほど簡単です。
デバイス一覧にiPadに加えMacが追加されているので、両方にチェックをつけます。確認ダイアログのEnableを押せばMac向けビルド用Configが自動で追加され、自動で署名周りも面倒を見てくれます。この辺りはさすがのXcodeですね。
iPadにチェックをつけないとMacにもチェックがつけられないので、原則iPadにも対応する必要があります。
例えばActionSheetはsourceViewを指定しないとMacでアプリがフリーズしてしまいます。
ここまでは順調でした・・・
ライブラリのCatalyst対応
ビルドできるようになるまでに対応したことを順番に解説します。
Resource Bundleへの署名
まず初めにでたエラーはこれです。
Signing for "XLPagerTabStrip-XLPagerTabStrip" requires a development team.
これはResource Bundleという画像などをライブラリの一部として配布する方式で、Catalyst向けにビルドするにはこれにアプリと同じチームに所属させる必要があるようです。
Cocoapods経由でこれらのライブラリを入れていたため、Podsのプロジェクトから該当するライブラリのSigning & Capabilitiesから、Teamを自分のTeamに設定します。
なおこれはPodsのプロジェクトの設定のためpod installするたびにこの変更はリセットされます・・・
AssetsLibraryのリンクを削除
次はこちらのエラーです。
framework not found AssetsLibrary
AssetsLibraryは昔のiOSバージョンで使われていた画像を取得するためのライブラリのようですが、現在はiOSでDeprecatedとなっており、Catalystにはそもそもそのライブラリが収録されていないようです。
しかしかなり古いライブラリのためプロジェクト内を見ても使っている箇所はありませんでした。そこでプロジェクト内のテキストを検索かけてみると意外なところがひっかかりました。
そう、Podsプロジェクトファイルの中でした。どうもobjc向けビルドの互換性維持のためにcocoapodsが自動で追加しているようです。
-framework "AssetsLibrary" までがワンセットのようなので、これを全て取り除きます。
なおこれはPodsのプロジェクトの設定のためpod installするたびにこの変更はリセットされます**(2回目)**
サポートしていないライブラリの削除
ここが一番大変でした。
Catalystに対応していないライブラリはビルドできませんので、丸ごと削除しなければならないのです。
これがどれが非対応なのかはビルドしないとわからず、また1個ずつしか教えてくれません。
なので根気よく
ビルド->ビルドエラー->対応していないライブラリをPodfileから削除->pod install->上のビルドエラー解除->ビルド
を成功するまで繰り返さなければなりません・・・
Podfileから消した現時点で未対応のライブラリ一覧です。
- pod 'AppsFlyerFramework'
- pod 'Crashlytics'
- pod 'KeychainAccess'
- pod 'Fabric'
- pod 'Firebase/Analytics'
- pod 'Firebase/Messaging'
- pod 'Firebase/RemoteConfig'
- pod 'RealmSwift'
- pod 'Repro'
- pod 'ZendeskSDK'
さすがにここまで対応していないとなるとプロダクションは無理ですね。
意外にもRealmはcocoapodsから消したあと、Swift Package Manager(SPM)経由でインストールすると使えました。
SPMはXcode11からGUIで使えるようになったので、SPM対応のライブラリは積極的にこちらに移すと良さそうです。
Firebase周りはプッシュ通知に対応できなかったものの、RealtimeDatabaseのライブラリはビルドできました。
Other Linker Flagsの掃除
pod installしてもリンカの指定が残ってしまうことがあるので、その場合は手動で消します。
ターゲットのBuild Settingsから「Other linker flags」で検索すると出てくる長いオプションをダブルクリックで開き、Podから消したライブラリをここからも消していきます。
上のframeworkとしたのライブラリ名がセットのようなので2行ずつ消していきます。
これをビルドが成功するまで繰り返します・・・私の場合は消したpodの数だけなので10回これを繰り返しようやくビルド成功までこぎつけました！
実行!
いきなり崩壊してますね・・・上のロゴはLottieというライブラリを使っていてアニメーションするのですが、その配置があまりよくないようです。でもボタンは普通に押せますし、PushやModalもiOSのUIKitと同じように動きます。
シフト表
かなりヌルっと動きます。
弊社エンジニア渾身の力作、多段Tabも問題なく動いています。SUGOI
チャット
プッシュ通知は対応していませんが、Firebase RDBが使えるのでリアルタイムでチャットができました。
カメラ・写真
iOSと同じくパーミッションの確認が行われます。写真はMacの写真アプリに登録されている画像が選択できるようになっていました。
ただiPhoneと違いMacはインカメしかないので本来の意図したカメラの使い方は難しそうですね・・・
SFSafariView
SFSafariViewControllerはそのままSafariを直接開く挙動になります。
UINavigationView
Safariのようにトラックパッド2本指で戻るような動作ができます。
UIScrollView
シミュレータのくせでつい引っ張ってスクロールしがちですが、普通にトラックパッドの2本指でスクロールできます。縦横どちらともいけます。
UIAlertController
Macのダイアログと同じ挙動になりました。
カスタムビューを突っ込んだ場合はウィンドウ内に表示されるようです。この辺りはよくできてますね。
UNUserNotification
Macの標準の通知として表示されました。
その他
基本的にモーダルはウィンドウ内でオーバーレイ表示されるようです。なのでiOS13のようなハーフモーダルで閉じれることを期待するとMacでは閉じられなくなるようです。WWDCでも閉じるボタンは置きましょうと言っていましたしね。
パッケージング
Macアプリと同じ手順でできるようです。My Macを選択しながらアーカイブするとMac向けのアーカイブができます。署名を行えば.app形式のファイルが手に入り、Xcodeを起動しなくてもアプリが実行できるようになります。
所感
ビルド成功までにもっていくのにかなりのハードルがあるものの、一度ビルドできてしまえばUIKitの再現度は非常に高いと感じました。
また先日TwitterがCatalyst対応をリリースされていましたが、非常によくできており改めて感心しました。