在Android中使用DataBinding(Kotlin)

本文主要介绍DataBinding在Android App中的使用方法。数据绑定是将“提供器”的数据源与“消费者”绑定并使其同步的一种通用技术。

1. Android应用程序使用数据绑定

1.1 介绍`DataBinding`

Android通过DataBinding提供了编写声明型布局的支持。这样可以最大程度简化布局和逻辑相关联的代码。

数据绑定要求修改文件，外层需要包裹一个layout布局。主要通过@{} 或 @={}语法把布局中的元素和表达式的引用写入到属性中。

<?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"
    xmlns:tools="http://schemas.android.com/tools">

    <data>
        <variable
            name="mainModel"
            type="me.ithome.jetpack.model.MainViewModel" />①
    </data>

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

        <TextView
            android:id="@+id/tv_userinfo"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{mainModel.userData.toString()}"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

        <Button
            android:id="@+id/button"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="56dp"
            android:onClick="@{(view) -> mainModel.getClick(view)}"
            android:text="@string/btn_getUserInfo"
            app:layout_constraintBottom_toTopOf="@+id/tv_userinfo"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintHorizontal_bias="0.498"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

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

①用户变量，定义了能在这个布局里面使用的属性和类
②常规布局

DataBinding会基于layout创建一个Binding class，这个类包含了布局属性(定义的变量)到相关视图的所有绑定，并且会为布局中的数据元素生成setter，生成的类的名称是基于layout的名称(驼峰命名，加上Binding后缀)。比如布局名是activity_main.xml，生成的类就是ActivityMainBinding。你能通过这个类去inflate布局和数据模型，也可以通过DataBindingUtil类。

DataBindingUtils加载布局

val mainBindingUtil = DataBindingUtil.setContentView<ActivityMainBinding>(this, R.layout.activity_main)
mainBindingUtil.lifecycleOwner = this

inflate加载布局(此方法也能用于RecyclerView, ViewPager)

val mainBindingUtil = ActivityMainBinding.inflate(layoutInflater)
setContentView(mainBindingUtil.root)

上述两种方法大家二选一，一般在Activity中我们都用第一种。

1.2 如何启用`DataBinding`

想要在Android App工程中使用databinding，只需要在app/build.gradle文件中设置如下代码：

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

1.3 `DataBinding`点击事件的处理

布局的处理除了数据的传递，还有点击事件的处理。使用方式和普通方法调用一样。比如我在MainViewModel.kt中定义了getClick方法

fun getClick(v: View) {
    //TODO
}

现在我想在Button点击的时候调用getClick方法，只需要在布局文件中添加下面的代码

android:onClick="@{(view) -> mainModel.getClick(view)}"

如果不需要参数，可以直接

android:onClick="@{() -> mainModel.getClick()}"

如果有其他参数，对应的添加参数列表

android:onClick="@{() -> mainModel.getClick(args)}"

其他比如onLongClick之类的处理都是同理。

1.4 `import`的使用

可以通过import的方式导入类，直接调用类的静态方法。

<data>
    <import type="me.ithome.jetpack.utils.StringUtils" />
    <variable
        name="mainModel"
        type="me.ithome.jetpack.model.MainViewModel" />
</data>

<TextView
   android:text="@{StringUtils.capitalize(mainModel.userData.name)}"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

1.5 数据实时刷新

当viewmodel的数据发生变化后，我们希望布局也同时刷新，有个非常简单的方法，不需要继承BaseObservable，我们通过引入LiveData来实现。

open class MainViewModel : ViewModel() {

    var userData: MutableLiveData<UserInfo> = MutableLiveData()

    init {
        getUserInfo()
    }

    private fun getUserInfo() {
        val user = UserInfo("李四", (10..50).random())
        userData.postValue(user)   //数据发生变化后，调用postValue，无需通过observe监听，布局数据会自动刷新
    }

    fun getClick(v: View) {
        getUserInfo()
    }
}

1.6 使用`BindingAdapter`

可以通过BindingAdapter这个注解来实现属性值变化的时候，控件状态也跟着变化，比如图片ImageView，当url变化的时候，控件会跟着显示不同的图片。

需要在静态类里面定义一个静态方法:

object StringUtils {

    @BindingAdapter("android:src")
    @JvmStatic fun loadImage(view: ImageView, url: String) {
        MyApplication._context?.let {
            Glide.with(it)
                .load(url)
                .into(view)
        }
    }
}

注意这里的android:src，这个可以直接指定控件的属性，也可以自己定义属性。

<ImageView
            android:id="@+id/imageView"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@+id/tv_userinfo"
            android:src="@{mainModel.imageUrl}"
            tools:srcCompat="@tools:sample/avatars" />

loadImage方法绑定的是android:src这个属性，所以当这个属性的值变化时会把view和url传递到loadImage。

如果是绑定的自定义字段呢？比如我现在绑定了一个自定义的url。

@BindingAdapter("url")
@JvmStatic fun loadImage(view: ImageView, url: String) {
...
}

那么布局文件就这么写

<ImageView
            android:id="@+id/imageView"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@+id/tv_userinfo"
            app:url="@{mainModel.imageUrl}"
            tools:srcCompat="@tools:sample/avatars" />

总结

前面主要是写了databinding的一些基本用法，扩展用法还比较多，我们后续再接着说。

1. Android应用程序使用数据绑定

1.1 介绍DataBinding

1.2 如何启用DataBinding

1.3 DataBinding点击事件的处理

1.4 import的使用