Android進階四：Databinding的使用(基礎篇)

阿新 • • 發佈：2019-02-14

Data Binding是2015年Google I/O大會上提出的，從Beta版至今，Data Binding已經是一個可用度較高，也能帶來實際生產力提升的技術。

Data Binding顧名思義就是資料繫結，是Google對MVVM在Android上的一種實現，可以直接繫結資料到xml上，並實現自動重新整理，現在最新的版本還支援雙向繫結。

Data Binding的優點：

1、去掉Activities & Fragments內的大部分UI程式碼（setOnClickListener, setText, findViewById, etc.)

2、 UI程式碼放到了xml中，佈局和資料更緊密

3、提升開發效率，效能高（甚至超越手寫程式碼）

4、功能強大

Data Binding的缺點：

1、 IDE支援還不那麼完善（提示、表示式）

2、報錯資訊不那麼直接

3、重構支援不好（xml中進行重構，java程式碼不會自動修改）

一.配置環境：

1、使用Databinding相容包，可以相容到Android 2.1（API level 7+）版本，Gradle外掛需要使用1.5.0-alpha1及以上版本，

2、需要使用Andorid Studio 1.3及以上IDE.

3、然後需要在專案的app主模組對應build.gradle檔案中配置：

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

假如你app主模組已經依賴了一個使用databinding功能的模組，也需要做以上配置

二.基本使用

1.佈局檔案

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

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

要實現 MVVM 的 ViewModel 就需要把資料與UI進行繫結，data 節點就為此提供了一個橋樑，我們先在 data 中宣告一個 variable，這個變數會為 UI 元素提供資料（例如 TextView 的 android:text），然後在 Java 程式碼中把”後臺”資料與這個 variable 進行繫結。

如果要用一個表格來展示使用者的基本資訊，用 Data Binding 應該怎麼實現呢？

2.資料物件

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

public class User {
    private final String firstName;
    private final String lastName;
    private String displayName;
    private int age;

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

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

    public int getAge() {
        return age;
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public String getDisplayName() {
        return firstName + " " + lastName;
    }

    public boolean isAdult() {
        return age >= 18;
    }
}

稍後，我們會在佈局檔案中新建一個 User 型別的變數，然後把它跟佈局檔案中宣告的變數進行繫結。

3.定義 Variable

再回到佈局檔案，在 data 節點中宣告一個變數 user。

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

其中 type 屬性就是我們在 Java 檔案中定義的 User 類。
當然，data 節點也支援 import ，所以上面的程式碼可以換一種形式來寫。

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

如果兩個類名都是User，可以使用alias 屬性：

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

然後Data Binding外掛會根據xml檔案的名稱 Generate 一個繼承自 ViewDataBinding 的類。
例如，這裡 xml 的檔名叫 activity_basic.xml，那麼生成的類就是 ActivityBasicBinding。

我們也可以自定義名稱，只需要：

<data class=“ContactItem”>
…
</data>

這樣生成的類就不是 ActivityBasicBinding，而會變成ContactItem。

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

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

4.繫結 Variable
修改 BasicActivity 的 onCreate 方法，用 DatabindingUtil.setContentView() 來替換掉 setContentView()，然後建立一個 user 物件，通過 binding.setUser(user) 與 variable 進行繫結。

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

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

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

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

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

這裡獲取ActivityBasicBinding類的例項，用於與user進行資料繫結，獲取ActivityBasicBinding例項還可以使用：

ActivityBasicBinding binding = ActivityBasicBinding.inflate(getLayoutInflater());

假如ListView和RecyclerView需要使用Data Binding，可以用以下方法獲取binding例項：

ListItemBinding binding = ListItemBinding.inflate(layoutInflater, viewGroup, false);
//or
ListItemBinding binding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false);

5.使用 Variable

資料與 Variable 繫結之後，xml 的 UI 元素就可以直接使用了，注意需要使用“@{}”語法。

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

至此，一個簡單的資料繫結就完成了，可參考完整程式碼

三.高階使用

1.事件繫結

我們可以在xml中直接繫結下面屬性的值，稱為事件繫結：
android:onClick
android:onLongClick
android:onTextChanged
…

事件繫結分方法引用和監聽器繫結

(1)、方法引用
通常會在java程式碼中定義一個名為Handler或者Presenter的類，然後set進來，方法簽名需和對應listener方法一致，即方法的傳參必須一樣。

@Override
protected void onCreate(Bundle savedInstanceState) {
    ...
    binding.setPresenter(new Presenter());
    ...
}

