Android，DataBinding的官方双向绑定

Posted 2023-03-29

参考技术A

在android Studio 2.1 Preview 3之后，官方开始支持双向绑定了。

可惜目前Google并没有在Data Binding指南里面加入这个教程，并且在整个互联网之中只有 这篇文章 介绍了如何使用反向绑定。

在阅读一下文章之前，我假设你已经知道如何正向绑定。

在正向绑定中，我们在Layout里面的绑定表达式是这样的：

当user.name的数据改动时，我们的TextView都会同步改变文字。

现在假设一种情况，当你更换成EditText时，如果你的用户名User.name已经绑定到 EditText 中，当用户输入文字的时候，你原来的user.name数据并没有同步改动，因此我们需要修改成：

看出微小的差别了吗？对，就是"@"改成了"@="，是不是很简单？

同样你也可以在别的View上引用属性：

当CheckBox的状态发生改变的时候，ImageView也会同时发生改变。在复杂情况下，这个特性没什么卵用，因为逻辑部分我们是不建议写在XML中。

开启双向绑定，需要在项目的build.gradle中设置：

同样，你需要在你Module的build.gradle中设置：

我们刚才的例子里面只显示了系统自带的应用，那么如果是自定义控件，或者是我们更细颗粒度的 Observable 呢？等下就揭晓如何自定义自己的双向绑定，我们来看看目前Android支持的控件：

设想一下我们使用了下拉刷新 SwipeRefreshLayout 控件，这个时候我们希望在加载数据的时候能控制refreshing的状态，所以我们加入了 ObservableBoolean 的变量swipeRefreshViewRefreshing来正向绑定数据，并且能够在用户手动下拉刷新的时候同步更新swipeRefreshViewRefreshing数据：

接下来我们需要告诉框架，我们需要将 SwipeRefreshLayout 的isRefreshing的值反向绑定到 swipeRefreshViewRefreshing ：

这是一种简单的定义，其中event和method都不是必须的，因为系统会自动生成，写出来是为了更好地了解如何绑定的，可以参考官方文档 InverseBindingMethod 。

当然你也可以使用另外一种写法，并且如果你的值并不是直接对应 Observable 的值的时候，就可以在这里进行转换：

上面的event同样也不是必须的。以上的定义都是为了让我们能够在布局文件中使用"@="这个双向绑定的特性。接下来你需要告诉框架如何处理refreshingAttrChanged事件，就像处理一般的监听事件一样：

一般情况下，我们都需要设置正常的OnRefreshListener，所以我们可以合并写成：

现在我们终于可以使用双向绑定的技术啦。但是要注意，需要设置 requireAll = false ，否则系统将识别不了refreshingAttrChanged属性，前文提到的文章例子里并没有设置这个。

在ViewModel中，我们的数据是这样的：

在布局文件中是这样设置的：

最后我们还有一个小问题，就是双向绑定有可能会出现死循环，因为当你通过Listener反向设置数据时，数据也会再次发送事件给View。所以我们需要在设置一下避免死循环：

这样就没问题啦。

Android jetpack Databinding 双向绑定

1、比较麻烦的方式

新建user类

package com.anguomob.jecpack.bean

data class User(var userName:String)

新建viewModel 继承自BaseObservable

package com.anguomob.jecpack.viewmodel

import android.util.Log
import androidx.databinding.BaseObservable
import androidx.databinding.Bindable
import androidx.databinding.library.baseAdapters.BR
import com.anguomob.jecpack.bean.User

class UserViewModel : BaseObservable() 
    private lateinit var user: User
    private val TAG = "UserViewModel"

    init 
        this.user = User("Jack")
    

    //数据发生变化 就会更新
    @Bindable
    fun getUserName(): String 
        return user.userName
    

    fun setUserName(userName: String) 
        if (userName != null && userName != "" && userName != user.userName) 
            user.userName = userName;
            Log.e(
                TAG, "setUserNmae: $userName"
            )
            notifyPropertyChanged(BR.userName)

        

    

布局

<?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="userViewModel"
            type="com.anguomob.jecpack.viewmodel.UserViewModel" />
    </data>

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

        <EditText
            android:id="@+id/editTextTextPersonName"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:ems="10"
            android:inputType="textPersonName"
            android:text="@=userViewModel.userName"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

代码

package com.anguomob.jecpack.activity

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.databinding.DataBindingUtil
import com.anguomob.jecpack.R
import com.anguomob.jecpack.databinding.ActivityDatabindingAdapterBinding
import com.anguomob.jecpack.databinding.ActivityTwoWayBindingBinding
import com.anguomob.jecpack.viewmodel.UserViewModel

class TwoWayBindingActivity : AppCompatActivity() 
    private lateinit var binding: ActivityTwoWayBindingBinding
    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        binding= DataBindingUtil.setContentView(this, R.layout.activity_two_way_binding)
        binding.userViewModel= UserViewModel()
    

当输入框输入文字后。也会打印出来对应tag

所以双向绑定完成

2、简单方式

 

package com.anguomob.jecpack.viewmodel

import android.util.Log
import androidx.databinding.BaseObservable
import androidx.databinding.Bindable
import androidx.databinding.ObservableField
import androidx.databinding.library.baseAdapters.BR
import com.anguomob.jecpack.bean.User

class UserViewModel2 
    private lateinit var userObservableField: ObservableField<User>
    private  val TAG = "UserViewModel2"
    init 
        userObservableField = ObservableField();
        userObservableField.set(User("jack"))
    

    fun getUserName(): String? 
        return userObservableField.get()?.userName;
    

    fun setUserName(userName: String) 
        Log.e(
            TAG, "setUserNmae: $userName"
        )
        userObservableField.get()?.userName = userName;
    

布局

<?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="userViewModel"
            type="com.anguomob.jecpack.viewmodel.UserViewModel2" />
    </data>

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

        <EditText
            android:id="@+id/editTextTextPersonName"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:ems="10"
            android:inputType="textPersonName"
            android:text="@=userViewModel.userName"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

页面

package com.anguomob.jecpack.activity

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.databinding.DataBindingUtil
import com.anguomob.jecpack.R
import com.anguomob.jecpack.databinding.ActivityDatabindingAdapterBinding
import com.anguomob.jecpack.databinding.ActivityTwoWayBindingBinding
import com.anguomob.jecpack.viewmodel.UserViewModel
import com.anguomob.jecpack.viewmodel.UserViewModel2

class TwoWayBindingActivity : AppCompatActivity() 
    private lateinit var binding: ActivityTwoWayBindingBinding
    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        binding= DataBindingUtil.setContentView(this, R.layout.activity_two_way_binding)
        binding.userViewModel= UserViewModel2()
    

更为简单。