Android DataBinding 從入門到進(jìn)階（修改版）

半年多前寫了一篇：Android DataBinding 從入門到進(jìn)階的文章，最近發(fā)現(xiàn)里面有些小錯誤棒厘，就修改了下文章纵穿，并且增添了幾個 DataBinding 的使用例子，希望對你所有幫助

本文是我在學(xué)習(xí) Google 的 DataBinding 框架的過程中寫的筆記奢人，會不定時更新谓媒，最新一次的更新時間是在 2019-02-27，希望對你有所幫助何乎，也歡迎 Star

項目 GitHub 地址：DataBindingSamples

DataBinding 是谷歌官方發(fā)布的一個框架句惯，顧名思義即為數(shù)據(jù)綁定，是 MVVM 模式在 Android 上的一種實現(xiàn)支救，用于降低布局和邏輯的耦合性抢野，使代碼邏輯更加清晰。MVVM 相對于 MVP各墨，其實就是將 Presenter 層替換成了 ViewModel 層指孤。DataBinding 能夠省去我們一直以來的 findViewById() 步驟，大量減少 Activity 內(nèi)的代碼贬堵，數(shù)據(jù)能夠單向或雙向綁定到 layout 文件中恃轩，有助于防止內(nèi)存泄漏，而且能自動進(jìn)行空檢測以避免空指針異常

啟用 DataBinding 的方法是在對應(yīng) Model 的 build.gradle 文件里加入以下代碼黎做，同步后就能引入對 DataBinding 的支持

android {
    dataBinding {
        enabled = true
    }
}

一叉跛、基礎(chǔ)入門

啟用 DataBinding 后，這里先來看下如何在布局文件中綁定指定的變量

打開布局文件引几，選中根布局的 ViewGroup昧互，按住 Alt + 回車鍵，點擊 “Convert to data binding layout”伟桅，就可以生成 DataBinding 需要的布局規(guī)則

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

    <data>

    </data>

    <android.support.constraint.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">
    </android.support.constraint.ConstraintLayout>
</layout>

和原始布局的區(qū)別在于多出了一個 layout 標(biāo)簽將原布局包裹了起來，data 標(biāo)簽用于聲明要用到的變量以及變量類型叽掘，要實現(xiàn) MVVM 的 ViewModel 就需要把數(shù)據(jù)（Model）與 UI（View）進(jìn)行綁定楣铁，data 標(biāo)簽的作用就像一個橋梁搭建了 View 和 Model 之間的通道

這里先來聲明一個 Modle

/**
 * 作者：leavesC
 * 時間：2019/2/27 21:36
 * 描述：
 * GitHub：https://github.com/leavesC
 * Blog：http://www.reibang.com/u/9df45b87cfdf
 */
public class User {

    private String name;

    private String password;

    public User(String name, String password) {
        this.name = name;
        this.password = password;
    }

    ···

}

在 data 標(biāo)簽里聲明要使用到的變量名、類的全路徑

    <data>
        <variable
            name="userInfo"
            type="leavesc.hello.databindingsamples.model.User" />
    </data>

如果 User 類型要多處用到更扁，也可以直接將之 import 進(jìn)來盖腕，這樣就不用每次都指明整個包名路徑了赫冬，而 java.lang.* 包中的類會被自動導(dǎo)入，所以可以直接使用

    <data>
        <import type="leavesc.hello.databindingsamples.model.User"/>
        <variable
            name="userInfo"
            type="User"/>
    </data>

如果存在 import 的類名相同的情況溃列，可以使用 alias 指定別名

    <data>
        <import type="leavesc.hello.databindingsamples.model.User" />
        <import
            alias="TempUser"
            type="leavesc.hello.databindingsamples.model2.User" />
        <variable
            name="userInfo"
            type="User" />
        <variable
            name="tempUserInfo"
            type="TempUser" />
    </data>

這里聲明了一個 User 類型的變量 userInfo劲厌，我們要做的就是使這個變量與兩個 TextView 控件掛鉤，通過設(shè)置 userInfo 的變量值同時使 TextView 顯示相應(yīng)的文本
完整的布局代碼如下所示

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

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <variable
            name="userInfo"
            type="User" />
    </data>

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

        <TextView
            style="@style/titleTextStyle"
            android:text="單向數(shù)據(jù)綁定" />

        <TextView
            android:id="@+id/tv_userName"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{userInfo.name}" />

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{userInfo.password}" />

    </LinearLayout>

</layout>

通過 @{userInfo.name} 使 TextView 引用到相關(guān)的變量听隐，DataBinding 會將之映射到相應(yīng)的 getter 方法
之后可以在 Activity 中通過 DataBindingUtil 設(shè)置布局文件补鼻，省略原先 Activity 的 setContentView() 方法，并為變量 userInfo 賦值

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
         ActivityMain2Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main2);
        User user = new User("leavesC", "123456");
        binding.setUserInfo(user);
    }

