Hedefler arasında veri geçirme

Gezinme, bir hedef için bağımsız değişkenler tanımlayarak gezinme işlemine veri eklemenize olanak tanır. Örneğin, bir kullanıcı profili hedefi, hangi kullanıcının gösterileceğini belirlemek için kullanıcı kimliği bağımsız değişkenini alabilir.

Genel olarak, hedefler arasında yalnızca minimum miktarda veri aktarmayı tercih etmeniz önerilir. Örneğin, Android'de kaydedilen tüm durumlar için toplam alan sınırlı olduğundan nesnenin kendisini iletmek yerine nesneyi almak için bir anahtar iletmeniz gerekir. Büyük miktarda veri aktarmanız gerekiyorsa ViewModel'e genel bakış bölümünde açıklandığı gibi ViewModel kullanın.

Hedef bağımsız değişkenleri tanımlama

Hedefler arasında veri aktarmak için önce aşağıdaki adımları uygulayarak bağımsız değişkeni, verileri alan hedefe ekleyip tanımlayın:

  1. Gezinme Düzenleyicisi'nde, bağımsız değişkeni alan hedefi tıklayın.
  2. Özellikler panelinde Ekle'yi (+) tıklayın.
  3. Açılan Add Argument Link (Bağımsız Değişken Bağlantısı Ekle) penceresinde bağımsız değişken adını, bağımsız değişken türünü, bağımsız değişkenin null değer alıp alamayacağını ve gerekirse varsayılan bir değer girin.
  4. Ekle'yi tıklayın. Bağımsız değişkenin artık Özellikler panelindeki Bağımsız değişkenler listesinde göründüğüne dikkat edin.
  5. Ardından, sizi bu hedefe götüren ilgili işlemi tıklayın. Özellikler panelinde, yeni eklediğiniz bağımsız değişkeni Bağımsız Değişken Varsayılan Değerleri bölümünde görebilirsiniz.
  6. Bağımsız değişkenin XML'e eklendiğini de görebilirsiniz. XML görünümüne geçmek için Text (Metin) sekmesini tıklayın ve bağımsız değişkeninizin, bağımsız değişkeni alan hedefe eklendiğini görün. Aşağıda bir örnek gösterilmiştir:

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

Desteklenen bağımsız değişken türleri

Gezinme kitaplığı aşağıdaki bağımsız değişken türlerini destekler:

