使用可观察数据对象

可观察性 指的是对象能够在自身数据发生变化时通知其他对象的能力。数据绑定库允许您使对象、字段或集合可观察。

您可以使用任何对象进行数据绑定，但修改对象不会自动导致 UI 更新。您可以使用数据绑定赋予您的数据对象通知其他对象（称为监听器）其数据发生变化的能力。可观察类有三种类型：字段、集合 和 对象。

当这些可观察数据对象之一绑定到 UI 并且数据对象的一个属性发生变化时，UI 会自动更新。

可观察字段

如果您的类只有几个属性，创建实现 Observable 接口的类可能不值得。在这种情况下，您可以使用泛型 Observable 类和以下特定于原语的类来使字段可观察

• ObservableBoolean
• ObservableByte
• ObservableChar
• ObservableShort
• ObservableInt
• ObservableLong
• ObservableFloat
• ObservableDouble
• ObservableParcelable

可观察字段是自包含的可观察对象，它们只有一个字段。原语版本在访问操作期间避免装箱和拆箱。要使用此机制，在 Java 编程语言中创建一个 public final 属性，或在 Kotlin 中创建一个只读属性，如以下示例所示

class User {
    val firstName = ObservableField<String>()
    val lastName = ObservableField<String>()
    val age = ObservableInt()
}

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

要访问字段值，请使用 set() 和 get() 访问器方法，或者使用 Kotlin 属性语法

user.firstName = "Google"
val age = user.age

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

可观察集合

一些应用使用动态结构来保存数据。可观察集合允许使用键访问这些结构。当键是引用类型（例如 String）时，ObservableArrayMap 类很有用，如下例所示

ObservableArrayMap<String, Any>().apply {
    put("firstName", "Google")
    put("lastName", "Inc.")
    put("age", 17)
}

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&lt;String, Object&gt;"/>
</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<Any>().apply {
    add("Google")
    add("Inc.")
    add(17)
}

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&lt;Object&gt;"/>
</data>
…
<TextView
    android:text='@{user[Fields.LAST_NAME]}'
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>
<TextView
    android:text='@{String.valueOf(1 + (Integer)user[Fields.AGE])}'
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>

可观察对象

实现 Observable 接口的类允许注册想要接收可观察对象属性更改通知的监听器。

Observable 接口提供了一种机制来添加和删除监听器，但您决定何时发送通知。为了简化开发，数据绑定库提供了 BaseObservable 类，该类实现了监听器注册机制。实现 BaseObservable 的数据类负责在属性更改时发出通知。为此，请将 Bindable 注释分配给 getter，并在 setter 中调用 notifyPropertyChanged() 方法，如下例所示

class User : BaseObservable() {

    @get:Bindable
    var firstName: String = ""
        set(value) {
            field = value
            notifyPropertyChanged(BR.firstName)
        }

    @get:Bindable
    var lastName: String = ""
        set(value) {
            field = value
            notifyPropertyChanged(BR.lastName)
        }
}

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

数据绑定在模块包中生成一个名为 BR 的类，其中包含用于数据绑定的资源 ID。Bindable 注释在编译期间在 BR 类文件中生成一个条目。如果数据类的基类无法更改，您可以使用 PropertyChangeRegistry 对象来实现 Observable 接口，以便有效地注册和通知监听器。

生命周期感知对象

您应用中的布局也可以绑定到数据绑定源，这些源会自动将数据更改通知 UI。这样，您的绑定将具有生命周期感知能力，并且只有在 UI 在屏幕上可见时才会触发。

数据绑定支持 StateFlow 和 LiveData。有关在数据绑定中使用 LiveData 的更多信息，请参阅 使用 LiveData 将数据更改通知 UI。

使用 StateFlow

如果您的应用使用带有 协程 的 Kotlin，您可以使用 StateFlow 对象作为数据绑定源。要将 StateFlow 对象与您的绑定类一起使用，请指定一个生命周期所有者来定义 StateFlow 对象的范围。以下示例在实例化绑定类后将活动指定为生命周期所有者

class ViewModelActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        // Inflate view and obtain an instance of the binding class.
        val binding: UserBinding = DataBindingUtil.setContentView(this, R.layout.user)

        // Specify the current activity as the lifecycle owner.
        binding.lifecycleOwner = this
    }
}

如 将布局视图绑定到架构组件 中所述，数据绑定与 ViewModel 对象无缝协作。您可以将 StateFlow 和 ViewModel 一起使用，如下所示

class ScheduleViewModel : ViewModel() {

    private val _username = MutableStateFlow<String>("")
    val username: StateFlow<String> = _username

    init {
        viewModelScope.launch {
            _username.value = Repository.loadUserName()
        }
    }
}

在您的布局中，使用绑定表达式将 ViewModel 对象的属性和方法分配给相应的视图，如下例所示

<TextView
    android:id="@+id/name"
    android:text="@{viewmodel.username}" />

无论何时用户姓名值发生更改，UI 都会自动更新。

禁用 StateFlow 支持

对于使用 Kotlin 和 AndroidX 的应用，数据绑定会自动包含 StateFlow 支持。这意味着，如果您的应用中不存在此依赖项，协程依赖项将自动包含在您的应用中。

您可以通过在 build.gradle 文件中添加以下内容来选择退出此功能

android {
    ...
    dataBinding {
        addKtx = false
    }
}

android {
    ...
    dataBinding {
        addKtx = false
    }
}

或者，您可以通过在 gradle.properties 文件中添加以下行来全局禁用 StateFlow

android.defaults.databinding.addKtx = false

android.defaults.databinding.addKtx = false

其他资源

要详细了解数据绑定，请参阅以下其他资源

示例

• Android 数据绑定库示例

Codelabs

• Android 中的数据绑定

博客文章

• 数据绑定——经验教训