由于 @{userInfo.name}在布局文件中并沒有明確的值雅任，所以在預(yù)覽視圖中什么都不會顯示风范，不便于觀察文本的大小和字體顏色等屬性，此時可以為之設(shè)定默認(rèn)值（文本內(nèi)容或者是字體大小等屬性都適用）沪么，默認(rèn)值將只在預(yù)覽視圖中顯示硼婿，且默認(rèn)值不能包含引號

    android:text="@{userInfo.name,default=defaultValue}"

此外，也可以通過 ActivityMain2Binding 直接獲取到指定 ID 的控件

    activityMain2Binding.tvUserName.setText("leavesC");

每個數(shù)據(jù)綁定布局文件都會生成一個綁定類禽车，ViewDataBinding 的實例名是根據(jù)布局文件名來生成寇漫，將之改為首字母大寫的駝峰命名法來命名，并省略布局文件名包含的下劃線殉摔≈硗螅控件的獲取方式類似，但首字母小寫

也可以通過如下方式自定義 ViewDataBinding 的實例名

    <data class="CustomBinding">

    </data>

此外钦勘，在綁定表達(dá)式中會根據(jù)需要生成一個名為context的特殊變量陋葡，context的值是根 View 的getContext()方法返回的Context對象， context變量會被具有該名稱的顯式變量聲明所覆蓋

Databinding 同樣是支持在 Fragment 和 RecyclerView 中使用彻采。例如腐缤，可以看 Databinding 在 Fragment 中的使用

    @Override
    public View onCreateView(@NonNull LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        FragmentBlankBinding binding = DataBindingUtil.inflate(inflater, R.layout.fragment_blank, container, false);
        binding.setHint("Hello");
        return binding.getRoot();
    }

**以上實現(xiàn)數(shù)據(jù)綁定的方式，每當(dāng)綁定的變量發(fā)生變化的時候肛响，都需要重新向 ViewDataBinding 傳遞新的變量值才能刷新 UI 岭粤。接下來看如何實現(xiàn)自動刷新 UI **

二、單向數(shù)據(jù)綁定

實現(xiàn)數(shù)據(jù)變化自動驅(qū)動 UI 刷新的方式有三種：BaseObservable特笋、ObservableField剃浇、ObservableCollection

2.1、BaseObservable

一個純凈的 ViewModel 類被更新后猎物，并不會讓 UI 自動更新虎囚。而數(shù)據(jù)綁定后，我們自然會希望數(shù)據(jù)變更后 UI 會即時刷新蔫磨，Observable 就是為此而生的概念

BaseObservable 提供了 notifyChange() 和 notifyPropertyChanged() 兩個方法淘讥，前者會刷新所有的值域，后者則只更新對應(yīng) BR 的 flag堤如，該 BR 的生成通過注釋 @Bindable 生成蒲列，可以通過 BR notify 特定屬性關(guān)聯(lián)的視圖

/**
 * 作者：leavesC
 * 時間：2019/2/27 21:36
 * 描述：
 * GitHub：https://github.com/leavesC
 * Blog：http://www.reibang.com/u/9df45b87cfdf
 */
public class Goods extends BaseObservable {

    //如果是 public 修飾符窒朋，則可以直接在成員變量上方加上 @Bindable 注解
    @Bindable
    public String name;

    //如果是 private 修飾符，則在成員變量的 get 方法上添加 @Bindable 注解
    private String details;

    private float price;

    public Goods(String name, String details, float price) {
        this.name = name;
        this.details = details;
        this.price = price;
    }

    public void setName(String name) {
        this.name = name;
        //只更新本字段
        notifyPropertyChanged(leavesc.hello.databindingsamples.BR.name);
    }

    @Bindable
    public String getDetails() {
        return details;
    }

    public void setDetails(String details) {
        this.details = details;
        //更新所有字段
        notifyChange();
    }

    public float getPrice() {
        return price;
    }

    public void setPrice(float price) {
        this.price = price;
    }

    @Override
    public String toString() {
        return "Goods{" +
                "name='" + name + '\'' +
                ", details='" + details + '\'' +
                ", price=" + price +
                '}';
    }

}

在 setName() 方法中更新的只是本字段蝗岖，而 setDetails() 方法中更新的是所有字段

添加兩個按鈕用于改變 goods 變量的三個屬性值侥猩，由此可以看出兩個 notify 方法的區(qū)別。當(dāng)中涉及的按鈕點擊事件綁定抵赢，在下面也會講到

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

    <data>

        <import type="leavesc.hello.databindingsamples.model.Goods" />

        <import type="leavesc.hello.databindingsamples.Main3Activity.GoodsHandler" />

        <variable
            name="goods"
            type="Goods" />

        <variable
            name="goodsHandler"
            type="GoodsHandler" />

    </data>

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

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{goods.name}" />

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{goods.details}" />

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{String.valueOf(goods.price)}" />

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:onClick="@{()->goodsHandler.changeGoodsName()}"
            android:text="改變屬性 name 和 price"
            android:textAllCaps="false" />

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:onClick="@{()->goodsHandler.changeGoodsDetails()}"
            android:text="改變屬性 details 和 price"
            android:textAllCaps="false" />

    </LinearLayout>
