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

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

　本連載は、「Android Studio2で始めるアプリ開発入門」連載、および『Androidアプリ開発の教科書』の続編にあたる内容として、Jetpackを取り上げていきます。前回は、画面遷移を管理してくれるナビゲーションコンポーネントの概要とナビゲーショングラフの使い方、ナビゲーションによる画面遷移を紹介しました。今回は、ナビゲーションを型安全に利用する方法とKotlin DSLによるナビゲーションの定義方法を紹介します。

型安全なナビゲーション

　本連載は、Android Jetpackを紹介しています。今回は、ナビゲーションコンポーネントを利用する際に、型安全に利用する方法から紹介していきます。

　なお、今回のサンプルデータは、GitHubから参照できます。

navigate()の引数がR値である問題

　前回、別のフラグメントへ画面遷移するコードとして、次のコードを紹介しました。

navController.navigate(R.id.action_memoListFragment_to_memoDetailFragment, arguments);

　画面遷移を行うために、取得したNavControllerインスタンスのnavigate()メソッドの実行コードです。その際、引数としてアクションのR値を渡します。

　このR値によるアクションの指定の場合、間違ったアクションを指定しても、そのアクションがアプリ全体として存在している限りは、コンパイルが通ってしまい、実行してみて初めてバグに気づくといった問題があります。

型安全ナビゲーションのSafe Args

　この問題を解決する仕組みとして、ナビゲーションコンポーネントには、Safe Argsがあります。これは、ナビゲーショングラフの設定にしたがって自動生成されたクラスを利用するものです。

　このSafe Argsを利用した画面遷移のコードは、Javaではリスト1、Kotlinではリスト2のようになります。

［リスト1］MemoListFragment.java

NavController navController = NavHostFragment.findNavController(MemoListFragment.this);
MemoListFragmentDirections.ActionMemoListFragmentToMemoDetailFragment action = MemoListFragmentDirections.actionMemoListFragmentToMemoDetailFragment();  // (1)
navController.navigate(action);  // (2)

［リスト2］MemoListFragment.kt

val navController = NavHostFragment.findNavController(this@MemoListFragment)
val action = MemoListFragmentDirections.actionMemoListFragmentToMemoDetailFragment()  // (1)
navController.navigate(action)  // (2)

　自動生成されたクラスの名前は、遷移元であるクラス名にDirectionsがついたクラスです。例えば、前回のリスト1のナビゲーショングラフが定義されている場合、MemoListFragment → MemoDetailFragmentへの画面遷移となります。その場合は、MemoListFragmentDirectionsとなります。

　さらに、アクションのidをキャメル記法に変換したstaticメソッドが自動生成されています。前回のリスト6の場合は、アクションのidがaction_memoListFragment_to_memoDetailFragmentなので、自動生成されたメソッドはactionMemoListFragmentToMemoDetailFragment()です。これら自動生成されたクラスとそのstaticメソッドを実行しているのが（1）です。

　リスト1のJavaコードの方を見るとわかるように、この戻り値の型は、これまた、アクションのidをキャメル記法に変換した名称、すなわち、アクションに対応したメソッドと同名クラスとなります。しかも、このクラスは、遷移元のDirectionsクラスのメンバクラスとして自動生成されています。

　このように生成されたAction〇〇のインスタンス、すなわち、action〇〇()メソッドの戻り値を、リスト1、およびリスト2では変数actionとしています。そしてこのactionを、そのままnavigate()メソッドの引数として渡すことで、R値を利用した遷移の代わりとなります。それが（2）のコードです。

　このように、ナビゲーショングラフの定義を元に各種クラスとメソッドが自動生成されており、そのメソッドの戻り値をnavigate()メソッドの引数として渡す仕組みにより、遷移の指定ミスを防ぐことができます。

Safe Args利用設定

　ただし、このSafe Argsを利用するためには、前回紹介したナビゲーションコンポーネントの依存ライブラリの他に、プロジェクトへの設定が必要です。

　まず、build.gradle.kts(Project)ファイルにリスト3のbuildscriptプロパティを追加します。なお、バージョン番号は、ナビゲーションコンポーネントの原稿執筆時点での番号です。

［リスト3］build.gradle.kts(Project)へSafe Argsを利用する設定

buildscript {
  repositories {
    google()
  }
  dependencies {
    classpath("androidx.navigation:navigation-safe-args-gradle-plugin:2.9.6")
  }
}

　その後、build.gradle.kts(Module)ファイルのpluginsプロパティにリスト4のidを追記します。

［リスト4］build.gradle.kts(Module)へSafe Argsを利用する設定

plugins {
  id("androidx.navigation.safeargs")
}