从零开始的 Android 新项目 8 - Data Binding 高级篇

时间 2019-11-16

标签开始 android 项目 data binding 高级栏目 Android 繁體版

原文原文链接

承接上篇，本篇继续讲解一些更加进阶的内容，包括：列表绑定、自定义属性、双向绑定、表达式链、Lambda表达式、动画、Component注入（测试）等。java

Demo源码库：DataBindingSample。android

列表绑定

App中常常用到列表展现，Data Binding在列表中同样能够扮演重要的做用，直接绑定数据和事件到每个列表的item。git

RecyclerView

过去咱们每每会使用ListView、GridView、或者GitHub上一些自定义的View来作瀑布流。自从RecyclerView出现后，咱们有了新选择，只须要使用LayoutManager就能够。RecyclerView内置的垃圾回收，ViewHolder、ItemDecoration装饰器机制都让咱们能够坚决果断地替换掉原来的ListView和GridView。github

因此本篇仅拿RecyclerView作例子。微信

Generic Binding

咱们只须要定义一个基类ViewHolder，就能够方便地使用上Data Binding:并发

public class BindingViewHolder<T extends ViewDataBinding> extends RecyclerView.ViewHolder {

    protected final T mBinding;

    public BindingViewHolder(T binding) {
        super(binding.getRoot());
        mBinding = binding;
    }

    public T getBinding() {
        return mBinding;
    }
}复制代码

Adapter能够直接使用该ViewHolder，或者再继承该ViewHolder，T使用具体Item的Binding类（以便直接访问内部的View）。至于Listener，能够在onBindViewHolder中进行绑定，作法相似于普通View，不作赘述。app

因为同一个adapter未必只有一种ViewHolder，可能有好几种View type，因此在onBindViewHolder中，咱们只能获取基类的ViewHolder类型，也就是BindingViewHolder，因此没法去作具体的set操做，如setEmployee。这时候就可使用setVariable接口，而后经过BR来指定variable的name。ide

又好比咱们可能有多重view type对应的xml，能够将对应的variable name全都写为item，这样能够避免强制转换Binding类去作set操做。相似地，监听器也能都统一取名为listener或者presenter。函数

开源方案及其局限性

evant / binding-collection-adapter radzio / android-data-binding-recyclerview学习

均提供了简化的RV data binding方案。

前者能够直接在layout的RV上，设置对应的items和itemView进去，也支持多种view type，还能直接设定对应的LayoutManager。

后者相似地，提供了xml中直接绑定RV的items和itemView的功能。

相比来讲前者的功能更强大一些。但这些开源库对应地都丧失了灵活性，ViewModel须要遵循规范，事件的绑定也比较死板，不如本身继承Adapter来得强大。惟一的好处也就是能够少写点代码了。

自定义属性

默认的android命名空间下，咱们会发现并非全部的属性都能直接经过data binding进行设置，好比margin，padding，还有自定义View的各类属性。

遇到这些属性，咱们就须要本身去定义它们的绑定方法。

Setter

就像Data Binding会自动去查找get方法一下，在遇到属性绑定的时候，它也会去自动寻找对应的set方法。

拿DrawerLayout举一个例子:

<android.support.v4.widget.DrawerLayout android:layout_width=“wrap_content” android:layout_height=“wrap_content” app:scrimColor=“@{@color/scrimColor}”/>复制代码

如此，经过使用app命名空间，data binding就会去根据属性名字找对应的set方法，scrimColor -> setScrimColor:

public void setScrimColor(@ColorInt int color) {
    mScrimColor = color;
    invalidate();
}复制代码

若是找不到的话，就会在编译期报错。

利用这种特性，对一些第三方的自定义View，咱们就能够继承它，来加上咱们的set函数，以对其使用data binding。

好比Fresco的SimpleDraweeView，咱们想要直接在xml指定url，就能够加上：

public void setUrl(String url) {
    view.setImageURI(TextUtils.isEmpty(url) ? null : Uri.parse(url));
}复制代码

这般，就能直接在xml中去绑定图片的url。这样是否是会比较麻烦呢，并且有一些系统的View，难道还要继承它们而后用本身实现的类？其实否则，咱们还有其余方法能够作到自定义属性绑定。

BindingMethods

若是View自己就支持这种属性的set，只是xml中的属性名字和java代码中的方法名不相同呢？难道就为了这个，咱们还得去继承View，使代码产生冗余？