</layout>

/**
 * 作者：leavesC
 * 時間：2019/2/27 21:36
 * 描述：
 * GitHub：https://github.com/leavesC
 * Blog：http://www.reibang.com/u/9df45b87cfdf
 */
public class Main3Activity extends AppCompatActivity {

    private static final String TAG = "Main3Activity";

    private Goods goods;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMain3Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main3);
        goods = new Goods("code", "hi", 24);
        binding.setGoods(goods);
        binding.setGoodsHandler(new GoodsHandler());
    }

    public class GoodsHandler {

        public void changeGoodsName() {
            goods.setName("code" + new Random().nextInt(100));
            goods.setPrice(new Random().nextInt(100));
        }

        public void changeGoodsDetails() {
            goods.setDetails("hi" + new Random().nextInt(100));
            goods.setPrice(new Random().nextInt(100));
        }

    }

}

可以看到欺劳，name 視圖的刷新沒有同時刷新 price 視圖，而 details 視圖刷新的同時也刷新了 price 視圖

實現(xiàn)了 Observable 接口的類允許注冊一個監(jiān)聽器瓣俯，當(dāng)可觀察對象的屬性更改時就會通知這個監(jiān)聽器杰标，此時就需要用到 OnPropertyChangedCallback

當(dāng)中 propertyId 就用于標(biāo)識特定的字段

        goods.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
            @Override
            public void onPropertyChanged(Observable sender, int propertyId) {
                if (propertyId == com.leavesc.databinding_demo.BR.name) {
                    Log.e(TAG, "BR.name");
                } else if (propertyId == com.leavesc.databinding_demo.BR.details) {
                    Log.e(TAG, "BR.details");
                } else if (propertyId == com.leavesc.databinding_demo.BR._all) {
                    Log.e(TAG, "BR._all");
                } else {
                    Log.e(TAG, "未知");
                }
            }
        });

2.2、ObservableField

繼承于 Observable 類相對來說限制有點高彩匕，且也需要進(jìn)行 notify 操作腔剂，因此為了簡單起見可以選擇使用 ObservableField。ObservableField 可以理解為官方對 BaseObservable 中字段的注解和刷新等操作的封裝驼仪，官方原生提供了對基本數(shù)據(jù)類型的封裝掸犬，例如 ObservableBoolean、ObservableByte绪爸、ObservableChar湾碎、ObservableShort、ObservableInt奠货、ObservableLong介褥、ObservableFloat、ObservableDouble 以及 ObservableParcelable 递惋，也可通過 ObservableField 泛型來申明其他類型

/**
 * 作者：leavesC
 * 時間：2019/2/27 21:36
 * 描述：
 * GitHub：https://github.com/leavesC
 * Blog：http://www.reibang.com/u/9df45b87cfdf
 */
public class ObservableGoods {

    private ObservableField<String> name;

    private ObservableField<String> details;

    private ObservableFloat price;

    public ObservableGoods(String name, String details, float price) {
        this.name = new ObservableField<>(name);
        this.details = new ObservableField<>(details);
        this.price = new ObservableFloat(price);
    }

    ···

}

對 ObservableGoods 屬性值的改變都會立即觸發(fā) UI 刷新柔滔，概念上與 Observable 區(qū)別不大，具體效果可看下面提供的源代碼萍虽，這里不再贅述

2.3睛廊、ObservableCollection

DataBinding 也提供了包裝類用于替代原生的 List 和 Map，分別是 ObservableList 和 ObservableMap,當(dāng)其包含的數(shù)據(jù)發(fā)生變化時杉编，綁定的視圖也會隨之進(jìn)行刷新

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

    <data>

        <import type="android.databinding.ObservableList" />

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

        <variable
            name="list"
            type="ObservableList&lt;String&gt;" />

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

        <variable
            name="index"
            type="int" />

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

    </data>

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

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:padding="20dp"
            android:text="@{list[index]}" />

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_marginTop="20dp"
            android:padding="20dp"
            android:text="@{map[key]}" />

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:onClick="onClick"
            android:text="改變數(shù)據(jù)" />

    </LinearLayout>
</layout>

    private ObservableMap<String, String> map;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMain5Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main5);
        map = new ObservableArrayMap<>();
        map.put("name", "leavesC");
        map.put("age", "24");
        binding.setMap(map);
        ObservableList<String> list = new ObservableArrayList<>();
        list.add("Ye");
        list.add("leavesC");
        binding.setList(list);
        binding.setIndex(0);
        binding.setKey("name");
    }

    public void onClick(View view) {
        map.put("name", "leavesC,hi" + new Random().nextInt(100));
    }

三超全、雙向數(shù)據(jù)綁定

雙向綁定的意思即為當(dāng)數(shù)據(jù)改變時同時使視圖刷新，而視圖改變時也可以同時改變數(shù)據(jù)

