型安全なナビゲーションとKotlin DSLによるナビゲーション

一歩進んだAndroidアプリ開発ができる「Android Jetpack」入門 第16回

Kotlin DSLによるナビゲーション定義

　Safe Argsによるナビゲーションの話はここまでとして、最後に、Kotlin DSLによるナビゲーション定義を紹介します。この方法は、全くxmlファイルを作成せずに、Kotlinコードをプログラミングすることでナビゲーションを定義する方法です。なお、Kotlin DSLによるナビゲーションの定義は、Kotlinコードのみとなります。

Kotlin DSLナビゲーション利用の設定

　Kotlin DSLによるナビゲーション定義を行う場合、前回紹介したナビゲーションコンポーネントの依存ライブラリの他に、追加の設定が必要です。

　build.gradle.kts(Module)ファイルのpluginsプロパティにリスト10の（1）のコードを追記します。これは、のちのコードで出てくる@Serializableアノテーションを利用するためのものです。さらに、dependenciesプロパティに（2）のコードを追記します。

［リスト10］build.gradle.kts(Module)への追加設定

plugins {
  :
  kotlin("plugin.serialization") version "2.0.21"  // (1)
}
  :
dependencies {
  api("androidx.navigation:navigation-fragment-ktx:2.9.6")  // (2)
}

　なお、Kotlin DSLでのナビゲーション定義を行う場合は、activity_main.xmlに記述するFragmentContainerViewタグ内のapp:navGrap属性は不要となるので注意してください。

idの代わりとなる型定義を行う

　Kotlin DSLでナビゲーションを定義する場合、XML記述に定義するid値は利用できません。このidの代わりとなるものを、型定義で代用します。これを、ルート（Route）といいます。

　例えば、これまでのサンプルと同様のものを考えると、リスト11のコードとなります。（2）がメモリストルートの定義、（3）がメモ詳細ルートの定義です。

［リスト11］navigation/MemoNavigation.kt

@Serializable  // (1)
data object MemoList  // (2)
@Serializable  // (1)
data class MemoDetail(val id: Long)  // (3)

　ルートの定義は、リスト11のように、dataオブジェクト、または、dataクラスとして作成します。さらに、その定義に対して、（1）のように、@Serializableアノテーションをつけます。

　そして、ルートに対して引数、すなわち、前節で紹介したような遷移元から受け取るデータを定義する場合は、（3）のように、プロパティとして定義します。そのため、引数が必要なルートに対しては、dataクラスを定義し、引数が不要なルートは、（2）のように、dataオブジェクトとします。

ナビゲーション定義

　リスト11のような、ルート定義（＝型定義）を行った上で、ナビゲーション定義を行います。これは、MainActivityのonCreate()メソッド内で、リスト12のコードを実行することです。

［リスト12］MainActivity.kt

val navHostFragment = supportFragmentManager.findFragmentById(R.id.navHostFragmentContainer) as NavHostFragment  // (1)
val navController = navHostFragment.navController  // (1)
navController.graph = navController.createGraph(MemoList) {  // (2)
  fragment<MemoListFragment, MemoList> {  // (3)
    label = resources.getString(R.string.tb_list_title)  // (4)
  }
  fragment<MemoDetailFragment, MemoDetail> {  // (5)
    label = resources.getString(R.string.tb_detail_title)  // (6)
  }
}

　リスト12の（2）のコードが、Kotlin DSLによるナビゲーション定義の核となります。これは、（1）によって取得したNavControllerオブジェクトのgraphプロパティに対して、同じくNavControllerオブジェクトのcreateGraph()メソッドの戻り値を代入する処理です。

　その際、引数として、初期表示画面のルートを渡します。今回のサンプルでは、もちろんリスト画面なので（2）のように、リスト11の（2）で定義したMemoListを渡します。

　さらに、同じく、createGraph()メソッドの引数ラムダ式内でfragment()関数を実行することで、デスティネーションが定義されます。それが、（3）と（5）です。

　その際、ジェネリクスとして、フラグメントクラスとそれに対応するルートを記述します。（3）ではMemoListFragmentとそのルートであるMemoList、（5）ではMemoDetailFragmentとそのルートであるMemoDetailを記述しています。

　fragment()関数の引数ラムダ内には、追加情報を設定できます。どのような設定情報があるかは誌面の都合上割愛しますが、少なくとも、（4）や（6）のように、labelとして、各デスティネーションのラベル文字列を定義しておいた方がよいでしょう。

　ここまでの内容を構文としてまとめると、以下の通りになります。

［構文］Kotlin DSLによるナビゲーション定義

val navController = navHostFragment.navController
navController.graph = navController.createGraph(初期表示ルート) {
  fragment<フラグメントクラス, ルート> {
    label = デスティネーションのラベル文字列
  }
    :
}

　この構文に該当するコード、すなわち、リスト12ならば（2）以降のコードに関しては、MainActivityのonCreate()メソッド内に直接記述するのではなく、例えば、createNavGraph()関数のようなものを別ファイルに定義しておき、それを読み込むという方法も、もちろん可能です。

　なお、ここまで説明してきたように、Kotlin DSLでのナビゲーション定義というのは、MainActivityのonCreate()実行時、つまり、アプリ起動時に定義されることになります。XMLによるナビゲーション定義と決定的に違うところは、このナビゲーション定義のタイミングです。XMLの場合は、ビルド時に決定されます。そのため、Kotlin DSLは、動的なナビゲーション定義に向く一方で、デザインモードによるナビゲーション定義が利用できず、ややわかりにくい面があります。適材適所で使い分けるのがよいでしょう。

Kotlin DSLを利用した画面遷移

　最後に、Kotlin DSLを利用した画面遷移コードを紹介します。これは、リスト13のように、navigate()メソッドの引数として、ルートインスタンスを渡すコードとなります。

［リスト13］MemoListFragment.kt

navController.navigate(MemoDetail(memoId))

まとめ

　Android Jetpackについて紹介していく本連載の第16回は、いかがでしたでしょうか。

　今回は、ナビゲーションコンポーネントの使い方のうち、型安全に画面遷移を行えるSafe Argsと、Kotlin DSLによるナビゲーション定義を紹介しました。次回は、長らく続いてきた本連載の最終回です。その最終回として、Android開発でDI（Dependency Injection）を実現するHiltを紹介します。