dataBinding数据绑定使用总结

概述

DataBinding是一个Android数据绑定库,使用此库可以使用声明性格式在xml中将布局的界面绑定到应用的数据源中,是MVVM框架的核心思想及工具。

一、基本使用

使用dataBinding主要包括如下几步:

  1. build配置
  2. layout布局改进
  3. 新建对应的viewModel
  4. 属性绑定

1. build配置

使用databinding首先需要打开databinding可用开关,即在build.gradle下添加如下代码:

android {
    dataBinding {
        enabled true
    }
}

2. layout布局进行改进

首先我们先写一个简单的布局文件,示例如下:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    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"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".mvvm.TestMvvmActivity">
    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

我们需要将此布局文件更改为如下内容:

<?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>
    </data>

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

        <TextView
            android:id="@+id/tv1"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

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

将布局使用<layout>标签包裹起来,然后添加<data>标签以添加对应的数据内容。
其实在Android Studio中,IDE可以自动帮助我们完成这一步的工作,选中需要转变的Viewgroup,然后点击command + enter键,即会触发下面的场景,点击convert to data binding layout即可自动生成上述类似布局:

databinding1.jpg

数据内容
<data>标签中需要填入的是数据内容,需要指定变量名称以及变量类型。可以填入单独的数据内容:

<variable
    name="name"
    type="String" />

同时也可以引入的ViewModel类等,此块内容在viewModel定义区会详细解释。

<data>中定义了数据类型之后便可以在控件中进行引用使用了,控件引用的话需要采用如下格式:

@{内容}

举例来说,如果上述例子中的TextVIew需要设置文本为name,则可以设置属性:

android:text="@{name}"

3. viewModel定义

viewModel是dataBinding的一个非常重要的部分,布局可以通过自定义ViewModel类去获取数据。示例如下:

class TestViewModel : ViewModel() {
    var text :String = "this is a test"
}

同时我们需要在activity中声明当前的新建一个ViewModel对象,同时通过dataBindingUtil来完成布局的设置,示例代码如下:

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        var binding: ActivityTestMvvmBinding =
            DataBindingUtil.setContentView(this, R.layout.activity_test_mvvm)
        binding.viewModel = TestViewModel()
    }

4. 数据绑定

在声明了ViewModel对象之后,我们需要在布局文件中进行数据绑定,首先要在<data>标签中设置ViewModel对象,示例如下(代码中对当前ViewModel声明了别名):

    <data>
        <import
            alias="testName"
            type="com.example.demowork1.mvvm.TestViewModel" />

        <variable
            name="viewModel"
            type="testName" />
    </data>

alias:别名标识,防止引入了两个名称相同的类而导致混乱

然后我们就可以在对应的控件上调用viewModel的属性了,示例如下:

<TextView
        ...
            android:text="@{viewModel.name}"
        ... />

二、事件处理

通过上述内容,我们能够通过viewModel实现单项数据的处理,那么如果对于像按钮这样的点击事件我们应当怎么去处理呢?其实处理方式和上述获取变量值相似,只不过需要去执行的是一个方法罢了。

1. 执行方法

我们首先在ViewModel中添加一个点击之后应该执行的方法:


class TestViewModel : ViewModel() {
    var name = "this is a test"
    fun showToast() {
        Toast.makeText(DemoApplication.mContext, "点击了文本", Toast.LENGTH_SHORT).show()
    }
    ...

然后我们可以直接在控件中直接调用:

<TextView
        ...
            android:onClick="@{() -> viewModel.showToast()}"
        ... />

2. 刷新UI

有时候我们可能会在事件触发中去刷新UI,我们很容易就会想到直接在ViewModel中设置方法更改属性就好了,例如:

class TestViewModel : ViewModel() {
    var name = "this is a test"
    var clickNum = 0
    fun showToast() {
        Toast.makeText(DemoApplication.mContext, "点击了文本", Toast.LENGTH_SHORT).show()
        clickNum++
    }
}

然后在布局文件中新设置一个TextView显示clickNum,示例如下:

    <androidx.constraintlayout.widget.ConstraintLayout
        ...>

        <TextView
            ...
            android:onClick="@{() -> viewModel.showToast()}"
            android:text="@{viewModel.name}" />

        <TextView
            ...
            android:text="@{String.valueOf(viewModel.clickNum)}" />

    </androidx.constraintlayout.widget.ConstraintLayout>

但是当我们写完之后却发现,这样当我们点击的时候Toast会在触发,但是UI却并没有刷新,显示这样写是不对的,那就继续查一下解决办法吧。

在查阅了文档之后,文档提醒我们对于需要有UI刷新的属性,最好使用LiveData这种类型来存储,使得在每次变化之后都去及时的更新UI。

LiveData 是一种可观察的数据存储器类。与常规的可观察类不同,LiveData 具有生命周期感知能力,意指它遵循其他应用组件(如 Activity、Fragment 或 Service)的生命周期。这种感知能力可确保 LiveData 仅更新处于活跃生命周期状态的应用组件观察者。

因此我们可以将上述代码修改为如下内容:

class TestViewModel : ViewModel() {
    var name = MutableLiveData<String>()
    var clickNum = MutableLiveData<Int>()
    fun showToast() {
        Toast.makeText(DemoApplication.mContext, "点击了文本", Toast.LENGTH_SHORT).show()
        clickNum.value = (clickNum.value ?: 0) + 1
    }

    init {
        name.value = "默认文案"
        clickNum.value = 0
    }
}

这样的话,我们再次点击文本,能够看到文本可以正常的刷新。

三、混合自定义属性

dataBinding提供了绑定适配器用来创建自定义属性:

@BindingAdapter("android:bgcolor")
fun setBgColor(view: TextView, color: Int) {
    view.setBackgroundColor(color)
}

可以通过@BindingAdapter注解设置自定义属性,然后设置方法实现具体的属性效果,然后就可以直接在View里调用:

android:bgcolor="@{viewModel.bgColor}"

有时可能需要存在有多个属性同时存在时才能够触发某些方法,这时可以采用多参数绑定适配器,示例如下:

@BindingAdapter(value = ["android:text","android:bgcolor"],requireAll = true)
fun setData(view: TextView,text:String,color: Int){
    view.setBackgroundColor(color)
    view.text = text
    view.textSize = 15f
}

requireAll参数决定何时使用此绑定适配器:

  • true:则必须同时存在定义的value属性时才能使用。
  • false:则缺少的属性为null,布尔值则为false,基本类型则为0,触发属性。

四、优缺点

优点:
  1. 减少了findViewById的重复操作.
  2. 数据解析在xml层上解决,数据解析能够更快,提高解析XML速度。
  3. 提供了双向绑定机制,当Model变化时,View也会自动变化,能够实现数据UI移植性。配合MVVM框架的使用更是比MVP框架提高了可维护性(解决了MVP中手动View和Model同步的问题)
缺点:
  1. 使得布局会变得更加复杂,不利于问题的排查
  2. 大模块中model也会很大,如果长期持有不释放内存,就会占用了较多的内存空间。
  3. 过度的数据双向绑定不利于代码复用。数据的双向绑定使得每个View都绑定了一个对应的model,不同模块的model不同,就不能够直接复用。

参考文档

官方网站

Demo示例

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容