看以下例子邓馒，當(dāng) EditText 的輸入內(nèi)容改變時嘶朱，會同時同步到變量 goods,綁定變量的方式比單向綁定多了一個等號：android:text="@={goods.name}"

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    
    <data>
        <import type="leavesc.hello.databindingsamples.model.ObservableGoods" />
        <variable
            name="goods"
            type="ObservableGoods" />
    </data>

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

        <TextView
            style="@style/titleTextStyle"
            android:layout_marginTop="10dp"
            android:text="雙向數(shù)據(jù)綁定" />

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{goods.name}" />

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

    </LinearLayout>

</layout>

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMain2Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main2);
        ObservableGoods goods = new ObservableGoods("code", "hi", 23);
        binding.setGoods(goods);
    }

四、事件綁定

嚴(yán)格意義上來說绒净，事件綁定也是一種變量綁定见咒，只不過設(shè)置的變量是回調(diào)接口而已
事件綁定可用于以下多種回調(diào)事件

android:onClick
android:onLongClick
android:afterTextChanged
android:onTextChanged
...

在 Activity 內(nèi)部新建一個 UserPresenter 類來聲明 onClick() 和 afterTextChanged() 事件相應(yīng)的回調(diào)方法

    public class UserPresenter {

        public void onUserNameClick(User user) {
            Toast.makeText(Main6Activity.this, "用戶名：" + user.getName(), Toast.LENGTH_SHORT).show();
        }

        public void afterTextChanged(Editable s) {
            user.setName(s.toString());
            binding.setUserInfo(user);
        }

        public void afterUserPasswordChanged(Editable s) {
            user.setPassword(s.toString());
            binding.setUserInfo(user);
        }

    }

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

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <import type="leavesc.hello.databindingsamples.Main6Activity.UserPresenter" />

        <import type="leavesc.hello.databindingsamples.StringUtils" />

        <variable
            name="userInfo"
            type="User" />

        <variable
            name="userPresenter"
            type="UserPresenter" />
    </data>

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

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:onClick="@{()->userPresenter.onUserNameClick(userInfo)}"
            android:text="@{StringUtils.toUpperCase(userInfo.name)}" />

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{userInfo.password}" />

        <EditText
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:afterTextChanged="@{userPresenter.afterTextChanged}"
            android:hint="用戶名" />

        <EditText
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:afterTextChanged="@{userPresenter.afterUserPasswordChanged}"
            android:hint="密碼" />

    </LinearLayout>

</layout>

方法引用的方式與調(diào)用函數(shù)的方式類似，既可以選擇保持事件回調(diào)方法的簽名一致：@{userPresenter.afterTextChanged}挂疆，此時方法名可以不一樣改览，但方法參數(shù)和返回值必須和原始的回調(diào)函數(shù)保持一致。也可以引用不遵循默認(rèn)簽名的函數(shù)：@{()->userPresenter.onUserNameClick(userInfo)}缤言，這里用到了 Lambda 表達(dá)式宝当，這樣就可以不遵循默認(rèn)的方法簽名，將userInfo對象直接傳回點擊方法中胆萧。此外庆揩，也可以使用方法引用 :: 的形式來進(jìn)行事件綁定

五、使用類方法

首先定義一個靜態(tài)方法

public class StringUtils {

    public static String toUpperCase(String str) {
        return str.toUpperCase();
    }

}

在 data 標(biāo)簽中導(dǎo)入該工具類

        <import type="leavesc.hello.databindingsamples.StringUtils" />

然后就可以像對待一般的函數(shù)一樣來調(diào)用了

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:onClick="@{()->userPresenter.onUserNameClick(userInfo)}"
            android:text="@{StringUtils.toUpperCase(userInfo.name)}" />

六跌穗、運算符

6.1订晌、基礎(chǔ)運算符

DataBinding 支持在布局文件中使用以下運算符、表達(dá)式和關(guān)鍵字

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

目前不支持以下操作

this
super
new
顯示泛型調(diào)用

此外蚌吸，DataBinding 還支持以下幾種形式的調(diào)用

6.2锈拨、Null Coalescing

空合并運算符 ?? 會取第一個不為 null 的值作為返回值

 <TextView
     android:layout_width="match_parent"
     android:layout_height="wrap_content"
     android:text="@{user.name ?? user.password}" />

等價于

    android:text="@{user.name != null ? user.name : user.password}"

6.3、屬性控制

可以通過變量值來控制 View 的屬性

 <TextView
     android:layout_width="match_parent"
     android:layout_height="wrap_content"
     android:text="可見性變化"
     android:visibility="@{user.male  ? View.VISIBLE : View.GONE}" />

6.4羹唠、避免空指針異常

DataBinding 也會自動幫助我們避免空指針異常
例如奕枢，如果 "@{userInfo.password}" 中 userInfo 為 null 的話，userInfo.password 會被賦值為默認(rèn)值 null佩微，而不會拋出空指針異常

七缝彬、include 和 viewStub

7.1、include

對于 include 的布局文件哺眯，一樣是支持通過 dataBinding 來進(jìn)行數(shù)據(jù)綁定谷浅，此時一樣需要在待 include 的布局中依然使用 layout 標(biāo)簽，聲明需要使用到的變量

