モジュラーアーキテクチャ (TMA)

TMA は、スケーラビリティを確保し、ビルドおよびテストサイクルを最適化し、チーム内で適切なプラクティスを維持できるようにアプリケーションを構造化するアーキテクチャアプローチです。その核となる考え方は、明確で簡潔な API を介して相互接続された独立した機能を作成することでアプリを構築することです。

これらのガイドラインでは、アーキテクチャの原則を紹介し、アプリケーションの機能を異なるレイヤーで識別・整理する方法を示します。また、このアーキテクチャを採用する場合に役立つヒント、ツール、アドバイスも紹介します。

µFeatures

このアーキテクチャは以前 µFeatures と呼ばれていました。その目的と背後にある原則をより適切に反映するため、The Modular Architecture (TMA) に名称を変更しました。

コア原則#

開発者は、UI プレビュー、コード補完、デバッグなどの Xcode 機能が確実に動作することを保証しながら、メインアプリとは独立して機能を迅速にビルド、テスト、試行できるべきです。

モジュールとは#

モジュールはアプリケーションの機能を表し、以下の 5 つのターゲット（ここでいうターゲットは Xcode のターゲットを指します）の組み合わせです。

Source: 機能のソースコード（Swift、Objective-C、C++、JavaScript...）とそのリソース（画像、フォント、ストーリーボード、xib）を含みます。
Interface: 機能のパブリックインターフェースとモデルを含むコンパニオンターゲットです。
Tests: 機能のユニットテストおよび統合テストを含みます。
Testing: テストやサンプルアプリで使用できるテストデータを提供します。また、後ほど説明するように、他の機能から使用できるモジュールのクラスやプロトコルのモックも提供します。
Example: 開発者が特定の条件（異なる言語、画面サイズ、設定など）で機能を試すために使用できるサンプルアプリを含みます。

ターゲットには命名規則に従うことを推奨します。これは Tuist の DSL を活用することでプロジェクト内で強制できます。

ターゲット	依存関係	内容
`Feature`	`FeatureInterface`	ソースコードとリソース
`FeatureInterface`	-	パブリックインターフェースとモデル
`FeatureTests`	`Feature`, `FeatureTesting`	ユニットテストおよび統合テスト
`FeatureTesting`	`FeatureInterface`	テストデータとモック
`FeatureExample`	`FeatureTesting`, `Feature`	サンプルアプリ

UI プレビュー

Feature は UI プレビューを有効にするため、FeatureTesting を Development Asset として使用できます

テストターゲットの代わりにコンパイラディレクティブを使用する

代わりに、Debug 向けにコンパイルする際にコンパイラディレクティブを使用して、Feature または FeatureInterface ターゲットにテストデータやモックを含めることができます。グラフは単純化されますが、アプリの実行には不要なコードまでコンパイルすることになります。

すべてのアプリソースコードが同じターゲットにある場合、コード内に暗黙的な依存関係が生まれやすく、いわゆるスパゲッティコードになりがちです。すべてが強く結合され、状態が予測不能になることがあり、新しい変更を導入するのが困難になります。独立したターゲットで機能を定義する場合、機能の実装の一部としてパブリック API を設計する必要があります。何を公開するか、どのように機能を利用してもらうか、何を非公開のままにするかを決定する必要があります。機能の利用者にどのように機能を使ってほしいかをより制御でき、安全な API を設計することで適切なプラクティスを強制できます。

小さなモジュール#

分割統治法。小さなモジュールで作業することで、より集中でき、機能を孤立させてテストや試行ができます。さらに、必要なコンポーネントのみをコンパイルする選択的なコンパイルを行うため、開発サイクルは大幅に高速化します。アプリ全体のコンパイルが必要なのは、機能をアプリに統合する必要が生じる作業の最終段階だけです。

再利用性#

フレームワークやライブラリを使用して、アプリ間や拡張機能などの他の製品間でコードを再利用することが推奨されます。モジュールを構築することで、その再利用は非常に簡単になります。既存のモジュールを組み合わせ、（必要に応じて） プラットフォーム固有の UI レイヤーを追加するだけで、iMessage 拡張機能、Today Extension、または watchOS アプリケーションを構築できます。

依存関係#

あるモジュールが別のモジュールに依存する場合、そのインターフェースターゲットに対して依存関係を宣言します。これには二つの利点があります。一つは、あるモジュールの実装が別のモジュールの実装と結合されるのを防ぎます。もう一つは、クリーンビルドが高速化することです。これは、自機能の実装と、直接および推移的な依存関係のインターフェースのみをコンパイルすれば済むためです。このアプローチは、SwiftRock のInterface Modules を使用して iOS ビルド時間を短縮するというアイデアに触発されています。

インターフェースへの依存は、アプリが実行時に実装のグラフを構築し、それを必要とするモジュールに依存性注入することを要求します。TMA は具体的な方法について意見を持っていませんが、ビルド時の間接参照を追加しない依存性注入のソリューションやパターン、あるいはこの目的のために設計されていないプラットフォーム API を使用しないソリューションを使用することを推奨します。

プロダクトタイプ#

モジュールを構築する際、ターゲットに対してライブラリとフレームワーク、および静的リンクと動的リンクから選択できます。Tuist なしでは、依存関係グラフを手動で設定する必要があるため、この決定はやや複雑になります。しかし、Tuist Projects のおかげで、これはもはや問題ではありません。

開発中は、バンドルアクセサを使用して動的ライブラリまたはフレームワークを使用することを推奨します。これにより、バンドルアクセスのロジックをターゲットがライブラリかフレームワークかという性質から切り離せます。これはコンパイル時間の高速化と、SwiftUI プレビューが確実に動作することを保証するために重要です。そして、リリースビルドではアプリの起動を高速化するため、静的ライブラリまたはフレームワークを使用します。動的構成を活用して、生成時にプロダクトタイプを変更できます。

bash

# You'll have to read the value of the variable from the manifest {#youll-have-to-read-the-value-of-the-variable-from-the-manifest}
# and use it to change the linking type {#and-use-it-to-change-the-linking-type}
TUIST_PRODUCT_TYPE=static-library tuist generate

swift

// You can place this in your manifest files or helpers
// and use the returned value when instantiating targets.
func productType() -> Product {
    if case let .string(productType) = Environment.productType {
        return productType == "static-library" ? .staticLibrary : .framework
    } else {
        return .framework
    }
}

マージ可能なライブラリ

Apple は、静的ライブラリと動的ライブラリの切り替えの手間を軽減するため、マージ可能なライブラリを導入しました。しかし、これによりビルド時の非決定性が生じ、ビルドの再現性が失われ、最適化が難しくなるため、使用は推奨しません。

コード#

TMA は、モジュールのコードアーキテクチャやパターンについて特定の意見を持っていません。ただし、経験に基づいたいくつかのヒントを紹介します。

コンパイラの活用は素晴らしいことです。 コンパイラへの依存が強すぎると、生産性が低下し、プレビューなどの Xcode 機能が不安定になる可能性があります。コンパイラを使用して良いプラクティスを強制し、早期にエラーを検出することを推奨しますが、コードの可読性や保守性を損なうほどには行わないでください。
Swift マクロは控えめに使用してください。 マクロは非常に強力ですが、コードの可読性や保守性を低下させる可能性もあります。
プラットフォームと言語を受け入れ、抽象化しないでください。 複雑な抽象化レイヤーを作成しようとすると、逆効果になる可能性があります。プラットフォームと言語は、追加の抽象化レイヤーなしでも優れたアプリを構築するのに十分な強力さを持っています。機能を実装する際は、優れたプログラミングおよびデザインパターンを参考にしてください。