Jetpack之DataBinding

2021-04-25

DataBinding是可以用来实现MVVM的一种很合适的方案，可以极大的精简Activity的逻辑代码。他能够在xml中引入简单的逻辑代码，也能够非常灵活的利用View自带的属性进行设置，同时也支持数据的双向绑定或者是单纯的View绑定。

基础使用

简单的使用或者是引入可以去官网查看，我们直接看如何使用。

在xml中，我们可以通过<data class="BindingName">来指定生成的DataBinding文件的名称而不使用默认的layout布局作为Binding名称
在值@{}中，常见的转义字符替换，使用&&需要使用&&代替，<使用<代替，>使用>，空格使用&nbsp， " 引号 "，格式化字符串android:text="@{@string/string_format(吴彦祖, 男)}"。
在布局中，假如merge作为根节点，include作为merge的直接子节点，这种情况DataBinding是不支持的。
在xml中一个View可以通过另外一个View的id去引用它，需要注意对应的属性应该是支持双向绑定的。

在xml中，把父布局的相关变量传递给include布局通过bind方式，比如

// 父布局
<layout
     xmlns:bind="http://schemas.android.com/apk/res-auto"   >
    <data>
        <variable name="name" type="String”/>
    </data>
    <Linearlayout
    ....
    >
        <include
            ....
            layout="@layout/include_layout"
            bind:includeName="@{name}"
    </Linearlayout>
</layout>
//include_layout布局
<layout
     xmlns:bind="http://schemas.android.com/apk/res-auto"    >
    <data>
        <variable includeName="name" type="String”/>
    </data>
   <Linearlayout
    .... >
        <TextView
            ...
           android:text="@{includeName}"
    </Linearlayout>
</layout>

使用相关的Observable类(ObservableField，ObservableBoolean等)，然后通过@{}进行单向数据绑定(data->View)。使用@={}进行双向的数据绑定，假如我们同时还需要观测数据的变化回调，则可以使用MutableLiveData进行双向数据绑定。

把布局与Activity/Fragment/View绑定的方式有以下几种

// Act直接绑定xml，不需要另外调用setContentView
setContentView(@NonNull Activity activity, int layoutId)  //返回Binding对象
// 这种是用在Fragment中，通过返回的Binding对象去获取跟View然后返回，自定义View获取布局也可以用这种，RecycleView的Item布局也可以用这种
inflate(@NonNull LayoutInflater inflater, int layoutId, @Nullable ViewGroup parent, boolean attachToParent) //返回Binding对象
// 直接使用自动生成的Binding类的inflate或者是bind静态方法，然后得到Binding对象，例如有一个MainBinding的文件
MainBinding.inflate(LayoutInflater)

我们在得到Binding对象之后，就可以通过mBinding.viewId的方式来引用xml对应的组件实例而不需要通过findViewById

给xml的变量设置值除了可以通过获取Binding对象得到变量赋值之外，还可以通过BR类得到对应的id然后赋值，BR类是编译之后生成的一个映射变量的id。例子如

// 布局 main.xml
...
<data>
    <variable name="name" type="String"/>
    <variable name="age" type="Integer"/>
</data>
...
//变量赋值方式
//第一种
mBinding.name = "name"
mBinding.age= 10
//第二种
mBinding.setVariable(BR.name,"name");
mBinding.setVariable(BR.age,10);

BindingAdapter

@BindingAdapter注解，他的作用是类似增加View对应属性的set方法。我们能在xml中使用自身属性绑定Data，是因为要么View对应的属性提供了set方法或者库默认提供的BindingAdapter中有注解到，比如ViewBindingAdapter，TextViewBindingAdapter，CardViewBindingAdapter等。总得来说，只有View的属性有对应的set方法，无论是否有对应的android属性，我们都可以用来进行数据绑定。比如ImageView的setImageBitmap没有对应的imageBitmap属性，但是可以在xml中使用imageBitmap，例如

<layout>
   <variable name="bitmap" type="android.graphics.Bitmap"/>
    ....
<ImageView
    ...
    app:imageBitmap="@{bitmap}"/>       
...
</layout>

但是当我们的View的属性没有提供这种set方法，而我们又需要这个属性与Data进行绑定，或者是我们需要给这个View额外增加一个属性去绑定数据，那么我们就可以使用 @BindingAdapter，它注解在静态方法上，作用是类似给View属性和他的对应方法做一个映射，或者是类似给View增加一个额外的属性和方法。例如LinearLayout的android:layout_marginTop属性，他没有对应的set方法，我们就可以通过下面的例子进行映射，也可以为另一个View增加属性进行数据绑定。

    @JvmStatic
    @BindingAdapter("android:layout_marginTop")
    fun marginTop(view: LinearLayout, top: Float?) {
        val lp = view.layoutParams as LinearLayout.LayoutParams
        top?.let { lp.topMargin = top.toInt() }
        view.layoutParams = lp
    }

    @JvmStatic
    @BindingAdapter("test")
    fun changeOrderStatusToText(tv: TextView,str: String|?) {
        tv.text = str?:""
    }

