MVVM&Android实践(二):动态绑定

第二部分：动态绑定

DataBinding的强大之处在于，数据的变化会直接体现在界面上。如何达到这总效果呢？

DataBinding有三种数据变化的通知机制：Observable接口、ObservableFields接口以及observable collections。

Observable

实现android.databinding.Observable接口的类，可以允许开发人员添加一个监听器，用于监听对象属性变化。方便起见，DataBinding已经提供了一个继承了BaseObservable的类来实现这种机制。示例代码如下：

import androidx.databinding.BaseObservable;
import androidx.databinding.Bindable;

public class User extends BaseObservable {
    private String name;

    @Bindable
    public String getName() {
        return this.name;
    }

    public void setName(String str) {
        this.name = str;
        notifyPropertyChanged(BR.name); // 通知界面数据刷新
    }

    public User(String name){
        this.name = name;
    }
}

代码中，有四个重点：

• BaseObservable：接口android.databinding.Observable的实现，为动态绑定提供基础，如notifyPropertyChanged函数就来自于该类。
• @Bindable：动态绑定的注解类，实现动态绑定的基础，用 @Bindable 标记过 getter 方法会在 BR 中生成一个 entry。
• notifyPropertyChanged：通过调用该函数，通知系统 BR.name 这个 entry 的数据已经发生变化，需要更新 UI。
• BR：编译阶段生成的一个类，类似于Android的R类，暂时无需关心。

对应的xml文件：

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    
    <data>
        <import type="com.dali.mvvmdemo.User"/>
        <variable
            name="person"
            type="com.dali.mvvmdemo.User" />
    data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">

        <TextView
            android:id="@+id/tv_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{person.name}"
            app:layout_constraintTop_toTopOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintBottom_toBottomOf="parent"/>
    androidx.constraintlayout.widget.ConstraintLayout>
layout>

xml文件中，比较特别的就是:android:text="@{person.name}"这里的name在User类中是一个私有属性的变量，但在DataBinding框架的加持下，却能自由使用，你猜是怎么实现的呢？

来调用试试：

    private User user = new User("SuperLi");
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        final ActivityMainBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_main);
        binding.setPerson(user);
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(1000 * 3);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                user.setName("MrHeLi");
            }
        }).start();
    }

应用启动三秒钟后，界面上的TextView将会从显示SuperLi变为MrHeLi。

这就是第一种动态绑定，我们来小结一下：

• 继承BaseObservable对象。
• 在需要动态绑定的成员属性的getter函数上添加@Bindable注解。
• 在需要动态绑定的成员属性的setter函数中手动调用notifyPropertyChanged通知UI刷新数据。

ObservableFields

前一种绑定方式，需要改动的代码太多了。DataBinding框架定义了一些列基础类型，来使一个Object变得observable。这就是ObservableFields，它包含一些列和基础数据类型对应的observable类，以及ObservableField类。见下表：

基础数据类型	集合	其它类
ObservableBoolean	ObservableArrayList	ObservableField
ObservableByte	ObservableArrayMap	ObservableParcelable
ObservableChar	ObservableMap
ObservableDouble	ObservableList
ObservableFloat
ObservableInt
ObservableShort
ObservableLong

将上述数据类型放在我们Model中使用，动态绑定会显得非常简洁：

import androidx.databinding.ObservableField;
 
public class Employ {
    public final ObservableField<String> mName = new ObservableField<>();

    public Employ(String name) {
        mName.set(name);
    }
}

没错，就这样，没有setter、getter。只是改变ObservableXXXd对象的值时，需要改用mName.set(T)函数和mName.get()函数。xml文件和前面的也没什么不同：

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    
    <data>
        <variable
            name="employ"
            type="com.superli.mvvmdemo.Employ" />
    data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">

        <TextView
            android:id="@+id/tv_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{employ.mName}"
            app:layout_constraintTop_toTopOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintBottom_toBottomOf="parent"/>
    androidx.constraintlayout.widget.ConstraintLayout>
layout>

主函数调用：

    private Employ employ = new Employ("张三");

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
		// ...
        binding.setEmploy(employ);
        // ...
    }

observable collections

这里就说一下简单并且常用的集合类型ObserableArrayList、ObservableArrayMap，其它的类型请自行探索。它们的底层数据结构都是动态数组，存取数据的逻辑本质也就是维护动态数组。本文的初衷不是研究具体实现，源码方面就不展开了。

对于这两个类，它们的值都是通过键值对的形式提供，下面详细看看它们的使用。

ObserableArrayList

对于该类，搜索了一下各类技术博客，发现大家都在使用一套让人一头雾水的代码。本人行文尽量不要多余代码，让初通Android的人都能看懂。

初始化和赋值

ObservableArrayList<Object> obserUser = new ObservableArrayList<>();
obserUser.add("This is the first data"); // 填加一条数据
obserUser.add("This is the second data");
obserUser.set(1, "hahhah"); // 将第二个位置的数据改为"hahhah"
binding.setObservableUser(obserUser); // 绑定数据

ObserableArrayList常用的函数有：

返回值	原型	说明
boolean	add(T object)	添加一条数据
boolean	void add (int index, T object)	向index插入一条数据，index后的数据依次向后移一位
boolean	addAll(Collection collection)	将集合数据整体添加进对象
boolean	addAll (int index, Collection collection)	在指定位置插入集合
void	clear()	清除所有数据
T	remove(int index)	删除指定index的数据

当然，不止这些，想要了解更多，请移步

官网

或者自行查看源码。

在使用ObserableArrayList进行数据的增删改查时，请注意你要操作的当前Index是否真是存在，如果不存在将会发生运行时异常。Index随着数据的添加（调用add(T object)）函数而自增，所以，在操作Index前，请判断该Index是否存在。

在xml中的使用

先看代码：

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    
    <data>
        
        <import type="androidx.databinding.ObservableArrayList"/>
        <variable
            name="observableUser"
            type="ObservableArrayList<Object>" />
    data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">

        <TextView
            android:id="@+id/tv_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{observableUser[1]}"
            app:layout_constraintTop_toTopOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintBottom_toBottomOf="parent"/>

    androidx.constraintlayout.widget.ConstraintLayout>
layout>

这段xml代码中，有如下几点需要注意：

1. 标签导入ObservableArrayList包：前面在使用String时，我们并没有用到标签，是因为String类型默认已经导入。但ObservableArrayList并没有包含在默认导入的列表中，我们需要手动导入。

2. 声明ObservableArrayList变量名为observableUser：type="ObservableArrayList<Object>"这个地方有两个在Android中不常用的符号<和>，它们分别时xml中间中的< 和>符号，替换一下就是：type="ObservableArrayList