6 月 3 日の「#Android11: The Beta Launch Show」にぜひご参加ください。

デスティネーション間でデータを渡す

Navigation コンポーネントを使用すると、デスティネーションに対して引数を定義することで、ナビゲーション処理にデータをアタッチできます。たとえば、ユーザー プロフィール デスティネーションがユーザー ID 引数を受け取ることで、表示するユーザーを決定することができます。

一般に、デスティネーション間で渡すデータの量は、最小限に抑えることを強くおすすめします。たとえば、オブジェクト自体を渡すのではなく、オブジェクトを取得するためのキーを渡すようにします。これは、Android では、保存するすべての状態の合計容量が限られているためです。大量のデータを渡す必要がある場合は、ViewModel を使用することをおすすめします。詳細については、フラグメント間でデータを共有するをご覧ください。

デスティネーション引数を定義する

デスティネーション間でデータを渡すには、まず、引数を定義します。そのためには、次の手順に沿って、引数を受け取るデスティネーションに引数を追加します。

  1. Navigation Editor 内で、引数を受け取るデスティネーションをクリックします。
  2. [Attributes] パネルで [Add]([+])をクリックします。
  3. 表示された [Add Argument Link] ウィンドウで、引数名、引数の型、引数に null を指定できるかどうか、デフォルト値(必要な場合)を入力します。
  4. [Add] をクリックします。これで、[Attributes] パネルの [Arguments] リストに引数が表示されます。
  5. 次に、対象のデスティネーションに移動するアクションをクリックします。これで、[Attributes] パネルの [Argument Default Values] に、新たに追加した引数が表示されるはずです。
  6. XML でも、引数が追加されたことを確認できます。[Text] タブをクリックして XML ビューに切り替えると、引数を受け取るデスティネーションに引数が追加されていることが確認できます。以下に例を示します。

     <fragment android:id="@+id/myFragment" >
             <argument
                 android:name="myArg"
                 app:argType="integer"
                 android:defaultValue="0" />
         </fragment>
        

サポートされている引数の型

Navigation ライブラリでは、以下の引数の型がサポートされています。

app:argType の構文 デフォルト値のサポート null 値のサポート
Integer app:argType="integer" ×
Float app:argType="float" ×
Long app:argType="long" ○ - デフォルト値は必ず接尾辞「L」で終わる必要があります(例: 「123L」)。 ×
Boolean app:argType="boolean" ○ - 「true」または「false」。 ×
String app:argType="string"
リソース参照 app:argType="reference" ○ - デフォルト値には「@resourceType/resourceName」の形式(例: 「@style/myCustomStyle」)または「0」を指定する必要があります。 ×
カスタム Parcelable app:argType="<type>"(<type> は Parcelable の完全修飾クラス名) デフォルト値「@null」をサポートしています。他のデフォルト値はサポートしていません。
カスタム Serializable app:argType="<type>"(<type> は Serializable の完全修飾クラス名) デフォルト値「@null」をサポートしています。他のデフォルト値はサポートしていません。
カスタム Enum app:argType="<type>"(<type> は Enum の完全修飾名) ○ - デフォルト値が非修飾名と一致する必要があります(例: 「SUCCESS」は MyEnum.SUCCESS と一致)。 ×

引数の型が null 値をサポートしている場合は、android:defaultValue="@null" を使用して null のデフォルト値を宣言できます。

カスタム型のいずれかを選択した場合、[Select Class] ダイアログが表示され、その型に対応するクラスを選択するよう促されます。[Project] タブの場合、現在のプロジェクトからクラスを選択できます。

<inferred type> を選択すると、指定した値に基づいて Navigation ライブラリに型を決めさせることができます。

選択した [Type] の値の配列を引数に指定する必要があることを示すには、[Array] チェックボックスをオンにします。なお、Enum の配列とリソース参照の配列はサポートされていません。基となる型の null 可能性に関係なく、配列には常に null を使用できます。配列は、単一のデフォルト値「@null」をサポートしています。他のデフォルト値はサポートしていません。

アクションでリンク先の引数をオーバーライドする

