AndroidDataBinding-MVVM模式

前言:前些天公司大牛給我分享了這篇教程耿导,我看了幾遍声怔,覺得真心不錯,就在這里分享給大家了舱呻。

本教程是跟著Data Binding Guide學習過程中得出的一些實踐經(jīng)驗醋火,同時修改了官方教程的一些錯誤,每一個知識點都有對應的源碼箱吕,爭取做到實踐與理論相結(jié)合芥驳。
Data Binding 解決了 Android UI 編程中的一個痛點,官方原生支持 MVVM 模型可以讓我們在不改變既有代碼框架的前提下茬高,非常容易地使用這些新特性兆旬。其實在此之前,已經(jīng)有些第三方的框架(RoboAndroid) 可以支持 MVVM 模型怎栽,無耐由于框架的侵入性太強丽猬,導致一直沒有流行起來。
Data Binding 框架一出熏瞄,是不是也意味著像RoboGuice脚祟、ButterKnife這樣的依賴注入框架也會慢慢失去市場,因為在 Java 代碼中直接使用View變量的情況會越來越少强饮。
準備
Android Studio 更新到 1.3 版本
打開 Preferences由桌,找到Appearances & Behavior下的Updates選項,把Automatically Check updates for修改成Canary Channel邮丰。

image

注意
Data Binding 是一個 support 包行您,因此與 Android M 沒什么關系,可以不用下載 Android MNC Preview 的 SDK柠座。
新建一個 Project
修改 Project 的build.gradle邑雅,為 build script 添加一條依賴片橡,Gradle 版本為 1.2.3妈经。

classpath'com.android.tools.build:gradle:1.2.3'
classpath'com.android.databinding:dataBinder:1.0-rc0'

為用到 Data Binding 的模塊添加插件,修改對應的build.gradle

apply plugin:'com.android.databinding'

基礎
工程創(chuàng)建完成后,我們通過一個最簡單的例子來說明 Data Binding 的基本用法吹泡。
布局文件
使用 Data Binding 之后骤星,xml的布局文件就不再單純地展示 UI 元素,還需要定義 UI 元素用到的變量爆哑。所以洞难,它的根節(jié)點不再是一個ViewGroup,而是變成了layout揭朝,并且新增了一個節(jié)點data队贱。

<layout xmlns:android="http://schemas.android.com/apk/res/android"> 
    <data> 
    </data> 
    <!--原先的根節(jié)點(Root Element)--> 
    <LinearLayout> 
    .... 
    </LinearLayout>
</layout>

要實現(xiàn) MVVM 的 ViewModel 就需要把數(shù)據(jù)與UI進行綁定,data節(jié)點就為此提供了一個橋梁潭袱,我們先在data中聲明一個variable柱嫌,這個變量會為 UI 元素提供數(shù)據(jù)(例如 TextView 的 android:text),然后在 Java 代碼中把"后臺"數(shù)據(jù)與這個variable進行綁定屯换。
如果要用一個表格來展示用戶的基本信息编丘,用 Data Binding 應該怎么實現(xiàn)呢?
數(shù)據(jù)對象
添加一個 POJO 類 -User彤悔,非常簡單嘉抓,四個屬性以及他們的 getter 和 setter。

    private final String firstName;
    private final String lastName;
    public User(String firstName,String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;    
    }
    public String getFirstName() {
        return firstName;    
    }
    public String getLastName() {
        return lastName;    
    }
}

稍后晕窑,我們會新建一個User類型的變量抑片,然后把它跟布局文件中聲明的變量進行綁定。
定義 Variable
再回到布局文件幕屹,在data節(jié)點中聲明一個變量user蓝丙。

<data>
    <variable name="user"  type="com.liangfeizc.databindingsamples.basic.User" />
</data>

其中type屬性就是我們在 Java 文件中定義的User類。
當然望拖,data節(jié)點也支持import渺尘,所以上面的代碼可以換一種形式來寫。

<data> 
    <import type="com.liangfeizc.databindingsamples.basic.User" />
    <variable name="user" type="User" />
</data>

然后我們剛才在 build.gradle 中添加的那個插件 -com.android.databinding會根據(jù)xml文件的名稱Generate一個繼承自ViewDataBinding的類说敏。
例如鸥跟,這里 xml 的文件名叫activity_basic.xml,那么生成的類就是ActivityBasicBinding盔沫。
注意
java.lang.*包中的類會被自動導入医咨,可以直接使用,例如要定義一個String類型的變量:

<variable name="firstName" type="String" />

綁定 Variable
修改BasicActivity的onCreate方法架诞,用DatabindingUtil.setContentView()來替換掉setContentView()拟淮,然后創(chuàng)建一個user對象,通過binding.setUser(user)與variable進行綁定谴忧。