view_include.xml

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

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <variable
            name="userInfo"
            type="User" />
    </data>

    <android.support.constraint.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:background="#acc">

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="20dp"
            android:text="@{userInfo.name}" />

    </android.support.constraint.ConstraintLayout>
</layout>

在主布局文件中將相應(yīng)的變量傳遞給 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"
    xmlns:tools="http://schemas.android.com/tools">

    <data>
        <import type="leavesc.hello.databindingsamples.model.User" />
        <variable
            name="userInfo"
            type="User" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
        
        <include
            layout="@layout/view_include"
            bind:userInfo="@{userInfo}" />
        
    </LinearLayout>
</layout>

7.2一疯、viewStub

dataBinding 一樣支持 ViewStub 布局

在布局文件中引用 viewStub 布局

   <ViewStub
        android:id="@+id/view_stub"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout="@layout/view_stub"/>

獲取到 ViewStub 對象，由此就可以來控制 ViewStub 的可見性

    ActivityMain7Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main7);
    View view = binding.viewStub.getViewStub().inflate();

如果需要為 ViewStub 綁定變量值寝杖，則 ViewStub 文件一樣要使用 layout 標(biāo)簽進(jìn)行布局违施，主布局文件使用自定義的 bind 命名空間將變量傳遞給 ViewStub

    <ViewStub
        android:id="@+id/view_stub"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout="@layout/view_stub"
        bind:userInfo="@{userInfo}" />

如果在 xml 中沒有使用 bind:userInfo="@{userInf}"對 ViewStub 進(jìn)行數(shù)據(jù)綁定，則可以等到當(dāng) ViewStub Inflate 時再綁定變量瑟幕，此時需要為 ViewStub 設(shè)置 setOnInflateListener回調(diào)函數(shù)磕蒲，在回調(diào)函數(shù)中進(jìn)行數(shù)據(jù)綁定

binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
            @Override
            public void onInflate(ViewStub stub, View inflated) {
                //如果在 xml 中沒有使用 bind:userInfo="@{userInf}" 對 viewStub 進(jìn)行數(shù)據(jù)綁定
                //那么可以在此處進(jìn)行手動綁定
                ViewStubBinding viewStubBinding = DataBindingUtil.bind(inflated);
                viewStubBinding.setUserInfo(user);
                Log.e(TAG, "onInflate");
            }
        });

八、BindingAdapter

dataBinding 提供了 BindingAdapter 這個注解用于支持自定義屬性只盹，或者是修改原有屬性辣往。注解值可以是已有的 xml 屬性，例如 android:src殖卑、android:text等站削，也可以自定義屬性然后在 xml 中使用

例如，對于一個 ImageView 孵稽，我們希望在某個變量值發(fā)生變化時许起，可以動態(tài)改變顯示的圖片十偶，此時就可以通過 BindingAdapter 來實現(xiàn)

需要先定義一個靜態(tài)方法，為之添加 BindingAdapter 注解园细，注解值是為 ImageView 控件自定義的屬性名惦积，而該靜態(tài)方法的兩個參數(shù)可以這樣來理解：當(dāng) ImageView 控件的 url 屬性值發(fā)生變化時，dataBinding 就會將 ImageView 實例以及新的 url 值傳遞給 loadImage() 方法猛频，從而可以在此動態(tài)改變 ImageView 的相關(guān)屬性

    @BindingAdapter({"url"})
    public static void loadImage(ImageView view, String url) {
        Log.e(TAG, "loadImage url : " + url);
    }

在 xml 文件中關(guān)聯(lián)變量值狮崩，當(dāng)中，bind 這個名稱可以自定義

<?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"
    xmlns:tools="http://schemas.android.com/tools">

    <data>
        <import type="leavesc.hello.databindingsamples.model.Image" />
        <variable
            name="image"
            type="Image" />
    </data>

    <android.support.constraint.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <ImageView
            android:id="@+id/image"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:src="@drawable/ic_launcher_background"
            bind:url="@{image.url}" />
        
    </android.support.constraint.ConstraintLayout>
</layout>

BindingAdapter 更為強(qiáng)大的一點是可以覆蓋 Android 原先的控件屬性鹿寻。例如睦柴，可以設(shè)定每一個 Button 的文本都要加上后綴：“-Button”

    @BindingAdapter("android:text")
    public static void setText(Button view, String text) {
        view.setText(text + "-Button");
    }

    <Button
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:onClick="@{()->handler.onClick(image)}"
       android:text='@{"改變圖片Url"}'/>

這樣，整個工程中使用到了 "android:text" 這個屬性的控件毡熏，其顯示的文本就會多出一個后綴

九坦敌、BindingConversion

dataBinding 還支持對數(shù)據(jù)進(jìn)行轉(zhuǎn)換，或者進(jìn)行類型轉(zhuǎn)換

與 BindingAdapter 類似招刹，以下方法會將布局文件中所有以@{String}方式引用到的String類型變量加上后綴-conversionString

    @BindingConversion
    public static String conversionString(String text) {
        return text + "-conversionString";
    }

