JetPack 组件之 DataBinding 详解

DataBinding 是谷歌官方推出的一个库，用于扩展 layout.xml 的功能，给 laytout 增加属性， layout 中的 View 可以使用这些属性，java 代码中可以设置这些属性，从而将 layout 和数据绑定起来。

一、基础用法

1.1 开启 DataBinding 配置

修改 build.gradle 文件：

android {
    ...
    dataBinding {
        enabled = true
    }
}

当引用一个开启了 DataBinding 配置的 Module 时，主 Module 也要开启 DataBinding 配置。

1.2 布局中的属性

<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}"/>
       <TextView 
       	   android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:text="@{user.lastName}"/>
   LinearLayout>
layout>

LinearLayout 标签内的是原始的 xml 布局，使用 DataBinding 时，需要在它外面再套一层 layout 标签，再给 layout 标签内添加一个 data 标签。在 data 标签内就可以通过 variable 标签声明 view 可引用的对象，即 layout 的属性。

如上述代码声明了 user 对象，在 TextView 中就可以通过 @{} 引用它的属性 @{user.firstName}。

快速转化：在根 ViewGroup 上，按 alt + 回车，就可以将该布局 convert to data binding layout。

1.2.1 数据对象

在 variable 标签中声明的对象需要添加 name、type 属性。name 就是名字，type 是类名，java.lang 中的类可以直接写类名称，如 String，其他类需要写类全名，如 com.example.User。

要访问到一个对象的属性，可以使用以下三种方式。DataBinding 会按 firstName、getFirstName()、firstName() 的顺序去寻找值。

// public
public class User {
  public String firstName;
  public String lastName;
}
// get属性名() 方法
public class User {
  private String firstName;
  private String lastName;
  
  public String getFirstName() {
    return firstName;
  }
  public String getLastName() {
    return lastName;
  }  
}
// 属性名() 方法
public class User {
  private String firstName;
  private String lastName;
  
  public String firstName() {
    return firstName;
  }
  public String lastName() {
    return lastName;
  }  
}

1.3 代码中的绑定

每个布局文件都会产生一个 binding 类，默认类名是布局文件名去除下划线再加上 Binding 后缀，如 activity_main.xml 的 binding 类是 ActivityMainBinding。存放于 /app/build/generated/source/apt/debug/.../databinding 目录下。（修改类名见 三）

推荐的方式是在 inflating layout 的时候去创建 binding，如下所示：

@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   ActivityMainBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_main);
   User user = new User("Test", "User");
   binding.setUser(user);
}

当在 Fragment、ListView/RecyclerView Adapter 中使用时，可以使用 inflate 方法：

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

1.4 binding 表达式语法

1.4.1 基础语法

binding 表达式可以使用 java 中的几乎所有语法（除了 this、super、new、泛型调用等）。

另有一些特殊语法，如下所示：

1. 非空判断符号 ??

   android:text="@{user.displayName ?? user.lastName}"
   

   相当于：

   android:text="@{user.displayName != null ? user.displayName : user.lastName}"
   

2. 非空检查

   binding 表达式取值时会进行非空判断，如果为空，则不进行下一步取值。

   如：

   android:text="@{String.valueOf(user.name)}，如果 user 为 null，显示 null
   android:text="@{String.valueOf(user.age)}，如果 user 为 null，显示 0

3. 集合

   <data>
   	<import type="android.util.SparseArray"/>
       <import type="java.util.Map"/>
       <import type="java.util.List"/>
       <variable name="list" type="List<String>"/>
       <variable name="sparse" type="SparseArray<String>"/>
       <variable name="map" type="Map<String, String>"/>
       <variable name="index" type="int"/>
       <variable name="key" type="String"/>
   data>
   …
   android:text="@{list[index]}"
   …
   android:text="@{sparse[index]}"
   …
   android:text="@{map[key]}"
   

   为了使 xml 的语法保持正确，不能使用左尖括号，如 List 要写作 List<String>。

   另外，@{map[key]} 可写作 @{map.key}。

4. 字面值

   在 @{} 中使用字面值，取决于 @{} 外部是什么。
   @{} 外部是 ‘’，则用 “” 来包围字面值。
   @{} 外部是 “”，则用 `` 来包围字面值。

   android:text='@{"firstName"}' 或 android:text="@{`firstName`}"

5. 资源

   android:padding="@{large? @dimen/largePadding : @dimen/smallPadding}"
   android:text="@{@string/nameFormat(firstName, lastName)}"
   

1.4.2 import、variables 和 include

import

import 可以使得在 binding 表达式、variable 标签中，可以引用某个类中的类方法、类变量。

如

<data>
    <import type="android.view.View"/>
data>

<TextView
   android:text="@{user.lastName}"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:visibility="@{user.isAdult ? View.VISIBLE : View.GONE}"/>

在 visibility 的 binding 表达式中，使用了 View.VISIBLE 和 View.GONE。如果不添加 import，是无法编译成功的。

如

<data>
    <import type="com.example.User"/>
    <import type="java.util.List"/>
    <variable name="user" type="User"/>
    <variable name="userList" type="List<User>"/>
