Data Binding Library

导航：

• 搭建环境
• 数据绑定编译器V2
• 数据绑定布局文件
  • 编写你的第一套数据绑定表达式
  • 数据对象
  • 绑定数据
  • 事件处理
    • 方法参考
    • 监听器绑定
• 布局细节
  • imports
  • variables
  • 自定义绑定类名称
  • includes
  • 表达式语言
• 数据对象(重点)
  • 可观察的对象
  • 可观察的字段
  • 可观察的集合
• 生成绑定
  • 创建
  • 带有ID的视图
  • 变量
  • ViewStubs
  • 高级绑定
• 属性setters
  • 自动setters
  • 重命名Setters
  • 自定义setters
• 转换器
  • 对象转换
  • 自定义转换
• Android Studio支持数据绑定

本文档解释了如何使用数据绑定库来编写声明式布局，并尽量减少绑定应用程序逻辑和布局所需的胶合代码。

数据绑定库提供了灵活性和广泛的兼容性 - 这是一个支持库，所以你可以在Android 2.1（API级别7+）的所有Android平台上使用它。

要使用数据绑定，Android Plugin for Gradle 1.5.0-alpha1 或更高版本是必需的。了解如何更新Android Plugin for Gradle。

1.配置环境

---

要开始使用数据绑定，请从Android SDK管理器的支持库中下载库。

要配置应用程序以使用数据绑定，请将dataBinding 元素添加到应用程序模块中的build.gradle文件中。

使用下面的代码片段来配置数据绑定：

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

如果您的应用程序模块依赖于使用数据绑定的库，则您的应用程序模块也必须在其build.gradle 配置数据绑定。

另外，请确保您使用的是Android Studio的兼容版本。Android Studio 1.3及更高版本支持数据绑定，如Android Studio支持数据绑定中所述。

2.数据绑定编译器V2

---

Android Gradle插件3.1.0 Canary 6附带一个可选的新编译器。要开始使用它，请更新您的gradle.properties文件以包含以下行：

android.databinding.enableV2=true

在编译器v2中：

• ViewBinding类是在java编译器之前由Android Gradle Plugin生成的。这可以避免由于不相关的原因导致java编译失败而导致太多的错误肯定错误。
• 在V1中，编译应用程序时会重新生成库的绑定类（以共享生成的代码并访问最终的“BR”和“R”文件）。在V2中，库保持其生成的绑定类以及映射器信息，这为多模块项目显着提高了数据绑定性能。

请注意，这个新的编译器是向后不兼容的，所以用v1编译的库不能被v2使用，反之亦然。

V2还会删除一些很少使用的功能来允许这些更改：

• 在V1中，一个应用程序能够提供绑定适配器，可以覆盖依赖项中的适配器。在V2中，它只对自己的模块/应用程序及其依赖项中的代码生效。
• 以前，如果一个布局文件在两个或多个不同的资源配置中包含一个 View具有相同id但不同类的数据，则数据绑定将查找最常见的父类。View当配置之间的类型不匹配时，它将始终默认为。
• 在V2中，不同的模块不能在清单中使用相同的包名称，因为数据绑定将使用该包名来生成绑定映射器类。

3.数据绑定布局文件

---

3.1编写你的第一套数据绑定表达式

数据绑定布局文件稍有不同，layout作为根标签，后跟data 元素和 view根元素。示例文件如下所示：

data标签中的user变量,描述了可以在布局中使用的属性。

布局中的使用@{}语法表达式写入属性。在这里，TextView的文本被设置为用户的firstName属性：

Data Object

3.2 数据对象

现在让我们假设你有一个普通的Java对象（PO​​JO）用户：

public class User {
   public final String firstName;
   public final String lastName;
   public User(String firstName, String lastName) {
       this.firstName = firstName;
       this.lastName = lastName;
   }
}

这种类型的对象的数据永远不会改变。在应用程序中通常会读取一次数据，之后再也不会更改。也可以使用JavaBeans对象：

public class User {
   private final String firstName;
   private final String lastName;
   public User(String firstName, String lastName) {
       this.firstName = firstName;
       this.lastName = lastName;
   }
   public String getFirstName() {
       return this.firstName;
   }
   public String getLastName() {
       return this.lastName;
   }
}

从数据绑定的角度来看，这两个类是等价的。@{user.firstName}用于TextView android:text属性的表达式将访问前一类中的firstName字段和后一类中的getFirstName()方法。或者，如果firstName()方法存在，也将被解析。

