はじめに
初心者から中級者に上がる際,最初の壁がアーキテクチャでした。
ViewControllerに全部書いていた時期もありました。
初めてMVCというものを教わったことで,
何が良くないのか,どうしていくのが好ましいのかと先へ進むことができました。
一方でネット上の情報は断片的で,自身ではその総括的な歴史やその変貌を追うことができませんでした。
各ソフトウェアアーキテクチャについての解説はあれど,それぞれがどのように異なるのか,
また,Review論文のようなものはあるのでしょうか (もしあれば教えていただきたいです) 。
作ったもの
architectures というiOSアプリのリポジトリを作成しました。
1つの本当に単純なボタンとラベルだけの簡単な送金プログラムのiOSサンプルアプリです。
API通信等のない簡単な1つのプロジェクトを作成し,それを複数のアーキテクチャ思想に則りコーディングすることで,「コードを読む」ためのアプリを作成致しました。
比較がしやすいよう,git branchで切り換えるのではなく,UISplitViewControllerを用いて1画面で確認できるようにしました。
動作概要
WatanabeさんからTakahashiさんへ,一方通行にお金を送金するプログラムです。
-
RESETボタンを押すと,Watanabeさんは0に,Takahashiさんは1000に初期化されます。
-
TRANSFERボタンを押すと,Watanabeさんは-100,Takahashiさんは+100されます。
-
Watanabeさんが0の場合にTRANSFERボタンを押すとErrorのアラートが表示され,キャンセルされます。
何が嬉しいのか
一言で伝えるならば,「自身の中にすでにある知見をもとに新しい知識を吸収することができる」点にあると考えています。
それぞれのソフトウェアアーキテクチャを学ぼうと思っても,そのサンプルが断片的な機能についてのサンプルであったり,そもそもサンプルコードの提供がなかったりします。
その結果,現在の設計との利点が上手く比較できなかったり,0から初めることで学習コストが高まったりします。
そのハードルをこのリポジトリがクッションとなることで,皆さんの学習を促進できればと考えています。
まとめ
今回,私がこれまで集めた知見をもとに,様々なアーキテクチャを利用し,1つのリポジトリを作成致しました。
本リポジトリは,ソフトウェア設計における情報を統一しようと試みるものであり,設計そのもの及び歴史に関する誤謬を含んだものであることを断っておきます。本記事及びコードが正確であることを保証するものではありません。そもそも設計方針であって,単体で1アーキテクチャとして成立するとは言い難いものもあります。本リポジトリは全てのアーキテクチャを網羅するものではなく,それぞれを比較し,優劣をつけるような意図はありません。
一方で,上辺だけの理解による実装も多く,もっとこうした方が良いよ!というご意見等ありましたら,遠慮なくコメント,PRよろしくお願い致します!
iOSアプリ設計パターン入門 という書籍が発売されるようです。一切無関係ですが,私の1疑問が少しでもこの書籍を通じて解決されればと期待しております!
詳しくはリポジトリを参照していただけましたら幸いなのですが,少し短いため以下にREADMEを転載します。
各アーキテクチャについて
PDS
概要
Presentation Domain Separationの略。プレゼンテーションロジックとドメインロジックが分離されることで,以下のようなメリットを享受することができる。
プレゼンテーションとドメインの分離 - Martin Fowler's Bliki (ja)
- プレゼンテーションロジックとドメインロジックが分かれていると、理解しやすい
同じ基本プログラムを、重複コードなしに、複数のプレゼンテーションに対応させることができる- ユーザーインターフェイスはテストがしにくいため、それを分離することにより、テスト可能なロジック部分に集中できる
- スクリプト用のAPIやサービスとして外部化するためのAPIを楽に追加できる(選択可能なプレゼンテーション部分で見かける)
- プレゼンテーション部分のコードは、ドメイン部分のコードと違ったスキルと知識が必要
(本リポジトリにおける) ディレクトリ構成
- Presentation (inherited UIViewController)
- Domain
依存ライブラリ
(なし)
参考
- PresentationDomainSeparation - Martin Fowler
- プレゼンテーションとドメインの分離 - Martin Fowler's Bliki (ja)
- MVCとかMVVMの前の自分まとめ - メモを揉め
- MOVEは望まれなかった子 - the sea of fertility
議論
(なし)
MVC
概要
Viewはアプリケーションの表示に関わるオブジェクトを定義し,ControllerはViewにおけるアクションの定義および遷移に関わる処理を,Modelにはデータおよびその処理を担う。
この時,ViewとModelはControllerを必ず経由し,ModelにはUIに関わるロジックは含まれない。
プレゼンテーションロジックとドメインロジックの分離に適した設計。
https://developer.apple.com/library/archive/documentation/General/Conceptual/DevPedia-CocoaCore/Art/model_view_controller_2x.png
ちなみに,
MVC is central to a good design for a Cocoa application. The benefits of adopting this pattern are numerous. Many objects in these applications tend to be more reusable, and their interfaces tend to be better defined. Applications having an MVC design are also more easily extensible than other applications. Moreover, many Cocoa technologies and architectures are based on MVC and require that your custom objects play one of the MVC roles.
と,Apple側の多くの設計はMVCに基づいていることが明記されている。
MVCの理解にはしばしば誤解があると言われる(議論を参照)。
(本リポジトリにおける) ディレクトリ構成
- Model
- View
- Controller (inherits UIViewController)
依存ライブラリ
(なし)
参考
- MVC - Apple Developer
- iOS開発でのMVCとは - スタック・オーバーフロー
- これが最強のMVC(iOS) - Qiita
- iOS Architecture Patterns; Demystifying MVC, MVP, MVVM and VIPER – Medium
- MOVEは望まれなかった子 - the sea of fertility
議論
- やはりお前らのMVCは間違っている - SlideShare
- Ruby on Railsの「えせMVC」の弊害 - Life is beautiful
- やはりおまえらの MVC は間違えている in バックボーンジェーエス - 猫型の蓄音機は 1 分間に 45 回にゃあと鳴く
MVP
概要
(本リポジトリにおける) ディレクトリ構成
- Model
- View (inherits UIViewController)
- Presenter
依存ライブラリ
(なし)
参考
議論
MVVM
概要
(なし)
(本リポジトリにおける) ディレクトリ構成
- Model
- View
- ViewModel (inherits UIViewController)
依存ライブラリ
参考
議論
(なし)
DDD
概要
(本リポジトリにおける) ディレクトリ構成
- UserInterface (inherits UIViewController)
- Application
- Domain
- Entity
- Infrastructure
依存ライブラリ
(なし)
参考
(なし)
議論
(なし)
ReSwift
概要
(本リポジトリにおける) ディレクトリ構成
- ViewController (inherits UIViewController)
- Reducer
- State
- Actions
依存ライブラリ
参考
(なし)
議論
(なし)
ReactorKit
概要
(本リポジトリにおける) ディレクトリ構成
- ViewController (inherits UIViewController)
- Reactor
依存ライブラリ
参考
(なし)
議論
(なし)
VIPER
概要
https://s3.amazonaws.com/ckl-website-static/wp-content/uploads/2016/04/viper_architecture-2000x720.jpg
(本リポジトリにおける) ディレクトリ構成
- ViewController (inherits UIViewController)
- Interactor
- Presenter
- Entity
- Router
- Protocols
依存ライブラリ
(なし)
テンプレート生成ツール
参考
- iOS Project Architecture : Using VIPER [和訳]
- iOS Project Architecture: Using VIPER - Cheesecake Labs
- Juanpe/Swift-VIPER-Module
議論
(なし)
Clean Architecture
概要
https://8thlight.com/blog/assets/posts/2012-08-13-the-clean-architecture/CleanArchitecture-8d1fe066e8f7fa9c7d8e84c1a6b0e2b74b2c670ff8052828f4a7e73fcbbc698c.jpg
(本リポジトリにおける) ディレクトリ構成
- Application/
- Wireframe
- Builder
- Data/
- Repository
- DataStore
- Entity
- Domain/
- UseCase
- Translator
- Model
- Presentation/
- Presenter
- UI/
- View
- ViewController (inherits UIViewController)
依存ライブラリ
テンプレート生成ツール
参考
- The Clean Architecture | 8th Light - 8th Light Blog
- クリーンアーキテクチャ(The Clean Architecture翻訳) - blog.tai2.net
- まだiOS Clean Architecture で消耗してるの? 爆速開発ツールを作ったのでご紹介 - Qiita
議論
(なし)
RxFeedback
概要
https://github.com/kzaher/rxswiftcontent/raw/master/RxFeedback.png
(本リポジトリにおける) ディレクトリ構成
- View
- ViewController (inherits UIViewController)
- State
- Event
依存ライブラリ
参考
議論
(なし)
Realistic ViewController
概要
この設計で実装する最低限の機能を実装したViewController。保存処理も含めない。
「最低限動く」このVCにユーザー管理の分割や保存処理を追加したものが各アーキテクチャで構成される。
保存処理を実装していない為,値の保持や他のViewとの連携は行われない。
(本リポジトリにおける) ディレクトリ構成
- ViewController (inherits UIViewController)
依存ライブラリ
参考
(なし)
議論
(なし)