從零開(kāi)始的Android新項(xiàng)目7 - Data Binding入門篇

原文:http://blog.zhaiyifan.cn/2016/06/16/android-new-project-from-0-p7/

Data Binding自從去年的Google I/O發(fā)布到至今,也有近一年的時(shí)間了。這一年來(lái),從Beta到如今比較完善的版本,從Android Studio 1.3到如今2.1.2的支持,可以說(shuō)Data Binding已經(jīng)是一個(gè)可用度較高,也能帶來(lái)實(shí)際生產(chǎn)力提升的技術(shù)了。

然而事實(shí)上,真正使用到Data Binding的公司、項(xiàng)目仍然是比較少的??赡苁浅鲇诜€(wěn)定性考慮,亦或是對(duì)Data Binding技術(shù)本身不夠熟悉,又或許對(duì)新技術(shù)沒(méi)什么追求。

我司在新的產(chǎn)品中就全面使用了Data Binding技術(shù),無(wú)論是我,還是新來(lái)直接面對(duì)Data Binding上手的工程師也好,都對(duì)其愛(ài)不釋手,用慣了后簡(jiǎn)直停不下來(lái)。

希望在看完本文的介紹后,會(huì)有更多的朋友產(chǎn)生興趣,來(lái)使用Data Binding,參與它的討論。

Demo源碼庫(kù):DataBindingSample

什么是Data Binding

Data Binding,顧名思義,數(shù)據(jù)綁定,是Google對(duì)MVVM在Android上的一種實(shí)現(xiàn),可以直接綁定數(shù)據(jù)到xml中,并實(shí)現(xiàn)自動(dòng)刷新?,F(xiàn)在最新的版本還支持雙向綁定,盡管使用場(chǎng)景不是那么多。

Data Binding可以提升開(kāi)發(fā)效率(節(jié)省很多以往需要手寫(xiě)的java代碼),性能高(甚至超越手寫(xiě)代碼),功能強(qiáng)(強(qiáng)大的表達(dá)式支持)。

用途

  • 去掉Activities & Fragments內(nèi)的大部分UI代碼(setOnClickListener, setText, findViewById, etc.)
  • XML變成UI的唯一真實(shí)來(lái)源
  • 減少定義view id的主要用途(數(shù)據(jù)綁定直接發(fā)生在xml)

開(kāi)源方案

  • ButterKnife, Jake大神的知名庫(kù)了,可以少些很多findViewById,setOnClickListener,取而代之地用annotation去生成代碼。
  • Android Annotations,同樣通過(guò)annotation,大量的annotation,侵入性較強(qiáng),需要遵循其規(guī)范寫(xiě)一些代碼,像是@AfterViews注釋中才能對(duì)View進(jìn)行操作。
  • RoboBinding,和Data Binding最相似的一個(gè)方案,同樣很多事情放在xml去做了,使用了aspectJ去做生成。

除了這些比較有名的,還有很多各不相同的方案,但自從data binding發(fā)布后,可以說(shuō)它們都再也沒(méi)有用武之地了,因?yàn)闊o(wú)論從性能、功能,還是ide的支持上,data binding都更好。

優(yōu)勢(shì)

  • UI代碼放到了xml中,布局和數(shù)據(jù)更緊密
  • 性能超過(guò)手寫(xiě)代碼
  • 保證執(zhí)行在主線程

劣勢(shì)

  • IDE支持還不那么完善(提示、表達(dá)式)
  • 報(bào)錯(cuò)信息不那么直接
  • 重構(gòu)支持不好(xml中進(jìn)行重構(gòu),java代碼不會(huì)自動(dòng)修改)

使用

使用起來(lái)實(shí)在很簡(jiǎn)單,在app模塊的build.gradle中加上幾行代碼就行了。

Gradle

android {
    …
    dataBinding {
        enabled = true
    }
}

layout tag

把一個(gè)普通的layout變成data binding layout也只要幾行的修改:

<layout>
    // 原來(lái)的layout
</layout>

在xml的最外層套上layout標(biāo)簽即可,修改后就可以看到生成了該布局對(duì)應(yīng)的*Binding類。

Binding生成規(guī)則