3.3 绑定数据

默认情况下，将根据布局文件的名称生成一个Binding类，将其转换为Pascal格式并将Binding后缀添加到该文件中。上面的布局文件是main_activity.xml这样的生成类是MainActivityBinding。这个类将布局属性（例如user变量）的所有绑定保存到布局的视图中，并知道如何为绑定表达式赋值。创建绑定的最简单方法是在inflating时进行：

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

你完成了！运行应用程序，你会看到用户界面中的测试user。或者，您可以通过以下方式获取视图：

MainActivityBinding binding = 
MainActivityBinding.inflate(getLayoutInflater());

如果您在ListView或RecyclerView适配器内使用数据绑定项目，则可能更愿意使用：

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

3.4 事件处理

数据绑定允许您编写表达式来处理从视图中分派的事件（例如onClick）。除少数例外，事件属性名称由侦听器方法的名称来管理。View.OnLongClickListener 有一个方法 onLongClick()，所以这个事件的属性是android:onLongClick。处理事件有两种方法。

• 方法引用：在你的表达式中，你可以引用符合侦听器方法签名的方法。当表达式评估为方法引用时，数据绑定将方法引用和所有者对象包装在侦听器中，并将该侦听器设置在目标视图上。如果表达式求值为null，则数据绑定不会创建侦听器，而是设置空侦听器。
• 监听器绑定：这些是在事件发生时被评估的lambda表达式。数据绑定总是创建一个监听器，它在视图上设置。事件发送时，监听器评估lambda表达式。

3.4.1方法引用

事件可以直接绑定到处理方法，类似于 android:onClick可以分配给Activity中的方法。与View#onClick属性相比，一个主要的优点是表达式在编译时被处理，所以如果方法不存在或者它的签名不正确，你会收到一个编译时错误。

方法引用和监听器绑定的主要区别在于实际的监听器实现是在绑定数据时创建的，而不是在事件触发时创建的。如果您喜欢在事件发生时评估表达式，则应该使用监听器绑定。

要将事件分配给其处理程序，请使用常规绑定表达式，其值是要调用的方法名称。例如，如果你的数据对象有两个方法：

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

绑定表达式可以为View分配一个点击监听器：

请注意，表达式中方法的签名必须与Listener对象中方法的签名完全匹配

3.4.2监听器绑定

监听器绑定是事件发生时运行的绑定表达式。它们类似于方法引用，但是它们允许您运行任意的数据绑定表达式。此功能适用于Gradle 2.0版及更高版本的Android Gradle插件。

在方法引用中，方法的参数必须与事件侦听器的参数匹配。在监听器绑定中，只有你的返回值必须与监听器的期望返回值相匹配（除非它预期为void）。例如，您可以有一个具有以下方法的演示者类：

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

然后你可以如下绑定点击事件：

监听器仅允许只允许由lambda表达式作为根元素的表达式。在表达式中使用回调函数时，数据绑定会自动为事件创建必要的侦听器和注册表。当视图触发事件时，数据绑定将评估给定的表达式。就像在常规的绑定表达式中一样，当这些监听器表达式被评估的时候，你仍然可以获得数据绑定的null和线程安全性。

请注意，在上面的例子中，我们没有定义view传入参数onClick(android.view.View)。监听器绑定为监听器参数提供了两个选择：您可以忽略该方法的所有参数或将其全部命名。如果您想要命名参数，则可以在表达式中使用它们。例如，上面的表达式可以写成：

  android:onClick="@{(view) -> presenter.onSaveClick(task)}"

或者如果你想使用表达式中的参数，它可以如下工作：

public class Presenter {
    public void onSaveClick(View view, Task task){}
}

---

android:onClick="@{(theView) -> presenter.onSaveClick(theView, task)}"

您可以使用多于一个参数的lambda表达式：

public class Presenter {
    public void onCompletedChanged(Task task, boolean completed){}
}
------
 

如果正在侦听的事件返回一个其类型不是void的值，则表达式必须返回相同类型的值。例如，如果要监听长按事件，则应该返回表达式boolean。

public class Presenter {
    public boolean onLongClick(View view, Task task){}
}
--------
android:onLongClick="@{(theView) -> presenter.onLongClick(theView, task)}"

如果由于是null对象而无法评估表达式，Data Binding将返回该类型的默认Java值。例如，null返回引用类型，0返回 int， false返回 boolean等。

如果您需要使用谓词（例如三元）表达式，则可以将 void用作符号。

