Android DataBinding双向绑定

建议参照源码观看，不然可能不知道在说什么TwoWaySample

单向绑定

当我们改变数据的时候，UI可以自动发生改变。

举一个EditText的例子

定义MyDataViewModel类继承ViewModel，使用可观察的变量提供可观察的数据。

class MyDataViewModel : ViewModel() {

    val name: ObservableField<String> = ObservableField()

    fun changeName() {
        name.set(name.get() + "_dmw")
    }

}

在布局文件中使用，将EditText的text属性绑定到viewModel的name属性

<data>
        <variable
            name="viewModel"
            type="com.example.android.databinding.twowaysample.data.MyDataViewModel" />
    </data>

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

        <EditText
            android:id="@+id/etText"
            android:layout_width="0dp"
            android:layout_height="48dp"
            android:layout_marginTop="40dp"
            android:background="#bdbdbd"
            android:gravity="center"
            android:text="@{viewModel.name}"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

         <Button
            android:id="@+id/btnChangeViewModel"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:onClick="@{()->viewModel.changeName()}"
            android:text="改变ViewModel的name属性"
            android:textAllCaps="false"
            app:layout_constraintTop_toBottomOf="@+id/etText" />

    </androidx.constraintlayout.widget.ConstraintLayout>

在activity中初始化MyDataViewModel对象并赋值给布局文件的viewModel变量。

override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val viewModel = ViewModelProvider(this).get(MyDataViewModel::class.java)

        val binding: ActivityBlogDemoBinding = DataBindingUtil.setContentView(this,
                R.layout.activity_blog_demo)
        binding.viewModel = viewModel
        binding.lifecycleOwner = this
    }

fun changeName() {
    name.set(name.get() + "_dmw")
}

我们调用MyDataViewModel的changeName方法改变_name的值，UI会自动跟着改变。但是如果我们直接改变EditText的text，那么对应的MyDataViewModel的_name的值会发生改变吗？我们试一试：

binding.btnChangeText.setOnClickListener {
        binding.etText.setText("Hello world")

        Log.d(TAG, "onCreate: binding.etText.text = " + binding.etText.text)
        Log.d(TAG, "onCreate: viewModel.name = " + viewModel.name.value)
}

输出结果可以看到，那么对应的MyDataViewModel的_name的值并不会发生变化。

D/BlogDemoActivity: onCreate: binding.etText.text = Hello world
D/BlogDemoActivity: onCreate: viewModel.name = Ada

我们如何实现当UI发生变化的时候，自动映射到数据变化呢？使用双向绑定。

双向绑定

当我们改变数据的时候，UI可以自动发生改变。当UI发生变化的时候，相应的数据也会发生改变。

数据绑定框架已经为常用的双向绑定属性和属性改变监听器提供了双向绑定的实现。android:text属性就是其中之一。下面我们使用android:text属性的双向绑定。修改EditText：

<EditText
            android:id="@+id/etText"
            android:layout_width="0dp"
            android:layout_height="48dp"
            android:layout_marginTop="40dp"
            android:background="#bdbdbd"
            android:gravity="center"
            android:text="@={viewModel.name}"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

注意变化的地方，使用的是@={}

android:text="@={viewModel.name}"

现在我们再直接改变EditText的text，看看对应的MyDataViewModel的name的值会是否会发生改变。

D/BlogDemoActivity: onCreate: binding.etText.text = Hello world
D/BlogDemoActivity: onCreate: viewModel.name = Hello world

可以看到，当UI发生变化当时候，数据也会跟着改变，这样就实现了双向绑定的功能。我们看一看TextViewBindingAdapter.java的实现。

public class TextViewBindingAdapter {
    
    private static final String TAG = "TextViewBindingAdapters";


    @BindingAdapter("android:text")
    public static void setText(TextView view, CharSequence text) {
        final CharSequence oldText = view.getText();
        Log.d(TAG, "setText: oldText = " + oldText + " , text = " + text);
        if (text == oldText || (text == null && oldText.length() == 0)) {
            return;
        }
        if (text instanceof Spanned) {
            if (text.equals(oldText)) {
                return; // No change in the spans, so don't set anything.
            }
        } else if (!haveContentsChanged(text, oldText)) {
            return; // No content changes, so don't set anything.
        }
        //注释1处，只有Text发生了变化，才会执行setText方法
        view.setText(text);
    }

    @InverseBindingAdapter(attribute = "android:text", event = "android:textAttrChanged")
    public static String getTextString(TextView view) {
        String s = view.getText().toString();
        Log.d(TAG, "getTextString: s = " + s);
        return s;
    }


