前言
Binding Adapter 主要用來呼叫適當方式來設定數值。一個例子為透過 setText 方法來設定屬性值，另一個例子為透過呼叫 setOnClickListener 方法來設定事件監聽器。
Data Binding Library 讓使用者指定調用方法來設定數值，客製化綁定邏輯，並使用適配器指定返回對象的類型。
Setting attribute values
每當綁定值發生更改時，綁定類別必須使用綁定表達式在視圖上調用 setter 方法。使用者可以允許 data binding library 自動決定哪個方法，顯式的聲明方法或提供自定義邏輯來選擇方法。
Automatic method selection
對於一個命名為 example 的屬性，data binding library 會嘗試尋找名稱為 setExample(arg) 的方法，其方法接受兼容的參數。
只有屬性的名稱和型別會被用於搜尋，屬性的名稱空間則不會被考慮。
例如，對於 android:text="@{user.name}" 表達式，data binding library 會尋找一個 setText(arg) 方法，該方法的參數(arg)的型別為 user.getName 方法所回傳的。例如，若 user.getName 方法回傳的型態為 String，則 data binding library 會尋找 setText 方法，其方法接受的參數型態為 String。若 user.getName 方法回傳的型態為 int，則 data binding library 會尋找 setText 方法，其方法接受的參數型態為 int。
表達式必須回傳正確的型態，如有必要可以進行轉型的動作。即使沒有屬性符合給定的名稱，數據綁定仍然工作。之後，可以使用數據綁定為任何 setter 建立屬性。
例如，類別 DrawerLayout 沒有任何屬性，但有很多 setter。
下方的佈局自動使用 setScrimColor(int) 和 setDrawerListener(DrawerListener) 方法作為 app:scrimColor 和 app:drawerListener 屬性的 setter
<android.support.v4.widget.DrawerLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:scrimColor="@{@color/scrim}"
app:drawerListener="@{fragment.drawerListener}">
Specify a custom method name
有些屬性的 setter 並不符合名稱，在這種情況下一個屬性可以藉由 BindingMethods 註解去連結一個 setter。
註釋與類別一起使用，可以包含多個 BindingMethod 註釋，每個註釋方法一個註釋。綁定方法可以添加到應用程序中任何類別的註釋。如下方範例
android:tint 屬性和 setImageTintList(ColorStateList) 方法結合，而不是和 setTint 方法結合。
@BindingMethods({
@BindingMethod(type = "android.widget.ImageView",
attribute = "android:tint",
method = "setImageTintList"),
}) 大多數情況下不需要重命名 setter。已使用名稱約定實現的屬性可自動查找相對應的方法。
Provide custom logic
有些屬性需要客製化綁定邏輯。例如 android:paddingLeft 屬性並沒有其相對應的 setter，代替的是 setPadding(left, top, right, bottom) 方法。
一個 static binding adapter 方法加上 BindingAdapter 註釋允許使用者自定義如何調用屬性的 setter。
Android framework 類別的屬性已經有 BindingAdapter 註釋。如下為 paddingLeft 屬性的 binding adapter
@BindingAdapter("android:paddingLeft")
public static void setPaddingLeft(View view, int padding) {
view.setPadding(padding,
view.getPaddingTop(),
view.getPaddingRight(),
view.getPaddingBottom());
} 參數的型態相當重要，第一個參數決定與屬性相關連的視圖型別。第二個參數確定給定屬性的綁定表達式所接受的型別。
Binding adapter 相當有用於其他客製化的類型。如一個客製化的 loader 可以從 worker thread 被呼叫用來讀取圖像。
當發生衝突時，使用者自定義的 binding adapter 會覆蓋過原先的 adapter。
也可以有多個 adapter 用來接收多個屬性。如下
@BindingAdapter({"imageUrl", "error"})
public static void loadImage(ImageView view, String url, Drawable error) {
Picasso.get().load(url).error(error).into(view);
} 如下，可以在 layout 使用 adapter。
注意 @drawable/venueError 參考到 App 中的資源。冒號包括住@{}的寫法為合法的綁定表達式。
<ImageView app:imageUrl="@{venue.imageUrl}" app:error="@{@drawable/venueError}" /> 注意 data binding library 會忽略自定義命名空間以進行匹配。
當 imageUrl 和 error 都被 ImageView 物件使用時，Adapter 將會被呼叫。
若想讓屬性其中之一被使用時就呼叫 adapter，可以設定 requireAll 為 false，如下
@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);
}
} Binding Adapter method 可以選擇在其處理程序中使用舊值。使用舊值和新值的方法應首先聲明屬性的所有舊值。如下
@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());
}
} Event handler 只能與帶有一個抽象方法的接口或抽象類別一起使用。如下
@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);
}
}
} 在 layout 中使用這個 event handler，如下
<View android:onLayoutChange="@{() -> handler.layoutChanged()}"/> 當偵聽器具有多個方法時，必須將其拆分為多個偵聽器。
例如 View.OnAttachStateChangeListener 有 2 個方法為 onViewAttachedToWindow(View) 和 onViewDetachedFromWindow(View)。就有 2 個介面去區分它們的 attribute 和 handler。
@TargetApi(VERSION_CODES.HONEYCOMB_MR1)
public interface OnViewDetachedFromWindow {
void onViewDetachedFromWindow(View v);
}
@TargetApi(VERSION_CODES.HONEYCOMB_MR1)
public interface OnViewAttachedToWindow {
void onViewAttachedToWindow(View v);
}
因為更改一個偵聽器也會影響另一個偵聽器，所以需要一個適用於任一屬性或適用於兩者的適配器。
可以透過設定 requireAll 為 false 表示並不是每個屬性都必須指定給表達式。
@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);
}
}
} 上面的示例比正常情況稍微複雜一些，因為 View 使用 addOnAttachStateChangeListener()和 removeOnAttachStateChangeListener()方法而不是 OnAttachStateChangeListener 的 setter 方法。
android.databinding.adapters.ListenerUtil 類別有助於跟踪以前的偵聽器，以便可以在綁定適配器中刪除它們。
藉由在 OnViewDetachedFromWindow 和 OnViewAttachedToWindow 方法加入 @TargetApi(VERSION_CODES.HONEYCOMB_MR1)，data binding library 只會在裝置運行為 Android3.1 或以上的版本產生 listener。
Object conversions
Automatic object conversion
從綁定表達式返回 Object 時，data binding library 會選擇用於設置屬性值的方法。Object 會被強制轉換為所選方法的參數類型。
在使用 ObservableMap 存儲數據的應用程序，此行為很方便，如以下示例所示
<TextView
android:text='@{userMap["lastName"]}'
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
也可以使用 object.key 的方式在 Map 中參考數值，如上例的 @{userMap["lastName"]} 可以使用 @{userMap.lastName} 來取代。
在表達式中的 userMap 會回傳一個數值，該數值將會被自動轉型為 setText(CharSequence) 方法的參數類型，該方法用來設定 android:text 屬型的値。
如果參數類型不明確，則必須在表達式中強制轉換返回類型。
Custom conversions
在某些情況下，特定類型之間需要自定義轉換。例如 android:background 需要 Drawable，但指定的顏色值是整數。
以下範例顯示需要 Drawable 的屬性，但是提供了一個整數
<View
android:background="@{isError ? @color/red : @color/white}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
每當需要 Drawable 並返回一個整數時，int 應該轉換為 ColorDrawable。可以使用帶有BindingConversion 註釋的靜態方法完成轉換，如下所示
@BindingConversion
public static ColorDrawable convertColorToDrawable(int color) {
return new ColorDrawable(color);
}
但是，綁定表達式中提供的值類型必須一致。不能在同一表達式中使用不同的類型，如下
<View
android:background="@{isError ? @drawable/error : @color/white}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
Orignal From: Binding adapters (綁定轉接器)
0 意見:
張貼留言