Android Data Binding 框架

來源 https://github.com/LyndonChin/MasteringAndroidDataBinding

本教程是跟着 Data Binding Guide 學習過程中得出的一些實踐經驗，同時修改了官方教程的一些錯誤，每一個知識點都有對應的源碼，爭取做到實踐與理論相結合。

Data Binding 解決了 Android UI 編程中的一個痛點，官方原生支持 MVVM 模型可以讓我們在不改變既有代碼框架的前提下，非常容易地使用這些新特性。其實在此之前，已經有些第三方的框架（RoboAndroid) 可以支持 MVVM 模型，無耐由於框架的侵入性太強，導致一直沒有流行起來。

準備

Android Studio 更新到 1.3 版本

打開 Preferences，找到 Appearances & Behavior 下的 Updates 選項，把 Automatically Check updates for 修改成 Canary Channel。

注意

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'

注意

如果 Module 用到的 buildToolsVersion 高於 22.0.1，比如 23 rc1，那 com.android.databinding:dataBinder 的版本要改爲 1.3.0-beta1，否則會出現如下錯誤：

基礎

工程創建完成後，我們通過一個最簡單的例子來說明 Data Binding 的基本用法。

佈局文件

使用 Data Binding 之後，xml的佈局文件就不再單純地展示 UI 元素，還需要定義 UI 元素用到的變量。所以，它的根節點不再是一個 ViewGroup，而是變成了 layout，並且新增了一個節點 data。

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

要實現 MVVM 的 ViewModel 就需要把數據與UI進行綁定，data 節點就爲此提供了一個橋樑，我們先在 data 中聲明一個 variable，這個變量會爲 UI 元素提供數據（例如 TextView 的 android:text），然後在 Java 代碼中把”後臺”數據與這個 variable 進行綁定。

如果要用一個表格來展示用戶的基本信息，用 Data Binding 應該怎麼實現呢？

數據對象

添加一個 POJO 類 - User，非常簡單，四個屬性以及他們的 getter 和 setter。

public class User {
    private final String firstName;
    private final String lastName;
    private String displayName;
    private int age;
 
    public User(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }
 
    public User(String firstName, String lastName, int age) {
        this(firstName, lastName);
        this.age = age;
    }
 
    public int getAge() {
        return age;
    }
 
    public String getFirstName() {
        return firstName;
    }
 
    public String getLastName() {
        return lastName;
    }
 
    public String getDisplayName() {
        return firstName + " " + lastName;
    }
 
    public boolean isAdult() {
        return age >= 18;
    }
}

稍後，我們會新建一個 User 類型的變量，然後把它跟佈局文件中聲明的變量進行綁定。

定義 Variable

再回到佈局文件，在 data 節點中聲明一個變量 user。

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

其中 type 屬性就是我們在 Java 文件中定義的 User 類。

當然，data 節點也支持 import，所以上面的代碼可以換一種形式來寫。

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

然後我們剛纔在 build.gradle 中添加的那個插件 - com.android.databinding會根據xml文件的名稱 Generate 一個繼承自 ViewDataBinding 的類。

例如，這裏 xml 的文件名叫 activity_basic.xml，那麼生成的類就是 ActivityBasicBinding。

注意

java.lang.* 包中的類會被自動導入，可以直接使用，例如要定義一個 String 類型的變量：

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

綁定 Variable

修改 BasicActivity 的 onCreate 方法，用 DatabindingUtil.setContentView() 來替換掉 setContentView()，然後創建一個 user 對象，通過 binding.setUser(user) 與 variable 進行綁定。

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

注意

ActivityBasicBinding 類是自動生成的，所有的 set 方法也是根據 variable 名稱生成的。例如，我們定義了兩個變量。

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

那麼就會生成對應的兩個 set 方法。

setFirstName(String firstName);
setLastName(String lastName);

使用 Variable

數據與 Variable 綁定之後，xml 的 UI 元素就可以直接使用了。

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

至此，一個簡單的數據綁定就完成了，可參考完整代碼

高級用法

使用類方法

首先爲類添加一個靜態方法

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 節點中導入：

<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 節點了導入了兩個同名的類怎麼辦？

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

這樣一來出現了兩個 User 類，那 user 變量要用哪一個呢？不用擔心，import 還有一個 alias 屬性。

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

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

使用資源數據

這個例子，官方教程有錯誤，可以參考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

本來這一節的標題應該叫雙向綁定，但是很遺憾，現在的 Data Binding 暫時支持單向綁定，還沒有達到 Angular.js 的威力。

要實現 Observable Binding，首先得有一個實現了 android.databinding.Observable 的類，爲了方便，Android 原生提供了已經封裝好的一個類 - BaseObservable，並且實現了監聽器的註冊機制。

我們可以直接繼承 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，當我們

通過代碼可以看出，當數據發生變化時還是需要手動發出通知。 通過調用notifyPropertyChanged(BR.firstName)來通知系統 BR.firstName 這個 entry 的數據已經發生變化，需要更新 UI。

除此之外，還有一種更細粒度的綁定方式，可以具體到成員變量，這種方式無需繼承 BaseObservable，一個簡單的 POJO 就可以實現。

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

系統爲我們提供了所有的 primitive type 所對應的 Observable類，例如 ObservableInt、ObservableFloat、ObservableBoolean 等等，還有一個 ObservableField 對應着 reference type。

剩下的數據綁定與前面介紹的方式一樣，具體可參考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 經過 binding 之後會轉換成 ViewStubProxy, 具體代碼可參考 ViewStubActivity.java

簡單用代碼說明一下，xml 文件與之前的代碼一樣，根節點改爲 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 需要動態生成，因此我們可以在 onCreateViewHolder 的時候創建這個 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, int i) {
    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 void onBindViewHolder(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。

轉換器 (Converters)

具體代碼可參考 ConversionsActivity.java。

在 xml 中爲屬性賦值時，如果變量的類型與屬性不一致，通過 DataBinding 可以進行轉換。

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

只需要定義一個標記了 @BindingConversion 的靜態方法即可：

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

轉載自：http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/0603/2992.html

參考：http://blog.csdn.net/u010687392/article/details/47319623