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

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

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

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

こやまカニ大好き

October 28, 2022
Tweet

More Decks by こやまカニ大好き

Other Decks in Programming

Transcript

  1. クックパッドアプリの構成 • マルチモジュールプロジェクト ◦ 画面実装は View(Compose)と関連ロジックを Scene という単位で定義 ◦ 関連のある複数

    Scene で機能モジュール(feature module) を構成 ◦ 共通ロジックやドメイン層は役割ごとにライブラリモジュール (library module)を構成 • モジュール数は全体で 52 ◦ 機能モジュール 21 ◦ ライブラリモジュール 19 ◦ そのほかは App モジュールや Demo モジュール
  2. 画面遷移の実装 • クックパッドアプリでは現在 Navigation Component 未使用 • 今回お話するのは全て自作している画面遷移実装の話 • Navigation

    Component 未使用の理由は主にタイミングの問題 ◦ Navigation Component 登場時点でマルチモジュール化していたため、導入が難しかった ◦ クックパッドアプリの画面遷移が複雑で利用できる箇所が限られていた ◦ 特にボトムタブに Multiple Back Stacks 相当の実装を自前で入れていたので乗り換えが難し い状況だった
  3. モジュール間画面遷移の基本 FeatureA SceneA FeatureB SceneB :FeatureA:SceneA と :FeatureB:SceneB は相互に画面 遷移したい

    お互いが見える状態にしようとする と :FeatureA と :FeatureB の循環 参照になってしまう
  4. モジュール間画面遷移の基本 FeatureA SceneA FeatureB SceneB Navigation DestinationFactory fun createSceneB() fun

    createSceneA() Navigation モジュールの DestinationFactory という interface を経由することにより、モジュール の循環参照を防ぐ
  5. モジュール間画面遷移の基本 FeatureA SceneA FeatureB SceneB Navigation DestinationFactory fun createSceneB() Application

    DestinationFactoryImpl fun createSceneB() 実装 Application モジュールに DestinationFactory の実態があり、 各Sceneのインスタンスを生成する Application モジュールは全てのモ ジュールを参照しているので全ての 画面のインスタンスを生成可能
  6. Back Stacks の切り替え • ボトムタブを切り替えた際、タブごとに Back Stacks を保存して切り替える機能 ◦ いわゆる

    Multiple Back Stacks 相当の機能 • PrimaryNavigationFragment という仕組みを使い、タブごとに FragmentManager を制御する Fragment を切り替えることで実現している ◦ Activity と実際に表示する画面の間に Fragment 階層を一枚挟み、タブ切り替えを 上位 Fragment の切り替えでやっているイメージ ◦ back の挙動なども自動的に切り替えてくれる ◦ 現在は FragmentManager に saveBackStack/restoreBackStack があるのでもう少しわかり や すい仕組みで切り替え可能
  7. Destination の導入 • Destination は遷移先(Fragment, DialogFragment, Intent)をラップする sealed class •

    NavigationController が Destination への遷移をサポートすることで画面実装 では遷移先が Fragment 、 DialogFragment 、 Intent のいずれであるのか考 慮する必要がなくなった ◦ Result を受け取るケースでは考慮する必要があるので Destination を使わない処理になって いる
  8. URL による画面遷移処理 • いわゆるディープリンク処理 • 遷移先は Fragment だったり Activity だったり

    • 外部からのアプリ起動、WebView内での遷移、APIレスポンスからのアクション など様々な箇所で同じ挙動を実現したい
  9. WebView における DestinationParams • 去年の DroidKaigi で発表した時点では DestinationParams は存在していな かった

    • 現在は WebView 内のURL解釈も DestinationParams で共通化しているため、 WebView画面で実装すべきメソッドは DestinationParams を渡して遷移するメ ソッドだけになった
  10. DestinationParams の機能ごとのタグづけ 各 DestinationParams がサポートする機能ごとにタグづけを行なっている sealed interface は複数実装できるので、サポートする機能によって DestinationParams の

    sub interface をそれぞれ実装している 例えば、ディープリンク関連の処理では DeepLinkSupportedDestinationParams だ けを用いることで、 when 分岐の無駄な記述を減らすことができる
  11. クックパッドアプリの 画面遷移を支える自作コンポーネント • DestinationParams ◦ 遷移先と必要なパラメータをまとめた sealed interface ◦ (理想的には)画面の数だけ

    DestinationParams が存在する • Destination ◦ 画面遷移に必要なFragmentやActivity(Intent) などの実態を抽象化する sealed class ◦ (基本的には) Factory を経由して DestinationParams から生成される • NavigationController ◦ Destination による画面遷移をサポートする仕組み ◦ Multiple Back Stacks などの実装を隠蔽し、各画面が意図している画面遷移実装に集中でき るようにする
  12. 今後の課題 • Jetpack Navigation Component を利用していないこと • Navigation Component は必須ではないと感じているが、長期的なメンテナンス

    コストを考えると公式が推している仕組みに近づけた方が良さそう • Navigation Component のマルチモジュールサポートは自作コンポーネントを 完全に置き換えられないため、しばらくは自作した仕組みを Navigation Component に寄せやすくする改良をしていくかも ◦ Navigation best practices for multi-module projects ◦ モジュール間遷移がディープリンク前提、 SafeArgs 使えないという制約は結構辛い