Android DataBinding使用详解（一）

封面

DataBinding是一个实现数据和UI绑定的框架，同时也是实现MVVM模式所依赖的工具。

官方文档

Demo下载地址

1.构建环境

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

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

环境要求：

  • 系统版本：Android 2.1(API level 7)及以上

  • Gradle版本：1.5.0-alpha1及以上

  • Android Studio版本：1.3及以上

2.基本使用

布局文件

DataBinding的布局文件使用了layout标签作为根节点，其中包含了data标签与view标签，view标签的内容就是不使用DataBinding时的普通布局内容：

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

    <data>
        <variable
            name="user"
            type="com.yl.databindingdemo.bean.User" />
    </data>

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

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

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

    </LinearLayout>

</layout>

data标签下的user变量定义了可以在此布局中使用的属性：

<data>
    <variable
        name="user"
        type="com.yl.databindingdemo.bean.User" />
</data>

布局中的表达式使用了@{ }语法：

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

数据实体

public class User {

    private String firstName;
    private String lastName;

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

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

数据绑定

默认情况下，DataBinding会根据布局文件名称自动生成ActivityBaseUseBinding类（activity_base_use -> ActivityBaseUseBinding）。

public class BaseUseActivity extends AppCompatActivity {

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

        // ActivityBaseUseBinding是根据布局名称自动生成的
        // 代替原来的setContentView(R.layout.activity_base_use)方法
        ActivityBaseUseBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_base_use);
        User user = new User("容华", "谢后");
        // set方法是根据data标签下的variable名称自动生成的
        binding.setUser(user);
    }
}

3.布局详情

导入

在data标签下可以使用多个import标签，就像Java一样把类导入到布局文件中：

<data>
    <import type="android.view.View"/>
</data>

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

当类名冲突时可以设置别名：

<import type="android.view.View"/>
<import type="com.example.real.estate.View"
        alias="Vista"/>

导入的类型也可以用于变量的类型引用和表达式中：

<data>
    <import type="com.example.User"/>
    <import type="java.util.List"/>
    <variable name="user" type="User"/>
    <variable name="userList" type="List<User>"/>
</data>

< >需要使用转义字符< >代替。

在表达式中使用静态方法：

public class StringUtils {

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

<data>
    <import type="com.yl.databindingdemo.utils.StringUtils"/>
    <variable name="user" type="com.yl.databindingdemo.bean.User"/>
</data>

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

和在Java中一样，java.lang. 会被自动导入。*

自定义绑定类名

默认情况下，Binding的类名是根据布局文件名称命名的，假如包名是com.yl.databindingdemo，那么Binding类就会被放在com.yl.databindingdemo.databinding包下，如果不想使用默认类名和路径，可以进行自定义修改：

<!-- 自定义Binding类名 -->
<data class="ContactItem">
    ...
</data>

<!-- 自定义Binding存放路径，.代表module根目录 -->
<data class=".ContactItem">
    ...
</data>

<!-- 自定义Binding存放路径，指定路径 -->
<data class="com.example.ContactItem">
    ...
</data>

Includes

变量可以传递到include布局中：

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

    <data>
        <variable
            name="user"
            type="com.yl.databindingdemo.bean.User" />
    </data>

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

        <include
            layout="@layout/layout_include"
            bind:user="@{user}" />

    </LinearLayout>

</layout>

layout_include布局中也需要声明user变量：

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

    <data>
        <variable
            name="user"
            type="com.yl.databindingdemo.bean.User" />
    </data>

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

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

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

    </LinearLayout>

</layout>

注意：DataBinding不支持使用merge节点。

表达式语法

支持的表达式：

  • 数学计算 + - / * %

  • 字符串连接 +

  • 逻辑 && ||

  • 二进制 & | ^

  • 一元运算符 + - ! ~

  • 位移 >> >>> <<

  • 比较 == > < >= <=

  • instanceof

  • 组 ()

  • 文字 - 字符，字符串，数字， null

  • 类型转换

  • 函数调用

  • 字段存取

  • 数组存取 []

  • 三目运算符 ?：

例如：

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

不支持的表达式：

  • this

  • super

  • new