@Override
protected void onCreate(BundlesavedInstanceState) {
    super.onCreate(savedInstanceState);
    ActivityBasicBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_basic);
    User user = new User("fei","Liang");    
    binding.setUser(user);
}

除了使用框架自動生成的ActivityBasicBinding很泊,我們也可以使用自定義的類名角虫。

<data class="com.example.CustomBinding">
</data>

注意
ActivityBasicBinding類是自動生成的,所有的 set 方法也是根據(jù)variable名稱生成的委造。例如戳鹅,我們定義了兩個變量。

<data> 
    <variable name="firstName" type="String" /> 
    <variable name="firstName" type="" />
</data>

那么就會生成對應的兩個 set 方法昏兆。

setFirstName(StringfirstName);
setLastName(StringlastName);

使用 Variable
數(shù)據(jù)與 Variable 綁定之后枫虏,xml 的 UI 元素就可以直接使用了。

<TextView 
    android:layout_width="wrap_content" 
    android:layout_height="wrap_content" 
    android:text="@{user.lastName}" />

至此爬虱,一個簡單的數(shù)據(jù)綁定就完成了隶债,可參考完整代碼

高級用法###

使用類方法
首先為類添加一個靜態(tài)方法

public class MyStringUtils{
public static String capitalize(final String word) {
    if(word.length()>1){
        return String.valueOf(word.charAt(0)).toUpperCase()+word.substring(1);        
    }
    return word;    
    }
}

然后在 xml 的data節(jié)點中導入:

<import type="com.liangfeizc.databindingsamples.utils.MyStringUtils" />

使用方法與 Java 語法一樣:

<TextView 
    android:layout_width="wrap_content" 
    android:layout_height="wrap_content" 
    android:text="@{StringUtils.capitalize(user.firstName)}" />

類型別名
如果我們在data節(jié)點了導入了兩個同名的類怎么辦?

 <import type="com.example.home.data.User" />
 <import type="com.examle.detail.data.User" />
 <variable name="user" type="User" />

這樣一來出現(xiàn)了兩個User類跑筝,那user變量要用哪一個呢燃异?不用擔心,import還有一個alias屬性继蜡。

 <import type="com.example.home.data.User" />
 <import type="com.examle.detail.data.User" alias="DetailUser" />
 <variable name="user" type="User" />

Null Coalescing 運算符

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

就等價于

android:text="@{user.displayName != null ? user.displayName : user.lastName}"

屬性值
通過${}可以直接把 Java 中定義的屬性值賦值給 xml 屬性回俐。

<TextView 
    android:text="@{user.lastName}" 
    android:layout_width="wrap_content" 
    android:layout_height="wrap_content" 
    android:visibility="@{user.isAdult ? View.VISIBLE : View.GONE}"/>

使用資源數(shù)據(jù)
這個例子,官方教程有錯誤稀并,可以參考Android Data Binder 的一個bug仅颇。

<TextView 
    android:padding="@{large? (int)@dimen/largePadding : (int)@dimen/smallPadding}" 
    android:background="@android:color/black" 
    android:textColor="@android:color/white" 
    android:layout_width="wrap_content" 
    android:layout_height="wrap_content" 
    android:text="@string/hello_world" />

Observable Binding
本來這一節(jié)的標題應該叫雙向綁定,但是很遺憾碘举,現(xiàn)在的Data Binding暫時支持單向綁定忘瓦,還沒有達到Angular.js的威力。
要實現(xiàn) Observable Binding引颈,首先得有一個實現(xiàn)了android.databinding.Observable的類耕皮,為了方便,Android 原生提供了已經(jīng)封裝好的一個類 -BaseObservable蝙场,并且實現(xiàn)了監(jiān)聽器的注冊機制凌停。
我們可以直接繼承BaseObservable。

public class ObservableUser extends BaseObservable{
    private String firstName;
    private String lastName;
    @Bindable 
    public String getFirstName() {
        return firstName;    
    }
    @Bindable 
    public String getLastName() {
        return lastName;    
    }
    public void setFirstName(String firstName) {
        this.firstName=firstName;
        notifyPropertyChanged(BR.firstName);   
    }
    public void setLastName(String lastName) {
        this.lastName=lastName;        
        notifyPropertyChanged(BR.lastName);    
    }
}