android:onClick="@{(v) -> v.isVisible() ? doSomething() : void}"

避免复杂的监听

监听器表达式非常强大，可以让你的代码非常容易阅读。另一方面，包含复杂表达式的监听会使您的布局难以阅读和维护。这些表达式应该像从UI中传递可用数据到回调方法一样简单。您应该在您从侦听器表达式调用的回调方法内实现任何业务逻辑。

存在一些专门的单击事件处理程序，它们需要一个属性， android:onClick以避免冲突。已经创建了以下属性以避免这种冲突：

class	Listener Setter	Attribute
SearchView	setOnSearchClickListener(View.OnClickListener)	android:onSearchClick
ZoomControls	setOnZoomInClickListener(View.OnClickListener)	android:onZoomIn
ZoomControls	setOnZoomOutClickListener(View.OnClickListener)	android:onZoomOut

4.布局细节

---

4.1 import

data元素中可以使用零个或多个import元素,这些就像在Java中一样可以轻松地引用布局文件中的类。

现在，可以在你的绑定表达式中使用视图：

当有类名冲突时，其中一个类可能会被重命名为“alias：”

现在，Vista可能会以com.example.real.estate.View，View可能以android.view.View在布局文件内引用。导入的类型可以用作变量和表达式中的类型引用：

注意：Android Studio尚未处理导入，因此导入变量的自动填充可能无法在您的IDE中工作。您的应用程序仍然可以正常编译，您可以通过在变量定义中使用完全限定的名称来解决IDE问题。

当在表达式中引用静态字段和方法时，也可以使用导入的类型：

    
    

…

就像在Java中一样，java.lang.*自动导入。

4.2 Variables

data元素内可以使用任意数量的variable元素，每个variable元素描述可以在布局上设置的属性，以用于布局文件中的绑定表达式。

变量类型在编译时被检查，所以如果一个变量实现Observable或者是一个observable collection，那么这个类型应该被反映出来。如果变量是不实现Observable接口的基类或接口，将不会观察变量！

当不同的配置文件（例如横向或纵向）有不同的布局文件时，变量将被合并。这些布局文件之间不得存在冲突的变量定义。
生成的绑定类将为每个描述的变量设置一个setter和getter。变量将采用默认的Java值，直到调用者被调用 - null是引用类型，0是 int，false是boolean等。

根据需要生成一个名为context的特殊变量用于绑定表达式。context是视图的getContext()得到的Context。context变量将被具有该名称的显式变量声明覆盖。

4.3自定义绑定类名称

默认情况下，根据布局文件的名称生成一个Binding类，以大写字母开头，删除下划线（_）并大写下面的字母，然后后缀“Binding”。这个类将被放置在模块包下的数据绑定包中。例如，布局文件contact_item.xml将生成 ContactItemBinding。如果模块包是 com.example.my.app，那么它将被放入com.example.my.app.databinding。

绑定类可以通过调整class元素的属性来重命名或放置data在不同的包中。

    ...

这将在模块包中的数据绑定包中生成绑定类ContactItem。如果该类应该在模块包中的其他包中生成，则可以用.作为前缀：

    ...

在这种情况下，ContactItem直接在模块包中生成。如果提供完整的软件包，则可以在任何软件包中：

    ...

4.4 Includes

通过使用应用程序名称空间和属性的变量名，变量可以被传递到包含布局的包含绑定中：

在这里，name.xml和contact.xml布局文件中都必须有一个user变量。

数据绑定不支持include作为merge元素的直接子元素。例如，不支持以下布局：

4.5 1. 表达式语言

共同特征

表达式语言看起来很像Java表达式。这些是一样的：

• 数学的: + - / * %
• 字符串连接: +
• 逻辑: && ||
• 二进制: & | ^
• 一元: + - ! ~
• 转移: >> >>> <<
• 对照: == > < >= <=
• instanceof
• 分组: ()
• 文字 - 字符，字符串，数字， null
• Cast
• 方法调用
• 字段访问
• 数组访问 []
• 三元操作符 ?:

例子：

android:text="@{String.valueOf(index + 1)}"
android:visibility="@{age < 13 ? View.GONE : View.VISIBLE}"
android:transitionName='@{"image_" + id}

不支持的操作

您可以在Java中使用的表达式语法中缺少一些操作。

• this
• super
• new
• 明确的泛型调用

空合并运算符

null合并运算符（??）选择左操作数（如果不是null）或右（如果为空）。

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