data>

在 variable 的 type 中也可以直接使用 import 的类，而不用再引用全名。

别名

当 import 两个同名的类时，可以使用别名对它们进行区分。

<import type="android.view.View"/>
<import type="com.example.real.estate.View"
        alias="Vista"/>

Variables

variable 标签可以声明 binding 表达式中可使用的变量。

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

如果一个布局文件有多种配置（竖屏、横屏等），它们里面的 variable 会被合并，所以不能有冲突。

每个 variable 都会默认生成 getter、setter 方法。

每个 layout 文件都会自带一个 context 对象，它来自根 View 的 getContext() 方法。

Includes

binding 支持 include 标签，可以使用 bind 给 include 的布局传递 variable，如下所示：

<layout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:bind="http://schemas.android.com/apk/res-auto">
   <data>
       <variable name="user" type="com.example.User"/>
   data>
   <LinearLayout
       android:orientation="vertical"
       android:layout_width="match_parent"
       android:layout_height="match_parent">
       <include layout="@layout/name"
           bind:user="@{user}"/>
       <include layout="@layout/contact"
           bind:user="@{user}"/>
   LinearLayout>
layout>

但是不支持给 merge 标签加 layout 外壳。

<layout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:bind="http://schemas.android.com/apk/res-auto">
   <data>
       <variable name="user" type="com.example.User"/>
   data>
   <merge>
       <include layout="@layout/name"
           bind:user="@{user}"/>
       <include layout="@layout/contact"
           bind:user="@{user}"/>
   merge>
layout>

1.4.3 事件处理

有两种方式可以进行事件处理：方法引用和监听器绑定

方法引用

事件可以直接绑定到处理器的方法上。

public class MyHandlers {
    public void onClickFriend(View view) { ... }
}

<layout xmlns:android="http://schemas.android.com/apk/res/android">
   <data>
       <variable name="handlers" type="com.example.MyHandlers"/>
       <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:onClick="@{handlers::onClickFriend}"/>
   LinearLayout>
layout>

这和原生的 android:onClick="..." 的区别在于，原生的 onClick 方法只能在 Activity 中创建，且没有编译期的检查。binding 表达式 的 onClick 可以指定任意对象，并有编译期的检查。

监听器绑定

方法绑定只能把 View 传给某个方法，这个方法的参数、返回值都必须与事件监听器所需的一样。

监听器绑定可以使用任何的 binding 表达式，即它实现的是方法的内容。所以参数不一定跟事件监听器所需的一样，只需返回值一样即可。

如：

public class Presenter {
    public void onSaveClick(Task task){}
}

<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <variable name="task" type="com.android.example.Task" />
        <variable name="presenter" type="com.android.example.Presenter" />
    data>
    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent">
        <Button android:layout_width="wrap_content" android:layout_height="wrap_content"
        android:onClick="@{() -> presenter.onSaveClick(task)}" />
    LinearLayout>
layout>

这里的 () -> presenter.onSaveClick(task) 相当于监听器方法，而 presenter.onSaveClick(task) 已经是监听器方法里的实现。

所以也可以直接这样：

<TextView
	...
	android:onClick="@{(v) -> v.setVisibility(View.GONE)}"
	.../>

但是尽量不要把复杂的逻辑放在 binding 表达式中，这会带来阅读和维护的成本。

二、使用响应式数据对象

响应式对象，指的是，对象数据变化后，会通知其他对象自己的修改，从而执行一些特定逻辑，如 UI 的变更。

2.1 响应式字段

要实现响应式的效果，数据对象必须实现 Observable 接口（DataBinding 库中的接口），但对于一个简单的类这么做有点过于复杂，所以 DataBinding 库提供了一系列 ObservableXXX 类，如 ObservableBoolean、ObservableByte、ObservableChar、ObservableShort、ObservableInt、ObservableLong、ObservableFloat、ObservableDouble、ObservableParcelable、ObservableField<> 等。

它们使用 get()、set() 来取值和赋值。

实例：

private static class User {
    public final ObservableField<String> firstName = new ObservableField<>();
    public final ObservableField<String> lastName = new ObservableField<>();
    public final ObservableInt age = new ObservableInt();
}

<TextView
	...
	android:text="@{user.firstName}"
	.../>

现在，当我们调用 user.firstName.set("Google")，TextView 就会显示 Google。而不用再去调一遍 setText()。

2.2 响应式集合

ObservableArrayMap：

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
user.put("age", 17);

<data>
    <import type="android.databinding.ObservableMap"/>
    <variable name="user" type="ObservableMap"/>
data>
…
<TextView
    android:text="@{user.lastName}"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>
<TextView
    android:text="@{String.valueOf(1 + (Integer)user.age)}"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>

ObservableArrayList：

ObservableArrayList<Object> user = new ObservableArrayList<>();
user.add("Google");
user.add("Inc.");
user.add(17);

<data>
    <import type="android.databinding.ObservableList"/>
    <import type="com.example.my.app.Fields"/>
    <variable name="user" type="ObservableList