本文轉載自：http://blog.zhaiyifan.cn/2016/06/16/android-new-project-from-0-p7/

引

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

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進來。

如:

<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方法一致。

<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代碼中:


@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）

可以不遵循默認的方法簽名：

<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)}"/>

public class Presenter {
    public void onClickListenerBinding(Employee employee) {
        Toast.makeText(DemoActivity.this, employee.getLastName(),
                Toast.LENGTH_SHORT).show();
    }
}

Data Binding原理

狹義原理

狹義上，我們可以直接通過調用的接口以及生成的一些類，來觀察其工作原理。

作爲切入口，我們來看看DataBindingUtil的接口:

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類中:

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:

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:

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泛型來申明其他類型，如：

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:

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
user.put("age", 17);

而在xml中，我們可以直接通過下標key訪問它們：

<data>
    <import type="android.databinding.ObservableMap"/>
    <variable name="user" type="ObservableMap&lt;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:

ObservableArrayList<Object> user = new ObservableArrayList<>();
user.add("Google");
user.add("Inc.");
user.add(17);

layout中直接通過數字下標進行訪問。

動態變量

有時候，我們並不知道具體生成的binding類是什麼。比如在RecyclerView中，可能有多種ViewHolder，而我們拿到的holder只是一個基類（這個基類具體怎麼寫下篇中會提到），這時候，我們可以在這些item的layout中都定義名字同樣的variable，比如item，然後直接調用setVariable：

public void onBindViewHolder(BindingHolder holder, int position) {
   final T item = mItems.get(position);
   holder.getBinding().setVariable(BR.item, item);
   holder.getBinding().executePendingBindings();
}

executePendingBindings會強制立即刷新綁定的改變。

參考資料

https://developer.android.com/topic/libraries/data-binding/index.html

Android DataBinding入門篇

引