マルチモジュール勉強メモ~EmbeddedFramework~

Embedded Frameworkとは

• プロジェクトのマルチモジュール化
  ざっくりいうとフレームワークのこと
  通常新しくProjectを作成するとTargetは一つだけど、Project内の要素をFrameworkとして抜き出して使うことができる

例えばUI,Core,Data,CommonというレイヤーでProjectが構成されていて、これをEmbedded Frameworkを使ってレイヤーごとにtargetを切り分けたりする

通常	マルチモジュール化	マルチモジュール化

使用する場合の注意点

Embedded Frameworkを使ってアプリ内の要素をFrameworkとして切り出した場合
通常Frameworkを使うとき同様に使用するファイルでimportする必要がある

なのでFrameworkとして切り出された側で、他ターゲットから利用することを想定しているメソッドなどの場合はアクセスコントロールとして先頭にpublicをつけなければならない
これはアクセスコントロールがデフォルトではinternalであるため

メリット

• コード共有
  共通分をFrameworkとして切り出すことで、他のプロジェクトで利用したり、UIだけ別に作って機能が同じであるアプリをいくつも横展開したりできる
  他にも一つのサービスをiOSアプリだけでなくwatchOSやtvOSなど複数端末で使えるようにしたりなどマルチプラットフォームへ展開することもできる

• レイヤー分割・依存関係の矯正
  先に書いたとおり、切り出されたターゲットはFrameworkとして扱われるため
  通常Frameworkを使うとき同様にimportしないとコンパイルエラーとなり使うことができない

これがレイヤー感の依存関係の矯正にどう影響するかというと
各レイヤーの依存関係は予め設定することができるから

例えば以下のように設定してみました

メインターゲット	Core	Data	Common

この場合メインターゲットはimport Coreやimport Data, import Commonを使用したいファイルで宣言することで各レイヤーにアクセスことができます

同様にCoreでDataを使いたい場合はimport Dataやimport Commonを必要に応じて宣言、Dataではimport Commonを必要に応じて宣言することでそれぞれ利用することができます
逆にこの依存関係だとCommonからDataだったりDataからCoreだったり、Coreからメインターゲットへアクセスすることはimportを使って宣言してもコンパイルエラーで弾かれてしまいます

なのでEmbedded Frameworkを使うとレイヤー分割や依存関係の矯正ができるといえます

以下の記事がとても参考になります
https://qiita.com/mono0926/items/e29cd17789fd1d1548aa#embedded-frameworkへの分け方の例

• ビルド時間の短縮

Swift1.2で差分ビルドが導入されビルド速度は改善されたはず
ただ自分は実感してないけど、過去には差分ビルドがうまく走らずに少しのコード修正にも関わらず全体のビルドが走ったりすることもあったらしい
*ただこれに関しては自分の実感がない&参照していた記事が古いのでもしかしたら2021年では問題ないのかもしれない

推測でしかないけど、1つのターゲットにすべてがまとまっている＆コード量が多い場合に差分ビルドが走らないことがあったのかもしれない

というのもEmbedded Frameworkを使うことで差分ビルドが効いたという内容は見かけるから

Embedded Frameworkで依存関係を明確にすることでコンパイラにそれが伝わり
一つ一つのレイヤーごとに差分を確認させることができる...???

またメインターゲット実行時に差分ビルドが効きやすく速くなるだけでなく、XcodeのScheme設定で特定のFrameworkを選択することで選択したFrameworkのみのビルドやテスト実行などを行えるのでビルドが速くなる

SchemeをそれぞれのFrameworkに設定してビルドしてみるとわかります
依存関係にあるものまでしかビルドは行わないのでScheme設定が下位レイヤーになればなるほど依存関係がすくなくなりビルドが速くなります

テストをしたい場合はこのScheme設定を対象のFrameworkにするとよさそうです

メインターゲット	Core	Data	Common

【メモ】
＞ Dynamic Frameworkが増えるにつれてアプリの起動時間が長くなることがあります。
Dynamiic Frameworkを使うとアプリの起動時間が長くなる？

ModuleをDynamic Frameworkではなく Static Framework としてビルドして使用することで起動時間の最適化が可能？
https://medium.com/eureka-engineering/create-merged-framework-to-cut-appstartuptime-72ee67b2bbab

StatickFramework化して起動時間短縮？
https://rizumita.medium.com/xcodeプロジェクト内のdynamic-frameworkをstaticビルドする-fcefd9bb1b48

https://tech.recruit-mp.co.jp/mobile/post-12398/
extension使うとビルド時間って長時間化するの？

static frameworkはembedしちゃだめ
https://stackoverflow.com/questions/41286887/custom-framework-always-include-in-embedded
https://qiita.com/rockname/items/bdf932bc6758d8820141
関連メモ
https://holyswift.app/frameworks-embed-or-not-embed-thats-the-question