BR是編譯階段生成的一個類售滤,功能與R.java類似罚拟,用@Bindable標記過getter方法會在BR中生成一個entry,當我們
通過代碼可以看出完箩,當數(shù)據(jù)發(fā)生變化時還是需要手動發(fā)出通知赐俗。 通過調(diào)用notifyPropertyChanged(BR.firstName)來通知系統(tǒng)BR.firstName這個entry的數(shù)據(jù)已經(jīng)發(fā)生變化,需要更新 UI弊知。
除此之外阻逮,還有一種更細粒度的綁定方式,可以具體到成員變量秩彤,這種方式無需繼承BaseObservable叔扼,一個簡單的POJO就可以實現(xiàn)皆尔。

public class PlainUser{
    public final ObservableField<String>         
    firstName = new ObservableField<>();
    public final ObservableField<String>     
    lastName = new ObservableField<>();
    public final ObservableInt age = new ObservableInt();
}

系統(tǒng)為我們提供了所有的primitive type所對應的Observable類,例如ObservableInt币励、ObservableFloat、ObservableBoolean等等珊拼,還有一個ObservableField對應著reference type食呻。
剩下的數(shù)據(jù)綁定與前面介紹的方式一樣,具體可參考ObservableActivity
帶 ID 的 View
Data Binding有效降低了代碼的冗余性澎现,甚至完全沒有必要再去獲取一個 View 實例仅胞,但是情況不是絕對的,萬一我們真的就需要了呢剑辫?不用擔心干旧,只要給 View 定義一個 ID,Data Binding就會為我們生成一個對應的final變量妹蔽。

<TextView 
    android:id="@+id/firstName" 
    android:layout_width="wrap_content" 
    android:layout_height="wrap_content" />

上面代碼中定義了一個 ID 為firstName* 的TextView椎眯,那么它對應的變量就是

public final TextView firstName;

具體代碼可參考ViewWithIDsActivity.java
ViewStubs
xml中的ViewStub經(jīng)過 binding 之后會轉(zhuǎn)換成ViewStubProxy, 具體代碼可參考ViewStubActivity.java
簡單用代碼說明一下,xml 文件與之前的代碼一樣胳岂,根節(jié)點改為layout编整,在LinearLayout中添加一個ViewStub,添加ID乳丰。

<layout xmlns:android="http://schemas.android.com/apk/res/android">
     <LinearLayout 
            ...> 
         <ViewStub 
             android:id="@+id/view_stub" 
             android:layout="@layout/view_stub"
             ... />
     </LinearLayout>
</layout>

在 Java 代碼中獲取binding實例掌测,為ViewStubProy注冊ViewStub.OnInflateListener事件,搞定产园!

binding = DataBindingUtil.setContentView(this,R.layout.activity_view_stub);
binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
    @Override 
    public void onInflate(ViewStub stub,View inflated) {
        ViewStubBinding binding = DataBindingUtil.bind(inflated);
        User user = new User("fee","lang");        
        binding.setUser(user);    
    }
});

Dynamic Variables
完整代碼可以參考dynamic
以RecyclerView為例汞斧,Adapter的DataBinding需要動態(tài)生成,因此我們可以在onCreateViewHolder的時候創(chuàng)建這個DataBinding什燕,然后在onBindViewHolder中獲取這個DataBinding粘勒。

public static class BindingHolder extends RecyclerView.ViewHolder{
    private ViewDataBinding binding;
    public BindingHolder(View itemView) {
        super(itemView);    
    }
    public ViewDataBinding getBinding() {
        return binding;   
    }
    public void setBinding(ViewDataBinding binding) {
        this.binding = binding;    
    }
}
@Override 
public BindingHolder onCreateViewHolder(ViewGroup viewGroup,inti) {
    ViewDataBinding binding = DataBindingUtil.inflate(LayoutInflater.from(viewGroup.getContext()),R.layout.list_item,            viewGroup,false);
    BindingHolder holder = new BindingHolder(binding.getRoot()); 
    holder.setBinding(binding);
    return holder;
}
@Override 
public voidon BindViewHolder(BindingHolder holder,int position) {
    User user = users.get(position);        
    holder.getBinding().setVariable(BR.user, user);    
    holder.getBinding().executePendingBindings();
}

注意此處DataBindingUtil的用法:

ViewDataBinding binding = DataBindingUtil.inflate(LayoutInflater.from(viewGroup.getContext()),R.layout.list_item, viewGroup, false);

Attribute setters
有了Data Binding,即使屬性沒有在declare-styleable中定義屎即,我們也可以通過 xml 進行賦值操作仲义。 為了演示這個功能,我自定義了一個 View -UserView剑勾,其中R.styleable.UserView中只定義了一個age屬性埃撵,其中firstName和lastName只有對應的兩個setter方法。
只要有setter方法就可以這樣為屬性賦值:

