Android databinding

什么是databinding?

Data Binding库是来写声明的layouts文件,并且用最少的代码来绑定你的app逻辑和layouts文件。
Data Binding库不仅灵活而且广泛兼容- 它是一个support库,因此你可以在所有的Android平台最低能到Android 2.1(API等级7+)上使用它。
需求:Android Plugin for Gradle **1.5.0-alpha1 **或 更高版本

简单的说: data binding就是一个将数据(model)和试图(view)绑定的库

准备工作

    新建一个 Project,确保 Android 的 Gradle 插件版本不低于 1.5.0-alpha1:

    classpath 'com.android.tools.build:gradle:1.5.0'

    然后修改对应模块(Module)的 build.gradle:

    dataBinding {
        enabled true
    }

工程创建完成后,我们通过一个最简单的例子来说明 Data Binding 的基本用法。

布局文件

使用 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 就需要把数据(Model)与 UI(View) 进行绑定,data 节点的作用就像一个桥梁,搭建了 View 和 Model 之间的通路。

我们先在 xml 布局文件的 data 节点中声明一个 variable,这个变量会为 UI 元素提供数据(例如 TextView 的 android:text),然后在 Java 代码中把『后台』数据与这个 variable 进行绑定。

下面我们使用 Data Binding 创建一个展示用户信息的表格

数据对象

添加一个 POJO 类 - User,非常简单,两个属性以及他们的 getter 和 setter。

    public class User {
        private final String firstName;
        private final String lastName;

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

        public String getFirstName() {
            return firstName;
        }

        public String getLastName() {
            return lastName;
        }
    }

稍后,我们会新建一个 User 类型的变量,然后把它跟布局文件中声明的变量进行绑定。

定义 Variable

回到布局文件,在 data 节点中声明一个 User 类型的变量 user。

    <data>
            <variable
                name="user"
                type="com.example.l.gjj_databinding_demo.User"/>
        </data>

其中 type 属性就是我们在 Java 文件中定义的 User 类。

当然,data 节点也支持 import,所以上面的代码可以换一种形式来写。

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

然后我们刚才在 build.gradle 中添加的那个插件 -com.android.databinding会根据 xml 文件的名称 Generate 一个继承自ViewDataBinding的类。 当然,IDE 中看不到这个文件,需要手动去 build 目录下找。
例如,这里 xml 的文件名叫activity_basic.xml,那么生成的类就是ActivityBasicBinding。

注意java.lang.包中的类会被自动导入,可以直接使用,例如要定义一个 String 类型的变量:

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

绑定Variable

修改 MainActivity 的 onCreate 方法,用 DatabindingUtil.setContentView() 来替换掉 setContentView(),然后创建一个 user 对象,通过 binding.setUser(user) 与 variable 进行绑定。

    @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            //上述的layout文件是activity_main.xml,因此生成的类名是ActivityMainBinding
            ActivityMainBinding binding = DataBindingUtil.setContentView(
                    this, R.layout.activity_main);
            User user = new User("fei", "Liang", 27);
            binding.setUser(user);
            
        }

除了使用框架自动生成的 ActivityBasicBinding,我们也可以通过如下方式自定义类名。

<data
    class="com.example.l.gjj_databinding_demo.MainBinding">
    <import type="com.example.l.gjj_databinding_demo.User"/>
    <variable
        name="user"
        type="User"/>
</data>

注意:

MainBinding类是自动生成的,所有的 set 方法也是根据 variable 名称生成的。例如,我们定义了两个变量

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

那么就会生成对应的两个 set 方法。

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

使用variable

数据与 Variable 绑定之后,xml 的 UI 元素就可以直接使用了。

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

至此,一个简单的数据绑定就完成了

高级用法


使用类方法

首先定义一个静态方法

    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.l.gjj_databinding_demo.MyStringUtils"/>

使用方法与 Java 语法一样:

     <TextView
                android:id="@+id/tv_test1"
                android:layout_marginTop="10dp"
                android:layout_below="@+id/tv_test"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="@{MyStringUtils.capitalize(user.firstName)}" />

类型别名

如果我们在 data 节点了导入了两个同名的类怎么办?

    <import type="com.example.l.gjj_databinding_demo.MyStringUtils"/>
    <import type="com.example.l.gjj_databinding_demo.User"/>
    <import type="com.example.l.gjj_databinding_demo.model.User"/>

这样一来出现了两个 User 类,那 user 变量要用哪一个呢?不用担心,import 还有一个 alias 属性。

    <data
            class="com.example.l.gjj_databinding_demo.MainBinding">

            <import type="com.example.l.gjj_databinding_demo.MyStringUtils"/>
            <import type="com.example.l.gjj_databinding_demo.User"/>
            <import type="com.example.l.gjj_databinding_demo.model.User" alias="demoUser"/>

            <variable
                name="user"
                type="demoUser"/>
        </data>

Null Coalescing 运算符

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

就等价于
android:text="@{user.displayName != null ? user.displayName : user.lastName}"

属性值

通过 @{} 可以直接把 Java 中定义的属性值赋值给 xml 属性

使用资源数据

这个例子,官方教程有错误,可以参考Android Data Binder 的一个bug,完整代码在此

使用字符串格式化

<string name="test_x_count">%1$d人使用</string

<TextView android:text="@{@string/test_x_count(model.count)}" />

Observable Binding


本来这一节的标题应该叫双向绑定,但是很遗憾,现在的 Data Binding 暂时支持单向绑定,还没有达到 Angular.js 的威力。
要实现 Observable Binding,首先得有一个implement了接口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。除此之外,还有一种更细粒度的绑定方式,可以具体到成员变量,这种方式无需继承BaseObservable,一个简单的 POJO 就可以实现。

系统为我们提供了所有的 primitive type 所对应的 Observable类,例如ObservableInt
、ObservableFloat
、ObservableBoolean
等等,还有一个ObservableField
对应着 reference type
剩下的数据绑定与前面介绍的方式一样,具体可参考ObservableActivity

带 ID 的 View

Data Binding 有效降低了代码的冗余性,甚至完全没有必要再去获取一个 View 实例,但是情况不是绝对的,万一我们真的就需要了呢?不用担心,只要给 View 定义一个 ID,Data Binding 就会为我们生成一个对应的final变量。

上面代码中定义了一个 ID 为 firstName* 的TextView,那么它对应的变量就是

public final TextView firstName;

具体代码可参考 ViewWithIDsActivity.java

关于android databinding教程参考

参考文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,183评论 6 516
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,850评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,766评论 0 361
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,854评论 1 299
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,871评论 6 398
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,457评论 1 311
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,999评论 3 422
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,914评论 0 277
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,465评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,543评论 3 342
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,675评论 1 353
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,354评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,029评论 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,514评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,616评论 1 274
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,091评论 3 378
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,685评论 2 360

推荐阅读更多精彩内容