Android DataBinding使用詳解(一)

DataBinding是一個實現數據和UI綁定的框架,同時也是實現MVVM模式所依賴的工具。

官方文檔

Demo下載地址

1.構建環境

在app根目錄的build.gradle文件中加入DataBinding配置:

android {
    ....
    dataBinding {
        enabled = true
    }
}

環境要求:

  • 系統版本:Android 2.1(API level 7)及以上

  • Gradle版本:1.5.0-alpha1及以上

  • Android Studio版本:1.3及以上

2.基本使用

佈局文件

DataBinding的佈局文件使用了layout標籤作爲根節點,其中包含了data標籤與view標籤,view標籤的內容就是不使用DataBinding時的普通佈局內容:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>
        <variable
            name="user"
            type="com.yl.databindingdemo.bean.User" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">

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

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

    </LinearLayout>

</layout>

data標籤下的user變量定義了可以在此佈局中使用的屬性:

<data>
    <variable
        name="user"
        type="com.yl.databindingdemo.bean.User" />
</data>

佈局中的表達式使用了@{ }語法:

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

數據實體

public class User {

    private String firstName;
    private String lastName;

    public User(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

數據綁定

默認情況下,DataBinding會根據佈局文件名稱自動生成ActivityBaseUseBinding類(activity_base_use -> ActivityBaseUseBinding)。

public class BaseUseActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // ActivityBaseUseBinding是根據佈局名稱自動生成的
        // 代替原來的setContentView(R.layout.activity_base_use)方法
        ActivityBaseUseBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_base_use);
        User user = new User("容華", "謝後");
        // set方法是根據data標籤下的variable名稱自動生成的
        binding.setUser(user);
    }
}

3.佈局詳情

導入

在data標籤下可以使用多個import標籤,就像Java一樣把類導入到佈局文件中:

<data>
    <import type="android.view.View"/>
</data>

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

當類名衝突時可以設置別名:

<import type="android.view.View"/>
<import type="com.example.real.estate.View"
        alias="Vista"/>

導入的類型也可以用於變量的類型引用和表達式中:

<data>
    <import type="com.example.User"/>
    <import type="java.util.List"/>
    <variable name="user" type="User"/>
    <variable name="userList" type="List&lt;User&gt;"/>
</data>

< >需要使用轉義字符&lt; &gt;代替。

在表達式中使用靜態方法:

public class StringUtils {

    public static String capitalize(String word) {
        if (word.length() > 1) {
            return String.valueOf(word.charAt(0)).toUpperCase() + word.substring(1);
        }
        return word;
    }
}
<data>
    <import type="com.yl.databindingdemo.utils.StringUtils"/>
    <variable name="user" type="com.yl.databindingdemo.bean.User"/>
</data>

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

和在Java中一樣,java.lang.* 會被自動導入。

自定義綁定類名

默認情況下,Binding的類名是根據佈局文件名稱命名的,假如包名是com.yl.databindingdemo,那麼Binding類就會被放在com.yl.databindingdemo.databinding包下,如果不想使用默認類名和路徑,可以進行自定義修改:

<!-- 自定義Binding類名 -->
<data class="ContactItem">
    ...
</data>

<!-- 自定義Binding存放路徑,.代表module根目錄 -->
<data class=".ContactItem">
    ...
</data>

<!-- 自定義Binding存放路徑,指定路徑 -->
<data class="com.example.ContactItem">
    ...
</data>

Includes

變量可以傳遞到include佈局中:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:bind="http://schemas.android.com/apk/res-auto">

    <data>
        <variable
            name="user"
            type="com.yl.databindingdemo.bean.User" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">

        <include
            layout="@layout/layout_include"
            bind:user="@{user}" />

    </LinearLayout>

</layout>

layout_include佈局中也需要聲明user變量:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>
        <variable
            name="user"
            type="com.yl.databindingdemo.bean.User" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">

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

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

    </LinearLayout>

</layout>

注意:DataBinding不支持使用merge節點。

表達式語法

支持的表達式:

  • 數學計算 + - / * %

  • 字符串連接 +

  • 邏輯 && ||

  • 二進制 & | ^

  • 一元運算符 + - ! ~

  • 位移 >> >>> <<

  • 比較 == > < >= <=

  • instanceof

  • 組 ()

  • 文字 - 字符,字符串,數字, null

  • 類型轉換

  • 函數調用

  • 字段存取

  • 數組存取 []

  • 三目運算符 ?:

例如:

