Android DataBinding 從入門到進階（2）

時間 2019-11-08

標籤 android databinding 入門進階欄目 Android 简体版

原文原文鏈接

半年多前寫了一篇：Android DataBinding 從入門到進階的文章，最近發現裏面有些小錯誤，就修改了下文章，而且增添了幾個 DataBinding 的使用例子，但願對你全部幫助php

本文是我在學習 Google 的 DataBinding 框架的過程當中寫的筆記，會不定時更新，最新一次的更新時間是在 2019-02-27，但願對你有所幫助，也歡迎 Star

項目 GitHub 地址：DataBindingSamples

DataBinding 是谷歌官方發佈的一個框架，顧名思義即爲數據綁定，是 MVVM 模式在 Android 上的一種實現，用於下降佈局和邏輯的耦合性，使代碼邏輯更加清晰。MVVM 相對於 MVP，其實就是將 Presenter 層替換成了 ViewModel 層。DataBinding 可以省去咱們一直以來的 findViewById() 步驟，大量減小 Activity 內的代碼，數據可以單向或雙向綁定到 layout 文件中，有助於防止內存泄漏，並且能自動進行空檢測以免空指針異常java

啓用 DataBinding 的方法是在對應 Model 的 build.gradle 文件里加入如下代碼，同步後就能引入對 DataBinding 的支持android

android {
    dataBinding {
        enabled = true
    }
}
複製代碼

1、基礎入門

啓用 DataBinding 後，這裏先來看下如何在佈局文件中綁定指定的變量git

打開佈局文件，選中根佈局的 ViewGroup，按住 Alt + 回車鍵，點擊「Convert to data binding layout」，就能夠生成 DataBinding 須要的佈局規則github

<?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>
複製代碼

和原始佈局的區別在於多出了一個 layout 標籤將原佈局包裹了起來，data 標籤用於聲明要用到的變量以及變量類型，要實現 MVVM 的 ViewModel 就須要把數據（Model）與 UI（View）進行綁定，data 標籤的做用就像一個橋樑搭建了 View 和 Model 之間的通道數組

這裏先來聲明一個 Modleapp

