從零開始的Android新項目7 - Data Binding入門篇

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代碼不會自己主動改動）

使用

使用起來實在非常easy，在app模塊的build.gradle中加上幾行代碼就可以了。

Gradle

android {
    …
    dataBinding {
        enabled = true
    }
}

layout tag

把一個普通的layout變成data binding layout也僅僅要幾行的改動:

<layout>
    // 原來的layout
</layout>

在xml的最外層套上layout標簽就可以，改動后就能夠看到生成了該布局相應的*Binding類。

Binding生成規則

默認生成規則：xml通過文件名稱生成，使用下划線切割大寫和小寫。

比方activity_demo.xml，則會生成ActivityDemoBinding，item_search_hotel則會生成ItemSearchHotelBinding。

view的生成規則相似，僅僅是由於是類變量，首字母不是大寫。比方有一個TextView的id是first_name，則會生成名為firstName的TextView。

我們也能夠自己定義生成的class名字，僅僅須要：

<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代碼中使用

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, 以及顯示的泛型調用。

值得一提的是還有空合並運算符。如

android:text=“@{user.displayName ??
 user.lastName}”

會取第一個非空值作為結果。

這里舉一個常見的樣例，某個view的margin是其左側ImageView的margin加上該ImageView的寬度，以往我們可能須要再定義一個dimension來放這兩個值的合，如今僅僅須要

android:marginLeft="@{@dimen/margin + @dimen/avatar_size}"

就搞定了。

我們甚至還能夠直接組合字符串。如:

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

<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中訪問則會相對麻煩：

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

---

歡迎關注我們的公眾號：魔都三帥，歡迎大家來投稿~