Wygenerowane klasy powiązań

Biblioteka wiązania danych generuje klasy wiązania, których możesz używać do uzyskiwania dostępu do zmiennych i widoków układu. Z tej dokumentacji dowiesz się, jak tworzyć i dostosowywać wygenerowane klasy wiązania.

Wygenerowana klasa wiązania łączy zmienne układu z widokami w układzie. Możesz dostosować nazwę i pakiet powiązania. Wszystkie wygenerowane klasy wiązania dziedziczą po klasie ViewDataBinding.

Dla każdego pliku układu generowana jest klasa wiązania. Domyślnie nazwa klasy to nazwa pliku układu przekonwertowana na format PascalCase z dodatkiem sufiksu Binding. Jeśli na przykład nazwa pliku układu to activity_main.xml, wygenerowana klasa będzie miała nazwę ActivityMainBinding. Ta klasa zawiera wszystkie powiązania właściwości układu z widokami układu i wie, jak przypisywać wartości do wyrażeń powiązań.

Tworzenie obiektu powiązania

Obiekt wiążący jest tworzony natychmiast po wygenerowaniu układu, aby mieć pewność, że hierarchia widoków nie zostanie zmodyfikowana, zanim zostanie powiązana z widokami z wyrażeniami w układzie. Najczęstszą metodą powiązania obiektu z układem jest użycie metod statycznych w klasie powiązania. Możesz rozwinąć hierarchię widoków i powiązać z nią obiekt, używając metody inflate() klasy powiązania, jak w tym przykładzie:

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    val binding: MyLayoutBinding = MyLayoutBinding.inflate(layoutInflater)

    setContentView(binding.root)
}

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    MyLayoutBinding binding = MyLayoutBinding.inflate(getLayoutInflater());

    setContentView(binding.root);
}

Istnieje alternatywna wersja metody inflate(), która oprócz obiektu LayoutInflater przyjmuje obiekt ViewGroup, jak w tym przykładzie:

Kotlin

val binding: MyLayoutBinding = MyLayoutBinding.inflate(getLayoutInflater(), viewGroup, false)

Java

MyLayoutBinding binding = MyLayoutBinding.inflate(getLayoutInflater(), viewGroup, false);

Jeśli układ jest rozwijany za pomocą innego mechanizmu, możesz go powiązać osobno w ten sposób:

Kotlin

val binding: MyLayoutBinding = MyLayoutBinding.bind(viewRoot)

Java

MyLayoutBinding binding = MyLayoutBinding.bind(viewRoot);

Czasami nie znasz typu powiązania z wyprzedzeniem. W takich przypadkach możesz utworzyć powiązanie za pomocą klasy DataBindingUtil, jak pokazano w tym fragmencie kodu:

Kotlin

val viewRoot = LayoutInflater.from(this).inflate(layoutId, parent, attachToParent)
val binding: ViewDataBinding? = DataBindingUtil.bind(viewRoot)

Java

View viewRoot = LayoutInflater.from(this).inflate(layoutId, parent, attachToParent);
ViewDataBinding binding = DataBindingUtil.bind(viewRoot);

Jeśli używasz elementów wiązania danych w adapterze Fragment, ListView lub RecyclerView, możesz użyć metod inflate() klas wiązań lub klasy DataBindingUtil, jak pokazano w tym przykładowym kodzie:

Kotlin

val listItemBinding = ListItemBinding.inflate(layoutInflater, viewGroup, false)
// or
val listItemBinding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false)

Java

ListItemBinding binding = ListItemBinding.inflate(layoutInflater, viewGroup, false);
// or
ListItemBinding binding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false);

Widoki z identyfikatorami

Biblioteka wiązania danych tworzy niezmienne pole w klasie wiązania dla każdego widoku, który ma identyfikator w układzie. Na przykład biblioteka wiązania danych tworzy pola firstName i lastName typu TextView z tego układu:

<layout xmlns:android="http://schemas.android.com/apk/res/android">
   <data>
       <variable name="user" type="com.example.User"/>
   </data>
   <LinearLayout
       android:orientation="vertical"
       android:layout_width="match_parent"
       android:layout_height="match_parent">
       <TextView android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:text="@{user.firstName}"
   android:id="@+id/firstName"/>
       <TextView android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:text="@{user.lastName}"
  android:id="@+id/lastName"/>
   </LinearLayout>
</layout>

Biblioteka wyodrębnia widoki, w tym identyfikatory, z hierarchii widoków w jednym przebiegu. Ten mechanizm może być szybszy niż wywoływanie metody findViewById() dla każdego widoku w układzie.