/** * 做者：leavesC * 時間：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.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 標籤裏聲明要使用到的變量名、類的全路徑框架

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

若是 User 類型要多處用到，也能夠直接將之 import 進來，這樣就不用每次都指明整個包名路徑了，而 java.lang.* 包中的類會被自動導入，因此能夠直接使用dom

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

若是存在 import 的類名相同的狀況，可使用 alias 指定別名ide

<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 控件掛鉤，經過設置 userInfo 的變量值同時使 TextView 顯示相應的文本完整的佈局代碼以下所示

<?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="單向數據綁定" />

        <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 引用到相關的變量，DataBinding 會將之映射到相應的 getter 方法以後能夠在 Activity 中經過 DataBindingUtil 設置佈局文件，省略原先 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}在佈局文件中並無明確的值，因此在預覽視圖中什麼都不會顯示，不便於觀察文本的大小和字體顏色等屬性，此時能夠爲之設定默認值（文本內容或者是字體大小等屬性都適用），默認值將只在預覽視圖中顯示，且默認值不能包含引號

android:text="@{userInfo.name,default=defaultValue}"
複製代碼

此外，也能夠經過 ActivityMain2Binding 直接獲取到指定 ID 的控件

activityMain2Binding.tvUserName.setText("leavesC");
複製代碼

每一個數據綁定佈局文件都會生成一個綁定類，ViewDataBinding 的實例名是根據佈局文件名來生成，將之改成首字母大寫的駝峯命名法來命名，並省略佈局文件名包含的下劃線。控件的獲取方式相似，但首字母小寫

也能夠經過以下方式自定義 ViewDataBinding 的實例名

<data class="CustomBinding">

    </data>
複製代碼

此外，在綁定表達式中會根據須要生成一個名爲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();
    }
複製代碼

**以上實現數據綁定的方式，每當綁定的變量發生變化的時候，都須要從新向 ViewDataBinding 傳遞新的變量值才能刷新 UI 。接下來看如何實現自動刷新 UI **

2、單向數據綁定

實現數據變化自動驅動 UI 刷新的方式有三種：BaseObservable、ObservableField、ObservableCollection

2.一、BaseObservable

一個純淨的 ViewModel 類被更新後，並不會讓 UI 自動更新。而數據綁定後，咱們天然會但願數據變動後 UI 會即時刷新，Observable 就是爲此而生的概念

BaseObservable 提供了 notifyChange() 和 notifyPropertyChanged() 兩個方法，前者會刷新全部的值域，後者則只更新對應 BR 的 flag，該 BR 的生成經過註釋 @Bindable 生成，能夠經過 BR notify 特定屬性關聯的視圖

/** * 做者：leavesC * 時間：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.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 方法的區別。當中涉及的按鈕點擊事件綁定，在下面也會講到

<?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：https://www.jianshu.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 視圖

實現了 Observable 接口的類容許註冊一個監聽器，當可觀察對象的屬性更改時就會通知這個監聽器，此時就須要用到 OnPropertyChangedCallback

當中 propertyId 就用於標識特定的字段

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.二、ObservableField

繼承於 Observable 類相對來講限制有點高，且也須要進行 notify 操做，所以爲了簡單起見能夠選擇使用 ObservableField。ObservableField 能夠理解爲官方對 BaseObservable 中字段的註解和刷新等操做的封裝，官方原生提供了對基本數據類型的封裝，例如 ObservableBoolean、ObservableByte、ObservableChar、ObservableShort、ObservableInt、ObservableLong、ObservableFloat、ObservableDouble 以及 ObservableParcelable ，也可經過 ObservableField 泛型來申明其餘類型

/** * 做者：leavesC * 時間：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.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 屬性值的改變都會當即觸發 UI 刷新，概念上與 Observable 區別不大，具體效果可看下面提供的源代碼，這裏再也不贅述

2.三、ObservableCollection

DataBinding 也提供了包裝類用於替代原生的 List 和 Map，分別是 ObservableList 和 ObservableMap,當其包含的數據發生變化時，綁定的視圖也會隨之進行刷新

<?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="改變數據" />

    </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));
    }
複製代碼

3、雙向數據綁定

雙向綁定的意思即爲當數據改變時同時使視圖刷新，而視圖改變時也能夠同時改變數據

看如下例子，當 EditText 的輸入內容改變時，會同時同步到變量 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="雙向數據綁定" />

        <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);
    }
複製代碼

4、事件綁定

嚴格意義上來講，事件綁定也是一種變量綁定，只不過設置的變量是回調接口而已事件綁定可用於如下多種回調事件

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

在 Activity 內部新建一個 UserPresenter 類來聲明 onClick() 和 afterTextChanged() 事件相應的回調方法

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>
複製代碼

方法引用的方式與調用函數的方式相似，既能夠選擇保持事件回調方法的簽名一致：@{userPresenter.afterTextChanged}，此時方法名能夠不同，但方法參數和返回值必須和原始的回調函數保持一致。也能夠引用不遵循默認簽名的函數：@{()->userPresenter.onUserNameClick(userInfo)}，這裏用到了 Lambda 表達式，這樣就能夠不遵循默認的方法簽名，將userInfo對象直接傳回點擊方法中。此外，也可使用方法引用 :: 的形式來進行事件綁定

5、使用類方法

首先定義一個靜態方法

public class StringUtils {

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

}
複製代碼

在 data 標籤中導入該工具類

<import type="leavesc.hello.databindingsamples.StringUtils" />
複製代碼

而後就能夠像對待通常的函數同樣來調用了

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

6、運算符

6.一、基礎運算符

DataBinding 支持在佈局文件中使用如下運算符、表達式和關鍵字

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

目前不支持如下操做

this
super
new
顯示泛型調用

此外，DataBinding 還支持如下幾種形式的調用

6.二、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.三、屬性控制

能夠經過變量值來控制 View 的屬性

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

6.四、避免空指針異常

DataBinding 也會自動幫助咱們避免空指針異常例如，若是 "@{userInfo.password}" 中 userInfo 爲 null 的話，userInfo.password 會被賦值爲默認值 null，而不會拋出空指針異常

7、include 和 viewStub

7.一、include

對於 include 的佈局文件，同樣是支持經過 dataBinding 來進行數據綁定，此時同樣須要在待 include 的佈局中依然使用 layout 標籤，聲明須要使用到的變量

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>
複製代碼

在主佈局文件中將相應的變量傳遞給 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.二、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 標籤進行佈局，主佈局文件使用自定義的 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 進行數據綁定，則能夠等到當 ViewStub Inflate 時再綁定變量，此時須要爲 ViewStub 設置 setOnInflateListener回調函數，在回調函數中進行數據綁定

binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
            @Override
            public void onInflate(ViewStub stub, View inflated) {
                //若是在 xml 中沒有使用 bind:userInfo="@{userInf}" 對 viewStub 進行數據綁定
                //那麼能夠在此處進行手動綁定
                ViewStubBinding viewStubBinding = DataBindingUtil.bind(inflated);
                viewStubBinding.setUserInfo(user);
                Log.e(TAG, "onInflate");
            }
        });
複製代碼

8、BindingAdapter

dataBinding 提供了 BindingAdapter 這個註解用於支持自定義屬性，或者是修改原有屬性。註解值能夠是已有的 xml 屬性，例如 android:src、android:text等，也能夠自定義屬性而後在 xml 中使用

例如，對於一個 ImageView ，咱們但願在某個變量值發生變化時，能夠動態改變顯示的圖片，此時就能夠經過 BindingAdapter 來實現

須要先定義一個靜態方法，爲之添加 BindingAdapter 註解，註解值是爲 ImageView 控件自定義的屬性名，而該靜態方法的兩個參數能夠這樣來理解：當 ImageView 控件的 url 屬性值發生變化時，dataBinding 就會將 ImageView 實例以及新的 url 值傳遞給 loadImage() 方法，從而能夠在此動態改變 ImageView 的相關屬性

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

在 xml 文件中關聯變量值，當中，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 更爲強大的一點是能夠覆蓋 Android 原先的控件屬性。例如，能夠設定每個 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" 這個屬性的控件，其顯示的文本就會多出一個後綴

9、BindingConversion

dataBinding 還支持對數據進行轉換，或者進行類型轉換

與 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 的優先級要高些

此外，BindingConversion 也能夠用於轉換屬性值的類型

看如下佈局，此處在向 background 和 textColor 兩個屬性賦值時，直接就使用了字符串，按正常狀況來講這天然是會報錯的，但有了 BindingConversion 後就能夠自動將字符串類型的值轉爲須要的 Drawable 和 Color 了

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

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="20dp" android:background='@{"藍色"}' android:padding="20dp" android:text="藍色背景紅色字" android:textColor='@{"紅色"}'/>
複製代碼

@BindingConversion
    public static Drawable convertStringToDrawable(String str) {
        if (str.equals("紅色")) {
            return new ColorDrawable(Color.parseColor("#FF4081"));
        }
        if (str.equals("藍色")) {
            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("藍色")) {
            return Color.parseColor("#3F51B5");
        }
        return Color.parseColor("#344567");
    }
複製代碼

10、Array、List、Set、Map ...

dataBinding 也支持在佈局文件中使用 數組、Lsit、Set 和 Map，且在佈局文件中均可以經過 list[index] 的形式來獲取元素

而爲了和 variable 標籤的尖括號區分開，在聲明 Lsit 之類的數據類型時，須要使用尖括號的轉義字符

<?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>
複製代碼

11、資源引用

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" />
複製代碼

12、與 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>
複製代碼

對應的 RecyclerView.Adapter

/** * 做者：leavesC * 時間：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.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;
        }
    }

}

複製代碼

十3、RecyclerView Adapter 高效率刷新

前文講到了 ObservableList ，此處就能夠經過 ObservableList 的實現類 ObservableArrayList 來實現 RecyclerView Adapter 的高效刷新，而不是每次都是直接 notifyDataSetChanged

能夠先看下 ObservableArrayList 的源碼，能夠發如今每次增刪改數據時，都會觸發到 ListChangeRegistry 內的 OnListChangedCallback 回調，且 OnListChangedCallback 是把每次改動到的數據位置都給透傳到外部，咱們能夠經過這些信息來只刷新 Adapter 的特定位置，從而實現高效刷新，而且得到一些動畫效果

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 來實現對 Adapter 的刷新操做

/** * 做者：leavesC * 時間：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.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 的數據刷新狀況

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

}
複製代碼

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。