Tür app:argType söz dizimi Varsayılan değerler için destek Rotalar tarafından yönetilir Null değer alabilir
Tam sayı app:argType="integer" Evet Evet Hayır
Kayan app:argType="float" Evet Evet Hayır
Uzun app:argType="long" Evet: Varsayılan değerler her zaman "L" son ekiyle bitmelidir (ör. "123L"). Evet Hayır
Boole app:argType="boolean" Evet - "true" veya "false" Evet Hayır
Dize app:argType="string" Evet Evet Evet
Kaynak Referansı app:argType="reference" Evet - Varsayılan değerler "@resourceType/resourceName" (ör. "@style/myCustomStyle") veya "0" biçiminde olmalıdır. Evet Hayır
Özel Parcelable app:argType="<type>" (<type>, Parcelable sınıfının tam adıdır) "@null" varsayılan değerini destekler. Diğer varsayılan değerleri desteklemez. Hayır Evet
Özel Serileştirilebilir app:argType="<type>" (<type>, Serializable sınıfının tam adıdır) "@null" varsayılan değerini destekler. Diğer varsayılan değerleri desteklemez. Hayır Evet
Özel Enum app:argType="<type>" (Burada <type>, enum'un tam adıdır.) Evet: Varsayılan değerler, nitelenmemiş adla eşleşmelidir (ör. MyEnum.SUCCESS ile eşleşmesi için "SUCCESS"). Hayır Hayır

Bir bağımsız değişken türü boş değerleri destekliyorsa android:defaultValue="@null" kullanarak varsayılan bir boş değer tanımlayabilirsiniz.

Rotalar, derin bağlantılar ve bağımsız değişkenleriyle birlikte URI'ler dizelerden ayrıştırılabilir. Önceki tabloda görüldüğü gibi Parcelable ve Serializable gibi özel veri türleri kullanılarak bu işlem yapılamaz. Özel karmaşık verileri aktarmak için verileri ViewModel veya veritabanı gibi başka bir yerde depolayın ve gezinme sırasında yalnızca bir tanımlayıcı iletin. Ardından, gezinme tamamlandıktan sonra verileri yeni konumda alın.

Özel türlerden birini seçtiğinizde Sınıf Seç iletişim kutusu görünür ve bu tür için ilgili sınıfı seçmeniz istenir. Proje sekmesi, mevcut projenizden bir sınıf seçmenize olanak tanır.

Navigation kitaplığının, türü sağlanan değere göre belirlemesi için <inferred type> seçeneğini belirleyebilirsiniz.

Bağımsız değişkenin, seçilen Tür değerinin bir dizisi olması gerektiğini belirtmek için Dizi'yi seçebilirsiniz. Aşağıdakileri göz önünde bulundurun:

  • Numaralandırma dizileri ve kaynak referans dizileri desteklenmez.
  • Diziler, temel türün null değer alabilen değerleri destekleyip desteklemediğine bakılmaksızın null değer alabilen değerleri destekler. Örneğin, app:argType="integer[]" kullanmak, boş bir dizinin iletilmesinin kabul edilebilir olduğunu belirtmek için app:nullable="true" kullanmanıza olanak tanır.
  • Diziler tek bir varsayılan değeri ("@null") destekler. Diziler başka bir varsayılan değeri desteklemez.

Bir işlemdeki hedef bağımsız değişkenini geçersiz kılma

Hedef düzeyindeki bağımsız değişkenler ve varsayılan değerler, hedefe giden tüm işlemler tarafından kullanılır. Gerekirse işlem düzeyinde bir bağımsız değişken tanımlayarak bağımsız değişkenin varsayılan değerini geçersiz kılabilirsiniz (veya mevcut değilse bir değer ayarlayabilirsiniz). Bu bağımsız değişken, hedefte tanımlanan bağımsız değişkenle aynı ada ve türe sahip olmalıdır.

Aşağıdaki XML, önceki örnekteki hedef düzeyindeki bağımsız değişkeni geçersiz kılan bir bağımsız değişken içeren bir işlem bildirir:

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

Verileri tip güvenliğiyle iletmek için Safe Args'ı kullanma

Gezinme bileşeninde, türe göre güvenli gezinme ve ilişkili bağımsız değişkenlere erişim için basit nesne ve oluşturucu sınıfları oluşturan Safe Args adlı bir Gradle eklentisi bulunur. Tip güvenliği sağladığı için gezinme ve veri aktarma işlemlerinde Safe Args kullanılması önemle tavsiye edilir.

Gradle kullanmıyorsanız Safe Args eklentisini kullanamazsınız. Bu gibi durumlarda, verileri doğrudan iletmek için Bundle'ları kullanabilirsiniz.

Projenize Safe Args'ı eklemek için üst düzey build.gradle dosyanıza aşağıdaki classpath öğesini ekleyin:

Groovy

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

Kotlin

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

Ayrıca, mevcut iki eklentiden birini de uygulamanız gerekir.

Java veya karma Java ve Kotlin modüllerine uygun Java dili kodu oluşturmak için uygulamanızın ya da modülünüzün build.gradle dosyasına şu satırı ekleyin:

Groovy

plugins {
  id 'androidx.navigation.safeargs'
}

Kotlin

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

Alternatif olarak, yalnızca Kotlin modüllerine uygun Kotlin kodu oluşturmak için şunu ekleyin:

Groovy

plugins {
  id 'androidx.navigation.safeargs.kotlin'
}

Kotlin

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

AndroidX'e taşıma işlemine göre gradle.properties dosyanızda android.useAndroidX=true olmalıdır.

Safe Args'i etkinleştirdikten sonra oluşturulan kodunuz, her işlem için ve her gönderen ve alan hedef için aşağıdaki tip güvenli sınıfları ve yöntemleri içerir.

  • Bir işlemin kaynaklandığı her hedef için bir sınıf oluşturulur. Bu sınıfın adı, başlangıç noktasının adının sonuna "Yol Tarifi" kelimesi eklenerek oluşturulur. Örneğin, kaynak hedef SpecifyAmountFragment adlı bir parçaysa oluşturulan sınıfın adı SpecifyAmountFragmentDirections olur.

    Bu sınıfta, kaynak hedefte tanımlanan her işlem için bir yöntem bulunur.

  • Bağımsız değişkeni iletmek için kullanılan her işlem için adı işleme dayalı bir iç sınıf oluşturulur. Örneğin, işlem confirmationAction, olarak adlandırılıyorsa sınıf ConfirmationAction olarak adlandırılır. İşleminiz defaultValue içermeyen bağımsız değişkenler içeriyorsa bağımsız değişkenlerin değerini ayarlamak için ilişkili işlem sınıfını kullanırsınız.

  • Alıcı hedef için bir sınıf oluşturulur. Bu sınıfın adı, hedefin adının sonuna "Args" kelimesi eklenerek oluşturulur. Örneğin, hedef parçanın adı ConfirmationFragment, ise oluşturulan sınıfın adı ConfirmationFragmentArgs olur. Bağımsız değişkenleri almak için bu sınıfın fromBundle() yöntemini kullanın.

Aşağıdaki örnekte, bir bağımsız değişken ayarlamak ve bunu navigate() yöntemine iletmek için bu yöntemlerin nasıl kullanılacağı gösterilmektedir:

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);
}