默認(rèn)生成規(guī)則:xml通過(guò)文件名生成,使用下劃線分割大小寫(xiě)。
比如activity_demo.xml,則會(huì)生成ActivityDemoBinding,item_search_hotel則會(huì)生成ItemSearchHotelBinding。

view的生成規(guī)則類似,只是由于是類變量,首字母不是大寫(xiě),比如有一個(gè)TextView的id是first_name,則會(huì)生成名為firstName的TextView。

我們也可以自定義生成的class名字,只需要:

<data class=“ContactItem”>
…
</data>

這樣生成的類就會(huì)變成ContactItem。

基礎(chǔ)用法

生成Binding實(shí)例

所有Binding實(shí)例的生成都可以通過(guò)DataBindingUtil進(jìn)行,方法名與該view的原inflate方法一致,如activity仍然為setContentView,只是增加了參數(shù)因?yàn)樾枰@得activity。

去除findViewById

使用了Data Binding后,我們?cè)僖膊恍枰猣indViewById,因?yàn)橐磺杏衖d的view,都已經(jīng)在Binding類中被初始化完成了,只需要直接通過(guò)binding實(shí)例訪問(wèn)即可。

變量綁定

使用data標(biāo)簽,我們就可以在xml中申明變量,在其中使用該變量的field,并通過(guò)binding實(shí)例set進(jìn)來(lái)。

如:

<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);
// 或者直接通過(guò)setVariable
binding.setVariable(BR.employee, employee);

事件綁定

嚴(yán)格意義上來(lái)說(shuō),事件綁定也是一種變量綁定。我們可以在xml中直接綁定

  • android:onClick
  • android:onLongClick
  • android:onTextChanged

方法引用

通常會(huì)在java代碼中定義一個(gè)名為Handler或者Presenter的類,然后set進(jìn)來(lái),方法簽名需和對(duì)應(yīng)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, "點(diǎn)到了", Toast.LENGTH_SHORT).show();
        }
    }

監(jiān)聽(tīng)器綁定(lambda)

可以不遵循默認(rèn)的方法簽名:

<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原理

狹義原理

狹義上,我們可以直接通過(guò)調(diào)用的接口以及生成的一些類,來(lái)觀察其工作原理。

作為切入口,我們來(lái)看看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);
    }
}

可以看到,然后會(huì)跑到具體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是一次完成的初始化,比起一個(gè)個(gè)進(jìn)行findViewById,顯然這樣一次性會(huì)更快。

除了view的初始化,在executeBindings中,會(huì)通過(guò)mDirtyFlags去判斷各個(gè)field是否需要更新,而其置位則通過(guò)各個(gè)set函數(shù)去更新。

流程原理

data binding

處理layout文件 -> 變?yōu)闆](méi)有databinding的layout文件
解析表達(dá)式 -> 確保表達(dá)式語(yǔ)法正確
解析依賴 -> user.isAdmin, isAdmin是field還是method…
Setter -> 如visibility

性能

  • 0反射
  • findViewById需要遍歷整個(gè)viewgroup,而現(xiàn)在只需要做一次就可以初始化所有需要的view
  • 使用位標(biāo)記來(lái)檢驗(yàn)更新(dirtyFlags)
  • 數(shù)據(jù)改變?cè)谙乱淮闻扛虏艜?huì)觸發(fā)操作
  • 表達(dá)式緩存,同一次刷新中不會(huì)重復(fù)計(jì)算

進(jìn)階用法

表達(dá)式

  • 算術(shù) + - / * %
  • 字符串合并 +
  • 邏輯 && ||
  • 二元 & | ^
  • 一元 + - ! ~
  • 移位 >> >>> <<
  • 比較 == > < >= <=
  • Instanceof
  • Grouping ()
  • 文字 - character, String, numeric, null
  • Cast
  • 方法調(diào)用
  • Field 訪問(wèn)
  • Array 訪問(wèn) []
  • 三元 ?:

尚且不支持this, super, new, 以及顯示的泛型調(diào)用。

值得一提的是還有空合并運(yùn)算符,如

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

會(huì)取第一個(gè)非空值作為結(jié)果。