  • 显式泛型调用 <T>

Null合并运算符

非null时选择左边的操作，反之选择右边的操作：

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

等价于：

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

集合

通用的集合类（arrays, lists, sparse lists, maps），可以使用[ ]操作符来存取：

<data>
    <import type="android.util.SparseArray"/>
    <import type="java.util.Map"/>
    <import type="java.util.List"/>
    <variable name="list" type="List<String>"/>
    <variable name="sparse" type="SparseArray<String>"/>
    <variable name="map" type="Map<String, String>"/>
    <variable name="index" type="int"/>
    <variable name="key" type="String"/>
</data>
…
android:text="@{list[index]}"
…
android:text="@{sparse[index]}"
…
android:text="@{map[key]}"

如果属性使用单引号的话，表达式就可以使用双引号：

android:text='@{map["firstName"]}'

属性使用双引号，表达式可以使用以下两种方式：

android:text="@{map[`firstName`}"
android:text="@{map['firstName']}"

资源

可以在表达式中使用普通语法来引用资源：

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

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

部分资源的表达式引用和普通引用有所不同：

Type Normal Reference Expression Reference
String[] @array @stringArray
int[] @array @intArray
TypedArray @array @typedArray
Animator @animator @animator
StateListAnimator @animator @stateListAnimator
color int @color @color
ColorStateList @color @colorStateList

4.动态更新

在上面的例子中，如果修改实体类的数据，UI是不会动态更新的，别担心，DataBinding为我们提供了一套很Nice的通知机制：

Observable Objects

DataBinding提供了Observable接口用于监听实体类对象属性的变化，Observable接口有具有添加、删除监听的功能。为了简化开发，DataBinding已经为我们实现了一个基本的监听类BaseObservable，实体类只要继承BaseObservable，然后在get方法上加入@Bindable注解，set方法中调用notifyPropertyChanged通知UI更新就可以了。

public class ObservableObjectsUser extends BaseObservable {

    private String firstName;
    private String lastName;

    public ObservableObjectsUser() {
    }

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

    @Bindable
    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
        notifyPropertyChanged(BR.firstName);
    }

    @Bindable
    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
        notifyPropertyChanged(BR.lastName);
    }
}

在get方法上加入@Bindable注解后，DataBinding就会在BR文件中生成相应的字段，BR是编译期间生成的类，类似于R文件。

在Activity中动态更新UI：

public class ObservableActivity extends AppCompatActivity {

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

        ActivityObservableBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_observable);
        final ObservableObjectsUser user = new ObservableObjectsUser("容华", "谢后");
        binding.setUser(user);

        binding.setClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                user.setFirstName("空谷");
                user.setLastName("幽兰");
            }
        });
    }
}

看下效果：

动态更新

ObservableFields

每个get方法都要加上注解，还要在每个set方法中通知UI更新，是不是有点麻烦，贴心的DataBinding还为我们提供了更简便的方式：

public class ObservableFieldsUser {

    public ObservableField<String> firstName = new ObservableField<>();
    public ObservableField<String> lastName = new ObservableField<>();

    public ObservableFieldsUser(String firstName, String lastName) {
        this.firstName.set(firstName);
        this.lastName.set(lastName);
    }
}

在Activity中动态更新UI：

public class ObservableActivity extends AppCompatActivity {

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

        ActivityObservableBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_observable);
        final ObservableFieldsUser user = new ObservableFieldsUser("容华", "谢后")
        binding.setUser(user);

        binding.setClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                user.firstName.set("空谷");
                user.lastName.set("幽兰");
        });
    }
}

除了ObservableField<T>，还可以使用ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, ObservableParcelable。

Observable Collections

不一定使用实体类才能动态更新，DataBinding还为我们提供了更灵活的方式：

public class ObservableActivity extends AppCompatActivity {

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

        ActivityObservableBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_observable);

        final ObservableArrayMap<String, String> user = new ObservableArrayMap<>();
        user.put("firstName", "容华");
        user.put("lastName", "谢后");

        binding.setUser(user);

        binding.setClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                user.put("firstName", "空谷");
                user.put("lastName", "幽兰");
            }
        });
    }
}

布局文件：

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

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

        <variable
            name="user"
            type="ObservableMap<String, String>" />

        <variable
            name="clickListener"
            type="android.view.View.OnClickListener" />
    </data>

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

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user[`firstName`]}" />

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

        <Button
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="10dp"
            android:onClick="@{clickListener}"
            android:text="更新数据" />

    </LinearLayout>

</layout>

5.双向绑定

DataBinding现在也支持双向绑定了，即UI改变的同时，数据模型中的数据也跟着改变：

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

    <data>

        <variable
            name="user"
            type="com.yl.databindingdemo.bean.ObservableObjectsUser" />
    </data>

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

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

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

    </LinearLayout>

