Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Framework-Independent Architecture (FIA) - Clea...

Framework-Independent Architecture (FIA) - Clean Architecture で iOS アプリを爆速でビルドする -

---
marp: true
theme: gaia
class: invert
---

## Framework-Independent Architecture (FIA)
#### - Clean Architecture で iOS アプリを爆速でビルドする -

2024/04/26

---

![bg right:35%](./assets/images/account.jpg)

## 自己紹介

- 高橋 俊
- iOS エンジニア
- アカウント
- X: [@ikuraikuraaaaaa](https://twitter.com/ikuraikuraaaaaa)
- GitHub: [@suguruTakahashi-1234](https://github.com/suguruTakahashi-1234)
- 技術
- Swift, iOS, IoT

---

## 話すこと

- **Clean Architecture を使って iOS アプリを爆速でビルドする方法**
- = [Framework-Independent Architecture (FIA)](https://github.com/suguruTakahashi-1234/framework-independent-architecture) の紹介
- **MV → MVP (MVVM) → Clean Architecture → FIA へのリアーキテクチャの実演**

---

## 話さないこと

- Clean Architecture の詳細

---

# iOS アプリ開発における現状のアーキテクチャ候補

---

## 大きくこれらの 3 パターンに分けられる

- Layered Architecture 系 (MVVM, MVP, [VIPER](https://cheesecakelabs.com/blog/ios-project-architecture-using-viper/))
- → View と ビズネスロジック の分離
- Redux 系 ([TCA](https://github.com/pointfreeco/swift-composable-architecture), [ReSwift](https://github.com/ReSwift/ReSwift))
- → 単方向データフロー
- [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) 系 ([VIPER](https://cheesecakelabs.com/blog/ios-project-architecture-using-viper/))
- → 内側方向への依存性の統一、依存性の逆転原則、関心事の分離

---

![](./assets/drawio/architecture_venn_diagram_delete_fia.drawio.svg)

### iOS アプリ開発 アーキテクチャ パターン

---

![](./assets/drawio/architecture_venn_diagram.drawio.svg)

### 今回、紹介する FIA は Clean Architecture 系 である

---

## Framework-Independent Architecture とは

### F = Framework Layer = Framework 層に
### I = Independent = 非依存な
### A = Architecture = アーキテクチャ

## → Framework 層に 非依存な アーキテクチャ

---

# Framework Layer ?

---

## Framework Layer ?

- Clean Architecture の最も外側の層
- Data Access Layer やInfrastructure Layer とも呼ばれる
- iOS アプリ開発においては3rd パーティー製 SDK やギークな処理を扱う層

※ 一般的な用語ではない

![bg right 100%](./assets/images/clean_architecture.jpg)

---

## FIA を採用する目的

- **Xcode でのビルド時間の短縮**
- テスト、Previews も対象
- Clean Architecture のメリットの享受
- 独立性
- テスタビリティー
- メンテナビリティー
- etc...

---

## FIA 概略

![bg contain 35%](./assets/drawio/architecture_outline.drawio.svg)

#### ポイント: 開発用の Application Layer が Clean な領域である

---

## Clean Architecture 円との比較

![bg contain 80%](./assets/images/clean_architecture.jpg)
![bg contain 80%](./assets/drawio/architecture_circle.drawio.svg)

### 本質的に両者は同じことを表している

---

## リアーキテクチャを通して FIA での実装の実演

[LIVE 動画リンク](https://www.youtube.com/watch?v=5blwYSQcL2E)

---

## リアーキテクチャのステップ

1. MV
2. MVP (MVVM) (Not Repository Pattern)
3. MVP (MVVM) + Repository Pattern
4. Clean Architecture
5. [Framework-Independent Architecture (FIA)](https://github.com/suguruTakahashi-1234/framework-independent-architecture)
1. Dependency Injection in Application Layer
2. Development Application Layer into Clean Area
3. Dependency Injection with DI Container
6. extra: Swift 6 support (any protocol → some protocol)

---

# それぞれのアーキテクチャの特徴

---

## MV

- メリット✨
- シンプル
- デメリット⚠️
- ビジネスロジックのテストができない
- テスト🧪
- 🆕 XCUITest での UI テスト
- 🆕 Previews での View の確認

---

## MVP (MVVM) (Not Repository Pattern)

- メリット✨
- View とビジネスロジックの分離
- ビジネスロジックのテスト可能
- デメリット⚠️
- Previews で View のバリエーションを増やすのが難しい
- テスト🧪
- 🆕 Presenter (ViewModel) のビジネスロジックのテスト

---

## MVP (MVVM) + Repository Pattern

- メリット✨
- ビジネスロジックとデータアクセスの分離
- モックによるデータの差し替えが可能
- データアクセスロジックのテストが可能
- デメリット⚠️
- View→Presenter での Repository (Driver) のバケツリレーの発生
- テスト🧪
- 🆕 Previews でのモックを使ったバリエーションテスト
- 🆕 Repository (Driver) のデータアクセスロジックの単体テスト

---

## Clean Architecture

- メリット✨
- Presentation 層 (View, Presenter (ViewModel)) が、 Framework 層 (Repository (Driver)) に非依存になる
- → 3rd パーティー製ライブラリの乗換えによる影響が限定的
- デメリット⚠️
- Domain Entity の定義の発生
- テスト🧪
- Clean Architecture に変更しても MVP (MVVM) + Repository Pattern から追加で実施できるテストは特にない

---

## Framework-Independent Architecture (FIA)

- メリット✨
- Framework 層に非依存なアプリ/モジュールのビルドの高速化
- デメリット⚠️
- Application 層からの Repository (Driver) のバケツリレーの発生
- → DI Container の導入で解決
- テスト🧪
- Framework 層に非依存なアプリの XCUITest の高速化

---

table { table-layout: fixed; width: 100%; display:table; font-size: 24px; }

## FIA で可能なテスト

| Test Type | DI Container | Test Target: | | | | |
| ---------- | :-----------: | :-----------------: | :---------------: | :-------: | :--------: | :----: |
| | | ViewInteraction | ViewVariation | Presenter | Interactor | Driver |
| XCUITest | Actual / Mock | ◎ | ◯ | ◯ | ◯ | ◯ / - |
| Previews | Mock | - | ◎ | ◯ | ◯ | - |
| Presenter | Actual / Mock | - | - | ◎ | ◯ | ◯ / - |
| Interactor | Actual / Mock | - | - | - | ◎ | ◯ / - |
| Driver | Actual | - | - | - | - | ◎ |

#### → 各テストがどの範囲をカバーするかが明確

---

## FIA の実装課題とその解決策

- protocol を any → some とする場合、型解決が複雑になる
- アーキテクチャ実現のための、多くのボイラーコードが必要
- モック用の DI Container の準備が手間になる
- View のテスト制約
- XCUITest: 長い実行時間、低いメンテナンス性
- Previews: 目視確認が必要、エラーが自動的には検出されない

### → [Sourcery](https://github.com/krzysztofzablocki/Sourcery)、[Mockolo](https://github.com/uber/mockolo)、[PreviewSnapshots](https://github.com/doordash-oss/swiftui-preview-snapshots) の導入

---

## FIA の実装を助けるライブラリの紹介

- [Sourcery](https://github.com/krzysztofzablocki/Sourcery)
- 繰り返しとなるボイラーコードの自動生成
- [Mockolo](https://github.com/uber/mockolo)
- モック用の DI Container の自動生成
- typealias での some protocol の型解決にも対応
- [PreviewSnapshots](https://github.com/doordash-oss/swiftui-preview-snapshots)
- Previews のコードをスナップショットテストとして転用可能

これらのライブラリを採用したリポジトリを公開:
https://github.com/suguruTakahashi-1234/fia-practical-sample

---

## まとめ

- [Framework-Independent Architecture (FIA)](https://github.com/suguruTakahashi-1234/framework-independent-architecture)
- Clean Architecture をベースにしたアーキテクチャ
- Framework 層に非依存である
- FIA 採用の目的
- ビルド時間の短縮
- Clean Architecture のメリットの享受
- FIA での実装
- MVP (MVVM) からリアーキテクチャが可能である
- [Sourcery](https://github.com/krzysztofzablocki/Sourcery) や [Mockolo](https://github.com/uber/mockolo) などの自動生成ツールが有効である

---

# Thank You🌸

Suguru Takahashi

April 23, 2024
Tweet

Other Decks in Programming

Transcript

  1. 話すこと Clean Architecture を使って iOS アプリを爆速でビルドする方法 = Framework-Independent Architecture (FIA)

    の紹介 MV → MVP (MVVM) → Clean Architecture → FIA への リアーキテクチャの実演 3
  2. 大きくこれらの 3 パターンに分けられる Layered Architecture 系 (MVVM, MVP, VIPER) →

    View と ビズネスロジック の分離 Redux 系 (TCA, ReSwift) → 単方向データフロー Clean Architecture 系 (VIPER) → 内側方向への依存性の統一、依存性の逆転原則、関心事の分離 6
  3. Architectural Patterns for iOS App Development Clean Architecture-based Layered Architecture-based

    Redux-based TCA MVVM (MVP) VIPER iOS アプリ開発 アーキテクチャ パターン 7
  4. Architectural Patterns for iOS App Development Clean Architecture-based Layered Architecture-based

    Redux-based Framework- Independent Architecture (FIA) TCA MVVM (MVP) VIPER 今回、紹介する FIA は Clean Architecture 系 である 8
  5. Framework-Independent Architecture とは F = Framework Layer = Framework 層に

    I = Independent = 非依存な A = Architecture = アーキテクチャ → Framework 層に 非依存な アーキテクチャ 9
  6. Framework Layer ? Clean Architecture の 最も外側の層 Data Access Layer

    や Infrastructure Layer とも 呼ばれる iOS アプリ開発においては 3rd パーティー製 SDK や ギークな処理を扱う層 ※ 一般的な用語ではない 11
  7. Clean Area Non-Clean Area Application Layer (Development) Application Layer (Production)

    DI Layer Framework Layer Third Party Layer Domain Layer Presentation Layer Framework-Independent Architecture (FIA) - Overview FIA 概略 ポイント: 開発用の Application Layer が Clean な領域である 13
  8. Framework-Independent Architecture (FIA) - Circle Domain 3rd Party Presentation Framework

    DI App (Prd) App (Dev) Clean Architecture 円との比較 本質的に両者は同じことを表している 14
  9. リアーキテクチャのステップ 1. MV 2. MVP (MVVM) (Not Repository Pattern) 3.

    MVP (MVVM) + Repository Pattern 4. Clean Architecture 5. Framework-Independent Architecture (FIA) 1. Dependency Injection in Application Layer 2. Development Application Layer into Clean Area 3. Dependency Injection with DI Container 6. extra: Swift 6 support (any protocol → some protocol) 16
  10. MVP (MVVM) (Not Repository Pattern) メリット View とビジネスロジックの分離 ビジネスロジックのテスト可能 デメリット

    Previews で View のバリエーションを増やすのが難しい テスト Presenter (ViewModel) のビジネスロジックのテスト 19
  11. MVP (MVVM) + Repository Pattern メリット ビジネスロジックとデータアクセスの分離 モックによるデータの差し替えが可能 データアクセスロジックのテストが可能 デメリット

    View→Presenter での Repository (Driver) のバケツリレーの発生 テスト Previews でのモックを使ったバリエーションテスト Repository (Driver) のデータアクセスロジックの単体テスト 20
  12. Clean Architecture メリット Presentation 層 (View, Presenter (ViewModel)) が、  Framework

    層 (Repository (Driver)) に非依存になる → 3rd パーティー製ライブラリの乗換えによる影響が限定的 デメリット Domain Entity の定義の発生 テスト Clean Architecture に変更しても MVP (MVVM) + Repository Pattern から追加で実施できるテストは特にない 21
  13. Framework-Independent Architecture (FIA) メリット Framework 層に非依存なアプリ/ モジュールのビルドの高速化 デメリット Application 層からの

    Repository (Driver) のバケツリレーの発生 → DI Container の導入で解決 テスト Framework 層に非依存なアプリの XCUITest の高速化 22
  14. FIA で可能なテスト Test Type DI Container Test Target: View Interaction

    View Variation Presenter Interactor Driver XCUITest Actual / Mock ◎ ◯ ◯ ◯ ◯ / - Previews Mock - ◎ ◯ ◯ - Presenter Actual / Mock - - ◎ ◯ ◯ / - Interactor Actual / Mock - - - ◎ ◯ / - Driver Actual - - - - ◎ → 各テストがどの範囲をカバーするかが明確 23
  15. FIA の実装課題とその解決策 protocol を any → some とする場合、型解決が複雑になる アーキテクチャ実現のための、多くのボイラーコードが必要 モック用の

    DI Container の準備が手間になる View のテスト制約 XCUITest: 長い実行時間、低いメンテナンス性 Previews: 目視確認が必要、エラーが自動的には検出されない → Sourcery 、Mockolo 、PreviewSnapshots の導入 24
  16. FIA の実装を助けるライブラリの紹介 Sourcery 繰り返しとなるボイラーコードの自動生成 Mockolo モック用の DI Container の自動生成 typealias

    での some protocol の型解決にも対応 PreviewSnapshots Previews のコードをスナップショットテストとして転用可能 これらのライブラリを採用したリポジトリを公開: https://github.com/suguruTakahashi-1234/fia-practical-sample 25
  17. まとめ Framework-Independent Architecture (FIA) Clean Architecture をベースにしたアーキテクチャ Framework 層に非依存である FIA

    採用の目的 ビルド時間の短縮 Clean Architecture のメリットの享受 FIA での実装 MVP (MVVM) からリアーキテクチャが可能である Sourcery や Mockolo などの自動生成ツールが有効である 26