    private static boolean haveContentsChanged(CharSequence str1, CharSequence str2) {
        if ((str1 == null) != (str2 == null)) {
            return true;
        } else if (str1 == null) {
            return false;
        }
        final int length = str1.length();
        if (length != str2.length()) {
            return true;
        }
        for (int i = 0; i < length; i++) {
            if (str1.charAt(i) != str2.charAt(i)) {
                return true;
            }
        }
        return false;
    }

}

首先定义了一个绑定适配器方法，当我们将数据绑定到EditText的android:text属性，会调用这个方法为text赋值。

@BindingAdapter("android:text")
public static void setText(TextView view, CharSequence text) {
    //...
    //注释1处，
    view.setText(text);
}

注意，我们是在经过一系列的判断之后，当tex发生变化的时候才调用EditText的setText方法。这是必须要注意的，否则会造成死循环。

然后定义了getTextString方法并使用了@InverseBindingAdapter注解，注解的属性是attribute = "android:text"，事件是"android:textAttrChanged"。当为EditText设置android:text属性的时候这个方法会被调用，并且会导致我们上面的绑定适配器方法setText(TextView view, CharSequence text)再次被调用，这也是为什么我们要在setText(TextView view, CharSequence text)中做判断避免死循环的原因。

@InverseBindingAdapter(attribute = "android:text", event = "android:textAttrChanged")
public static String getTextString(TextView view) {
    String s = view.getText().toString();
    Log.d(TAG, "getTextString: s = " + s);
    return s;
}

那么这两个方法到底是在那里被调用的呢？这里面涉及到数据绑定框架底层实现原理，暂时没时间研究，只是粗略的说一下。

在这个例子中，数据绑定框架为我们生成了一个类ActivityBlogDemoBindingImpl。我们看看其中的一些方法。

@Override
protected void executeBindings() {
    //...
    androidx.databinding.ObservableField<java.lang.String> viewModelName = null;
    java.lang.String viewModelNameGet = null;
    MyDataViewModel viewModel = mViewModel;


    //...
    viewModelName = viewModel.getName();
    //注释1处，获取name值
    viewModelNameGet = viewModelName.get();
    //注释2处
    TextViewBindingAdapter.setTextWatcher(this.etText, null, null, null,
             etTextandroidTextAttrChanged);
    //注释3处
    TextViewBindingAdapter.setText(this.etText, viewModelNameGet);
}

在执行绑定的时候，会调用executeBindings方法。
在注释1处，获取name的值。
注释2处给EditText添加text改变监听，我们待会再看。
注释3处，调用绑定适配器中的setText(TextView view, CharSequence text)方法给EditText设置text。当给EditText设置text以后，会回调到etTextandroidTextAttrChanged这个对象的onChange方法中。

注释2处，etTextandroidTextAttrChanged是一个InverseBindingListener类型的对象。

//注释2处
TextViewBindingAdapter.setTextWatcher(this.etText, null, null, null,
             etTextandroidTextAttrChanged);

private androidx.databinding.InverseBindingListener etTextandroidTextAttrChanged = new androidx.databinding.InverseBindingListener() {
    @Override
    public void onChange() {
        //注释1处，从EditText获取text值
        java.lang.String callbackArg_0 = androidx.databinding.adapters.TextViewBindingAdapter.getTextString(etText);
        // localize variables for thread safety
        // viewModel.name.get()
        java.lang.String viewModelNameGet = null;
        // viewModel.name != null
        boolean viewModelNameJavaLangObjectNull = false;
        // viewModel.name
        androidx.databinding.ObservableField<java.lang.String> viewModelName = null;
        // viewModel
        com.example.android.databinding.twowaysample.data.MyDataViewModel viewModel = mViewModel;
        // viewModel != null
        boolean viewModelJavaLangObjectNull = false;

        viewModelJavaLangObjectNull = (viewModel) != (null);
        if (viewModelJavaLangObjectNull) {
            //注释2处，获取name
            viewModelName = viewModel.getName();
            viewModelNameJavaLangObjectNull = (viewModelName) != (null);
            if (viewModelNameJavaLangObjectNull) {
                //注释3处
                viewModelName.set(((java.lang.String) (callbackArg_0)));
            }
        }
    }
};

注释1处，调用getTextString方法从EditText获取text值。这个方法就是我们使用@InverseBindingAdapter注解的方法。
注释2处，获取ViewModel中的name。
注释3处，为name重新赋值。

注意：这里为name重新赋值以后，绑定适配器方法setText(TextView view, CharSequence text)又会被调用，所以setText(TextView view, CharSequence text)方法要进行判断，只有新的text和oldText不一致的时候才调用EditText的setText方法。否则会发生死循环。

自定义属性使用双向绑定

自定义属性使用双向绑定，需要使用 @InverseBindingAdapter和@InverseBindingMethod注解。

使用@InverseBindingAdapter

