Data Binding 詳解(二)-布局和綁定表達式

知是行之始菲宴，行是知之成。
文章配套的 Demo：https://github.com/muyi-yang/DataBindingDemo
Demo 支持 Java 和 Kotlin 雙語言腹尖，master 分支為 Java 語言代碼避乏，kotlin 分支為 Kotlin 語言代碼胳蛮。

本章將講解在 Data Binding 中的布局及布局中如何使用表達式。

支持的表達式

在布局中支持很多表達式和關鍵字：
Mathematical + - / * %
String concatenation +
Logical && ||
Binary & | ^
Unary + - ! ~
Shift >> >>> <<
Comparison == > < >= <=
instanceof
Grouping ()
Literals - character, String, numeric, null
Cast
Method calls
Field access
Array access []
Ternary operator ?:
例如：

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

看上去支持大部分表達式溉苛，但是在寫起來往往會遇到問題，會編譯都不過弄诲，這是因為在布局中有很多符號是不能直接使用的炊昆，需要轉義一下，比如小于號<要寫成&lt;威根，轉義知識請自行學習凤巨。例如：

<!-- android:visibility="@{age < 10 ? View.GONE : View.VISIBLE}" 此句編譯不過 -->
android:visibility="@{age &lt; 10 ? View.GONE : View.VISIBLE}"

注意：如果這段代碼你直接拷貝到你項目中，可能依然編譯不過洛搀，這是因為你沒有導入 View 包敢茁，在布局中寫表達式的時候特別要注意這一點，因為 java 文件寫慣了留美，導包都是自動的彰檬，而在布局中則需要手動導入，需要在布局中的 data 標簽中這樣寫：<import type="android.view.View" />谎砾，import 后面也會專門講解逢倍。

空合并運算符

上面的運算符和表達式在 java 代碼中應該都用過，但空合并運算符可能比較陌生景图，空合并運算符是通過兩個問號來表達 ??较雕，如果左操作數(shù)不為 null，則選擇左操作數(shù)挚币，如果為 null亮蒋，則選擇右操作數(shù)。

android:text="@{user.remark ?? user.name}"

這在功能上等同于:

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

表達式中使用集合

為了方便使用妆毕，可以使用[]運算符訪問常用集合慎玖，如數(shù)組、List笛粘、和Map趁怔。下面在 UserInfo 中增加了幾個集合數(shù)據(jù)：

public class UserInfo {
    ...
    public String[] tripMode={"公交車","地鐵","開車"};
    public List<String> colleague = new ArrayList<>();
    public Map<String, String> task = new HashMap<>();

    public UserInfo(){
        colleague.add("張三");
        colleague.add("李四");
        colleague.add("王五");

        task.put("monday","整理思路及確定整體框架");
        task.put("tuesday","開始進行編寫");
        task.put("wednesday","檢測及修訂");
    }
}

布局中的使用：

    <data>
     ...
        <variable
            name="index"
            type="int" />
    </data>
    ...
        <TextView
            ...
            android:text="@{@string/trip(user.tripMode[index]), default=上班出行方式}"
            ... />

        <TextView
            ...
            android:text="@{@string/colleague(user.colleague[index]), default=身邊的同事}"
            ... />

        <TextView
            ...
            android:text="@{@string/task(user.task[`monday`]), default=今天任務}"
            .../>

代碼中設置索引：

public class UserActivity extends AppCompatActivity {
    ...
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ...
        binding.setIndex(1);
        ...
    }
    ...
}

Map 的使用也可以直接引用 key 值，寫成這樣：

<TextView
            ...
            android:text="@{@string/task(user.task.monday), default=今天任務}"
            .../>

表達式中使用字符串

在布局中避免不了直接使用字符串薪前，你可以使用單引號來包圍屬性值润努，這允許你在表達式中使用雙引號，如下面的例子所示:

    android:text='@{@string/task(user.task["monday"]), default=今天任務}'

還可以使用雙引號來包圍屬性值序六， 這個時候字符串文本就需要被反引號包圍（反引號就是鍵盤的第二排第一個這個鍵值）:

    android:text="@{@string/task(user.task[`monday`]), default=今天任務}"