固然没有这么笨，这时候咱们可使用BindingMethods注释。

android:tint是给ImageView加上着色的属性，能够在不换图的前提下改变图标的颜色。若是咱们直接对android:tint使用data binding，因为会去查找setTint方法，而该方法不存在，则会编译出错。而实际对应的方法，应该是setImageTintList。

这时候咱们就可使用BindingMethod指定属性的绑定方法：

@BindingMethods({
       @BindingMethod(type = “android.widget.ImageView”,
                      attribute = “android:tint”,
                      method = “setImageTintList”),
})复制代码

咱们也能够称BindingMethod为Setter重命名。

BindingAdapter

若是没有对应的set方法，或者方法签名不一样怎么办？BindingAdapter注释能够帮咱们来作这个。

好比View的android:paddingLeft属性，是没有对应的直接进行设置的方法的，只有setPadding(left, top, right, bottom)，而咱们又不可能为了使用Data Binding去继承修改这种基础的View（即使修改了，还有一堆继承它的View呢）。又好比那些margin，须要修改必须拿到LayoutParams，这些都没法经过简单的set方法去作。

这时候咱们可使用BindingAdapter定义一个静态方法:

@BindingAdapter("android:paddingLeft")
public static void setPaddingLeft(View view, int padding) {
    view.setPadding(padding,
                    view.getPaddingTop(),
                    view.getPaddingRight(),
                    view.getPaddingBottom());
}复制代码

事实上这个Adapter已经由Data Binding实现好了，能够在android.databinding.adapters.ViewBindingAdapter看到有不少定义好的适配器，还有BindingMethod。若是须要本身再写点什么，仿照这些来写就行了。

咱们还能够进行多属性绑定，好比

@BindingAdapter({"bind:imageUrl", "bind:error"})
public static void loadImage(ImageView view, String url, Drawable error) {
   Picasso.with(view.getContext()).load(url).error(error).into(view);
}复制代码

来使用Picasso读取图片到ImageView。

BindingConversion

有时候咱们想在xml中绑定的属性，未必是最后的set方法须要的，好比咱们想用color（int），可是view须要Drawable，好比咱们想用String，而view须要的是Url。这时候咱们就可使用BindingConversion:

<View android:background=“@{isError ? @color/red : @color/white}” android:layout_width=“wrap_content” android:layout_height=“wrap_content”/>复制代码

@BindingConversion
    public static ColorDrawable convertColorToDrawable(int color) {
        return new ColorDrawable(color);
}复制代码

双向绑定

自定义Listener

过去，咱们须要本身定义Listener来作双向绑定:

<EditText android:text=“@{user.name}” android:afterTextChanged=“@{callback.change}”/>复制代码

public void change(Editable s) {
    final String text = s.toString();
    if (!text.equals(name.get()) {
        name.set(text);
    }
}复制代码

须要本身绑定afterTextChanged方法，而后检测text是否有改变，有改变则去修改observable。

新方式 - @=

如今能够直接使用@=（而不是@）来进行双向绑定了，使用起来十分简单

<EditText android:layout_width="match_parent" android:layout_height="wrap_content" android:inputType="textNoSuggestions" android:text="@={model.name}"/>复制代码

这样，咱们对这个EditText的输入，就会自动set到对应model的name字段上。

原理

InverseBindingListener

InverseBindingListener是事件发生时触发的监听器:

public interface InverseBindingListener {
    void onChange();
}复制代码

全部双向绑定，最后都是经过这个接口来observable改变的，各类监听，好比TextWatcher、OnCheckedChange，都是间接经过这个接口来通知的，以上面的EditText为例子，最后生成的InverseBindingListener:

private android.databinding.InverseBindingListener mboundView1androidTe = new android.databinding.InverseBindingListener() {
     @Override
     public void onChange() {
         // Inverse of model.name
         // is model.setName((java.lang.String) callbackArg_0)
         java.lang.String callbackArg_0 = android.databinding.adapters.TextViewBindingAdapter.getTextString(mboundView1);
         // localize variables for thread safety
         // model != null
         boolean modelObjectnull = false;
         // model
         com.github.markzhai.sample.FormModel model = mModel;
         // model.name
         java.lang.String nameModel = null;
         modelObjectnull = (model) != (null);
         if (modelObjectnull) {
             model.setName((java.lang.String) (callbackArg_0));
         }
     }
 };复制代码

InverseBindingMethod & InverseBindingAdapter

上面的生成代码中，咱们能够看到代码经过TextViewBindingAdapter.getTextString(mboundView1)去得到EditText中的字符串，查看源码能够看到

@InverseBindingAdapter(attribute = "android:text", event = "android:textAttrChanged")
public static String getTextString(TextView view) {
    return view.getText().toString();
}复制代码

原来跟上面的BindingMethod和BindingAdapter作set操做相似，双向绑定经过注解进行get操做。

完整的逻辑又是:

@BindingAdapter("android:text")
public static void setText(TextView view, CharSequence text) {
    final CharSequence oldText = view.getText();
    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.
    }
    view.setText(text);
}

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