android:text="@{String.valueOf(index + 1)}"
android:visibility="@{age < 13 ? View.GONE : View.VISIBLE}"
android:transitionName='@{"image_" + id}'

不支持的表達式:

  • this

  • super

  • new

  • 顯式泛型調用

Null合併運算符

非null時選擇左邊的操作,反之選擇右邊的操作:

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

等價於:

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

集合

通用的集合類(arrays, lists, sparse lists, maps),可以使用[ ]操作符來存取:

<data>
    <import type="android.util.SparseArray"/>
    <import type="java.util.Map"/>
    <import type="java.util.List"/>
    <variable name="list" type="List&lt;String&gt;"/>
    <variable name="sparse" type="SparseArray&lt;String&gt;"/>
    <variable name="map" type="Map&lt;String, String&gt;"/>
    <variable name="index" type="int"/>
    <variable name="key" type="String"/>
</data>
…
android:text="@{list[index]}"
…
android:text="@{sparse[index]}"
…
android:text="@{map[key]}"

如果屬性使用單引號的話,表達式就可以使用雙引號:

android:text='@{map["firstName"]}'

屬性使用雙引號,表達式可以使用以下兩種方式:

android:text="@{map[`firstName`}"
android:text="@{map['firstName']}"

資源

可以在表達式中使用普通語法來引用資源:

<string name="full_name">%1$s %2$s</string>

android:text="@{@string/full_name(user.firstName, user.lastName)}"

部分資源的表達式引用和普通引用有所不同:

Type Normal Reference Expression Reference
String[] @array @stringArray
int[] @array @intArray
TypedArray @array @typedArray
Animator @animator @animator
StateListAnimator @animator @stateListAnimator
color int @color @color
ColorStateList @color @colorStateList

4.動態更新

在上面的例子中,如果修改實體類的數據,UI是不會動態更新的,別擔心,DataBinding爲我們提供了一套很Nice的通知機制:

Observable Objects

DataBinding提供了Observable接口用於監聽實體類對象屬性的變化,Observable接口有具有添加、刪除監聽的功能。爲了簡化開發,DataBinding已經爲我們實現了一個基本的監聽類BaseObservable,實體類只要繼承BaseObservable,然後在get方法上加入@Bindable註解,set方法中調用notifyPropertyChanged通知UI更新就可以了。

public class ObservableObjectsUser extends BaseObservable {

    private String firstName;
    private String lastName;

    public ObservableObjectsUser() {
    }

    public ObservableObjectsUser(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    @Bindable
    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
        notifyPropertyChanged(BR.firstName);
    }

    @Bindable
    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
        notifyPropertyChanged(BR.lastName);
    }
}

在get方法上加入@Bindable註解後,DataBinding就會在BR文件中生成相應的字段,BR是編譯期間生成的類,類似於R文件。

在Activity中動態更新UI:

public class ObservableActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        ActivityObservableBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_observable);
        final ObservableObjectsUser user = new ObservableObjectsUser("容華", "謝後");
        binding.setUser(user);

        binding.setClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                user.setFirstName("空谷");
                user.setLastName("幽蘭");
            }
        });
    }
}

看下效果:

動態更新

ObservableFields

每個get方法都要加上註解,還要在每個set方法中通知UI更新,是不是有點麻煩,貼心的DataBinding還爲我們提供了更簡便的方式:

public class ObservableFieldsUser {

    public ObservableField<String> firstName = new ObservableField<>();
    public ObservableField<String> lastName = new ObservableField<>();

    public ObservableFieldsUser(String firstName, String lastName) {
        this.firstName.set(firstName);
        this.lastName.set(lastName);
    }
}

在Activity中動態更新UI:

public class ObservableActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        ActivityObservableBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_observable);
        final ObservableFieldsUser user = new ObservableFieldsUser("容華", "謝後")
        binding.setUser(user);

        binding.setClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                user.firstName.set("空谷");
                user.lastName.set("幽蘭");
        });
    }
}

除了ObservableField,還可以使用ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, ObservableParcelable。

Observable Collections

不一定使用實體類才能動態更新,DataBinding還爲我們提供了更靈活的方式:

public class ObservableActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        ActivityObservableBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_observable);

        final ObservableArrayMap<String, String> user = new ObservableArrayMap<>();
        user.put("firstName", "容華");
        user.put("lastName", "謝後");

        binding.setUser(user);

        binding.setClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                user.put("firstName", "空谷");
                user.put("lastName", "幽蘭");
            }
        });
    }
}

