マルチモジュールアプリの画面遷移処理実装

After Party DroidKaigi 2022 で発表したスライドです。
https://cookpad.connpass.com/event/260672/

Transcript

1. マルチモジュールアプリの画 面遷移処理実装 こやまカニ大好き
2. 自己紹介 こやまカニ大好き レシピサービス開発部 所属 モバイルアプリ開発の生産性を向上させ るタスクに従事 去年から WebView 大好き
3. 今日のトピック • クックパッドアプリの構成 • クックパッドアプリの画面遷移実装 • まとめ
4. クックパッドアプリの構成
5. クックパッドアプリの構成 • マルチモジュールプロジェクト ◦ 画面実装は View(Compose)と関連ロジックを Scene という単位で定義 ◦ 関連のある複数 Scene で機能モジュール(feature module) を構成 ◦ 共通ロジックやドメイン層は役割ごとにライブラリモジュール (library module)を構成 • モジュール数は全体で 52 ◦ 機能モジュール 21 ◦ ライブラリモジュール 19 ◦ そのほかは App モジュールや Demo モジュール
6. モジュール構成
7. 画面遷移の実装 • クックパッドアプリでは現在 Navigation Component 未使用 • 今回お話するのは全て自作している画面遷移実装の話 • Navigation Component 未使用の理由は主にタイミングの問題 ◦ Navigation Component 登場時点でマルチモジュール化していたため、導入が難しかった ◦ クックパッドアプリの画面遷移が複雑で利用できる箇所が限られていた ◦ 特にボトムタブに Multiple Back Stacks 相当の実装を自前で入れていたので乗り換えが難し い状況だった
8. クックパッドアプリの 画面遷移実装
9. モジュール間画面遷移の基本 • 機能モジュールAは機能モジュールBを直接参照しない ◦ もし参照しようとすると画面によってはモジュール同士の循環参照になってしまう • 別モジュールの画面を生成するため、 navigation module に Factory を定義す る • 各画面は navigation module の Factory を経由して画面を生成し、遷移処理を 実装する
10. モジュール間画面遷移の基本 FeatureA SceneA FeatureB SceneB :FeatureA:SceneA と :FeatureB:SceneB は相互に画面 遷移したい お互いが見える状態にしようとする と :FeatureA と :FeatureB の循環 参照になってしまう
11. モジュール間画面遷移の基本 FeatureA SceneA FeatureB SceneB Navigation DestinationFactory fun createSceneB() fun createSceneA() Navigation モジュールの DestinationFactory という interface を経由することにより、モジュール の循環参照を防ぐ
12. モジュール間画面遷移の基本 FeatureA SceneA FeatureB SceneB Navigation DestinationFactory fun createSceneB() Application DestinationFactoryImpl fun createSceneB() 実装 Application モジュールに DestinationFactory の実態があり、 各Sceneのインスタンスを生成する Application モジュールは全てのモ ジュールを参照しているので全ての 画面のインスタンスを生成可能
13. 追加要求1 ボトムタブごとに画面遷移の履歴(Back Stacks) を切り替えられるようにしたい
14. Back Stacks の切り替え • ボトムタブを切り替えた際、タブごとに Back Stacks を保存して切り替える機能 ◦ いわゆる Multiple Back Stacks 相当の機能 • PrimaryNavigationFragment という仕組みを使い、タブごとに FragmentManager を制御する Fragment を切り替えることで実現している ◦ Activity と実際に表示する画面の間に Fragment 階層を一枚挟み、タブ切り替えを 上位 Fragment の切り替えでやっているイメージ ◦ back の挙動なども自動的に切り替えてくれる ◦ 現在は FragmentManager に saveBackStack/restoreBackStack があるのでもう少しわかり や すい仕組みで切り替え可能
15. Back Stacks の切り替え • requireActivity().supportFragmentManager を使う代わりに以下のような方法 で FragmentManager を取り出すことで常にタブ挙動を考慮した画面遷移にで きる
16. NavigationController の導入 • 毎回　　　　　 　　　　　　　　　　　の記述を書いていられないので、 NavigationController という仕組みを導入した • アプリ内の画面遷移における共通処理を吸収するレイヤー ◦ 処理対象の FragmentManager の選択 ◦ replace 時の containerViewId 指定 ◦ backstack の管理
17. NavigationController のコード(一部)
18. NavigationController の生成
19. NavigationController を使った画面遷移
20. 追加要求2 条件によって遷移先が Fragment だったり Activity だったりする画面遷移を実装したい
21. 遷移先がActivity/Fragmentで分岐 • ユーザー状態などによって遷移先が変わるアクションが存在する • ログイン済みの場合は目的の画面(Fragment)、未ログインの場合はログイン画 面(Activity)という複雑なパターンも存在する
22. Destination の導入 • Destination は遷移先(Fragment, DialogFragment, Intent)をラップする sealed class • NavigationController が Destination への遷移をサポートすることで画面実装 では遷移先が Fragment 、 DialogFragment 、 Intent のいずれであるのか考 慮する必要がなくなった ◦ Result を受け取るケースでは考慮する必要があるので Destination を使わない処理になって いる
23. Destination の実装
24. NavigationController 側の処理
25. 追加要求3 URLによる画面遷移処理を実装したい
26. URL による画面遷移処理 • いわゆるディープリンク処理 • 遷移先は Fragment だったり Activity だったり • 外部からのアプリ起動、WebView内での遷移、APIレスポンスからのアクション など様々な箇所で同じ挙動を実現したい
27. DestinationParams の導入 • DestinaionParams は Destination を生成するための情報をまとめたもの • URLから遷移先(Destination)の種別と必要なパラメータを抽出し、プロパティと して保持する • DestinationParams の定義は sealed interface なため、when による分岐処理 でパターン網羅しやすい
28. DestinationParams の実装
29. DestinationParams の利用 ほとんどのケースで、以下のような実装だけで動作するようにしている
30. WebView における DestinationParams • 去年の DroidKaigi で発表した時点では DestinationParams は存在していな かった • 現在は WebView 内のURL解釈も DestinationParams で共通化しているため、 WebView画面で実装すべきメソッドは DestinationParams を渡して遷移するメ ソッドだけになった
31. WebView における DestinationParams
32. DestinationParams の機能ごとのタグづけ 各 DestinationParams がサポートする機能ごとにタグづけを行なっている sealed interface は複数実装できるので、サポートする機能によって DestinationParams の sub interface をそれぞれ実装している 例えば、ディープリンク関連の処理では DeepLinkSupportedDestinationParams だ けを用いることで、 when 分岐の無駄な記述を減らすことができる
33. DestinationParams の機能ごとのタグづけ
34. まとめ
35. クックパッドアプリの 画面遷移を支える自作コンポーネント • DestinationParams ◦ 遷移先と必要なパラメータをまとめた sealed interface ◦ (理想的には)画面の数だけ DestinationParams が存在する • Destination ◦ 画面遷移に必要なFragmentやActivity(Intent) などの実態を抽象化する sealed class ◦ (基本的には) Factory を経由して DestinationParams から生成される • NavigationController ◦ Destination による画面遷移をサポートする仕組み ◦ Multiple Back Stacks などの実装を隠蔽し、各画面が意図している画面遷移実装に集中でき るようにする
36. 今後の課題 • Jetpack Navigation Component を利用していないこと • Navigation Component は必須ではないと感じているが、長期的なメンテナンス コストを考えると公式が推している仕組みに近づけた方が良さそう • Navigation Component のマルチモジュールサポートは自作コンポーネントを 完全に置き換えられないため、しばらくは自作した仕組みを Navigation Component に寄せやすくする改良をしていくかも ◦ Navigation best practices for multi-module projects ◦ モジュール間遷移がディープリンク前提、 SafeArgs 使えないという制約は結構辛い
37. おわり