從零開始的 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）一塊兒學習。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程