public class Presenter {
    public void onTextChanged(CharSequence s, int start, int before, int count) {
        employee.setFirstName(s.toString());
        employee.setFired(!employee.isFired.get());
    }

    public void onClick(View view) {
        Toast.makeText(DemoActivity.this, "點到了", Toast.LENGTH_SHORT).show();
    }
}

在xml中：

<layout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:bind="http://schemas.android.com/apk/res-auto">
    <data>
        <import type="android.view.View"/>
        <variable
            name="employee"
            type="com.github.markzhai.databindingsample.Employee"/>
        <variable
            name="presenter"
            type="com.github.markzhai.databindingsample.DemoActivity.Presenter"/>
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center_horizontal"
        android:orientation="vertical"
        tools:context=".DemoActivity">
        <EditText
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:hint="輸入 First Name"
            android:onTextChanged="@{presenter::onTextChanged}"/>
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:onClick="@{presenter.onClick}"/>
    </LinearLayout>
</layout>

注意這裡使用presenter.onClick或者presenter::onClick都可以

(2)、監聽器繫結

監聽器繫結就相當於直接在xml寫方法體，只不過方法體只有呼叫一個方法，使用lambda表示式：

public class Presenter {
    public void onClickListenerBinding(Employee employee) {
        Toast.makeText(DemoActivity.this, employee.getLastName(),
                Toast.LENGTH_SHORT).show();
    }
}

<TextView
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_margin="5dp"
    android:visibility="@{employee.isFired ? View.GONE : View.VISIBLE}"
    android:onClick="@{() -> presenter.onClickListenerBinding(employee)}"/>

或者可以寫為：

android:onClick="@{(view) -> presenter.onClickListenerBinding(employee)}

如果要使用view引數，可以寫為：

android:onClick="@{(theview) -> presenter.onClickListenerBinding(theview,employee)}

加入你想使用三元表示式，注意返回型別需要一致，這裡是onClick(view)的返回型別為void：

android:onClick="@{(v) -> v.isVisible() ? doSomething() : void}"

2.變數傳遞Includes

variable節點定義個變數，可以在xml之間傳遞，
主佈局：

<?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.example.User"/>
   </data>
   <LinearLayout
       android:orientation="vertical"
       android:layout_width="match_parent"
       android:layout_height="match_parent">
       <include layout="@layout/sub_layout"
           bind:user="@{user}"/>
   </LinearLayout>
</layout>

子佈局sub_layout.xml：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <variable name="user" type="com.example.User"/>
    </data>
    <LinearLayout
        android:orientation="vertical"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.firstName}"/>
    </LinearLayout>
</layout>

或者：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <variable name="user" type="com.example.User"/>
    </data>
    <merge
        android:orientation="vertical"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.firstName}"/>
    </merge>
</layout>

注意：
這裡如果主佈局使用了merge節點，將不支援引數傳遞：

<?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.example.User"/>
   </data>
   <merge>
       <include layout="@layout/sub_layout"
           bind:user="@{user}"/>
   </merge>
</layout>

3.使用類方法（靜態方法）

首先為類新增一個靜態方法

public class MyStringUtils {
    public static String capitalize(final String word) {
        if (word.length() > 1) {
            return String.valueOf(word.charAt(0)).toUpperCase() + word.substring(1);
        }
        return word;
    }
}

然後在 xml 的 data 節點中匯入：

<import type="com.example.StringUtils" />

使用方法與 Java 語法一樣：

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

4.Null Coalescing 運算子

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

就等價於：

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

5.屬性值

通過 ${} 可以直接把 Java 中定義的屬性值賦值給 xml 屬性。

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

6.使用資源資料

如使用dimen.xml裡面的資源

<TextView
    android:padding="@{large? (int)@dimen/largePadding : (int)@dimen/smallPadding}"
    android:background="@android:color/black"
    android:textColor="@android:color/white"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="@string/hello_world" />

使用colors.xml中的資源：

   android:textColor = "@{@color/scrim}"

兩個dimen相加：

android:marginLeft="@{@dimen/margin + @dimen/avatar_size}"

使用strings.xml中的資源：

<string name="app_name">Databinding</string>

android:text= "@{@string/app_name}"

組合string：

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

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

使用plurals：

android:text="@{@plurals/banana(bananaCount)}"

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

7.帶 ID 的 View

Data Binding 有效降低了程式碼的冗餘性，甚至完全沒有必要再去獲取一個 View 例項，但是情況不是絕對的，萬一我們真的就需要了呢？不用擔心，只要給 View 定義一個 ID，Data Binding 就會為我們生成一個對應的 final 變數。

<TextView
    android:id="@+id/firstName"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content" />