</layout>

使用@={ }表达式进行双向绑定，看下效果：

双向绑定

6.事件处理

类似于android:onClick可以指定Activity中的方法，DataBinding也提供了事件处理的机制：

  • 方法调用：方法的参数必须与监听对象的参数相匹配，比如点击事件onClick(View v)，对应的方法必须为methodName(View v)。

  • 监听绑定：只要方法的返回值与监听对象的返回值相匹配就可以，比如onLongClick(View v)的返回值是boolean类型的，那么对应的方法返回值也必须是boolean类型的。

方法调用

表达式会在编译时处理，如果方法不存在，编译将会报错。

public class EventHandler {

    public void onClickFriend(View view) {
        Toast.makeText(view.getContext(), "onClickFriend", Toast.LENGTH_LONG).show();
    }
}

布局文件：

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

    <data>

        <variable
            name="handler"
            type="com.yl.databindingdemo.handler.EventHandler" />
    </data>

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

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"
            android:onClick="@{handler::onClickFriend}"
            android:text="方法调用" />

    </LinearLayout>

</layout>

@{handler::onClickFriend}代表调用EventHandler类中的onClickFriend方法，注意onClickFriend方法的参数必须与onClick(View v)方法的参数相匹配。

监听绑定

官方文档上的说明是：监听绑定在事件发生时调用，可以使用任意表达式。测试过程中发现如果方法不存在，编译也会报错。

注意：需要在Android Gradle Plugin version 2.0版本以上使用。

public class EventHandler {

    public void onTaskClick(Task task) {
        task.run();
    }

    public void onTaskClick(View view, Task task) {
        Toast.makeText(view.getContext(), "onTaskClick", Toast.LENGTH_LONG).show();
        task.run();
    }

    public void onCompletedChanged(Task task, boolean completed) {
        if (completed) {
            task.run();
        }
    }
}

public class Task implements Runnable {

    private static final String TAG = "Task";

    @Override
    public void run() {
        Log.i(TAG, "Task running");
    }
}

布局文件：

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

    <data>

        <variable
            name="handler"
            type="com.yl.databindingdemo.handler.EventHandler" />

        <variable
            name="task"
            type="com.yl.databindingdemo.task.Task" />
    </data>

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

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"
            android:onClick="@{() -> handler.onTaskClick(task)}"
            android:text="监听绑定" />

        <Button
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"
            android:onClick="@{(view) -> handler.onTaskClick(view,task)}"
            android:text="监听绑定_使用参数" />

        <CheckBox
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center_horizontal"
            android:layout_margin="10dp"
            android:onCheckedChanged="@{(checkBox, isChecked) -> handler.onCompletedChanged(task, isChecked)}" />

    </LinearLayout>

</layout>

lambda表达式中的参数有两种选择，全不写或者全写，例如onCheckedChanged(CompoundButton buttonView, boolean isChecked)方法有两个参数，如果用到其中一个参数，另一个参数也要补上，不能只写一个，参数名称可以自定义。

7.写在最后

源码已托管到GitHub上，欢迎Fork，觉得还不错就Start一下吧！

GitHub传送门

欢迎同学们吐槽评论，如果你觉得本篇博客对你有用，那么就留个言或者点下喜欢吧(＾－＾)

在下一篇文章中我们将会学习一下DataBinding的其他用法，例如如何在RecyclerView中使用DataBinding，如何自定义属性等，敬请期待！

《Android DataBinding使用详解（二）》

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,547评论 6赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,399评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,428评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,599评论 1赞 274
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,612评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,577评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,941评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,603评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,852评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,375评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,955评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2赞 342

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,401评论 25赞 707
  • DataBinding（一）-初识
    一个刚入行半年的菜鸟安卓开发人员，始终有一颗不安分的心。mvvm框架是我在学习vue的时候才知道的一种新型架构。公...
    sakasa阅读 4,245评论 5赞 22
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,585评论 18赞 139
  • Data Binding 使用指南
    DataBinding 库是 Google 公司 Android Framework UI 工具团队开发出来的一款...
    bravian阅读 5,404评论 2赞 16
  • JavaScript和Object-OC互相调用
    一 调用的方法:## 1. OC调用js方法,只需要调用UIWebView自带的方法即可. 2.js调用OC方法,...
    480a52903ce5阅读 456评论 0赞 0