Android DataBinding使用詳解（一）

封面

DataBinding是一個實現(xiàn)數(shù)據(jù)和UI綁定的框架，同時也是實現(xiàn)MVVM模式所依賴的工具。

官方文檔

Demo下載地址

1.構建環(huán)境

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

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

環(huán)境要求：

  • 系統(tǒng)版本：Android 2.1(API level 7)及以上

  • Gradle版本：1.5.0-alpha1及以上

  • Android Studio版本：1.3及以上

2.基本使用

布局文件

DataBinding的布局文件使用了layout標簽作為根節(jié)點，其中包含了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}" />

數(shù)據(jù)實體

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;
    }
}

數(shù)據(jù)綁定

默認情況下，DataBinding會根據(jù)布局文件名稱自動生成ActivityBaseUseBinding類（activity_base_use -> ActivityBaseUseBinding）。

public class BaseUseActivity extends AppCompatActivity {

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

        // ActivityBaseUseBinding是根據(jù)布局名稱自動生成的
        // 代替原來的setContentView(R.layout.activity_base_use)方法
        ActivityBaseUseBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_base_use);
        User user = new User("容華", "謝后");
        // set方法是根據(jù)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<User>"/>
</data>

< >需要使用轉義字符< >代替。

在表達式中使用靜態(tài)方法：

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的類名是根據(jù)布局文件名稱命名的，假如包名是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節(jié)點。

表達式語法

支持的表達式：

  • 數(shù)學計算 + - / * %

  • 字符串連接 +

  • 邏輯 && ||

  • 二進制 & | ^

  • 一元運算符 + - ! ~

  • 位移 >> >>> <<

  • 比較 == > < >= <=

  • instanceof

  • 組 ()

  • 文字 - 字符，字符串，數(shù)字， null

  • 類型轉換

  • 函數(shù)調用

  • 字段存取

  • 數(shù)組存取 []

  • 三目運算符 ?：

例如：

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

不支持的表達式：

  • this

  • super

  • new

  • 顯式泛型調用 <T>

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<String>"/>
    <variable name="sparse" type="SparseArray<String>"/>
    <variable name="map" type="Map<String, String>"/>
    <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.動態(tài)更新

在上面的例子中，如果修改實體類的數(shù)據(jù)，UI是不會動態(tài)更新的，別擔心，DataBinding為我們提供了一套很Nice的通知機制：

Observable Objects

DataBinding提供了Observable接口用于監(jiān)聽實體類對象屬性的變化，Observable接口有具有添加、刪除監(jiān)聽的功能。為了簡化開發(fā)，DataBinding已經(jīng)為我們實現(xiàn)了一個基本的監(jiān)聽類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中動態(tài)更新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("幽蘭");
            }
        });
    }
}

看下效果：

動態(tài)更新

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中動態(tài)更新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<T>，還可以使用ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, ObservableParcelable。

Observable Collections

不一定使用實體類才能動態(tài)更新，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<String, String>" />

        <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="更新數(shù)據(jù)" />

    </LinearLayout>

</layout>

5.雙向綁定

DataBinding現(xiàn)在也支持雙向綁定了，即UI改變的同時，數(shù)據(jù)模型中的數(shù)據(jù)也跟著改變：

<?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也提供了事件處理的機制：

  • 方法調用：方法的參數(shù)必須與監(jiān)聽對象的參數(shù)相匹配，比如點擊事件onClick(View v)，對應的方法必須為methodName(View v)。

  • 監(jiān)聽綁定：只要方法的返回值與監(jiān)聽對象的返回值相匹配就可以，比如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方法的參數(shù)必須與onClick(View v)方法的參數(shù)相匹配。

監(jiān)聽綁定

官方文檔上的說明是：監(jiān)聽綁定在事件發(fā)生時調用，可以使用任意表達式。測試過程中發(fā)現(xiàn)如果方法不存在，編譯也會報錯。

注意：需要在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="監(jiān)聽綁定" />

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

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

7.寫在最后

源碼已托管到GitHub上，歡迎Fork，覺得還不錯就Start一下吧！

GitHub傳送門

歡迎同學們吐槽評論，如果你覺得本篇博客對你有用，那么就留個言或者點下喜歡吧(＾－＾)

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

《Android DataBinding使用詳解（二）》

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

相關閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,323評論 25贊 708
  • 一個剛入行半年的菜鳥安卓開發(fā)人員，始終有一顆不安分的心。mvvm框架是我在學習vue的時候才知道的一種新型架構。公...
    sakasa閱讀 4,369評論 5贊 22
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,695評論 19贊 139
  • DataBinding 庫是 Google 公司 Android Framework UI 工具團隊開發(fā)出來的一款...
    bravian閱讀 5,523評論 2贊 16
  • 一 調用的方法:## 1. OC調用js方法,只需要調用UIWebView自帶的方法即可. 2.js調用OC方法,...
    480a52903ce5閱讀 531評論 0贊 0

友情鏈接更多精彩內容