佈局文件:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>
        <import type="android.databinding.ObservableMap" />

        <variable
            name="user"
            type="ObservableMap&lt;String, String&gt;" />

        <variable
            name="clickListener"
            type="android.view.View.OnClickListener" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:layout_margin="10dp"
        android:orientation="vertical">

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user[`firstName`]}" />

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

        <Button
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="10dp"
            android:onClick="@{clickListener}"
            android:text="更新數據" />

    </LinearLayout>

</layout>

5.雙向綁定

DataBinding現在也支持雙向綁定了,即UI改變的同時,數據模型中的數據也跟着改變:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <variable
            name="user"
            type="com.yl.databindingdemo.bean.ObservableObjectsUser" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:layout_margin="10dp"
        android:orientation="vertical">

        <EditText
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@={user.firstName}" />

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

    </LinearLayout>

</layout>

使用@={ }表達式進行雙向綁定,看下效果:

雙向綁定

6.事件處理

類似於android:onClick可以指定Activity中的方法,DataBinding也提供了事件處理的機制:

  • 方法調用:方法的參數必須與監聽對象的參數相匹配,比如點擊事件onClick(View v),對應的方法必須爲methodName(View v)。

  • 監聽綁定:只要方法的返回值與監聽對象的返回值相匹配就可以,比如onLongClick(View v)的返回值是boolean類型的,那麼對應的方法返回值也必須是boolean類型的。

方法調用

表達式會在編譯時處理,如果方法不存在,編譯將會報錯。

public class EventHandler {

    public void onClickFriend(View view) {
        Toast.makeText(view.getContext(), "onClickFriend", Toast.LENGTH_LONG).show();
    }
}

佈局文件:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <variable
            name="handler"
            type="com.yl.databindingdemo.handler.EventHandler" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center_vertical"
        android:orientation="vertical">

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"
            android:onClick="@{handler::onClickFriend}"
            android:text="方法調用" />

    </LinearLayout>

</layout>

@{handler::onClickFriend}代表調用EventHandler類中的onClickFriend方法,注意onClickFriend方法的參數必須與onClick(View v)方法的參數相匹配。

監聽綁定

官方文檔上的說明是:監聽綁定在事件發生時調用,可以使用任意表達式。測試過程中發現如果方法不存在,編譯也會報錯。

注意:需要在Android Gradle Plugin version 2.0版本以上使用。

public class EventHandler {

    public void onTaskClick(Task task) {
        task.run();
    }

    public void onTaskClick(View view, Task task) {
        Toast.makeText(view.getContext(), "onTaskClick", Toast.LENGTH_LONG).show();
        task.run();
    }

    public void onCompletedChanged(Task task, boolean completed) {
        if (completed) {
            task.run();
        }
    }
}

public class Task implements Runnable {

    private static final String TAG = "Task";

    @Override
    public void run() {
        Log.i(TAG, "Task running");
    }
}

佈局文件:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <variable
            name="handler"
            type="com.yl.databindingdemo.handler.EventHandler" />

        <variable
            name="task"
            type="com.yl.databindingdemo.task.Task" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center_vertical"
        android:orientation="vertical">

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"
            android:onClick="@{() -> handler.onTaskClick(task)}"
            android:text="監聽綁定" />

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"
            android:onClick="@{(view) -> handler.onTaskClick(view,task)}"
            android:text="監聽綁定_使用參數" />

        <CheckBox
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center_horizontal"
            android:layout_margin="10dp"
            android:onCheckedChanged="@{(checkBox, isChecked) -> handler.onCompletedChanged(task, isChecked)}" />

    </LinearLayout>

</layout>

lambda表達式中的參數有兩種選擇,全不寫或者全寫,例如onCheckedChanged(CompoundButton buttonView, boolean isChecked)方法有兩個參數,如果用到其中一個參數,另一個參數也要補上,不能只寫一個,參數名稱可以自定義。

7.寫在最後

源碼已託管到GitHub上,歡迎Fork,覺得還不錯就Start一下吧!

GitHub傳送門

歡迎同學們吐槽評論,如果你覺得本篇博客對你有用,那麼就留個言或者頂一下吧(^-^)

在下一篇文章中我們將會學習一下DataBinding的其他用法,例如如何在RecyclerView中使用DataBinding,如何自定義屬性等,敬請期待!

《 Android DataBinding使用詳解(二)》

發佈了64 篇原創文章 · 獲贊 275 · 訪問量 27萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章