上面程式碼中定義了一個 ID 為 firstName* 的 TextView，那麼它對應的變數就是：

public final TextView firstName;

可以直接在activity中使用它：

firstName.setText();

8.避免空指標

data binding會自動幫助我們進行空指標的避免，比如說@{employee.firstName}，如果employee是null的話，employee.firstName則會被賦預設值（null）。int的話，則是0。

需要注意的是陣列的越界，畢竟這兒是xml而不是java，沒地方讓你去判斷size的。

9.ViewStubs

ViewStub比較特殊，在被實際inflate前是不可見的，所以使用了特殊的方案，用了final的ViewStubProxy來代表它，並監聽了ViewStub.OnInflateListener:

<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <LinearLayout
        ...>
        <ViewStub
            android:id="@+id/view_stub"
            android:layout="@layout/view_stub"
            ... />
    </LinearLayout>
</layout>

binding = DataBindingUtil.setContentView(this, R.layout.activity_view_stub);
binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
    @Override
    public void onInflate(ViewStub stub, View inflated) {
        ViewStubBinding binding = DataBindingUtil.bind(inflated);
        User user = new User("fee", "lang");
        binding.setUser(user);
    }
});

10.轉換器(Converters)

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

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

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

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

11.集合（Collections）

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

12.Attribute setters

有了 Data Binding，即使屬性沒有在 declare-styleable 中定義，我們也可以通過 xml 進行賦值操作。為了演示這個功能，我自定義了一個 View - UserView，其中 R.styleable.UserView 中只定義了一個 age 屬性，其中 firstName 和 lastName 只有對應的兩個 setter 方法。
（https://github.com/LyndonChin/MasteringAndroidDataBinding/blob/master/app/src/main/res/values/styles.xml）
只要有 setter 方法就可以這樣為屬性賦值：

<com.liangfeizc.databindingsamples.attributesetters.UserView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:paddingLeft="@dimen/largePadding"
    app:onClickListener="@{activity.clickListener}"
    app:firstName="@{@string/firstName}"
    app:lastName="@{@string/lastName}"
    app:age="27" />

onClickListener 也是同樣道理，只不過我們是在 Activity 中定義了一個 Listener。

13.表示式

1、算術 + - / * %
2、字串合併 +
3、邏輯 && ||
4、二元 & | ^
5、一元 + - ! ~
6、移位 >> >>> <<
7、比較 == > < >= <=
8、Instanceof
9、Grouping ()
10、文字 - character, String, numeric, null
11、Cast
12、方法呼叫
13、Field 訪問
14、Array 訪問 []
15、三元 ?:

比如：

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

14.動態變數

以 RecyclerView 為例，Adapter 的 DataBinding 需要動態生成，因此我們可以在 onCreateViewHolder 的時候建立這個 DataBinding，然後在 onBindViewHolder 中獲取這個 DataBinding。

public static class BindingHolder extends RecyclerView.ViewHolder {
    private ViewDataBinding binding;
    public BindingHolder(View itemView) {
        super(itemView);
    }
    public ViewDataBinding getBinding() {
        return binding;
    }
    public void setBinding(ViewDataBinding binding) {
        this.binding = binding;
    }
}
@Override
public BindingHolder onCreateViewHolder(ViewGroup viewGroup, int i) {
    ViewDataBinding binding = DataBindingUtil.inflate(
            LayoutInflater.from(viewGroup.getContext()),
            R.layout.list_item,
            viewGroup,
            false);
    BindingHolder holder = new BindingHolder(binding.getRoot());
    holder.setBinding(binding);
    return holder;
}
@Override
public void onBindViewHolder(BindingHolder holder, int position) {
    User user = users.get(position);
    holder.getBinding().setVariable(BR.user, user);
    holder.getBinding().executePendingBindings();
}

注意此處 DataBindingUtil 的用法：

ViewDataBinding binding = DataBindingUtil.inflate(
    LayoutInflater.from(viewGroup.getContext()),
    R.layout.list_item,
    viewGroup,
    false);

15.Observable

一個純淨的Java ViewModel類被更新後，並不會讓UI去更新。而資料繫結後，我們當然會希望資料變更後UI會即時重新整理，Observable就是為此而生的概念。
要實現 Observable Binding，首先得有一個實現了 android.databinding.Observable 的類，為了方便，Android 原生提供了已經封裝好的一個類 - BaseObservable，並且實現了監聽器的註冊機制。
我們可以直接繼承 BaseObservable。