例如，如果你想在一个自定义控件MyView中为一个自定义time属性启用双向绑定，请完成以下步骤。

使用@BindingAdapter注解设置和更新time属性的方法。

@BindingAdapter("time")
@JvmStatic fun setTime(view: MyView, newValue: String) {
    // Important to break potential infinite loops.
    if (view.time != newValue) {
        view.time = newValue
    }
}

在调用setTime方法更新值的时候，一定要注意判断，不要出现死循环。

使用@InverseBindingAdapter注解从MyView中获取自定义time属性值的方法。

@InverseBindingAdapter(attribute = "time", event = "timeAttrChanged")
@JvmStatic fun getTime(view: MyView) : Strings {
    return view.getTime()
}

InverseBindingAdapter注解的方法是用来从View中获取属性值的。如果不声明event类型类型的话，默认的event类型是属性名加上AttrChanged后缀。

现在，数据绑定框架知道一下两点：

当数据发生变化的时候调用@BindingAdapter("time")注解的方法。
当View的属性值(可以理解为UI)发生了改变的时候就调用 InverseBindingListener的onChange方法，内部会调用@InverseBindingAdapter("time")注解的方法来获取最新的属性值。

但是数据绑定框架还不知道属性何时会发生变化以及属性如何变化。为了让数据绑定框架知道，你需要为View设置一个监听器。这个监听器可以是一个自定义的监听器，或者是一个通用的事件，例如失去或者获得焦点、text发生改变等等。使用@BindingAdapter注解设置监听器的方法。

@BindingAdapter("app:timeAttrChanged")
@JvmStatic fun setListeners(
        view: MyView,
        attrChange: InverseBindingListener
) {
    // Set a listener for click, focus, touch, text change etc.
}

设置监听器的方法中传入了一个InverseBindingListener类型的参数。是为了使用InverseBindingListener来告诉数据绑定系统View的属性发生了变化。View的属性发生变化时，数据绑定系统会调用@InverseBindingAdapter注解的方法获取新的View属性值，赋值给数据。

最后，在布局文件里面，使用双向绑定即可。

<com.example.android.databinding.twowaysample.MyView
            android:id="@+id/myView"
            time="@={viewModel.time}"
 />

使用@InverseBindingMethod

@InverseBindingMethods(
        InverseBindingMethod(
                type = MyView::class,
                attribute = "time",
                event = "timeAttrChanged",
                method = "getTime"
        )
)
object MyBindingAdapters {

    //@InverseBindingAdapter不需要了
    //@InverseBindingAdapter(attribute = "time", event = "timeAttrChanged")
    @JvmStatic
    fun getTime(view: MyView): String? {
        val time = view.time
        Log.d(TAG, "getTime: time = " + time)
        return time
    }

}

我们使用@InverseBindingMethod注解，然后就不必使用@InverseBindingAdapter注解
getTime(view: MyView): String?方法了。

转换器（Converters）

如果一个绑定到View的变量在显示之前需要被格式化、被转换或者做一些改变，这时候就需要转换器了。

例如，一个TextView显示日期，官方举的例子是EditText，我感觉有点问题，我们可能无法正确输入日期。有兴趣的可以将TextView换成EditText试一试。

<TextView
   android:text="@={MyConverter.dateToString(viewModel.birthDate)}"
 />

viewModel.birthDate是Long类型的，而android:text需要的是字符串类型的值。所以viewModel.birthDate需要使用转换器转换成字符串。

在上面的例子中，我们使用dateToString方法将Long类型的值转化成字符串。因为我们是使用双向绑定，当View属性改变的时候，我们也需要改变viewModel.birthDate，所以我们也需要一个将字符串转化成Long类型的方法。需要使用 @InverseMethod，如下所示：

object MyConverter {

    private val format = SimpleDateFormat("yyyy-MM-dd", Locale.getDefault())

    @InverseMethod("stringToDate")
    @JvmStatic
    fun dateToString(value: Long): String {
        // Converts long to String.
        return format.format(value)
    }

    //dateToString对应的方法
    @JvmStatic
    fun stringToDate(
            value: String
    ): Long {
        // Converts String to long.
        return format.parse(value).time
    }
}

参考链接：

最后编辑于：2020.03.09 23:19:16

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 206,968评论 6赞 482
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 88,601评论 2赞 382
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 153,220评论 0赞 344
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 55,416评论 1赞 279
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 64,425评论 5赞 374
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 49,144评论 1赞 285
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 38,432评论 3赞 401
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,088评论 0赞 261
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 43,586评论 1赞 300
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,028评论 2赞 325
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,137评论 1赞 334
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 33,783评论 4赞 324
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 39,343评论 3赞 307
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,333评论 0赞 19
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 31,559评论 1赞 262
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 45,595评论 2赞 355
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 42,901评论 2赞 345