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

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

Demo源码库:DataBindingSample

列表绑定

App中经常用到列表展示,Data Binding在列表中一样可以扮演重要的作用,直接绑定数据和事件到每一个列表的item。

RecyclerView

过去我们往往会使用ListView、GridView、或者GitHub上一些自定义的View来做瀑布流。自从RecyclerView出现后,我们有了新选择,只需要使用LayoutManager就可以。RecyclerView内置的垃圾回收,ViewHolder、ItemDecoration装饰器机制都让我们可以毫不犹豫地替换掉原来的ListView和GridView。

所以本篇仅拿RecyclerView做例子。

Generic Binding

我们只需要定义一个基类ViewHolder,就可以方便地使用上Data Binding:

1
2
3
4
5
6
7
8
9
10
11
12
13
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,不做赘述。

由于同一个adapter未必只有一种ViewHolder,可能有好几种View type,所以在onBindViewHolder中,我们只能获取基类的ViewHolder类型,也就是BindingViewHolder,所以无法去做具体的set操作,如setEmployee。这时候就可以使用setVariable接口,然后通过BR来指定variable的name。

又比如我们可能有多重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举一个例子:

1
2
3
4
<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:

1
2
3
4
public void setScrimColor(@ColorInt int color) {
mScrimColor = color;
invalidate();
}

如果找不到的话,就会在编译期报错。

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

比如Fresco的SimpleDraweeView,我们想要直接在xml指定url,就可以加上:

1
2
3
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指定属性的绑定方法:

1
2
3
4
5
@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定义一个静态方法:

1
2
3
4
5
6
7
@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。如果需要自己再写点什么,仿照这些来写就好了。

我们还可以进行多属性绑定,比如

1
2
3
4
@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:

1
2
3
4
<View
android:background=“@{isError ? @color/red : @color/white}”
android:layout_width=“wrap_content”
android:layout_height=“wrap_content”/>

1
2
3
4
@BindingConversion
public static ColorDrawable convertColorToDrawable(int color) {
return new ColorDrawable(color);
}

双向绑定

自定义Listener

过去,我们需要自己定义Listener来做双向绑定:

1
2
<EditText android:text=“@{user.name}”
android:afterTextChanged=“@{callback.change}”/>

1
2
3
4
5
6
public void change(Editable s) {
final String text = s.toString();
if (!text.equals(name.get()) {
name.set(text);
}
}

需要自己绑定afterTextChanged方法,然后检测text是否有改变,有改变则去修改observable。

新方式 - @=

现在可以直接使用@=(而不是@)来进行双向绑定了,使用起来十分简单

1
2
3
4
5
<EditText
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:inputType="textNoSuggestions"
android:text="@={model.name}"/>

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

原理

InverseBindingListener

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

1
2
3
public interface InverseBindingListener {
void onChange();
}

所有双向绑定,最后都是通过这个接口来observable改变的,各种监听,比如TextWatcher、OnCheckedChange,都是间接通过这个接口来通知的,以上面的EditText为例子,最后生成的InverseBindingListener:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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中的字符串,查看源码可以看到

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

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

完整的逻辑又是:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@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做到一样的效果:

1
2
3
4
5
6
@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通知InverseBindingListeneronChange方法,onChange方法则使用找到的get和set方法去进行检查和更新。

解决死循环

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

为了解决死循环,我们需要做一个简单的检查,在上面的setText方法我们可以看到,如果两次的text没有改变,则会直接return,这样就杜绝了无限循环调用的可能。在自己做自定义双向绑定的时候,需要注意这点。

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

属性改变监听

如果除了更新Observable,我们还想做一些其他事情怎么办?比如根据输入内容更新标志位?
我们可以直接使用observable上的addOnPropertyChangedCallback方法:

1
2
3
4
5
6
7
8
9
10
11
12
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();
}
}
});

表达式链

重复的表达式

1
2
3
<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}"/>

可以简化为:

1
2
3
4
<ImageView android:id=“@+id/avatar
android:visibility=“@{user.isAdult ? View.VISIBLE : View.GONE}”/>

<TextView android:visibility=“@{avatar.visibility}”/>
<CheckBox android:visibility="@{avatar.visibility}"/>

隐式更新

1
2
3
<CheckBox android:id=”@+id/seeAds“/>
<ImageView android:visibility=“@{seeAds.checked ?
View.VISIBLE : View.GONE}”/>

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

Lambda表达式

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

1
2
3
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动画:

1
2
3
4
5
6
7
8
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做一些测试功能怎么办?比如打点,记录一下东西:

1
2
3
4
5
6
7
8
9
10
public class MyBindingAdapter {
@BindingAdapter(“android:text”)
public static void setText(TextView view, String value) {
if (isTesting) {
doTesting(view, value);
} else {
TextViewBindingAdapter.setText(view, value)
}
}
}

但如此一来,我们就要给所有的方法都写上if/else,维护起来很困难,也影响美感。

那么我们就可以使用component:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public class TestBindingAdapter extends MyBindingAdapter {
@Override
public void setText(TextView view, String value) {
doTesting(view, value);
}
}

public interface DataBindingComponent {
MyBindingAdapter getMyBindingAdapter();
}

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

public MyBindingAdapter getMyBindingAdapter() {
return mAdapter;
}
}

静态的adapter怎么办呢,我们只需要把component作为第一个参数:

1
2
3
4
@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)一起学习。

Mark Zhai (翟一帆) wechat
欢迎您扫一扫上面的微信公众号,订阅我们的公众号!
坚持原创技术分享,您的支持将鼓励我继续创作!