表達式中引用資源

使用正常的表達式來訪問 Resources 也是可行的：

    <TextView
            ...
            android:padding="@{@dimen/view_margin}"
            android:text="@{@string/name(user.name), default=姓名}"
            ... />

    //strings.xml
    <string name="name">姓名：%1$s</string>

這里引用了 dimen 和 string任连，string 還可以帶格式化參數(shù)，當然也可以引用復數(shù)例诀，但是一般情況下我們用不到随抠，因為中文沒有這個需求裁着。比如：

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

除了這些，還支持其他的資源引用拱她，但有些資源的引用需要明確指明類型二驰，如下表所示:

類型 正常引用 表達式引用
String[] @array @stringArray
int[] @array @intArray
TypedArray @array @typedArray
Animator @animator @animator
StateListAnimator @animator @stateListAnimator
color int @color @color
ColorStateList @color @colorStateList

事件綁定

Data Binding 允許你編寫表達式來處理 View 分派的事件。事件屬性名字取決于監(jiān)聽器方法名字秉沼。例如 View.OnClickListener 有 onClick() 方法桶雀，View.OnLongClickListener 有 onLongClick() 的方法，因此事件的屬性是 android:onLongClick唬复，android:onClick矗积。
對于 click 事件，為了避免多種 click 事件的沖突敞咧，Google也定義了一些專門的事件處理棘捣，比如：

Class 設置監(jiān)聽器的方法 綁定時的屬性
SearchView setOnSearchClickListener(View.OnClickListener) android:onSearchClick
ZoomControls setOnZoomInClickListener(View.OnClickListener) android:onZoomIn
ZoomControls setOnZoomOutClickListener(View.OnClickListener) android:onZoomOut

除了它們，Google 還定義了其他一些常用的綁定事件的屬性休建，這些可以閱讀 Data Binding 源碼（android.databinding.adapters 包下）或者 Google 官方 Data Binding 的 API乍恐。

事件綁定有兩種使用方式：引用方法和綁定監(jiān)聽器。接下來將具體介紹這兩種方式的使用测砂。

引用方法

可以引用綁定對象中已經定義好的特定規(guī)則的 click 方法：

public class MainActivity extends AppCompatActivity {
    private ActivityMainBinding binding;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        binding = DataBindingUtil.setContentView(this, R.layout.activity_main);
        binding.tvInfo.setText("我是使用Data Binding的Demo");
        binding.setActivity(this);
    }
    //被綁定的方法茵烈，注意參數(shù)
    public void userClick(View view){
        startActivity(new Intent(this, UserActivity.class));
    }
}

布局中的使用：

<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <variable
            name="activity"
            type="com.example.databindingdemo.MainActivity" />
    </data>
    ...
    <Button
           ...
            android:onClick="@{activity::userClick}"
           ... />
    ...
</layout>

注意：被綁定的方法有一個 View 參數(shù)，這個參數(shù)是必須的砌些，因為 Data Binding 在引用方法時呜投，需要方法的參數(shù)和返回值必須與事件監(jiān)聽器的參數(shù)和返回值相匹配，如果參數(shù)或者返回值不匹配則會在編譯時報錯寄症。

當表達式計算為引用方法的方式時宙彪，Data Binding 在監(jiān)聽器中包裝引用方法和所有者對象，并在目標 View 上設置該監(jiān)聽器有巧，但是監(jiān)聽器對象是在數(shù)據(jù)綁定的時候創(chuàng)建的，如果綁定的對象為空悲没，這個監(jiān)聽器則不會創(chuàng)建篮迎。引用方法方式的優(yōu)點是找不到符合規(guī)定的方法則編譯報錯。

綁定監(jiān)聽器

綁定監(jiān)聽器是在布局中寫一個 lambda 表達式示姿，表達式是在事件發(fā)生時被求值甜橱。它類似于引用方法厨钻，但允許你運行任意的數(shù)據(jù)綁定表達式进肯。這個特性是在 Android Gradle Plugin for Gradle version 2.0 或更高版本中才支持。以下示例為一個頁面跳轉的 click 事件綁定：