@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) {
    final TextWatcher newValue;
    if (before == null && after == null && on == null && textAttrChanged == null) {
        newValue = null;
    } else {
        newValue = new TextWatcher() {
            @Override
            public void beforeTextChanged(CharSequence s, int start, int count, int after) {
                if (before != null) {
                    before.beforeTextChanged(s, start, count, after);
                }
            }

            @Override
            public void onTextChanged(CharSequence s, int start, int before, int count) {
                if (on != null) {
                    on.onTextChanged(s, start, before, count);
                }
                if (textAttrChanged != null) {
                    textAttrChanged.onChange();
                }
            }

            @Override
            public void afterTextChanged(Editable s) {
                if (after != null) {
                    after.afterTextChanged(s);
                }
            }
        };
    }
    final TextWatcher oldValue = ListenerUtil.trackListener(view, newValue, R.id.textWatcher);
    if (oldValue != null) {
        view.removeTextChangedListener(oldValue);
    }
    if (newValue != null) {
        view.addTextChangedListener(newValue);
    }
}复制代码

咱们也可使用InverseBindingMethod作到同样的效果:

@InverseBindingMethods({
    @InverseBindingMethod(
    type=android.widget.TextView.class,
    attribute=“android:text”,
    method=“getText”,                   // 默认会根据attribute name获取get
    event=“android:textAttrChanged”)})  // 默认根据attribute增长AttrChanged复制代码

data binding经过textAttrChanged的event找到setTextWatcher方法，而setTextWatcher通知InverseBindingListener的onChange方法，onChange方法则使用找到的get和set方法去进行检查和更新。

解决死循环

若是仔细想一想双向绑定的逻辑，用户输入致使实例事件发生，更新了实例的属性，实例的属性改变又会触发这个View的notify，从而变成了一个不断互相触发刷新的死循环。

为了解决死循环，咱们须要作一个简单的检查，在上面的setText方法咱们能够看到，若是两次的text没有改变，则会直接return，这样就杜绝了无限循环调用的可能。在本身作自定义双向绑定的时候，须要注意这点。

目前双向绑定仅支持如text，checked，year，month，hour，rating，progress等绑定。

属性改变监听

若是除了更新Observable，咱们还想作一些其余事情怎么办？好比根据输入内容更新标志位？咱们能够直接使用observable上的addOnPropertyChangedCallback方法:

mModel.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
    @Override
    public void onPropertyChanged(Observable observable, int i) {
        if (i == BR.name) {
            Toast.makeText(TwoWayActivity.this, "name changed",
                    Toast.LENGTH_SHORT).show();
        } else if (i == BR.password) {
            Toast.makeText(TwoWayActivity.this, "password changed",
                    Toast.LENGTH_SHORT).show();
        }
    }
});复制代码

表达式链

重复的表达式

<ImageView android:visibility=“@{user.isAdult ? View.VISIBLE : View.GONE}”/>
<TextView android:visibility=“@{user.isAdult ? View.VISIBLE : View.GONE}”/>
<CheckBox android:visibility="@{user.isAdult ? View.VISIBLE : View.GONE}"/>复制代码

能够简化为:

<ImageView android:id=“@+id/avatar” android:visibility=“@{user.isAdult ? View.VISIBLE : View.GONE}”/>
<TextView android:visibility=“@{avatar.visibility}”/>
<CheckBox android:visibility="@{avatar.visibility}"/>复制代码

隐式更新

<CheckBox android:id=”@+id/seeAds“/>
<ImageView android:visibility=“@{seeAds.checked ? View.VISIBLE : View.GONE}”/>复制代码

这样CheckBox的状态变动后ImageView会自动改变visibility。

Lambda表达式

