產生的繫結類別

資料繫結程式庫會產生繫結類別,可用於存取版面配置的變數和檢視畫面。本文件說明如何建立及自訂產生的繫結類別。

產生的繫結類別會將版面配置變數與版面配置中的檢視畫面連結。您可以自訂繫結的名稱和套件。所有產生的繫結類別都會繼承 ViewDataBinding 類別。

系統會為每個版面配置檔案產生繫結類別。根據預設,類別名稱是版面配置檔案名稱轉換為 Pascal 命名法,並加上 Binding 後置字串。舉例來說,如果版面配置檔案名稱為 activity_main.xml,則對應產生的類別為 ActivityMainBinding。這個類別會保留從版面配置屬性到版面配置檢視畫面的所有繫結,並知道如何為繫結運算式指派值。

建立繫結物件

系統會在加載版面配置後立即建立繫結物件,確保檢視區塊階層在繫結至版面配置中含有運算式的檢視區塊之前,不會遭到修改。將物件繫結至版面配置最常見的方法,是使用繫結類別的靜態方法。您可以使用繫結類別的 inflate() 方法,加載檢視區塊階層並將物件繫結至該階層,如以下範例所示:

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

inflate() 方法有另一個版本,除了 LayoutInflater 物件外,還會採用 ViewGroup 物件,如以下範例所示:

Kotlin

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

Java

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

如果版面配置是使用其他機制加載,您可以單獨繫結,如下所示:

Kotlin

val binding: MyLayoutBinding = MyLayoutBinding.bind(viewRoot)

Java

MyLayoutBinding binding = MyLayoutBinding.bind(viewRoot);

有時您無法事先得知繫結類型。在這種情況下,您可以使用 DataBindingUtil 類別建立繫結,如以下程式碼片段所示:

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

如果您在 Fragment、ListView 或 RecyclerView 轉接器中使用資料繫結項目,建議您使用繫結類別或 DataBindingUtil 類別的 inflate() 方法,如以下程式碼範例所示:

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

含 ID 的檢視畫面

資料繫結程式庫會在繫結類別中,為版面配置中具有 ID 的每個檢視區塊建立不可變動的欄位。舉例來說,資料繫結程式庫會從下列版面配置建立 TextView 類型的 firstName 和 lastName 欄位:

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

程式庫會從檢視區塊階層中一次擷取檢視區塊,包括 ID。這種機制可能比為版面配置中的每個檢視畫面呼叫 findViewById() 方法更快。

ID 不像沒有資料繫結時那麼必要,但在某些情況下,仍需要透過程式碼存取檢視畫面。

變數

資料繫結程式庫會為版面配置中宣告的每個變數產生存取子方法。舉例來說,下列版面配置會在繫結類別中,為 user、image 和 note 變數產生 setter 和 getter 方法:

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

ViewStub

與一般檢視畫面不同,ViewStub 物件一開始是隱形檢視畫面。當它們設為可見或明確加載時,會加載另一個版面配置,並在版面配置中取代自身。

由於 ViewStub 會從檢視區塊階層中消失,因此繫結物件中的檢視區塊也必須消失,才能由垃圾收集機制回收。由於檢視畫面是最終版本,因此 ViewStubProxy 物件 會取代產生的繫結類別中的 ViewStub,讓您在 存在時 存取 ViewStub,並在 ViewStub 擴充時存取擴充的檢視畫面 階層。

加載其他版面配置時,必須為新版面配置建立繫結。因此,ViewStubProxy 必須監聽 ViewStub OnInflateListener,並在需要時建立繫結。由於一次只能有一個事件監聽器,ViewStubProxy 可讓您設定 OnInflateListener,並在建立繫結後呼叫。

立即繫結

當變數或可觀察物件變更時,繫結會排定在下一個影格之前變更。不過,有時必須立即執行繫結。如要強制執行,請使用 executePendingBindings() 方法。

動態變數

有時,特定繫結類別不明。例如,針對任意版面配置運作的 RecyclerView.Adapter 不知道特定繫結類別。在呼叫 onBindViewHolder() 方法時,必須指派繫結值。

在以下範例中,RecyclerView 繫結的所有版面配置都有 item 變數。BindingHolder 物件具有 getBinding() 方法,可傳回 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();
}

背景執行緒

只要資料模型不是集合,您就可以在背景執行緒中變更資料模型。資料繫結會在評估期間將每個變數或欄位本地化,避免發生任何並行問題。

自訂繫結類別名稱

根據預設,繫結類別會根據版面配置檔案的名稱產生,開頭為大寫字母,移除底線 ( _ ),將後續字母大寫,並加上 Binding 字詞。舉例來說,版面配置檔案 contact_item.xml 會產生 ContactItemBinding 類別。這個類別會放在模組套件下的 databinding 套件中。舉例來說,如果模組套件是 com.example.my.app,則繫結類別會放在 com.example.my.app.databinding 套件中。

您可以調整 data 元素的 class 屬性,重新命名繫結類別或將其置於不同的套件中。舉例來說,下列版面配置會在目前模組的 databinding 套件中,產生 ContactItem 繫結類別:

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

您可以在類別名稱前加上句號,在不同的套件中產生繫結類別。以下範例會在模組套件中產生繫結類別:

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

您也可以在要產生繫結類別的位置使用完整套件名稱。以下範例會在 com.example 套件中建立 ContactItem 繫結類別:

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

其他資源

如要進一步瞭解資料繫結,請參閱下列其他資源。