リンク先レベルの引数とデフォルト値は、リンク先に移動するアクションのすべてで使用されます。必要に応じて、アクション レベルで引数を定義することにより、引数のデフォルト値をオーバーライドできます(デフォルト値をまだ設定していない場合は設定できます)。この引数は、リンク先で宣言されている引数と名前および型が同じである必要があります。

次の XML では、上の例のリンク先レベルの引数をオーバーライドする引数を使用してアクションを宣言しています。

<action android:id="@+id/startMyFragment"
        app:destination="@+id/myFragment">
        <argument
            android:name="myArg"
            app:argType="integer"
            android:defaultValue="1" />
    </action>
    

Safe Args を使用してタイプセーフにデータを渡す

Navigation コンポーネントには、Safe Args と呼ばれる Gradle プラグインが含まれています。Safe Args は、ナビゲーションや関連引数へのアクセスをタイプセーフに行うためのシンプルなオブジェクトとビルダークラスを生成します。Safe Args を使用すると型の安全性が保証されるため、ナビゲーションやデータの受け渡しに関しては Safe Args を使用することを強くおすすめします。

場合によっては、Safe Args プラグインを使用できないこともあります(Gradle を使用していない場合など)。そのような場合は、Bundle を使用することで、データを直接渡すことができます。

Safe Args をプロジェクトに追加するには、最上位の build.gradle ファイルに次の classpath を含めます。

buildscript {
    repositories {
        google()
    }
    dependencies {
        def nav_version = "2.3.0-alpha06"
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
    }
}

また、使用可能な 2 つのプラグインのいずれかを適用する必要があります。

Java モジュールまたは Java と Kotlin の混合モジュールに適した Java 言語コードを生成するには、アプリまたはモジュールbuild.gradle ファイルに次の行を追加します。

apply plugin: "androidx.navigation.safeargs"

Kotlin のみのモジュールに適した Kotlin コードを生成するには、次の行を追加します。

apply plugin: "androidx.navigation.safeargs.kotlin"

AndroidX への移行にあるとおり、gradle.properties ファイルandroid.useAndroidX=true が必要です。

Safe Args を有効にすると、生成されるコード内に、以下のような各アクション用のタイプセーフなクラスおよびメソッドと、送信側および受信側のデスティネーションが組み込まれます。

  • アクションの発生元となる送信側デスティネーションごとにクラスが作成されます。このクラスの名前は、送信側デスティネーションの名前に「Directions」という語が付加されたものになります。たとえば、送信側デスティネーションが「SpecifyAmountFragment」という名前のフラグメントの場合、「SpecifyAmountFragmentDirections」という名前のクラスが作成されます。

    このクラスには、送信側デスティネーション内で定義されている各アクション用のメソッドが格納されます。

  • 引数を渡すために使用されるアクションごとに、アクションに基づく名前を持つ内部クラスが作成されます。たとえば、「confirmationAction,」という名前のアクションの場合、クラスの名前は「ConfirmationAction」になります。defaultValue が指定されていない引数がアクションに含まれている場合は、関連付けられているアクション クラスを使用して引数の値を設定します。

  • 受信側デスティネーション用のクラスが作成されます。このクラスの名前は、デスティネーションの名前に「Args」という語が付加されたものになります。たとえば、デスティネーション フラグメントが「ConfirmationFragment,」という名前の場合、「ConfirmationFragmentArgs」という名前のクラスが作成されます。このクラスの fromBundle() メソッドを使用して引数を取得します。

上記のメソッドを使用して引数を設定し、navigate() メソッドに渡す例を以下に示します。

Kotlin

    override fun onClick(v: View) {
       val amountTv: EditText = view!!.findViewById(R.id.editTextAmount)
       val amount = amountTv.text.toString().toInt()
       val action = SpecifyAmountFragmentDirections.confirmationAction(amount)
       v.findNavController().navigate(action)
    }
    

Java

    @Override
    public void onClick(View view) {
       EditText amountTv = (EditText) getView().findViewById(R.id.editTextAmount);
       int amount = Integer.parseInt(amountTv.getText().toString());
       ConfirmationAction action =
               SpecifyAmountFragmentDirections.confirmationAction()
       action.setAmount(amount)
       Navigation.findNavController(view).navigate(action);
    }
    