xml 文件

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text='@{"xxx"}'
            android:textAllCaps="false"/>

可以看到恬试，對于 Button 來說，BindingAdapter 和 BindingConversion 同時生效了疯暑，而 BindingConversion 的優(yōu)先級要高些

此外训柴，BindingConversion 也可以用于轉(zhuǎn)換屬性值的類型

看以下布局，此處在向 background 和 textColor 兩個屬性賦值時妇拯，直接就使用了字符串幻馁，按正常情況來說這自然是會報錯的，但有了 BindingConversion 后就可以自動將字符串類型的值轉(zhuǎn)為需要的 Drawable 和 Color 了

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:background='@{"紅色"}'
            android:padding="20dp"
            android:text="紅色背景藍(lán)色字"
            android:textColor='@{"藍(lán)色"}'/>

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_marginTop="20dp"
            android:background='@{"藍(lán)色"}'
            android:padding="20dp"
            android:text="藍(lán)色背景紅色字"
            android:textColor='@{"紅色"}'/>

    @BindingConversion
    public static Drawable convertStringToDrawable(String str) {
        if (str.equals("紅色")) {
            return new ColorDrawable(Color.parseColor("#FF4081"));
        }
        if (str.equals("藍(lán)色")) {
            return new ColorDrawable(Color.parseColor("#3F51B5"));
        }
        return new ColorDrawable(Color.parseColor("#344567"));
    }

    @BindingConversion
    public static int convertStringToColor(String str) {
        if (str.equals("紅色")) {
            return Color.parseColor("#FF4081");
        }
        if (str.equals("藍(lán)色")) {
            return Color.parseColor("#3F51B5");
        }
        return Color.parseColor("#344567");
    }

十越锈、Array仗嗦、List、Set甘凭、Map ...

dataBinding 也支持在布局文件中使用 數(shù)組稀拐、Lsit、Set 和 Map丹弱，且在布局文件中都可以通過 list[index] 的形式來獲取元素

而為了和 variable 標(biāo)簽的尖括號區(qū)分開德撬，在聲明 Lsit<String> 之類的數(shù)據(jù)類型時，需要使用尖括號的轉(zhuǎn)義字符

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

    <data>
        <import type="java.util.List" />
        <import type="java.util.Map" />
        <import type="java.util.Set" />
        <import type="android.util.SparseArray" />
        <variable
            name="array"
            type="String[]" />
        <variable
            name="list"
            type="List&lt;String&gt;" />
        <variable
            name="map"
            type="Map&lt;String, String&gt;" />
        <variable
            name="set"
            type="Set&lt;String&gt;" />
        <variable
            name="sparse"
            type="SparseArray&lt;String&gt;" />
        <variable
            name="index"
            type="int" />
        <variable
            name="key"
            type="String" />
    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".Main7Activity">

        <TextView
            ···
            android:text="@{array[1]}" />
        <TextView
            ···
            android:text="@{sparse[index]}" />
        <TextView
            ···
            android:text="@{list[index]}" />
        <TextView
            ···
            android:text="@{map[key]}" />
        <TextView
            ···
            android:text='@{map["leavesC"]}' />
        <TextView
            ···
            android:text='@{set.contains("xxx")?"xxx":key}' />
    </LinearLayout>
</layout>

十一躲胳、資源引用

dataBinding 支持對尺寸和字符串這類資源的訪問

dimens.xml

    <dimen name="paddingBig">190dp</dimen>
    <dimen name="paddingSmall">150dp</dimen>

strings.xml

    <string name="format">%s is %s</string>

    <data>
        <variable
            name="flag"
            type="boolean" />
    </data>       
    <Button
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:paddingLeft="@{flag ? @dimen/paddingBig:@dimen/paddingSmall}"
         android:text='@{@string/format("leavesC", "Ye")}'
         android:textAllCaps="false" />

十二蜓洪、與 RecyclerView 搭配使用

dataBinding 與 RecyclerView 搭配使用的話可以讓代碼更加簡潔明了

先聲明需要的 item 布局文件

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

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <variable
            name="user"
            type="User" />

    </data>

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

        <TextView
            android:id="@+id/tvName"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="8dp"
            android:text="@{user.name}" />

        <TextView
            android:id="@+id/tvPassword"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="8dp"
            android:text="@{user.password}" />

        <View
            android:layout_width="match_parent"
            android:layout_height="1dp"
            android:background="#c6cdd4" />

    </LinearLayout>

</layout>

對應(yīng)的 RecyclerView.Adapter

/**
 * 作者：leavesC
 * 時間：2019/2/27 21:36
 * 描述：
 * GitHub：https://github.com/leavesC
 * Blog：http://www.reibang.com/u/9df45b87cfdf
 */
public class UserAdapter extends RecyclerView.Adapter<UserAdapter.UserAdapterHolder> {

    private List<User> userList;

    public UserAdapter(List<User> userList) {
        this.userList = userList;
    }