public class MainActivity extends AppCompatActivity {
    ...
    public void startList(){
        startActivity(new Intent(this, ListActivity.class));
    }
}

聲明了一個 startList() 方法友存，接著把按鈕點擊事件綁定到 startList() 方法上：

<Button
            ...
            android:onClick="@{()->activity.startList()}"
            ... />

在引用方法的方式中子檀，方法的參數(shù)和返回值必須與事件監(jiān)聽器的參數(shù)和返回值相匹配镊掖。 在綁定監(jiān)聽器的方式中乃戈，則只要返回值與監(jiān)聽器的預期返回值匹配即可。 例如:

public class MainActivity extends AppCompatActivity {
    ...
    public boolean listLongClick() {
        //長按操作
        return true;
    }
}

一個長按事件的處理需要返回一個 Boolean 類型的值：

<Button
            ...
            android:onLongClick="@{()->activity.listLongClick()}"
            ... />

綁定監(jiān)聽器在編譯時會自動創(chuàng)建必要的監(jiān)聽器并為它注冊事件（監(jiān)聽器是一開始就創(chuàng)建好了亩进，等到觸發(fā)時才會判斷被綁定的對象是否為空症虑，為空則不執(zhí)行任何操作）。 當 View 觸發(fā)事件時归薛，Data Binding 才會計算給定的表達式谍憔，在計算這些表達式時可以獲得 Data Binding 的 null 安全和線程安全性。

有些時候 Click 方法可能需要帶一些必要的參數(shù)主籍，比如：

public class UserActivity extends AppCompatActivity {
    private ActivityUserBinding binding;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ...
        binding.setActivity(this);
    }

    public void showSign(View v, UserInfo info) {
        Toast.makeText(v.getContext(), info.sign, Toast.LENGTH_LONG).show();
    }
}

    <data>
        <import type="com.example.databindingdemo.bean.UserInfo" />
        <variable  name="user" type="UserInfo" />
        ...
        <variable
            name="activity"
            type="com.example.databindingdemo.UserActivity"/>
    </data>
    ...
    <Button
    ...
    android:onClick="@{(view)->activity.showSign(view, user)}"
    .../>

在上面例子中习贫，showSign 方法需要一個 View 和 UserInfo 對象，在布局中這樣使用 @{(view)->activity.showSign(view, user)}千元，view 是 lambada 表達式中獲取的沈条，user 是上面聲明需綁定的變量。如果綁定方法是多個參數(shù)诅炉，或者監(jiān)聽器事件是帶返回值的都是以此類推蜡歹，保證參數(shù)和返回值匹配即可。

如果需要使用帶有謂詞的表達式(例如涕烧，三元表達式) 月而，可以使用監(jiān)聽器相匹配的返回值類型作為表達式，比如 onCLick 屬性使用 void议纯，onLongClick 屬性使用 Boolean父款。

    android:onClick="@{(view)->view.isEnabled()?activity.showSign(view, user):void}"
    android:onLongClick="@{(v)->v.isEnabled()?activity.showSign(user):false}"

注意：監(jiān)聽器表達式非常強大，可以使您的代碼簡化瞻凤，容易閱讀憨攒。另一方面，如果包含復雜表達式的監(jiān)聽器也會使你的布局難以理解和維護阀参。布局中表達式應該盡量的簡單肝集，你應該在監(jiān)聽器表達式調用的回調方法中實現(xiàn)相對復雜的業(yè)務邏輯。

布局中的一些關鍵標簽

Data Binding 庫提供了 import, variable 以及 include 標簽蛛壳，import 使得可以在布局文件中引用類杏瞻。variable 允許你聲明可在綁定表達式中使用的變量。include 可以讓你重用布局衙荐。

Import

import 可以讓你在布局中使用類捞挥，比如導入 View 類，導入 View 類允許你在綁定表達式中引用它的常量 VISIBLE 和 GONE忧吟。

...
<data>
    <import type="android.view.View"/>
</data>
...
<TextView
   ...
  android:visibility="@{age > 13 ? View.GONE : View.VISIBLE}"/>

