数据绑定库生成用于访问布局的变量和视图的绑定类。生成的绑定类将布局变量与布局中的视图链接起来。绑定类的名称和包可以自定义。所有生成的绑定类都继承自ViewDataBinding类。

为每个布局文件生成绑定类。默认情况下,类的名称基于布局文件的名称,将其转换为Pascal大小写并向其添加Binding后缀。布局文件名是activity_main.xml,因此相应的生成类是ActivityMainBinding。此类包含布局属性(例如,用户变量)到布局视图的所有绑定,并知道如何为绑定表达式指定值。

创建一个绑定对象

在对布局进行inflate之后,应该很快创建绑定对象,以确保在使用布局中的表达式绑定到视图之前不会修改视图层次结构。将对象绑定到布局的最常用方法是使用绑定类上的静态方法。您可以通过使用绑定类的inflate()方法来扩展视图层次结构并将对象绑定到该层次结构,如以下示例所示:

1
2
3
4
5
@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  MyLayoutBinding binding = MyLayoutBinding.inflate(getLayoutInflater());
}

还有另外一个版本的inflate()方法,它除了LayoutInflater对象之外,还接受一个ViewGroup对象,如下例所示:

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

如果使用不同的机制对布局进行了inflate,则可以单独绑定,如下所示:

1
MyLayoutBinding binding = MyLayoutBinding.bind(viewRoot);

有时不能事先知道绑定类型。在这种情况下,可以使用DataBindingUtil类创建绑定,如以下代码段所示:

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

如果在FragmentListViewRecyclerView适配器中使用数据绑定项,则可能更喜欢使用绑定类或DataBindingUtil类的inflate()方法,如以下代码示例所示:

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

带Id的View

数据绑定库在绑定类中为每个在布局中具有ID的视图创建不可变字段。例如,数据绑定库从以下布局创建类型为TextViewfirstNamelastName字段。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<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没有必要,因为它们没有数据绑定,但仍有一些情况需要从代码访问视图。

变量

数据绑定库为布局中声明的每个变量生成访问器方法。例如,以下布局在绑定类中为变量userimage和注image的生成settergetter方法:

1
2
3
4
5
6
<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

与普通View不同,ViewStub对象从一个不可见的视图开始。当它们被显示或被明确告知要inflate时,它们会通过inflate另一个布局来替换自己的布局。

由于ViewStub从视图层次结构中消失,因此绑定对象中的视图也必须消失以允许垃圾回收声明。因为视图是最终的,所以ViewStubProxy对象取代了生成的绑定类中的ViewStub,使您可以在ViewStub存在时访问它,并在ViewStub inflate时访问inflate的视图层次结构。

inflate另一个布局时,必须为新布局建立绑定。因此,ViewStubProxy必须监听ViewStub OnInflateListener并在需要时建立绑定。由于在给定时间只能存在一个侦听器,因此ViewStubProxy允许您设置OnInflateListener,它在建立绑定后调用它。

立即绑定

当变量或可观察对象发生更改时,绑定计划在下一帧之前更改。但是,有时必须立即执行绑定。要强制执行,请使用executePendingBindings()方法。

高级绑定

动态变量

有时,特定的绑定类是未知的。例如,针对任意布局操作的RecyclerView.Adapter不知道特定的绑定类。它仍然必须在调用onBindViewHolde()方法期间分配绑定值。

在下面的例子中,RecyclerView绑定的所有布局都有一个item变量。 BindingHolder对象有一个getBinding()方法返回ViewDataBinding基类。

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

注意:数据绑定库在模块包中生成一个名为BR的类,其中包含用于数据绑定的资源的ID。在上面的示例中,库自动生成BR.item变量。

后台线程

您可以在后台线程中更改数据模型,只要它不是集合即可。数据绑定在评估期间本地化每个变量/字段以避免任何并发问题。

自定义绑定类名字

默认情况下,将根据布局文件的名称生成绑定类,以大写字母开头,删除下划线(_),大写以下字母,并为单词Binding添加后缀。该类放在模块包下的数据绑定包中。例如,布局文件contact_item.xml生成ContactItemBinding类。如果模块包是com.example.my.app,则绑定类放在com.example.my.app.databinding包中。

通过调整数据元素的class属性,可以重命名绑定类或将绑定类放在不同的包中。例如,以下布局在当前模块的数据绑定包中生成ContactItem绑定类:

1
2
3
<data class="ContactItem"></data>

您可以通过在类名前加一个句点来为不同的包生成绑定类。以下示例在模块包中生成绑定类:

1
2
3
<data class=".ContactItem"></data>

您还可以使用要在其中生成绑定类的完整包名称。以下示例在com.example包中创建ContactItem绑定类:

1
2
3
<data class="com.example.ContactItem"></data>