Adaptery wiązania odpowiadają za wykonywanie odpowiednich wywołań platformy w celu ustawienia wartości. Przykładem może być ustawienie wartości właściwości, np. wywołanie metody setText(). Innym przykładem jest ustawienie detektora zdarzeń, np. wywołanie metody setOnClickListener().
Biblioteka wiązania danych umożliwia określenie wywołania metody w celu ustawienia wartości, podanie własnej logiki wiązania i określenie typu zwracanego obiektu za pomocą adapterów.
Ustawianie wartości atrybutów
Za każdym razem, gdy zmienia się powiązana wartość, wygenerowana klasa powiązania musi wywołać metodę setter w widoku z wyrażeniem powiązania. Możesz pozwolić bibliotece wiązania danych na automatyczne określenie metody, możesz też wyraźnie zadeklarować metodę lub podać niestandardową logikę, aby wybrać metodę.
Automatyczny wybór metody
W przypadku atrybutu o nazwie example biblioteka automatycznie znajduje metodę setExample(arg), która akceptuje zgodne typy jako argument. Przestrzeń nazw atrybutu nie jest brana pod uwagę. Podczas wyszukiwania metody używane są tylko nazwa atrybutu i typ.
Na przykład w przypadku wyrażenia android:text="@{user.name}" biblioteka szuka metody setText(arg), która akceptuje typ zwracany przez user.getName(). Jeśli zwracany typ user.getName() to String, biblioteka szuka metody setText(), która akceptuje argument String. Jeśli wyrażenie zwraca int, biblioteka wyszukuje metodę setText(), która akceptuje argument int. Wyrażenie musi zwracać prawidłowy typ. W razie potrzeby możesz rzutować zwracaną wartość.
Wiązanie danych działa nawet wtedy, gdy nie ma atrybutu o podanej nazwie. Możesz tworzyć atrybuty dla dowolnego elementu setter, używając wiązania danych. Na przykład klasa pomocy DrawerLayout nie ma atrybutów, ale ma wiele metod ustawiających. Ten układ automatycznie używa metod setScrimColor(int) i addDrawerListener(DrawerListener) jako metod ustawiających odpowiednio atrybuty app:scrimColor i app:drawerListener:
<androidx.drawerlayout.widget.DrawerLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:scrimColor="@{@color/scrim}"
app:drawerListener="@{fragment.drawerListener}">
Określ niestandardową nazwę metody
Niektóre atrybuty mają metody ustawiające, które nie pasują do nazwy. W takich sytuacjach atrybut można powiązać z metodą ustawiającą za pomocą adnotacji BindingMethods. Adnotacja jest używana z klasą i może zawierać wiele adnotacji BindingMethod, po jednej dla każdej metody o zmienionej nazwie. Metody wiązania to adnotacje, które możesz dodać do dowolnej klasy w aplikacji.
W tym przykładzie atrybut android:tint jest powiązany z metodą setImageTintList(ColorStateList), a nie z metodą setTint():
Kotlin
@BindingMethods(value = [ BindingMethod( type = android.widget.ImageView::class, attribute = "android:tint", method = "setImageTintList")])
Java
@BindingMethods({ @BindingMethod(type = "android.widget.ImageView", attribute = "android:tint", method = "setImageTintList"), })
Zwykle nie trzeba zmieniać nazw metod ustawiających w klasach platformy Androida. Atrybuty są już zaimplementowane przy użyciu konwencji nazewnictwa, aby automatycznie znajdować pasujące metody.
Podaj niestandardową logikę
Niektóre atrybuty wymagają niestandardowej logiki wiązania. Na przykład nie ma powiązanej metody ustawiającej dla atrybutu android:paddingLeft. Zamiast tego dostępna jest metoda setPadding(left,
top, right, bottom). Metoda statyczna adaptera wiązania z adnotacją BindingAdapter pozwala dostosować sposób wywoływania metody ustawiającej atrybut.
Atrybuty klas platformy Androida mają już adnotacje BindingAdapter. Poniższy przykład pokazuje adapter wiązania dla atrybutu paddingLeft:
Kotlin
@BindingAdapter("android:paddingLeft") fun setPaddingLeft(view: View, padding: Int) { view.setPadding(padding, view.getPaddingTop(), view.getPaddingRight(), view.getPaddingBottom()) }
Java
@BindingAdapter("android:paddingLeft") public static void setPaddingLeft(View view, int padding) { view.setPadding(padding, view.getPaddingTop(), view.getPaddingRight(), view.getPaddingBottom()); }
Typy parametrów są ważne. Pierwszy parametr określa typ widoku powiązanego z atrybutem. Drugi parametr określa typ akceptowany w wyrażeniu wiązania dla danego atrybutu.
Adaptery wiązania są też przydatne w przypadku innych rodzajów dostosowywania. Na przykład niestandardowy moduł ładujący może zostać wywołany z wątku instancji roboczej, aby wczytać obraz.
Możesz też mieć adaptery, które otrzymują wiele atrybutów, jak w tym przykładzie:
Kotlin
@BindingAdapter("imageUrl", "error") fun loadImage(view: ImageView, url: String, error: Drawable) { Picasso.get().load(url).error(error).into(view) }
Java
@BindingAdapter({"imageUrl", "error"}) public static void loadImage(ImageView view, String url, Drawable error) { Picasso.get().load(url).error(error).into(view); }
Możesz użyć adaptera w układzie, jak w tym przykładzie. Zwróć uwagę, że @drawable/venueError odnosi się do zasobu w aplikacji. Otoczenie zasobu znakami @{} sprawia, że jest on prawidłowym wyrażeniem wiążącym.
<ImageView app:imageUrl="@{venue.imageUrl}" app:error="@{@drawable/venueError}" />
Adapter jest wywoływany, jeśli imageUrl i error są używane w przypadku obiektu ImageView, imageUrl jest ciągiem znaków, a error jest obiektem Drawable. Jeśli chcesz, aby adapter był wywoływany, gdy ustawiony jest dowolny z atrybutów, ustaw opcjonalną flagę requireAll adaptera na false, jak w tym przykładzie:
Kotlin
@BindingAdapter(value = ["imageUrl", "placeholder"], requireAll = false) fun setImageUrl(imageView: ImageView, url: String?, placeHolder: Drawable?) { if (url == null) { imageView.setImageDrawable(placeholder); } else { MyImageLoader.loadInto(imageView, url, placeholder); } }
Java
@BindingAdapter(value={"imageUrl", "placeholder"}, requireAll=false) public static void setImageUrl(ImageView imageView, String url, Drawable placeHolder) { if (url == null) { imageView.setImageDrawable(placeholder); } else { MyImageLoader.loadInto(imageView, url, placeholder); } }
Metody adaptera wiązania mogą przyjmować stare wartości w swoich modułach obsługi. Metoda, która przyjmuje stare i nowe wartości, musi najpierw zadeklarować wszystkie stare wartości atrybutów, a następnie nowe wartości, jak w tym przykładzie:
Kotlin
@BindingAdapter("android:paddingLeft") fun setPaddingLeft(view: View, oldPadding: Int, newPadding: Int) { if (oldPadding != newPadding) { view.setPadding(newPadding, view.getPaddingTop(), view.getPaddingRight(), view.getPaddingBottom()) } }
Java
@BindingAdapter("android:paddingLeft") public static void setPaddingLeft(View view, int oldPadding, int newPadding) { if (oldPadding != newPadding) { view.setPadding(newPadding, view.getPaddingTop(), view.getPaddingRight(), view.getPaddingBottom()); } }
Modułów obsługi zdarzeń można używać tylko z interfejsami lub klasami abstrakcyjnymi z jedną metodą abstrakcyjną, jak w tym przykładzie:
Kotlin
@BindingAdapter("android:onLayoutChange") fun setOnLayoutChangeListener( view: View, oldValue: View.OnLayoutChangeListener?, newValue: View.OnLayoutChangeListener? ) { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) { if (oldValue != null) { view.removeOnLayoutChangeListener(oldValue) } if (newValue != null) { view.addOnLayoutChangeListener(newValue) } } }
Java
@BindingAdapter("android:onLayoutChange") public static void setOnLayoutChangeListener(View view, View.OnLayoutChangeListener oldValue, View.OnLayoutChangeListener newValue) { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) { if (oldValue != null) { view.removeOnLayoutChangeListener(oldValue); } if (newValue != null) { view.addOnLayoutChangeListener(newValue); } } }
Użyj tego modułu obsługi zdarzeń w układzie w ten sposób:
<View android:onLayoutChange="@{() -> handler.layoutChanged()}"/>
Jeśli detektor ma wiele metod, należy go podzielić na kilka detektorów.
Na przykład View.OnAttachStateChangeListener ma 2 metody: onViewAttachedToWindow(View) i onViewDetachedFromWindow(View).
Biblioteka udostępnia 2 interfejsy, które pozwalają rozróżniać atrybuty i ich moduły obsługi:
Kotlin
// Translation from provided interfaces in Java: @TargetApi(Build.VERSION_CODES.HONEYCOMB_MR1) interface OnViewDetachedFromWindow { fun onViewDetachedFromWindow(v: View) } @TargetApi(Build.VERSION_CODES.HONEYCOMB_MR1) interface OnViewAttachedToWindow { fun onViewAttachedToWindow(v: View) }
Java
@TargetApi(VERSION_CODES.HONEYCOMB_MR1) public interface OnViewDetachedFromWindow { void onViewDetachedFromWindow(View v); } @TargetApi(VERSION_CODES.HONEYCOMB_MR1) public interface OnViewAttachedToWindow { void onViewAttachedToWindow(View v); }
Zmiana jednego detektora może mieć wpływ na drugi, dlatego potrzebujesz adaptera, który działa z jednym lub obydwoma atrybutami. Możesz ustawić requireAll na false w adnotacji, aby określić, że nie każdy atrybut musi mieć przypisane wyrażenie wiążące, jak w tym przykładzie:
Kotlin
@BindingAdapter( "android:onViewDetachedFromWindow", "android:onViewAttachedToWindow", requireAll = false ) fun setListener(view: View, detach: OnViewDetachedFromWindow?, attach: OnViewAttachedToWindow?) { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB_MR1) { val newListener: View.OnAttachStateChangeListener? newListener = if (detach == null && attach == null) { null } else { object : View.OnAttachStateChangeListener { override fun onViewAttachedToWindow(v: View) { attach.onViewAttachedToWindow(v) } override fun onViewDetachedFromWindow(v: View) { detach.onViewDetachedFromWindow(v) } } } val oldListener: View.OnAttachStateChangeListener? = ListenerUtil.trackListener(view, newListener, R.id.onAttachStateChangeListener) if (oldListener != null) { view.removeOnAttachStateChangeListener(oldListener) } if (newListener != null) { view.addOnAttachStateChangeListener(newListener) } } }
Java
@BindingAdapter({"android:onViewDetachedFromWindow", "android:onViewAttachedToWindow"}, requireAll=false) public static void setListener(View view, OnViewDetachedFromWindow detach, OnViewAttachedToWindow attach) { if (VERSION.SDK_INT >= VERSION_CODES.HONEYCOMB_MR1) { OnAttachStateChangeListener newListener; if (detach == null && attach == null) { newListener = null; } else { newListener = new OnAttachStateChangeListener() { @Override public void onViewAttachedToWindow(View v) { if (attach != null) { attach.onViewAttachedToWindow(v); } } @Override public void onViewDetachedFromWindow(View v) { if (detach != null) { detach.onViewDetachedFromWindow(v); } } }; } OnAttachStateChangeListener oldListener = ListenerUtil.trackListener(view, newListener, R.id.onAttachStateChangeListener); if (oldListener != null) { view.removeOnAttachStateChangeListener(oldListener); } if (newListener != null) { view.addOnAttachStateChangeListener(newListener); } } }
Powyższy przykład jest nieco skomplikowany, ponieważ klasa View używa metod addOnAttachStateChangeListener() i removeOnAttachStateChangeListener() zamiast metody setter dla OnAttachStateChangeListener.
Klasa android.databinding.adapters.ListenerUtil pomaga śledzić te detektory, aby można je było usunąć w adapterze wiązania.
Konwersje obiektów
Automatyczna konwersja obiektów
Gdy wyrażenie wiązania zwraca Object, biblioteka wybiera metodę używaną do ustawiania wartości właściwości. Wartość Object jest rzutowana na typ parametru wybranej metody. Takie zachowanie jest wygodne w aplikacjach, które używają klasy ObservableMap do przechowywania danych, jak w tym przykładzie:
<TextView
android:text='@{userMap["lastName"]}'
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
Obiekt userMap w wyrażeniu zwraca wartość, która jest automatycznie rzutowana na typ parametru znaleziony w metodzie setText(CharSequence) używanej do ustawiania wartości atrybutu android:text. Jeśli typ parametru jest niejednoznaczny, rzutuj zwracany typ w wyrażeniu.
Konwersje niestandardowe
W niektórych sytuacjach wymagana jest konwersja niestandardowa między określonymi typami. Na przykład atrybut android:background widoku oczekuje wartości Drawable, ale podana wartość color jest liczbą całkowitą. W tym przykładzie atrybut oczekuje wartości Drawable, ale zamiast tego podano liczbę całkowitą:
<View
android:background="@{isError ? @color/red : @color/white}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
Gdy oczekiwana jest wartość Drawable, a zwracana jest liczba całkowita, przekonwertuj int na ColorDrawable.
Aby przeprowadzić konwersję, użyj metody statycznej z adnotacją BindingConversion w ten sposób:
Kotlin
@BindingConversion fun convertColorToDrawable(color: Int) = ColorDrawable(color)
Java
@BindingConversion public static ColorDrawable convertColorToDrawable(int color) { return new ColorDrawable(color); }
Typy wartości podane w wyrażeniu wiązania muszą być jednak spójne. Nie możesz używać różnych typów w tym samym wyrażeniu, jak w tym przykładzie:
// The @drawable and @color represent different value types in the same
// expression, which causes a build error.
<View
android:background="@{isError ? @drawable/error : @color/white}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
Dodatkowe materiały
Więcej informacji o wiązaniu danych znajdziesz w tych materiałach.
Przykłady
Posty na blogu
Polecane dla Ciebie
- Uwaga: tekst linku jest wyświetlany, gdy język JavaScript jest wyłączony.
- Biblioteka wiązania danych
- Układy i wyrażenia wiążące
- Wyświetlanie powiązania