Identyfikatory nie są tak potrzebne jak bez wiązania danych, ale nadal istnieją przypadki, w których dostęp do widoków jest konieczny z poziomu kodu.

Zmienne

Biblioteka wiązania danych generuje akcesory dla każdej zmiennej zadeklarowanej w układzie. Na przykład ten układ generuje metody ustawiające i pobierające w klasie wiązania dla zmiennych user, image i note:

<data>
   <import type="android.graphics.drawable.Drawable"/>
   <variable name="user" type="com.example.User"/>
   <variable name="image" type="Drawable"/>
   <variable name="note" type="String"/>
</data>

ViewStubs

W przeciwieństwie do zwykłych widoków obiekty ViewStub zaczynają jako widoki niewidoczne. Gdy są widoczne lub wyraźnie powiększone, zastępują się w układzie, powiększając inny układ.

Ponieważ ViewStub znika z hierarchii widoków, widok w obiekcie wiążącym również musi zniknąć, aby mógł zostać usunięty przez mechanizm odzyskiwania pamięci. Widoki są ostateczne, więc obiekt ViewStubProxy zastępuje ViewStub w wygenerowanej klasie powiązania, co daje dostęp do ViewStub, gdy istnieje, oraz do hierarchii widoków, gdy ViewStub jest wyodrębniony.

Podczas rozwijania innego układu należy utworzyć powiązanie dla nowego układu. Dlatego ViewStubProxy musi nasłuchiwać ViewStub OnInflateListener i w razie potrzeby ustanawiać powiązanie. Ponieważ w danym momencie może istnieć tylko 1 detektor, ViewStubProxy umożliwia ustawienie OnInflateListener, który jest wywoływany po ustanowieniu powiązania.

Wiązanie natychmiastowe

Gdy zmienna lub obserwowany obiekt ulegnie zmianie, wiązanie zostanie zaplanowane do zmiany przed następną klatką. Zdarza się jednak, że powiązanie musi zostać wykonane natychmiast. Aby wymusić wykonanie, użyj metody executePendingBindings().

Zmienne dynamiczne

Czasami konkretna klasa powiązania jest nieznana. Na przykład RecyclerView.Adapter działający na dowolnych układach nie zna konkretnej klasy wiązania. Musi przypisać wartość powiązania podczas wywołania metody onBindViewHolder().

W tym przykładzie wszystkie układy, z którymi jest powiązany element RecyclerView, mają zmienną item. Obiekt BindingHolder ma metodę getBinding(), która zwraca klasę bazową ViewDataBinding.

Kotlin

override fun onBindViewHolder(holder: BindingHolder, position: Int) {
    item: T = items.get(position)
    holder.binding.setVariable(BR.item, item);
    holder.binding.executePendingBindings();
}

Java

public void onBindViewHolder(BindingHolder holder, int position) {
    final T item = items.get(position);
    holder.getBinding().setVariable(BR.item, item);
    holder.getBinding().executePendingBindings();
}

Wątek w tle

Możesz zmienić model danych w wątku w tle, o ile nie jest to kolekcja. Wiązanie danych lokalizuje każdą zmienną lub pole podczas oceny, aby uniknąć problemów ze współbieżnością.

Nazwy niestandardowych klas powiązań

Domyślnie klasa powiązania jest generowana na podstawie nazwy pliku układu, zaczynając od wielkiej litery, usuwając podkreślenia ( _ ), zamieniając następną literę na wielką i dodając na końcu słowo Binding. Na przykład plik układu contact_item.xml generuje klasę ContactItemBinding. Klasa jest umieszczana w pakiecie databinding w pakiecie modułu. Jeśli na przykład pakiet modułu to com.example.my.app, klasa wiązania jest umieszczana w pakiecie com.example.my.app.databinding.

Klasy wiązania można zmieniać lub umieszczać w różnych pakietach, dostosowując atrybut class elementu data. Na przykład ten układ generuje klasę wiązania ContactItem w pakiecie databinding w bieżącym module:

<data class="ContactItem">
    ...
</data>

Możesz wygenerować klasę wiązania w innym pakiecie, dodając kropkę przed nazwą klasy. W poniższym przykładzie klasa wiązania jest generowana w pakiecie modułu:

<data class=".ContactItem">
    ...
</data>

Możesz też użyć pełnej nazwy pakietu, w którym chcesz wygenerować klasę wiązania. W tym przykładzie tworzona jest klasa wiązania ContactItem w pakiecie com.example:

<data class="com.example.ContactItem">
    ...
</data>

Dodatkowe materiały

Więcej informacji o wiązaniu danych znajdziesz w tych materiałach: