承接上篇,本篇繼續(xù)講解一些Data Binding更加進階的內(nèi)容廓俭,包括:列表綁定云石、自定義屬性、雙向綁定研乒、表達式鏈汹忠、Lambda表達式、動畫雹熬、Component注入(測試)等宽菜。
Demo源碼庫:DataBindingSample。
列表綁定
App中經(jīng)常用到列表展示竿报,Data Binding在列表中一樣可以扮演重要的作用铅乡,直接綁定數(shù)據(jù)和事件到每一個列表的item。
RecyclerView
過去我們往往會使用ListView烈菌、GridView阵幸、或者GitHub上一些自定義的View來做瀑布流花履。自從RecyclerView出現(xiàn)后,我們有了新選擇挚赊,只需要使用LayoutManager就可以臭挽。RecyclerView內(nèi)置的垃圾回收,ViewHolder咬腕、ItemDecoration裝飾器機制都讓我們可以毫不猶豫地替換掉原來的ListView和GridView。
所以本篇僅拿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類(以便直接訪問內(nèi)部的View)举反。至于Listener,可以在onBindViewHolder
中進行綁定扒吁,做法類似于普通View火鼻,不做贅述。
由于同一個adapter未必只有一種ViewHolder雕崩,可能有好幾種View type魁索,所以在onBindViewHolder
中,我們只能獲取基類的ViewHolder類型盼铁,也就是BindingViewHolder
粗蔚,所以無法去做具體的set操作,如setEmployee饶火。這時候就可以使用setVariable
接口鹏控,然后通過BR來指定variable的name。
又比如我們可能有多重view type對應的xml肤寝,可以將對應的variable name全都寫為item当辐,這樣可以避免強制轉(zhuǎn)換Binding類去做set操作。類似地鲤看,監(jiān)聽器也能都統(tǒng)一取名為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需要遵循規(guī)范沐祷,事件的綁定也比較死板,不如自己繼承Adapter來得強大攒岛。唯一的好處也就是可以少寫點代碼了赖临。
自定義屬性
默認的android命名空間下,我們會發(fā)現(xiàn)并不是所有的屬性都能直接通過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就會去根據(jù)屬性名字找對應的set方法,scrimColor -> setScrimColor:
public void setScrimColor(@ColorInt int color) {
mScrimColor = color;
invalidate();
}
如果找不到的話佃乘,就會在編譯期報錯囱井。
利用這種特性,對一些第三方的自定義View恕稠,我們就可以繼承它琅绅,來加上我們的set函數(shù),以對其使用data binding鹅巍。
比如Fresco的SimpleDraweeView
千扶,我們想要直接在xml指定url,就可以加上:
public void setUrl(String url) {
view.setImageURI(TextUtils.isEmpty(url) ? null : Uri.parse(url));
}
這般骆捧,就能直接在xml中去綁定圖片的url澎羞。這樣是不是會比較麻煩呢,而且有一些系統(tǒng)的View敛苇,難道還要繼承它們?nèi)缓笥米约簩崿F(xiàn)的類妆绞?其實不然,我們還有其他方法可以做到自定義屬性綁定枫攀。
BindingMethods
如果View本身就支持這種屬性的set括饶,只是xml中的屬性名字和java代碼中的方法名不相同呢?難道就為了這個来涨,我們還得去繼承View图焰,使代碼產(chǎn)生冗余?
當然沒有這么笨蹦掐,這時候我們可以使用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定義一個靜態(tài)方法:
@BindingAdapter("android:paddingLeft")
public static void setPaddingLeft(View view, int padding) {
view.setPadding(padding,
view.getPaddingTop(),
view.getPaddingRight(),
view.getPaddingBottom());
}
事實上這個Adapter已經(jīng)由Data Binding實現(xiàn)好了彰阴,可以在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。
新方式 - @=
現(xiàn)在可以直接使用@=(而不是@)來進行雙向綁定了厢洞,使用起來十分簡單
<EditText
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:inputType="textNoSuggestions"
android:text="@={model.name}"/>
這樣仇让,我們對這個EditText的輸入典奉,就會自動set到對應model的name字段上。
原理
InverseBindingListener
InverseBindingListener
是事件發(fā)生時觸發(fā)的監(jiān)聽器:
public interface InverseBindingListener {
void onChange();
}
所有雙向綁定丧叽,最后都是通過這個接口來observable改變的卫玖,各種監(jiān)聽,比如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操作類似垄开,雙向綁定通過注解進行g(shù)et操作琴许。
完整的邏輯又是:
@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”, // 默認會根據(jù)attribute name獲取get
event=“android:textAttrChanged”)}) // 默認根據(jù)attribute增加AttrChanged
data binding通過textAttrChanged
的event找到setTextWatcher
方法,而setTextWatcher
通知InverseBindingListener
的onChange
方法溉躲,onChange方法則使用找到的get和set方法去進行檢查和更新榜田。
解決死循環(huán)
如果仔細想想雙向綁定的邏輯,用戶輸入導致實例事件發(fā)生锻梳,更新了實例的屬性箭券,實例的屬性改變又會觸發(fā)這個View的notify,從而變成了一個不斷互相觸發(fā)刷新的死循環(huán)疑枯。
為了解決死循環(huán)辩块,我們需要做一個簡單的檢查,在上面的setText方法我們可以看到荆永,如果兩次的text沒有改變废亭,則會直接return,這樣就杜絕了無限循環(huán)調(diào)用的可能具钥。在自己做自定義雙向綁定的時候滔以,需要注意這點。
目前雙向綁定僅支持如text氓拼,checked你画,year,month桃漾,hour坏匪,rating,progress等綁定撬统。
屬性改變監(jiān)聽
如果除了更新Observable适滓,我們還想做一些其他事情怎么辦?比如根據(jù)輸入內(nèi)容更新標志位恋追?
我們可以直接使用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的狀態(tài)變更后ImageView會自動改變visibility凭迹。
Lambda表達式
除了直接使用方法引用罚屋,在Presenter中寫和OnClickListener一樣參數(shù)的方法,我們還能使用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發(fā)生改變猛拴,比如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;
}
}
靜態(tài)的adapter怎么辦呢倒谷,我們只需要把component作為第一個參數(shù):
@BindingAdapter(“android:src”)
public static void loadImage(TestComponent component, ImageView view, String url) {
/// ...
}
最后通過DataBindingUtil.setDefaultComponent(new TestComponent());
就能讓data binding使用該Component提供的adapter方法。
學習和使用建議
學習建議
- 盡量在項目中進行嘗試糙箍,只有在不斷碰到業(yè)務的需求時,才會在真正的場景下使用并發(fā)現(xiàn)Data Binding的強大之處牵祟。
- 摸索xml和java的界限深夯,不要以為Data Binding是萬能的,而想盡辦法把邏輯寫在xml中诺苹,如果你的同事沒法一眼看出這個表達式是做什么的咕晋,那可能它就應該放在Java代碼中,以ViewModel的形式去承擔部分邏輯收奔。
- Lambda表達式/測試時注入等Data Binding的高級功能也可以自己多試試掌呜,尤其是注入,相當強大坪哄。
使用建議
- 對新項目质蕉,不要猶豫,直接上翩肌。
- 對于老的項目模暗,可以替換ButterKnife這種庫,從findViewById開始改造念祭,逐漸替換老代碼兑宇。
- callback綁定只做事件傳遞,NO業(yè)務邏輯粱坤,比如轉(zhuǎn)賬
- 保持表達式簡單(不要做過于復雜的字符串隶糕、函數(shù)調(diào)用操作)
對于老項目瓷产,可以進行以下的逐步替換:
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
創(chuàng)建ViewModel類來進行即時的屬性更新觸發(fā)UI刷新。
Level 5 - 雙向綁定
運用雙向綁定來簡化表單的邏輯霎冯,將form data變成ObservableField铃拇。這樣我們還可以在xml做一些酷炫的事情,比如button僅在所有field非空才為enabled(而過去要做到這個得加上好幾個EditText的OnTextChange監(jiān)聽)沈撞。
總結(jié)
本文上下兩篇介紹了大部分data binding現(xiàn)存的特性及部分的實現(xiàn)原理慷荔,大家如果純看而不實踐的話,可能會覺得有些頭大缠俺,建議還是通過項目進行一下實踐显晶,才能真正體會到data binding的強大之處。歡迎加入我們的QQ群(568863373)進行討論壹士,你也可以加我的微信(shin_87224330)一起學習磷雇。