當存在類名沖突時砌函，還可以將其中一個類重命名為別名。 下面的示例將 com.example.databindingdemo.bean 包中的 View 類重命名為 Vista，這樣可以使用 Vista 引用 com.example.databindingdemo.bean.View 類讹俊，使用 View 來引用系統(tǒng)中的 android.View.View垦沉。

    <import type="android.view.View" />
    <import
        alias="Vista"
        type="com.example.databindingdemo.bean.View" />
    ...
    <ImageView
            ...
            android:visibility="@{Vista.isShow?View.VISIBLE:View.GONE}"
            ... />

導入的類型可以用作變量和表達式中的類型引用。下面的示例顯示了用作變量類型的 UserInfo:

<import type="com.example.databindingdemo.bean.UserInfo" />
<variable name="user" type="UserInfo" />

它等同于：

<variable name="user" type="com.example.databindingdemo.bean.UserInfo" />

也可以導入類來做類型轉換劣像，或者導入工具類來使用它的靜態(tài)方法：

<data>
    <import type="com.example.MyStringUtils"/>
    <import name="user" type="com.example.User"/>
</data>
...
<TextView
   android:text="@{((User)(user.connection)).lastName}"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>
…
<TextView
   android:text="@{MyStringUtils.capitalize(user.lastName)}"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

但不是所有類都需要自己導包乡话，基本數(shù)據(jù)類型，String耳奕，以及 Data Binding 自己本身提供的 Observable 相關的類編譯器會自動導入绑青。

Variable

可以在 data 標簽內部使用多個 variable。 每個 variable 描述一個變量屋群，該變量可以在布局文件中的綁定表達式中使用闸婴。下面的示例聲明了 UserInfo、Drawable 和 String 變量:

<data>
    <variable name="user" type="com.example.User"/>
    <variable name="image" type="android.graphics.drawable.Drawable"/>
    <variable name="note" type="String"/>
</data>

在自動生成的綁定類中具有每個變量的 setter 和 getter 方法芍躏，這些變量在調用 setter 方法賦值之前都有默認值邪乍，對象為 null，int 為 0对竣，boolean 為 false 等等庇楞。同時也會生成一個名為 context 的特殊變量，以便根據(jù)需要在綁定表達式中使用否纬。context 的值是根 View 的 getContext()方法中的 Context 對象吕晌。以下為直接通過 context 變量獲取程序包名：

    <TextView
            ...
            android:text="@{context.packageName}"
            ... 
           />

但 context 變量可以被具有該名稱的顯式變量聲明所覆蓋，比如聲明了一個 String 類型的 context 變量：

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

這個時候就不能直接使用 @{context.packageName} 了临燃，因為 context 已經被覆蓋為 String 類型睛驳。

注意：當設備針對橫豎屏有不同的布局文件時，這些布局文件之間不能有沖突的變量定義膜廊，必須保證不同配置的布局文件中的變量是一致的乏沸。

Include

include 標簽和普通布局中使用的 include 是一樣的功能，都是導入一個已經存在的布局文件爪瓜，來實現(xiàn)布局的重用蹬跃。只不過在 Data Binding 中它多了綁定數(shù)據(jù)的功能。下面展示了來自 layout_avatar.xml 布局文件：

<!--layout_avatar.xml-->
<?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">
    <data>
        <variable
            name="resId"
            type="int" />
    </data>
    <ImageView
        android:layout_width="100dp"
        android:layout_height="100dp"
        android:layout_margin="10dp"
        android:src="@drawable/default_mini_avatar"
        app:image="@{resId}"
        app:layout_constraintRight_toRightOf="parent" />
</layout>

這個布局很簡單钥勋，里面只有一個 ImageView炬转，里面聲明了一個表達式 app:image="@{resId}"（這是一個自定義的適配器，自定義適配器后面會講到算灸，這里不深究），它需要一個 resId 的變量驻啤，接下來展示在 activity_user.xml 布局中的使用：

    <data>

        <import type="com.example.databindingdemo.bean.UserInfo" />
        <variable name="user"  type="UserInfo" />
        ...
    </data>
    ...
    <include layout="@layout/layout_avatar"
            bind:resId="@{user.avatarId}"/>
    ...