受信側デスティネーションのコード内で、getArguments() メソッドを使用して、バンドルを取得し、そのコンテンツを使用します。-ktx 依存関係を使用している場合、Kotlin ユーザーは、by navArgs() プロパティ デリゲートを使用して引数にアクセスすることもできます。

Kotlin

    val args: ConfirmationFragmentArgs by navArgs()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        val tv: TextView = view.findViewById(R.id.textViewAmount)
        val amount = args.amount
        tv.text = amount.toString()
    }
    

Java

    @Override
    public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
        TextView tv = view.findViewById(R.id.textViewAmount);
        int amount = ConfirmationFragmentArgs.fromBundle(getArguments()).getAmount();
        tv.setText(amount + "")
    }
    

Safe Args とグローバル アクションを併用する

Safe Args とグローバル アクションを併用する場合は、ルートの <navigation> 要素で android:id 値を指定する必要があります。次の例をご覧ください。

    <?xml version="1.0" encoding="utf-8"?>
    <navigation xmlns:app="http://schemas.android.com/apk/res-auto"
                xmlns:tools="http://schemas.android.com/tools"
                xmlns:android="http://schemas.android.com/apk/res/android"
                android:id="@+id/main_nav"
                app:startDestination="@id/mainFragment">

        ...

    </navigation>
    

Navigation コンポーネントは、<navigation> 要素用に、android:id 値に基づく Directions クラスを生成します。たとえば、<navigation> 要素に対して android:id=@+id/main_nav が指定されている場合、MainNavDirections という名前のクラスが生成されます。<navigation> 要素内のすべてのデスティネーションで、上記のセクションで説明したものと同じメソッドを使用して、すべての関連グローバル アクションにアクセスするためのメソッドが生成されます。

Bundle オブジェクトを使用してデスティネーション間でデータを渡す

Gradle を使用していない場合でも、Bundle オブジェクトを使用することで、デスティネーション間で引数を渡すことができます。Bundle オブジェクトを作成し、navigate() を使用してデスティネーションに渡します。以下をご覧ください。

Kotlin

    var bundle = bundleOf("amount" to amount)
    view.findNavController().navigate(R.id.confirmationAction, bundle)
    

Java

    Bundle bundle = new Bundle();
    bundle.putString("amount", amount);
    Navigation.findNavController(view).navigate(R.id.confirmationAction, bundle);
    

受信側デスティネーションのコード内で、getArguments() メソッドを使用して Bundle を取得し、そのコンテンツを使用します。

Kotlin

    val tv = view.findViewById<TextView>(R.id.textViewAmount)
    tv.text = arguments?.getString("amount")
    

Java

    TextView tv = view.findViewById(R.id.textViewAmount);
    tv.setText(getArguments().getString("amount"));
    

開始デスティネーションにデータを渡す

アプリの開始デスティネーションにデータを渡すことができます。まず、データを保持する Bundle を明示的に作成する必要があります。次に、以下のいずれかのメソッドを使用して、Bundle を開始デスティネーションに渡します。

開始デスティネーション内でデータを取得するには、Fragment.getArguments() を呼び出します。

ProGuard に関する注意事項

コードを圧縮する場合は、圧縮プロセスの過程で、ParcelableSerializableEnum のクラス名が難読化されないようにする必要があります。これには、以下の 2 つの方法があります。

@Keep アノテーションを使用する

@Keep アノテーションをモデルクラス定義に追加する例を以下に示します。

Kotlin

    @Keep class ParcelableArg : Parcelable { ... }

    @Keep class SerializableArg : Serializable { ... }

    @Keep enum class EnumArg { ... }
    

Java

    @Keep public class ParcelableArg implements Parcelable { ... }

    @Keep public class SerializableArg implements Serializable { ... }

    @Keep public enum EnumArg { ... }
    

keepnames ルールを使用する

keepnames ルールを proguard-rules.pro ファイルに追加することもできます。次の例をご覧ください。

proguard-rules.pro

...

    -keepnames class com.path.to.your.ParcelableArg
    -keepnames class com.path.to.your.SerializableArg
    -keepnames class com.path.to.your.EnumArg

    ...
    

参考情報

ナビゲーションについて詳しくは、以下の参考情報をご確認ください。

サンプル

コードラボ

動画