從零開始的 Android 新專案 8 - Data Binding 高階篇

宅一帆markzhai發表於2016-07-17

承接上篇,本篇繼續講解一些更加進階的內容,包括:列表繫結、自定義屬性、雙向繫結、表示式鏈、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:

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舉一個例子:

<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通知InverseBindingListeneronChange方法,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)一起學習。

相關文章