    @NonNull
    @Override
    public UserAdapterHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        ItemUserBinding binding = DataBindingUtil.inflate(LayoutInflater.from(parent.getContext()), R.layout.item_user, parent, false);
        return new UserAdapterHolder(binding);
    }

    @Override
    public void onBindViewHolder(@NonNull UserAdapterHolder holder, int position) {
        holder.getBinding().setUser(userList.get(position));
    }

    @Override
    public int getItemCount() {
        if (userList == null) {
            return 0;
        }
        return userList.size();
    }

    class UserAdapterHolder extends RecyclerView.ViewHolder {

        private ItemUserBinding binding;

        UserAdapterHolder(ItemUserBinding binding) {
            super(binding.getRoot());
            this.binding = binding;
        }

        public ItemUserBinding getBinding() {
            return binding;
        }
    }

}

十三、RecyclerView Adapter 高效率刷新

前文講到了 ObservableList 坯苹，此處就可以通過 ObservableList 的實現(xiàn)類 ObservableArrayList 來實現(xiàn) RecyclerView Adapter 的高效刷新隆檀，而不是每次都是直接 notifyDataSetChanged

可以先看下 ObservableArrayList 的源碼，可以發(fā)現(xiàn)在每次增刪改數(shù)據(jù)時，都會觸發(fā)到 ListChangeRegistry 內(nèi)的 OnListChangedCallback 回調(diào)恐仑，且 OnListChangedCallback 是把每次改動到的數(shù)據(jù)位置都給透傳到外部泉坐，我們可以通過這些信息來只刷新 Adapter 的特定位置，從而實現(xiàn)高效刷新菊霜，并且獲得一些動畫效果

public class ObservableArrayList<T> extends ArrayList<T> implements ObservableList<T> {
   
    private transient ListChangeRegistry mListeners = new ListChangeRegistry();

    ···

    @Override
    public boolean add(T object) {
        super.add(object);
        notifyAdd(size() - 1, 1);
        return true;
    }
    
    @Override
    public void clear() {
        int oldSize = size();
        super.clear();
        if (oldSize != 0) {
            notifyRemove(0, oldSize);
        }
    }

    @Override
    public T remove(int index) {
        T val = super.remove(index);
        notifyRemove(index, 1);
        return val;
    }

    @Override
    public T set(int index, T object) {
        T val = super.set(index, object);
        if (mListeners != null) {
            mListeners.notifyChanged(this, index, 1);
        }
        return val;
    }

    private void notifyAdd(int start, int count) {
        if (mListeners != null) {
            mListeners.notifyInserted(this, start, count);
        }
    }

    private void notifyRemove(int start, int count) {
        if (mListeners != null) {
            mListeners.notifyRemoved(this, start, count);
        }
    }
    
    ···
    
}

此處通過 DynamicChangeCallback 來實現(xiàn)對 Adapter 的刷新操作

/**
 * 作者：leavesC
 * 時間：2019/2/27 21:36
 * 描述：
 * GitHub：https://github.com/leavesC
 * Blog：http://www.reibang.com/u/9df45b87cfdf
 */
public class DynamicChangeCallback<T> extends ObservableList.OnListChangedCallback<ObservableList<T>> {

    private RecyclerView.Adapter adapter;

    public DynamicChangeCallback(RecyclerView.Adapter adapter) {
        this.adapter = adapter;
    }

    @Override
    public void onChanged(ObservableList<T> sender) {
        adapter.notifyDataSetChanged();
    }

    @Override
    public void onItemRangeChanged(ObservableList<T> sender, int positionStart, int itemCount) {
        adapter.notifyItemRangeChanged(positionStart, itemCount);
    }

    @Override
    public void onItemRangeInserted(ObservableList<T> sender, int positionStart, int itemCount) {
        adapter.notifyItemRangeInserted(positionStart, itemCount);
    }

    @Override
    public void onItemRangeMoved(ObservableList<T> sender, int fromPosition, int toPosition, int itemCount) {
        adapter.notifyItemRangeRemoved(fromPosition, itemCount);
        adapter.notifyItemRangeInserted(toPosition, itemCount);
    }

    @Override
    public void onItemRangeRemoved(ObservableList<T> sender, int positionStart, int itemCount) {
        adapter.notifyItemRangeRemoved(positionStart, itemCount);
    }

}

通過幾個按鈕來分別測試 Adapter 的數(shù)據(jù)刷新情況

public class Main13Activity extends AppCompatActivity {