<com.liangfeizc.databindingsamples.attributesetters.UserView
    android:layout_width="match_parent" 
    android:layout_height="wrap_content" 
    android:paddingLeft="@dimen/largePadding" 
    app:onClickListener="@{activity.clickListener}" 
    app:firstName="@{@string/firstName}" 
    app:lastName="@{@string/lastName}" 
    app:age="27" />

onClickListener也是同樣道理虽另,只不過我們是在Activity中定義了一個Listener暂刘。
轉(zhuǎn)換器 (Converters)
重要
使用Converter一定要保證它不會影響到其他的屬性胖翰,例如這個@BindingConversion-就會影響到, 因為他們都是都符合從 int 到 int 的轉(zhuǎn)換厚宰。
具體代碼可參考ConversionsActivity.java霎烙。
在 xml 中為屬性賦值時叁怪,如果變量的類型與屬性不一致,通過DataBinding可以進行轉(zhuǎn)換森缠。

<Button 
    android:onClick="toggleIsError" 
    android:text="@{isError.get() ? @color/red : @color/white}" 
    android:layout_width="match_parent" 
    android:layout_height="wrap_content" />

只需要定義一個標記了@BindingConversion的靜態(tài)方法即可:

@BindingConversion
public static int convertColorToString(intcolor) {
    switch(color) {
        caseColor.RED:
            return R.string.red;
        caseColor.WHITE:
            return R.string.white;    
    }
    return R.string.app_name;
}

include
用法可以參考代碼 IncludeActivity.java
如果在非根節(jié)點的 ViewGroup 中使用include會導致 crash拔鹰,已經(jīng)在 StackOverflow 上提了一個問題Android Data Binding makes app crash when using include tag in a non-root ViewGroup

轉(zhuǎn)載自(源碼下載): LyndonChin/MasteringAndroidDataBinding · GitHub

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市贵涵,隨后出現(xiàn)的幾起案子列肢,更是在濱河造成了極大的恐慌,老刑警劉巖宾茂,帶你破解...
    沈念sama閱讀 222,590評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件瓷马,死亡現(xiàn)場離奇詭異,居然都是意外死亡跨晴,警方通過查閱死者的電腦和手機欧聘,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,157評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來端盆,“玉大人怀骤,你說我怎么就攤上這事』烂睿” “怎么了晒喷?”我有些...
    開封第一講書人閱讀 169,301評論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長访敌。 經(jīng)常有香客問我凉敲,道長,這世上最難降的妖魔是什么寺旺? 我笑而不...
    開封第一講書人閱讀 60,078評論 1 300
  • 正文 為了忘掉前任爷抓,我火速辦了婚禮,結(jié)果婚禮上阻塑,老公的妹妹穿的比我還像新娘蓝撇。我一直安慰自己,他們只是感情好陈莽,可當我...
    茶點故事閱讀 69,082評論 6 398
  • 文/花漫 我一把揭開白布渤昌。 她就那樣靜靜地躺著,像睡著了一般走搁。 火紅的嫁衣襯著肌膚如雪独柑。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,682評論 1 312
  • 那天私植,我揣著相機與錄音忌栅,去河邊找鬼。 笑死曲稼,一個胖子當著我的面吹牛索绪,可吹牛的內(nèi)容都是我干的湖员。 我是一名探鬼主播,決...
    沈念sama閱讀 41,155評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼瑞驱,長吁一口氣:“原來是場噩夢啊……” “哼娘摔!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起唤反,我...
    開封第一講書人閱讀 40,098評論 0 277
  • 序言:老撾萬榮一對情侶失蹤凳寺,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后拴袭,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,638評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡曙博,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,701評論 3 342
  • 正文 我和宋清朗相戀三年拥刻,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片父泳。...
    茶點故事閱讀 40,852評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡般哼,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出惠窄,到底是詐尸還是另有隱情蒸眠,我是刑警寧澤,帶...
    沈念sama閱讀 36,520評論 5 351
  • 正文 年R本政府宣布杆融,位于F島的核電站楞卡,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏脾歇。R本人自食惡果不足惜蒋腮,卻給世界環(huán)境...
    茶點故事閱讀 42,181評論 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望藕各。 院中可真熱鬧池摧,春花似錦、人聲如沸激况。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,674評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽乌逐。三九已至竭讳,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間浙踢,已是汗流浹背代咸。 一陣腳步聲響...
    開封第一講書人閱讀 33,788評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留成黄,地道東北人呐芥。 一個月前我還...
    沈念sama閱讀 49,279評論 3 379
  • 正文 我出身青樓逻杖,卻偏偏與公主長得像,于是被迫代替她去往敵國和親思瘟。 傳聞我的和親對象是個殘疾皇子荸百,可洞房花燭夜當晚...
    茶點故事閱讀 45,851評論 2 361

推薦閱讀更多精彩內(nèi)容