public class ObservableUser extends BaseObservable {
    private String firstName;
    private String lastName;
    @Bindable
    public String getFirstName() {
        return firstName;
    }
    @Bindable
    public String getLastName() {
        return lastName;
    }
    public void setFirstName(String firstName) {
        this.firstName = firstName;
        notifyPropertyChanged(BR.firstName);
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
        notifyPropertyChanged(BR.lastName);
    }
}

BR 是編譯階段生成的一個類，功能與 R.java 類似，用 @Bindable 標記過 getter 方法會在 BR 中生成一個 entry，當我們

通過程式碼可以看出，當資料發生變化時還是需要手動發出通知。通過呼叫notifyPropertyChanged(BR.firstName)來通知系統 BR.firstName 這個 entry 的資料已經發生變化，需要更新 UI。

(1)、Observable Fields：

如果所有要繫結的都需要建立Observable類，那也太麻煩了。所以Data Binding還提供了一系列Observable，包括 ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, 和ObservableParcelable。我們還能通過ObservableField泛型來申明其他型別，如：

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

而在xml中，使用方法和普通的String，int一樣，只是會自動重新整理，但在java中訪問則會相對麻煩：

user.firstName.set("Google");
int age = user.age.get();

相對來說，每次要get/set還是挺麻煩，私以為還不如直接去繼承BaseObservable。

(2)、Observable Collections：

有一些應用使用更動態的結構來儲存資料，這時候我們會希望使用Map來儲存資料結構。Observable提供了ObservableArrayMap:

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
user.put("age", 17);

而在xml中，我們可以直接通過下標key訪問它們：

<data>
    <import type="android.databinding.ObservableMap"/>
    <variable name="user" type="ObservableMap&lt;String, Object>"/>
</data>
…
<TextView
   android:text='@{user["lastName"]}'
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>
<TextView
   android:text='@{String.valueOf(1 + (Integer)user["age"])}'
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

當我們不想定義key的時候，可以使用ObservableArrayList:

ObservableArrayList<Object> user = new ObservableArrayList<>();
user.add("Google");
user.add("Inc.");
user.add(17);

layout中直接通過數字下標進行訪問。

16.開發時預覽

在android studio佈局編輯介面，可以用default關鍵字設定設定TextView的預覽，如下：

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

這時候在android studio右側的Preview介面就可以看到TextView上顯示”PLACEHOLDER”:

Android進階四：Databinding的使用(基礎篇)

一.配置環境：

二.基本使用

三.高階使用

1.事件繫結

2.變數傳遞Includes

3.使用類方法（靜態方法）

4.Null Coalescing 運算子

5.屬性值

6.使用資源資料

7.帶 ID 的 View

8.避免空指標

9.ViewStubs

10.轉換器(Converters)

11.集合（Collections）

12.Attribute setters

13.表示式

14.動態變數

15.Observable

16.開發時預覽

Android進階四：Databinding的使用(基礎篇)

android進階3step1：Android元件通訊——Service基礎

android進階3step2：Android App通訊 ——埠號IP等網路基礎知識掃盲

進階之路（基礎篇） - 011 arduino api基礎手冊

進階之路（基礎篇） - 008 SPI數據傳輸(庫函數方法)

進階之路（基礎篇） - 009 通過底層AVR方法實現SPI數據傳輸

進階之路（基礎篇） - 007 脈沖寬度測量

【思庫教育】2017PHP項目實戰基礎+進階+項目之基礎篇

Android進階筆記：AIDL內部實現詳解（二）

Android 進階13：幾種程序通訊方式的對比總結

android進階3step1：Android元件通訊——事件框架匯流排Otto

android進階3step1：Android元件通訊——廣播接收者BroadCast

android進階3step2：Android App通訊——經典藍芽通訊

android進階3step2：Android App通訊——Https和Http通訊

android進階3step2：Android App通訊——Socket通訊

android進階3step2：Android App通訊 ——觀察者模式

android進階3step2：Android App通訊——Android執行緒間通訊

android進階3step2：Android App通訊——AIDL實現遠端服務的通訊

android進階3step3：Android 常用框架——Logger框架

android進階3step4：Android 拓展學習——Gif介紹

Android進階四：Databinding的使用(基礎篇)

一.配置環境：

二.基本使用

三.高階使用

1.事件繫結

2.變數傳遞Includes

3.使用類方法（靜態方法）

4.Null Coalescing 運算子

5.屬性值

6.使用資源資料

7.帶 ID 的 View

8.避免空指標

9.ViewStubs

10.轉換器(Converters)

11.集合（Collections）

12.Attribute setters

13.表示式

14.動態變數

15.Observable

16.開發時預覽

相關推薦