Android 官方 MVVM 框架:DataBinding 实例讲解(一)

引子

前一段开始学习并在项目中运用 MVVM 时,首先学习的便是 DataBinding 这个 Google 爸爸官方出品的数据绑定框架。我在网上查资料时发现,DataBinding 相关的资料虽然不少,但大多是在 DataBinding 推出不久时写的,有很多之后新加入的功能都没有提到,内容略显陈旧,而 Android 开发者官网提供的官方文档也不并全面,有些很重要的知识点没有提到。所以我想结合官方文档和自己的实际使用经验,向大家介绍一下 DataBinding 的使用方法。在这个系列完成后,我想再聊聊 RxJava、Retrofit、DataBinding 等相结合打造 MVVM 架构的方法。

如果你在阅读时发现错误,或者有什么建议,欢迎反馈给我。

DataBinding 框架简介

DataBinding 是 Google 在2015年7月推出的一个支持库,最低兼容至 Android 2.1(API level 7+),需要 Gradle 版本高于 1.5.0-alpha1。

Google 一直在增强 DataBinding 的功能以及 Android Studio 对其的支持度,目前 Studio 已经支持了大部分的代码补全和错误提示,但仍有部分正确语法会被报错。Anyway,我强烈建议你保持 Android Studio 和 Gradle 为最新稳定版。

配置环境

首先确保你已下载安装最新版 Support Repository,接下来在 module 层级的 build.gradle 文件中添加以下配置代码:

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

绑定数据

首先创建一个标准的 JavaBean

//  Person.class

public class Person {

    private String name;

    //  省略的 getter 和 setter 方法
}

然后需要编写布局文件。将根元素改为 layout,在其中添加用于包裹数据的 data 元素和正常的布局代码。
一个编写好的布局类似如下代码:

//  activity_main.xml

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

    <data>

        <variable
            name="person"
            type="com.spacerover.databindingdemo.data.Person"/>
    </data>

    <LinearLayout
        android:id="@+id/activity_main"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">

        <TextView
            android:id="@+id/nameTv"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{person.name}"
            android:textAlignment="center"/>

        <EditText
            android:id="@+id/nameEt"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@{person.name}"/>
    </LinearLayout>
</layout>

代码中的 variable 用于定义数据绑定所需要的变量,其中 name 属性定义变量名,type 定义变量类型。
示例中将 person 声明为位于 com.spacerover.databindingdemo.data 包下的 Person,也就是我们刚刚写的 JavaBean
使用 @{} 语法可以将变量绑定到控件的属性。

接下来需要编写布局文件相对应的 Activity。像这样重写 onCreate(...) 方法:

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    //  替换 setContentView(R.layout.activity_main);
    ActivityMainBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_main);
    final Person person = new Person();
    person.setName("张三");
    binding.setPerson(person);
    new Handler().postDelayed(new Runnable() {
        @Override
        public void run() {
            person.setName("李四");
        }
    }, 3000);
}

其中,ActivityMainBinding 是根据之前编写的布局文件 activity_main.xml 自动编译生成的类。它接管了布局文件中声明的所有绑定,我们可以通过 binding.setPerson(...)binding.getPerson() 方法设置、访问绑定的变量。

此外,binding 还带来了另一个重要福利,这一知识点本应放在之后介绍,但我忍不住现在就告诉你:我们现在终于可以与 findViewById(...)ButterKnife 说再见了!binding 会自动通过 id 创建对控件的引用。在本例中我们可以通过 binding.nameEt 直接访问 idnameEtEditText!虽然它不能直接访问到通过 include 添加进布局的控件,但我们可以给被 include 的布局添加 layout 元素从而间接访问其中的控件。

回到正题,除了示例中的方法,我们还可以通过以下方法在不同组件中添加绑定:

//  Activity
ActivityMainBinding binding = MainActivityBinding.inflate(getLayoutInflater());

//  Fragment
FragmentPageBinding binding = DataBindingUtil.inflate(layoutInflater, R.layout.fragment_page, viewGroup, false);
//  or
FragmentPageBinding binding = FragmentPageBinding.inflate(layoutInflater, R.layout.fragment_page, viewGroup, false);

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

至此,我们已经可以运行程序查看效果了。运行之后可以看到界面上成功显示出「张三」,但3秒后并没有显示「李四」。这是因为单纯的使用 JavaBean 绑定数据时,DataBinding 无法自动刷新界面。此时我们需要对 JavaBean 进行一些改造,首先继承 BaseObservable 类,然后在 getter 方法之前添加 Bindable 注解,在 setter 方法之内添加 notifyPropertyChanged(...) 方法,就像这样:

//  Person.class

public class Person extends BaseObservable{

    private String name;

    @Bindable
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
        notifyPropertyChanged(BR.name);
    }
}

再次运行代码,界面应该可以正常显示「李四」了。但使用这种方法比较麻烦,代码量偏高,而且在实际使用时编译环境可能经常报错,所以我推荐使用 DataBinding 提供的另一种方式:ObserableField

除了 BaseObservableDatabinding 还向我们提供了 ObserableField 用于快速创建绑定。ObserableField 通过泛型的方式实现对对象的支持,对于其它数据类型则实现了:ObserableBooleanObserableByteObserableCharObserableShortObserableIntObserableLongObserableFloatObserableDoubleObserableParcelable。我们可以这样使用:

//  Pserson.class

public class Person {

    public final ObservableField<String> name = new ObservableField<>();
    public final ObservableInt age = new ObservableInt();
}

当访问变量时只需:

person.name.set("张三");
int age = person.age.get();

看起来不管用什么方法创建绑定都很简单,但你可能已经发现一个问题:从 EditText 修改名字时 TextView 无法同步刷新,而 pserson.name 的值也没有变化!修复这个问题实现数据的双向绑定非常简单。让我们回到布局文件,然后将给 EditText 绑定数据时使用的 @{} 语法改为 @={},然后,就没然后了!数据的双向绑定就此完成!

尾巴

我计划在下一篇文章里继续介绍 DataBinding 的高级用法,如命令绑定等。

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

推荐阅读更多精彩内容