//使用为
...
// 是使用androidl开头还是app开头看这个属性是不是View本身就有的
<LinearLayout
android:layout_marginTop="@{marginTop}"
/>
<TextView
app:test="@{vmStr}"
/>
...

当然我们也可以给一个View一次设置多个额外的属性去进行数据绑定，比如

@JvmStatic
    @BindingAdapter(value = ["imageUrl", "placeDrawableId", "errorDrawableId"], requireAll = false)//requireAll表示所有参数都必须有
    fun setImageUrl(imageView: ImageView, imageUrl: String?, placeDrawableId: Drawable?, errorDrawableId: Drawable?) {
    }

其中requireAll=false表示不需要全部属性都赋值，默认为true，使用吐下

<androidx.appcompat.widget.AppCompatImageView
          android:layout_width="50dp"
          app:imageUrl="@{url}"
          android:layout_height="50dp"/>

      <androidx.appcompat.widget.AppCompatImageView
          android:layout_width="50dp"
          app:placeDrawableId="@{@drawable/home_ic_send_goods}"
          app:errorDrawableId="@{@drawable/home_ic_send_goods}"
          app:imageUrl="@{url}"
          android:layout_height="50dp"/>

BindingMethods

@BindingMethods注解是包含了一个或者是多个@BindingMethod组件的注解，他的作用常见就是把View的属性和方法绑定在一起，当然我们也可以使用上面的了BindingAdapter，但是需要新增方法的形式。假如说我们的View存在一个属性(没有提供set方法)，在数据与他绑定的时候，就需要调用View的某个方法，这时候就可以使用到@BindingMethods，例如ViewBindingAdapter的

@BindingMethods({
        @BindingMethod(type = View.class, attribute = "android:backgroundTint", method = "setBackgroundTintList"),
        @BindingMethod(type = View.class, attribute = "android:fadeScrollbars", method = "setScrollbarFadingEnabled"),
        ....
})
public class ViewBindingAdapter{
}

//使用的时候就可以直接进行数据绑定
<layout>
    <data>    
        ...
    </data>

    ...
    <View
        android:backgroundTint="@{ColorStateList}"
        />
...
</layout>

总的来说他是直接建立起View属性和方法的映射而不需要额外的代码。@BindingMethods的声明是在何处都可以的，不一定要在BindingAdapter里面，也可以在对应的View上面(假如自定义的话)。

BindingConversion

@BindingConversion注解，他是在数据层的数据不符合的时候，会自动去查询被@BindingConversion注解的静态方法，是否有可以把当前类型转换为目标类型的参数，如果存在则编译通过可以执行，否则不可以(需要注意的是TextView的text如果想要使用Int值是不可以的，因为他会被识别为resource id，BindingConversion无法起效)。比如

 @BindingConversion
    @JvmStatic
    fun boolean2String(boolean: Boolean):String {
        return  boolean.toString()
    }
//使用
 <androidx.appcompat.widget.AppCompatTextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{boo}"/>

Inverse系列

包括@InverseMethod，@InverseBindingMethods，InverseBindingMethod，InverseBindingAdapter。
他们一般用于双向绑定之中而不是单向的数据绑定，下面逐一举例说明。

InverseMethod

@InverseMethod，当我们的ViewModel提供的数据类型与View需要的数据类型不匹配，而且他们是双向绑定的情况的话，我们就可以使用 @InverseMethod。例如


//定义，需要两个方法，使用InverseMethod注解在xml中，InverseMethod的值是另外一个静态方法，用于把View数据转为ViewModel数据。
@JvmStatic
    @InverseMethod("view2ViewModel")
    fun  viewModel2View(view: TextView, id: Int):String {
        if (id == 0) {
            return "Hi好"
        }
        return "Hello"
    }
    @JvmStatic
    fun view2ViewModel(view: TextView, name:String):Int {
        if ("Hi好" == name) {
            return 0;
        }
        return 1
    }
//使用，他需要view有id，然后调用InverseMethod注解的方法，传入对应的参数，view参数传入id名称即可
 <androidx.appcompat.widget.AppCompatTextView
            android:layout_width="match_parent"
            android:id="@+id/tv"
            android:text="@={InverseTest.viewModel2View(tv,vm.id)}"
            android:layout_height="wrap_content" />