这在功能上等同于：

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

属性引用

第一个已经在上面的编写第一个数据绑定表达式中讨论过了：简短形式的JavaBean引用。当一个表达式引用一个类的属性时，它对字段，获取器和ObservableFields使用相同的格式。

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

避免空指针异常

生成的数据绑定代码自动检查空值并避免空指针异常。例如，在 @{user.name}表达式中如果user为null， user.name将被赋予其默认值（null）。如果你是引用user.age，年龄是一个int，那么它将默认为0。

集合

公共集合：数组，列表，稀疏列表和地图，为了方便可以使用[]操作符。

    
    
    
    
    
    
    
    

…
android:text="@{list[index]}"
…
android:text="@{sparse[index]}"
…
android:text="@{map[key]}"

字符串文字

在属性值周围使用单引号时，在表达式中使用双引号很容易：

android:text='@{map["firstName"]}'

也可以使用双引号来包围属性值。这样做时，字符串文字应该使用'或者反引号( ` )。

android:text="@{map[`firstName`}"
android:text="@{map['firstName']}"

资源

使用正常语法可以将资源作为表达式的一部分进行访问：

android:padding="@{large? @dimen/largePadding : @dimen/smallPadding}"

格式字符串和复数可以通过提供参数来评估：

android:text="@{@string/nameFormat(firstName, lastName)}"
android:text="@{@plurals/banana(bananaCount)}"

当一个复数有多个参数时，所有参数都应该传递：

  Have an orange
  Have %d oranges

android:text="@{@plurals/orange(orangeCount, orangeCount)}"

有些资源需要明确的类型评估。

Type	Normal Reference	Expression Reference
String[]	@array	@stringArray
int[]	@array	@intArray
TypedArray	@array	@typedArray
Animator	@animator	@animator
StateListAnimator	@animator	@stateListAnimator
color int	@color	@color
ColorStateList	@color	@colorStateList

5.数据对象

---

任何普通的旧Java对象（PO​​JO）都可以用于数据绑定，但修改POJO不会导致UI更新。数据绑定的真正威力可以通过给你的数据对象提供在数据改变时通知的能力。有三种不同的数据更改通知机制： 可观察对象， 可观察字段和 可观察集合。
当这些可观察的数据对象之一被绑定到UI并且数据对象的属性改变时，UI将被自动更新。

5.1可观察的对象

实现Observable接口的类将允许绑定将单个侦听器附加到绑定对象，以侦听该对象上所有属性的更改。

Observable接口具有添加和删除侦听器的机制，但通知由开发人员决定。为了简化开发，创建了一个BaseObservable基类来实现监听器注册机制。数据类实现者仍然负责通知属性何时更改，通过分配一个Bindable注释给getter并且在setter中使用通知来完成的。

private static class User extends BaseObservable {
   private String firstName;
   private String lastName;
   @Bindable
   public String getFirstName() {
       return this.firstName;
   }
   @Bindable
   public String getLastName() {
       return this.lastName;
   }
   public void setFirstName(String firstName) {
       this.firstName = firstName;
       notifyPropertyChanged(BR.firstName);
   }
   public void setLastName(String lastName) {
       this.lastName = lastName;
       notifyPropertyChanged(BR.lastName);
   }
}

生成编译期间Bindable注解在BR类文件中生成一个条目。而BR类文件将在模块包中生成。如果数据类的基类不能改变，那么Observable将会被实现，通过使用PropertyChangeRegistry去存储和有效地通知侦听器。

5.2 可观察字段

Observable类大有内涵，所以开发者想要节省时间和添加有几个属性，可以使用ObservableField和它的兄弟姐妹
ObservableBoolean，ObservableByte，ObservableChar，ObservableShort，ObservableInt，ObservableLong，ObservableFloat，ObservableDouble，和ObservableParcelable。

ObservableFields是具有单个字段的自包含可观察对象。原始版本在访问操作期间避免装箱和取消装箱。要使用，请在数据类中创建一个公共final字段：

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

就这么简单！要访问该值，请使用set和get访问器方法：

user.firstName.set("Google");
int age = user.age.get();

5.3 可观察的集合

一些应用程序使用更多的动态结构来保存数据,可观察集合允许对这些数据对象进行键控访问。当键是引用类型（如String）时ObservableArrayMap非常有用。

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

在布局中，可以通过String键访问map：

    
    

…

当键是一个整数时使用ObservableArrayList：

ObservableArrayList