引
Data Binding自从去年的Google I/O发布到至今,也有近一年的时间了。这一年来,从Beta到如今比较完善的版本,从Android Studio 1.3到如今2.1.2的支持,可以说Data Binding已经是一个可用度较高,也能带来实际生产力提升的技术了。
然而事实上,真正使用到Data Binding的公司、项目仍然是比较少的。可能是出于稳定性考虑,亦或是对Data Binding技术本身不够熟悉,又或许对新技术没什么追求。
我司在新的产品中就全面使用了Data Binding技术,无论是我,还是新来直接面对Data Binding上手的工程师也好,都对其爱不释手,用惯了后简直停不下来。
希望在看完本文的介绍后,会有更多的朋友产生兴趣,来使用Data Binding,参与它的讨论。
Demo源码库:DataBindingSample
什么是Data Binding
Data Binding,顾名思义,数据绑定,是Google对MVVM在Android上的一种实现,可以直接绑定数据到xml中,并实现自动刷新。现在最新的版本还支持双向绑定,尽管使用场景不是那么多。
Data Binding可以提升开发效率(节省很多以往需要手写的java代码),性能高(甚至超越手写代码),功能强(强大的表达式支持)。
用途
去掉Activities & Fragments内的大部分UI代码(setOnClickListener, setText, findViewById, etc.)
XML变成UI的唯一真实来源
减少定义view id的主要用途(数据绑定直接发生在xml)
开源方案
ButterKnife, Jake大神的知名库了,可以少些很多findViewById,setOnClickListener,取而代之地用annotation去生成代码。
Android Annotations,同样通过annotation,大量的annotation,侵入性较强,需要遵循其规范写一些代码,像是@AfterViews注释中才能对View进行操作。
RoboBinding,和Data Binding最相似的一个方案,同样很多事情放在xml去做了,使用了aspectJ去做生成。
除了这些比较有名的,还有很多各不相同的方案,但自从data binding发布后,可以说它们都再也没有用武之地了,因为无论从性能、功能,还是ide的支持上,data binding都更好。
优势
UI代码放到了xml中,布局和数据更紧密
性能超过手写代码
保证执行在主线程
劣势
IDE支持还不那么完善(提示、表达式)
报错信息不那么直接
重构支持不好(xml中进行重构,java代码不会自动修改)
使用
使用起来实在很简单,在app模块的build.gradle中加上几行代码就行了。
Gradle
1 2 3 4 5 6 | android { … dataBinding { enabled = true } } |
layout tag
把一个普通的layout变成data binding layout也只要几行的修改:
1 2 3 | <layout> // 原来的layout </layout> |
在xml的最外层套上layout标签即可,修改后就可以看到生成了该布局对应的*Binding类。
Binding生成规则
默认生成规则:xml通过文件名生成,使用下划线分割大小写。
比如activity_demo.xml,则会生成ActivityDemoBinding,item_search_hotel则会生成ItemSearchHotelBinding。
view的生成规则类似,只是由于是类变量,首字母不是大写,比如有一个TextView的id是first_name,则会生成名为firstName的TextView。
我们也可以自定义生成的class名字,只需要:
1 2 3 | <data class=“ContactItem”> … </data> |
这样生成的类就会变成ContactItem
。
基础用法
生成Binding实例
所有Binding实例的生成都可以通过DataBindingUtil
进行,方法名与该view的原inflate方法一致,如activity仍然为setContentView,只是增加了参数因为需要获得activity。
去除findViewById
使用了Data Binding后,我们再也不需要findViewById,因为一切有id的view,都已经在Binding类中被初始化完成了,只需要直接通过binding实例访问即可。
变量绑定
使用data标签,我们就可以在xml中申明变量,在其中使用该变量的field,并通过binding实例set进来。
如:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | <data> <variable name="employee" type="com.github.markzhai.databindingsample.Employee"/> </data> <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:gravity="center_horizontal" android:orientation="vertical" tools:context=".DemoActivity"> <TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@{employee.lastName}" android:layout_marginLeft="5dp"/> </LinearLayout> |
然后我们就可以在java代码中使用
1 2 3 | binding.setEmployee(employee); // 或者直接通过setVariable binding.setVariable(BR.employee, employee); |
事件绑定
严格意义上来说,事件绑定也是一种变量绑定。我们可以在xml中直接绑定
android:onClick
android:onLongClick
android:onTextChanged
…
方法引用
通常会在java代码中定义一个名为Handler或者Presenter的类,然后set进来,方法签名需和对应listener方法一致。
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 | <layout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" xmlns:bind="http://schemas.android.com/apk/res-auto"> <data> <import type="android.view.View"/> <variable name="employee" type="com.github.markzhai.databindingsample.Employee"/> <variable name="presenter" type="com.github.markzhai.databindingsample.DemoActivity.Presenter"/> </data> <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:gravity="center_horizontal" android:orientation="vertical" tools:context=".DemoActivity"> <EditText android:layout_width="match_parent" android:layout_height="wrap_content" android:hint="输入 First Name" android:onTextChanged="@{presenter::onTextChanged}"/> <TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:onClick="@{presenter.onClick}" android:text="@{employee.firstName}"/> </LinearLayout> </layout> |
在Java代码中:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | @Override protected void onCreate(Bundle savedInstanceState) { ... binding.setPresenter(new Presenter()); ... } public class Presenter { public void onTextChanged(CharSequence s, int start, int before, int count) { employee.setFirstName(s.toString()); employee.setFired(!employee.isFired.get()); } public void onClick(View view) { Toast.makeText(DemoActivity.this, "点到了", Toast.LENGTH_SHORT).show(); } } |
监听器绑定(lambda)
可以不遵循默认的方法签名:
1 2 3 4 5 6 | <TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:layout_margin="5dp" android:visibility="@{employee.isFired ? View.GONE : View.VISIBLE}" android:onClick="@{() -> presenter.onClickListenerBinding(employee)}"/> |
1 2 3 4 5 6 | public class Presenter { public void onClickListenerBinding(Employee employee) { Toast.makeText(DemoActivity.this, employee.getLastName(), Toast.LENGTH_SHORT).show(); } } |
Data Binding原理
狭义原理
狭义上,我们可以直接通过调用的接口以及生成的一些类,来观察其工作原理。
作为切入口,我们来看看DataBindingUtil的接口:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | public static <T extends ViewDataBinding> T setContentView(Activity activity, int layoutId, DataBindingComponent bindingComponent) { activity.setContentView(layoutId); View decorView = activity.getWindow().getDecorView(); ViewGroup contentView = (ViewGroup) decorView.findViewById(android.R.id.content); return bindToAddedViews(bindingComponent, contentView, 0, layoutId); } private static <T extends ViewDataBinding> T bindToAddedViews(DataBindingComponent component, ViewGroup parent, int startChildren, int layoutId) { final int endChildren = parent.getChildCount(); final int childrenAdded = endChildren - startChildren; if (childrenAdded == 1) { final View childView = parent.getChildAt(endChildren - 1); return bind(component, childView, layoutId); } else { final View[] children = new View[childrenAdded]; for (int i = 0; i < childrenAdded; i++) { children[i] = parent.getChildAt(i + startChildren); } return bind(component, children, layoutId); } } |
可以看到,然后会跑到具体Binding类中:
1 2 3 4 5 6 7 8 9 10 11 12 13 | public ItemFeedRecommendUserBinding(android.databinding.DataBindingComponent bindingComponent, View root) { super(bindingComponent, root, 9); final Object[] bindings = mapBindings(bindingComponent, root, 5, sIncludes, sViewsWithIds); this.mboundView0 = (android.widget.LinearLayout) bindings[0]; this.mboundView0.setTag(null); this.recommendUserFirst = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[1]; this.recommendUserFourth = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[4]; this.recommendUserSecond = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[2]; this.recommendUserThird = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[3]; setRootTag(root); // listeners invalidateAll(); } |
可以看到所有view是一次完成的初始化,比起一个个进行findViewById,显然这样一次性会更快。
除了view的初始化,在executeBindings
中,会通过mDirtyFlags
去判断各个field是否需要更新,而其置位则通过各个set函数去更新。
流程原理
处理layout文件 -> 变为没有data binding的layout文件
解析表达式 -> 确保表达式语法正确
解析依赖 -> user.isAdmin, isAdmin是field还是method…
Setter -> 如visibility
性能
0反射
findViewById需要遍历整个viewgroup,而现在只需要做一次就可以初始化所有需要的view
使用位标记来检验更新(dirtyFlags)
数据改变在下一次批量更新才会触发操作
表达式缓存,同一次刷新中不会重复计算
进阶用法
表达式
算术 + - / * %
字符串合并 +
逻辑 && ||
二元 & | ^
一元 + - ! ~
移位 >> >>> <<
比较 == > < >= <=
Instanceof
Grouping ()
文字 - character, String, numeric, null
Cast
方法调用
Field 访问
Array 访问 []
三元 ?:
尚且不支持this, super, new, 以及显示的泛型调用。
值得一提的是还有空合并运算符,如
1 | android:text=“@{user.displayName ?? user.lastName}” |
会取第一个非空值作为结果。
这里举一个常见的例子,某个view的margin是其左侧ImageView的margin加上该ImageView的宽度,以往我们可能需要再定义一个dimension来放这两个值的合,现在只需要
1 | android:marginLeft="@{@dimen/margin + @dimen/avatar_size}" |
就搞定了。
我们甚至还可以直接组合字符串,如:
1 2 3 | android:text="@{@string/nameFormat(firstName, lastName)}" <string name="nameFormat">%s, %s</string> |
避免空指针
data binding会自动帮助我们进行空指针的避免,比如说@{employee.firstName},如果employee是null的话,employee.firstName则会被赋默认值(null)。int的话,则是0。
需要注意的是数组的越界,毕竟这儿是xml而不是java,没地方让你去判断size的。
include
1 | <include layout=“@layout/name” bind:user="@{user}"/> |
对于include的布局,使用方法类似,不过需要在里面绑定两次,外面include该布局的layout使用bind:user
给set进去。
这里需要注意的一点是,被include的布局必须顶层是一个ViewGroup,目前Data Binding的实现,如果该布局顶层是一个View,而不是ViewGroup的话,binding的下标会冲突(被覆盖),从而产生一些预料外的结果。
ViewStubs
ViewStub比较特殊,在被实际inflate前是不可见的,所以使用了特殊的方案,用了final的ViewStubProxy
来代表它,并监听了ViewStub.OnInflateListener
:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | private OnInflateListener mProxyListener = new OnInflateListener() { @Override public void onInflate(ViewStub stub, View inflated) { mRoot = inflated; mViewDataBinding = DataBindingUtil.bind(mContainingBinding.mBindingComponent, inflated, stub.getLayoutResource()); mViewStub = null; if (mOnInflateListener != null) { mOnInflateListener.onInflate(stub, inflated); mOnInflateListener = null; } mContainingBinding.invalidateAll(); mContainingBinding.forceExecuteBindings(); } }; |
在onInflate的时候才会进行真正的初始化。
Observable
一个纯净的Java ViewModel类被更新后,并不会让UI去更新。而数据绑定后,我们当然会希望数据变更后UI会即时刷新,Observable就是为此而生的概念。
BaseObservable
类继承BaseObservable:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | private static class User extends BaseObservable { private String firstName; private String lastName; @Bindable public String getFirstName() { return this.firstName; } @Bindable public String getLastName() { return this.lastName; } public void setFirstName(String firstName) { this.firstName = firstName; notifyPropertyChanged(BR.firstName); } public void setLastName(String lastName) { this.lastName = lastName; notifyPropertyChanged(BR.lastName); } } |
BaseObservable提供了一系列notify函数(其实就是notifyChange和notifyPropertyChanged),前者会刷新所有的值域,后者则只更新对应BR的flag,该BR的生成通过注释@Bindable生成,在上面的实例代码中,我们可以看到两个get方法被注释上了,所以我们可以通过BR访问到它们并进行特定属性改变的notify。
Observable Fields
如果所有要绑定的都需要创建Observable类,那也太麻烦了。所以Data Binding还提供了一系列Observable,包括 ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, 和ObservableParcelable。我们还能通过ObservableField泛型来申明其他类型,如:
1 2 3 4 5 6 7 | private static class User { public final ObservableField<String> firstName = new ObservableField<>(); public final ObservableField<String> lastName = new ObservableField<>(); public final ObservableInt age = new ObservableInt(); } |
而在xml中,使用方法和普通的String,int一样,只是会自动刷新,但在java中访问则会相对麻烦:
1 2 | user.firstName.set("Google"); int age = user.age.get(); |
相对来说,每次要get/set还是挺麻烦,私以为还不如直接去继承BaseObservable。
Observable Collections
有一些应用使用更动态的结构来保存数据,这时候我们会希望使用Map来存储数据结构。Observable提供了ObservableArrayMap
:
1 2 3 4 | ObservableArrayMap<String, Object> user = new ObservableArrayMap<>(); user.put("firstName", "Google"); user.put("lastName", "Inc."); user.put("age", 17); |
而在xml中,我们可以直接通过下标key访问它们:
1 2 3 4 5 6 7 8 9 10 11 12 13 | <data> <import type="android.databinding.ObservableMap"/> <variable name="user" type="ObservableMap<String, Object>"/> </data> … <TextView android:text='@{user["lastName"]}' android:layout_width="wrap_content" android:layout_height="wrap_content"/> <TextView android:text='@{String.valueOf(1 + (Integer)user["age"])}' android:layout_width="wrap_content" android:layout_height="wrap_content"/> |
当我们不想定义key的时候,可以使用ObservableArrayList
:
1 2 3 4 | ObservableArrayList<Object> user = new ObservableArrayList<>(); user.add("Google"); user.add("Inc."); user.add(17); |
layout中直接通过数字下标进行访问。
动态变量
有时候,我们并不知道具体生成的binding类是什么。比如在RecyclerView中,可能有多种ViewHolder,而我们拿到的holder只是一个基类(这个基类具体怎么写下篇中会提到),这时候,我们可以在这些item的layout中都定义名字同样的variable,比如item,然后直接调用setVariable
:
1 2 3 4 5 | public void onBindViewHolder(BindingHolder holder, int position) { final T item = mItems.get(position); holder.getBinding().setVariable(BR.item, item); holder.getBinding().executePendingBindings(); } |
executePendingBindings会强制立即刷新绑定的改变。