InverseBindingAdapter

首先是他的参数

attribute，属性值，是必填的
2.event，非必填，属性值+AttrChanged后缀，比如假如attribute=text，那么event=textAttrChanged

他作用于方法，也是需要静态方法，并且需要结合@BindingAdapter使用。也是需要用在双向绑定中，双向绑定的是BindingAdapter的对应的属性，BindingAdapter是ViewModel到View，InverseBindingAdapter则是相反的，比如库给的例子

   // 监听text属性改变的回调，这里使用到textAttrChanged，则知道是下面InverseBindingAdapter对应的
@BindingAdapter(value = {"android:beforeTextChanged", "android:onTextChanged",
            "android:afterTextChanged", "android:textAttrChanged"}, requireAll = false)
    public static void setTextWatcher(TextView view, final BeforeTextChanged before,
            final OnTextChanged on, final AfterTextChanged after,
            final InverseBindingListener textAttrChanged){
            ...
            newValue = new TextWatcher() {
                 ...
                @Override
                public void onTextChanged(CharSequence s, int start, int before, int count) {
                    ...
                    if (textAttrChanged != null) {
                        textAttrChanged.onChange();
                    }
                }
                ...
            };
        }
    ...
    }
// text自身属性的绑定
@BindingAdapter("android:text")
    public static void setText(TextView view, CharSequence text) {
        ...
    }
//当Text改变，假如是双向绑定的则会通过调用这个方法获取值
@InverseBindingAdapter(attribute = "android:text", event = "android:textAttrChanged")
public static String getTextString(TextView view) {
  return view.getText().toString();
}

InverseBindingMethods

他的参数是InverseBindingMethod，可以有多个值。他必须与BindingAdapter一起使用，他的作用与BindingMethods的类型，InverseBindingMethods是把自身的属性值与对应的get方法映射出来，他是使用在双向绑定当中的。ViewMode通过BindingAdapter设置值到View中，View的属性改变了ViewModel通过InverseBindingMethods注解的属性对应的get方法获取。InverseBindingMethod的参数

type，必填的，是那个View类
attribute，必填，是那个属性，
method，选填，他是属性值的getter形式作为默认值通过属性指定变化监听和返回方法。假如存在 attribute对应的get方法则可以不填，否则是手动填写具体对应的View的那个方法

event，选填，他是属性值+AttrChanged，类似InverseBindingAdapter的event

@InverseBindingMethods({
        @InverseBindingMethod(type = AdapterView.class, attribute = "android:selectedItemPosition"),
        @InverseBindingMethod(type = AdapterView.class, attribute = "android:selection",
                method = "getSelectedItemPosition",
                event = "android:selectedItemPositionAttrChanged"),
})
public class AdapterViewBindingAdapter {
    @BindingAdapter("android:selectedItemPosition")
    public static void setSelectedItemPosition(AdapterView view, int position) {
        if (view.getSelectedItemPosition() != position) {
            view.setSelection(position);
        }
    }
    @BindingAdapter("android:selection")
    public static void setSelection(AdapterView view, int position) {
        setSelectedItemPosition(view, position);
    }
    @BindingAdapter({"android:selectedItemPosition", "android:adapter"})
    public static void setSelectedItemPosition(AdapterView view, int position, Adapter adapter) {
        if (adapter != view.getAdapter()) {
            //noinspection unchecked
            view.setAdapter(adapter);
            view.setSelection(position);
        } else if (view.getSelectedItemPosition() != position) {
            view.setSelection(position);
        }
    }
    @BindingAdapter({"android:selection", "android:adapter"})
    public static void setSelection(AdapterView view, int position, Adapter adapter) {
        setSelectedItemPosition(view, position, adapter);
    }

    @BindingAdapter(value = {"android:onItemSelected", "android:onNothingSelected",
            "android:selectedItemPositionAttrChanged" }, requireAll = false)
    public static void setOnItemSelectedListener(AdapterView view, final OnItemSelected selected,
            final OnNothingSelected nothingSelected, final InverseBindingListener attrChanged) {
        if (selected == null && nothingSelected == null && attrChanged == null) {
            view.setOnItemSelectedListener(null);
        } else {
            view.setOnItemSelectedListener(
                    new OnItemSelectedComponentListener(selected, nothingSelected, attrChanged));
        }
    }
}

其他注解

Bindable是用于生成BR类的，BindingBuildInfo和Untaggable是用于生成DataBinding自动生成的Java类使用的。