    private ObservableArrayList<User> userObservableArrayList;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main13);
        RecyclerView rvList = findViewById(R.id.rvList);
        rvList.setLayoutManager(new LinearLayoutManager(this));
        initData();
        UserAdapter userAdapter = new UserAdapter(userObservableArrayList);
        userAdapter.notifyDataSetChanged();
        userObservableArrayList.addOnListChangedCallback(new DynamicChangeCallback(userAdapter));
        rvList.setAdapter(userAdapter);
    }

    private void initData() {
        userObservableArrayList = new ObservableArrayList<>();
        for (int i = 0; i < 20; i++) {
            User user = new User("user_" + i, String.valueOf(new Random().nextInt() * 4));
            userObservableArrayList.add(user);
        }
    }

    public void addItem(View view) {
        if (userObservableArrayList.size() >= 3) {
            User user = new User("user_" + 100, String.valueOf(new Random().nextInt() * 4));
            userObservableArrayList.add(1, user);
        }
    }

    public void addItemList(View view) {
        if (userObservableArrayList.size() >= 3) {
            List<User> userList = new ArrayList<>();
            for (int i = 0; i < 3; i++) {
                User user = new User("user_" + 100, String.valueOf(new Random().nextInt() * 4));
                userList.add(user);
            }
            userObservableArrayList.addAll(1, userList);
        }
    }

    public void removeItem(View view) {
        if (userObservableArrayList.size() >= 3) {
            userObservableArrayList.remove(1);
        }
    }

    public void updateItem(View view) {
        if (userObservableArrayList.size() >= 3) {
            User user = userObservableArrayList.get(1);
            user.setName("user_" + new Random().nextInt());
            userObservableArrayList.set(1, user);
        }
    }

}

公眾號：字節(jié)數(shù)組坚冀，熱衷于分享 Android 系統(tǒng)源碼解析济赎，Jetpack 源碼解析辜御、熱門開源庫源碼解析等面試必備的知識點

最后編輯于：2021.10.24 23:40:22

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者

人面猴
序言：七十年代末歼郭，一起剝皮案震驚了整個濱河市，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌忠聚，老刑警劉巖，帶你破解...
沈念sama閱讀 216,372評論 6贊 498
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件虹曙，死亡現(xiàn)場離奇詭異氓癌，居然都是意外死亡，警方通過查閱死者的電腦和手機(jī)统扳，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 92,368評論 3贊 392
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門喘帚，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人咒钟，你說我怎么就攤上這事吹由。” “怎么了朱嘴？”我有些...
開封第一講書人閱讀 162,415評論 0贊 353
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵倾鲫，是天一觀的道長。經(jīng)常有香客問我萍嬉，道長乌昔，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 58,157評論 1贊 292
?港島之戀（遺憾婚禮）
正文為了忘掉前任壤追，我火速辦了婚禮磕道，結(jié)果婚禮上，老公的妹妹穿的比我還像新娘行冰。我一直安慰自己溺蕉，他們只是感情好，可當(dāng)我...
茶點故事閱讀 67,171評論 6贊 388
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布资柔。她就那樣靜靜地躺著焙贷，像睡著了一般。火紅的嫁衣襯著肌膚如雪贿堰。梳的紋絲不亂的頭發(fā)上辙芍，一...
開封第一講書人閱讀 51,125評論 1贊 297
城市分裂傳說
那天，我揣著相機(jī)與錄音，去河邊找鬼故硅。笑死庶灿，一個胖子當(dāng)著我的面吹牛，可吹牛的內(nèi)容都是我干的吃衅。我是一名探鬼主播往踢，決...
沈念sama閱讀 40,028評論 3贊 417
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼徘层！你這毒婦竟也來了峻呕？” 一聲冷哼從身側(cè)響起，我...
開封第一講書人閱讀 38,887評論 0贊 274
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤趣效，失蹤者是張志新（化名）和其女友劉穎瘦癌，沒想到半個月后，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體跷敬，經(jīng)...
沈念sama閱讀 45,310評論 1贊 310
?護(hù)林員之死
正文獨居荒郊野嶺守林人離奇死亡讯私，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點故事閱讀 37,533評論 2贊 332
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時候發(fā)現(xiàn)自己被綠了西傀。大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片斤寇。...
茶點故事閱讀 39,690評論 1贊 348
活死人
序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖拥褂，靈堂內(nèi)的尸體忽然破棺而出娘锁，到底是詐尸還是另有隱情，我是刑警寧澤肿仑，帶...
沈念sama閱讀 35,411評論 5贊 343
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布致盟，位于F島的核電站，受9級特大地震影響尤慰，放射性物質(zhì)發(fā)生泄漏馏锡。R本人自食惡果不足惜，卻給世界環(huán)境...
茶點故事閱讀 41,004評論 3贊 325
男人毒藥：我在死后第九天來索命
文/蒙蒙一伟端、第九天我趴在偏房一處隱蔽的房頂上張望杯道。院中可真熱鬧，春花似錦责蝠、人聲如沸党巾。這莊子的主人今日做“春日...
開封第一講書人閱讀 31,659評論 0贊 22
一樁弒父案霜医，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽齿拂。三九已至，卻和暖如春肴敛，著一層夾襖步出監(jiān)牢的瞬間署海，已是汗流浹背吗购。一陣腳步聲響...
開封第一講書人閱讀 32,812評論 1贊 268
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留砸狞，地道東北人捻勉。一個月前我還...
沈念sama閱讀 47,693評論 2贊 368
代替公主和親
正文我出身青樓，卻偏偏與公主長得像刀森，于是被迫代替她去往敵國和親踱启。傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當(dāng)晚...
茶點故事閱讀 44,577評論 2贊 353