這里舉一個(gè)常見(jiàn)的例子,某個(gè)view的margin是其左側(cè)ImageView的margin加上該ImageView的寬度,以往我們可能需要再定義一個(gè)dimension來(lái)放這兩個(gè)值的合,現(xiàn)在只需要

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

就搞定了。

我們甚至還可以直接組合字符串,如:

android:text="@{@string/nameFormat(firstName, lastName)}"

<string name="nameFormat">%s, %s</string>

避免空指針

data binding會(huì)自動(dòng)幫助我們進(jìn)行空指針的避免,比如說(shuō)@{employee.firstName},如果employee是null的話,employee.firstName則會(huì)被賦默認(rèn)值(null)。int的話,則是0。

需要注意的是數(shù)組的越界,畢竟這兒是xml而不是java,沒(méi)地方讓你去判斷size的。

include

<include layout=“@layout/name” bind:user="@{user}"/>

對(duì)于include的布局,使用方法類似,不過(guò)需要在里面綁定兩次,外面include該布局的layout使用bind:user給set進(jìn)去。

這里需要注意的一點(diǎn)是,被include的布局必須頂層是一個(gè)ViewGroup,目前Data Binding的實(shí)現(xiàn),如果該布局頂層是一個(gè)View,而不是ViewGroup的話,binding的下標(biāo)會(huì)沖突(被覆蓋),從而產(chǎn)生一些預(yù)料外的結(jié)果。

ViewStubs

ViewStub比較特殊,在被實(shí)際inflate前是不可見(jiàn)的,所以使用了特殊的方案,用了final的ViewStubProxy來(lái)代表它,并監(jiān)聽(tīng)了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的時(shí)候才會(huì)進(jìn)行真正的初始化。

Observable

一個(gè)純凈的Java ViewModel類被更新后,并不會(huì)讓UI去更新。而數(shù)據(jù)綁定后,我們當(dāng)然會(huì)希望數(shù)據(jù)變更后UI會(huì)即時(shí)刷新,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函數(shù)(其實(shí)就是notifyChange和notifyPropertyChanged),前者會(huì)刷新所有的值域,后者則只更新對(duì)應(yīng)BR的flag,該BR的生成通過(guò)注釋@Bindable生成,在上面的實(shí)例代碼中,我們可以看到兩個(gè)get方法被注釋上了,所以我們可以通過(guò)BR訪問(wèn)到它們并進(jìn)行特定屬性改變的notify。

Observable Fields

如果所有要綁定的都需要?jiǎng)?chuàng)建Observable類,那也太麻煩了。所以Data Binding還提供了一系列Observable,包括 ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, 和ObservableParcelable。我們還能通過(guò)ObservableField泛型來(lái)申明其他類型,如:

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一樣,只是會(huì)自動(dòng)刷新,但在java中訪問(wèn)則會(huì)相對(duì)麻煩:

user.firstName.set("Google");
int age = user.age.get();

相對(duì)來(lái)說(shuō),每次要get/set還是挺麻煩,私以為還不如直接去繼承BaseObservable。

Observable Collections

有一些應(yīng)用使用更動(dòng)態(tài)的結(jié)構(gòu)來(lái)保存數(shù)據(jù),這時(shí)候我們會(huì)希望使用Map來(lái)存儲(chǔ)數(shù)據(jù)結(jié)構(gòu)。Observable提供了ObservableArrayMap:

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

而在xml中,我們可以直接通過(guò)下標(biāo)key訪問(wèn)它們:

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

當(dāng)我們不想定義key的時(shí)候,可以使用ObservableArrayList:

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

layout中直接通過(guò)數(shù)字下標(biāo)進(jìn)行訪問(wèn)。

動(dòng)態(tài)變量

有時(shí)候,我們并不知道具體生成的binding類是什么。比如在RecyclerView中,可能有多種ViewHolder,而我們拿到的holder只是一個(gè)基類(這個(gè)基類具體怎么寫(xiě)下篇中會(huì)提到),這時(shí)候,我們可以在這些item的layout中都定義名字同樣的variable,比如item,然后直接調(diào)用setVariable

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

executePendingBindings會(huì)強(qiáng)制立即刷新綁定的改變。

參考資料

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容