除了直接使用方法引用，在Presenter中写和OnClickListener同样参数的方法，咱们还能使用Lambda表达式:

android:onClick=“@{(view)->presenter.save(view, item)}”
android:onClick=“@{()->presenter.save(item)}”
android:onFocusChange=“@{(v, fcs)->presenter.refresh(item)}”复制代码

咱们还能够在lambda表达式引用view id（像上面表达式链那样），以及context。

动画

transition

使用data binding后，咱们还能自动去作transition动画:

binding.addOnRebindCallback(new OnRebindCallback() {
    @Override
    public boolean onPreBind(ViewDataBinding binding) {
        ViewGroup sceneRoot = (ViewGroup) binding.getRoot();
        TransitionManager.beginDelayedTransition(sceneRoot);
        return true;
    }
});复制代码

这样，当咱们的view发生改变，好比visibility变化的时候，就能看到一些transition动画。

Component注入

若是咱们想要利用data binding作一些测试功能怎么办？好比打点，记录一下东西:

public class MyBindingAdapters {
    @BindingAdapter(“android:text”)
    public static void setText(TextView view, String value) {
        if (isTesting) {
            doTesting(view, value);
        } else {
            TextViewBindingAdapter.setText(view, value)
        }
    }
}复制代码

但如此一来，咱们就要给全部的方法都写上if/else，维护起来很困难，也影响美感。

那么咱们就可使用component:

public class MyBindingAdapters {
    @BindingAdapter(“android:text”)
    public static void setText(TextView view, String value) {
        if (isTesting) {
            doTesting(view, value);
        } else {
            TextViewBindingAdapter.setText(view, value)
        }
    }
}

public class TestBindingAdapter extends MyBindingAdapters {
    @Override
    public void setText(TextView view, String value) {
        doTesting(view, value);
    }
}

public interface DataBindingComponent {
    MyBindingAdapter getMyBindingAdapter();
}

public TestComponent implements DataBindingComponent {
    private MyBindingAdapter mAdapter = new TestBindingAdapters();

    public MyBindingAdapter getMyBindingAdapter() {
        return mAdapter;
    }
}复制代码

静态的adapter怎么办呢，咱们只须要把component做为第一个参数:

@BindingAdapter(“android:src”)
public static void loadImage(TestComponent component, ImageView view, String url) {
    /// ...
}复制代码

最后经过DataBindingUtil.setDefaultComponent(new TestComponent());就能让data binding使用该Component提供的adapter方法。

学习和使用建议

学习建议

尽可能在项目中进行尝试，只有在不断碰到业务的需求时，才会在真正的场景下使用并发现Data Binding的强大之处。
摸索xml和java的界限，不要觉得Data Binding是万能的，而想尽办法把逻辑写在xml中，若是你的同事无法一眼看出这个表达式是作什么的，那可能它就应该放在Java代码中，以ViewModel的形式去承担部分逻辑。
Lambda表达式/测试时注入等Data Binding的高级功能也能够本身多试试，尤为是注入，至关强大。

使用建议

对新项目，不要犹豫，直接上。
对于老的项目，能够替换ButterKnife这种库，从findViewById开始改造，逐渐替换老代码。
callback绑定只作事件传递，NO业务逻辑，好比转帐
保持表达式简单（不要作过于复杂的字符串、函数调用操做）

对于老项目，能够进行如下的逐步替换:

Level 1 - No more findViewById

逐步替换findViewById，取而代之地，使用binding.name, binding.age直接访问View。

Level 2 - SetVariable

引入variable，把手动在代码对View进行set替换为xml直接引用variable。

Level 3 - Callback

使用Presenter/Handler类来作事件的绑定。

Level 4 - Observable

建立ViewModel类来进行即时的属性更新触发UI刷新。

Level 5 - 双向绑定

运用双向绑定来简化表单的逻辑，将form data变成ObservableField。这样咱们还能够在xml作一些酷炫的事情，好比button仅在全部field非空才为enabled（而过去要作到这个得加上好几个EditText的OnTextChange监听）。

总结

本文上下两篇介绍了大部分data binding现存的特性及部分的实现原理，你们若是纯看而不实践的话，可能会以为有些头大，建议仍是经过项目进行一下实践，才能真正体会到data binding的强大之处。欢迎加入咱们的QQ群（568863373）进行讨论，你也能够加个人微信（shin_87224330）一块儿学习。