KMP (Kotlin Multiplatform) を利用している場合、Kotlin で共通部分を実装し KMP で Apple Framework を生成して Swift から呼び出す形になります。
このとき Xcode の補完の調子が悪かったり、Kotlin で定義した I/F のシンボルが Swift (via Objective-C) で変わっていたりして、目的のシンボルが何なのか分からず迷子になることがあります。
そんなときに Xcode の補完に頼りきらず目的のシンボルを見つける術を知っていると、開発体験が少し改善されます。
この記事では、シンボルを見つけるための複数の方法を紹介します。
私はケースバイケースで使い分けていますが、シンボルを確認するだけなら ② の import <module> から Swift の Generated Interface を表示するのが一番早いかなと思っています。
① Xcode で Objective-C のヘッダーを表示する
KMP に含まれるシンボルの定義元へジャンプします。
すると、このような Objective-C のヘッダーファイルが表示されます。
※ ヘッダーファイルが膨大になると定義元へジャンプする際に Xcode が固まることがありました
② Xcode で Swift の Interface を表示する
① で Objective-C のヘッダーファイルを表示した状態で Assistant を選択します。
Xcode が Objective-C のヘッダーファイルを Swift の Generated Interface に変換して表示してくれます。
このときは ① と異なり Quick Help が表示されるようになるという違いがあります。
若干表示内容は異なりますが、import <module> から定義元へジャンプしても同等の内容を表示することができます。
※ import <module> から定義元へジャンプする場合は、ヘッダーファイルが膨大になっても Xcode が固まることはありませんでした
③ 生成された Apple Framework のヘッダーファイルを参照する
①, ② の方法で Xcode が上手く表示してくれない場合は Apple Framework に含まれるヘッダーファイルを直接参照することもできます。
Direct Integration の形式で取り込んでいる場合は DerivedData/ 配下に .framework が生成されています。
例えば ~/Library/Developer/Xcode/DerivedData/iosApp/Build/Products/Debug-iphonesimulator/Shared.framework/Headers/Shared.h などです。
XCFramework で配布している場合は、生成された .xcframework の中からヘッダーファイルを探します。
まとめ
KMP を利用していると、Kotlin のシンボルが Swift からどう見えるか分からずに実装の足が止まることがあります。
上記で紹介した方法を知っていると開発時のストレスが少し軽減されるかもしれないので機会があれば試してみてください。