Alıcı hedefin kodunda, paketi almak ve içeriğini kullanmak için getArguments() yöntemini kullanın. -ktx bağımlılıklarını kullanırken Kotlin kullanıcıları, bağımsız değişkenlere erişmek için by navArgs() özellik temsilcisini de kullanabilir.

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 + "");
}

Genel işlemle Safe Args kullanma

Safe Args'ı genel işlem ile kullanırken aşağıdaki örnekte gösterildiği gibi kök <navigation> öğeniz için bir android:id değeri sağlamanız gerekir:

<?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>

Gezinme, android:id değerine göre <navigation> öğesi için bir Directions sınıfı oluşturur. Örneğin, android:id=@+id/main_nav içeren bir <navigation> öğeniz varsa oluşturulan sınıfın adı MainNavDirections olur. <navigation> öğesindeki tüm hedefler, önceki bölümde açıklanan yöntemlerle aynı yöntemleri kullanarak ilişkili tüm genel işlemlere erişmek için yöntemler oluşturmuştur.

Bundle nesneleriyle hedefler arasında veri aktarma

Gradle kullanmıyorsanız Bundle nesnelerini kullanarak hedefler arasında bağımsız değişkenler iletebilirsiniz. Bir Bundle nesnesi oluşturun ve aşağıdaki örnekte olduğu gibi navigate() kullanarak hedefe iletin:

Kotlin

val 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);

Alıcı hedefinizin kodunda, Bundle değerini almak ve içeriğini kullanmak için getArguments() yöntemini kullanın:

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"));

Verileri başlangıç hedefine iletme

Uygulamanızın başlangıç hedefine veri aktarabilirsiniz. Öncelikle, verileri barındıran bir Bundle oluşturmanız gerekir. Ardından, Bundle değerini başlangıç hedefine iletmek için aşağıdaki yaklaşımlardan birini kullanın:

Başlangıç hedefinizdeki verileri almak için Fragment.getArguments() yöntemini çağırın.

ProGuard ile ilgili dikkat edilmesi gereken noktalar

Kodunuzu küçültüyorsanız Parcelable, Serializable ve Enum sınıf adlarınızın sadeleştirme sürecinde gizlenmesini önlemeniz gerekir. Bunu iki şekilde yapabilirsiniz:

  • @Keep ek açıklamalarını kullanın.
  • keepnames kurallarını kullanın.

Aşağıdaki alt bölümlerde bu yaklaşımlar açıklanmaktadır.

@Keep ek açıklamalarını kullanma

Aşağıdaki örnekte, model sınıfı tanımlarına @Keep ek açıklamaları eklenmektedir:

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 kurallarını kullanma

Aşağıdaki örnekte gösterildiği gibi proguard-rules.pro dosyanıza keepnames kuralları da ekleyebilirsiniz:

proguard-rules.pro

...

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

...

Ek kaynaklar

Gezinme hakkında daha fazla bilgi edinmek için aşağıdaki ek kaynaklara göz atın.

Codelab uygulamaları

Videolar