在布局中 include 了 layout_avatar.xml 文件菲驴，并聲明了一個屬性且綁定了表達式bind:resId="@{user.avatarId}"，這個屬性就是 layout_avatar.xml 文件中的 resId 變量骑冗，它的規(guī)則就是被 include 的布局里面的變量名就是這里綁定的屬性名赊瞬，遵循這個規(guī)則先煎，就可以為 layout_avatar.xml 布局中的 resId 變量賦值。

注意：Data Binding 不支持在 merge 標簽中直接 include 布局巧涧。

此篇到這里就結束了薯蝎，可以查看下一篇 Data Binding 詳解（三）-可觀察（監(jiān)聽）的數(shù)據(jù)對象。

如果你覺得文章有幫助到你谤绳，記得點個喜歡以表支持占锯，同時歡迎你的指正和建議。十分感謝缩筛！

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末消略，一起剝皮案震驚了整個濱河市，隨后出現(xiàn)的幾起案子瞎抛，更是在濱河造成了極大的恐慌艺演，老刑警劉巖，帶你破解...
    沈念sama閱讀 222,252評論 6贊 516
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件桐臊，死亡現(xiàn)場離奇詭異胎撤，居然都是意外死亡，警方通過查閱死者的電腦和手機断凶，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3贊 399
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門伤提，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人懒浮，你說我怎么就攤上這事飘弧。” “怎么了砚著？”我有些...
    開封第一講書人閱讀 168,814評論 0贊 361
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵次伶，是天一觀的道長。 經常有香客問我稽穆，道長冠王，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 59,869評論 1贊 299
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任舌镶，我火速辦了婚禮柱彻，結果婚禮上，老公的妹妹穿的比我還像新娘餐胀。我一直安慰自己哟楷，他們只是感情好，可當我...
    茶點故事閱讀 68,888評論 6贊 398
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布否灾。 她就那樣靜靜地躺著卖擅，像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上惩阶，一...
    開封第一講書人閱讀 52,475評論 1贊 312
  • 城市分裂傳說
    那天挎狸，我揣著相機與錄音，去河邊找鬼断楷。 笑死锨匆，一個胖子當著我的面吹牛，可吹牛的內容都是我干的冬筒。 我是一名探鬼主播恐锣，決...
    沈念sama閱讀 41,010評論 3贊 422
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼账千！你這毒婦竟也來了侥蒙？” 一聲冷哼從身側響起，我...
    開封第一講書人閱讀 39,924評論 0贊 277
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤匀奏，失蹤者是張志新（化名）和其女友劉穎鞭衩，沒想到半個月后，有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體娃善，經...
    沈念sama閱讀 46,469評論 1贊 319
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡论衍，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3贊 342
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時候發(fā)現(xiàn)自己被綠了聚磺。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片坯台。...
    茶點故事閱讀 40,680評論 1贊 353
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖瘫寝，靈堂內的尸體忽然破棺而出蜒蕾，到底是詐尸還是另有隱情，我是刑警寧澤焕阿，帶...
    沈念sama閱讀 36,362評論 5贊 351
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布咪啡，位于F島的核電站，受9級特大地震影響暮屡，放射性物質發(fā)生泄漏撤摸。R本人自食惡果不足惜，卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3贊 335
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一褒纲、第九天 我趴在偏房一處隱蔽的房頂上張望准夷。 院中可真熱鬧，春花似錦莺掠、人聲如沸衫嵌。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0贊 25
  • 一樁弒父案彻秆，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽渐扮。三九已至论悴，卻和暖如春掖棉，著一層夾襖步出監(jiān)牢的瞬間墓律，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1贊 274
  • 情欲美人皮
    我被黑心中介騙來泰國打工幔亥， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留耻讽，地道東北人。 一個月前我還...
    沈念sama閱讀 49,099評論 3贊 378
  • 代替公主和親
    正文 我出身青樓帕棉，卻偏偏與公主長得像针肥，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子香伴，可洞房花燭夜當晚...
    茶點故事閱讀 45,691評論 2贊 361