DataBinding 初探

DataBinding

DataBinding是把数据直接绑定到 XML 文件上，并能实现自动刷新。减少了代码的耦合性，一些如 findViewById、setText 之类的操作都可以通过绑定实现。

基本用法

演示将User数据绑定到 XML 上的实现。

build.gradle配置

启用DataBinding非常简单，只需要在对应module的build.gradle配置即可。

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

在 XML 中绑定数据

创建布局文件，使用ALT + ENTER生成data binding layout。默认情况下，会根据 XML 文件的名称（将xml名称的小驼峰转为大驼峰命名，并加上 Binding后缀）在 <package name>.databinding 目录下生成文件。比如 package 名为 com.example.myapplication，那么会在 com.example.myapplication.databinding 下面生成文件。

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <!-- data的 class属性，可以用来给生成的文件指定名称。 data 标签下面的 variable 定义数据绑定用的实体类，type用来指定需要导入的类(需要完整包名)，
    name用来给 type的对象进行命名以给dataBinding使用。 -->
    
    <data class="TestBinding">
        
        <!-- 当在 XML 中数据绑定的时候，用到了 java.lang 之外的类，必须在 data 标签下面 import -->
        <import type="android.view.View" />
        
        <variable
            name="user"
            type="com.duode.dlog.test.bean.User" />
    </data>

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

         <!-- 用 @{} 来把数据绑定到 UI 上 -->
        <TextView
            android:id="@+id/tv_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.name}"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

        <!-- DataBinding中可以使用一些 运算符 和 表达式-->
        <TextView
            android:id="@+id/tv_age"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{String.valueOf(user.age)}"
            android:visibility="@{user.age==0 ? View.VISIBLE : View.GONE}"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@id/tv_name" />

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

注意：当import的类名相同，但包名不同时，可以使用在import使用alias属性，进行指定。

双向绑定

如果希望UI的变更也反应到对象上，那么就需要双向绑定了。其实双向绑定很简单，只需要加个 = 就好了。

<EditText
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:text="@={viewModel.firstName}"/>

View中实现DataBinding

有多种的实现DataBinding的方法。

• DataBindingUtil.setContentView
• DataBindingUtil.inflate
• DataBindingUtil.bind

Observable数据

对指定的数据实现观察者模式，当数据变化时自动刷新UI。

继承 BaseObservable

可以通过继承 BaseObservable来对指定的数据进行观察。

class BaseObservableUser() : BaseObservable() {

    @Bindable
    var name: String = ""
        set(value) {
            field = value
            // BR.name是编译后生成的唯一标识
            notifyPropertyChanged(BR.name)
        }

}

实现 Observable

由于 继承的类是唯一，有些时候我们需要自己去实现接口来观察数据。

class ObservableUser : Observable {

    private val registry = PropertyChangeRegistry()

    override fun addOnPropertyChangedCallback(callback: Observable.OnPropertyChangedCallback?) {
        registry.add(callback)
    }

    override fun removeOnPropertyChangedCallback(callback: Observable.OnPropertyChangedCallback?) {
        registry.remove(callback)
    }

    @Bindable
    var name: String = ""
        set(value) {
            field = value
            registry.notifyChange(this, BR.name)
        }
}

只对指定的属性数据进行观察

实体类的字段很多很多，为每个get/set方法都对应加上@Bindable注解和notifyPropertyChanged()方法太浪费时间
为解决这个问题，DataBinding提供了响应式对象。

基础数据

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

集合

• ObservableArrayList
• ObservableArrayMap

实现了Parcelable接口的对象提供的包装类

• ObservableParcelable

自定义类型

• ObservableField

自定义属性

可以通过使用BindingAdapter、BindingMethods来对XML中的属性进行自定义。

BindingAdapter

XML布局中实现ImageView直接指定需要加载的图片链接和加载失败时的默认图片。

    // BindingAdapter 的value表示需要在xml中使用的属性名称；requireAll默认true，表示所有指定的属性同时申明时方法才能生效
    @BindingAdapter("imageUrl", "error")
    // 这里的方法一定要是静态的
    @JvmStatic
    fun ImageView.loadImage(url: String, error: Int) {
        Glide.with(context).load(url).error(error).into(this)
    }

BindingMethods

XML布局中实现自定义的CustomImageView直接指定需要加载的图片资源。

@BindingMethods(value = [
    BindingMethod(type = CustomImageView::class, attribute =
    "loadImage",
        method = "setImage")]
)
class CustomImageView(ctx: Context, attrs: AttributeSet? = null) :
   AppCompatImageView(ctx, attrs) {

    fun setImage(res: Int) {
        setImageResource(res)
    }
}