详解Android的MVVM框架 - 数据绑定

本教程是跟着 data binding guide 学习过程中得出的一些实践经验，同时修改了官方教程的一些错误，每一个知识点都有对应的源码，争取做到实践与理论相结合。

data binding 解决了 android ui 编程中的一个痛点，官方原生支持 mvvm 模型可以让我们在不改变既有代码框架的前提下，非常容易地使用这些新特性。其实在此之前，已经有些第三方的框架可以支持 mvvm 模型，无耐由于框架的侵入性太强，导致一直没有流行起来。

准备

android studio 更新到 1.3 版本

打开 preferences，找到 appearances & behavior 下的 updates 选项，把 automatically check updates for 修改成 canary channel。

 

注意

data binding 是一个 support 包，因此与 android m 没什么关系，可以不用下载 android mnc preview 的 sdk。

新建一个 project

修改 project 的 build.gradle，为 build script 添加一条依赖，gradle 版本为 1.2.3。

classpath 'com.android.tools.build:gradle:1.2.3'
classpath 'com.android.databinding:databinder:1.0-rc0'

为用到 data binding 的模块添加插件，修改对应的 build.gradle。

apply plugin: 'com.android.databinding'

注意

如果 module 用到的 buildtoolsversion 高于 22.0.1，比如 23 rc1，那 com.android.databinding:databinder 的版本要改为 1.3.0-beta1，否则会出现如下错误：

 

基础

工程创建完成后，我们通过一个最简单的例子来说明 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 就需要把数据与ui进行绑定，data 节点就为此提供了一个桥梁，我们先在 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;
  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 类型的变量，然后把它跟布局文件中声明的变量进行绑定。

定义 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>

然后我们刚才在 build.gradle 中添加的那个插件 - com.android.databinding会根据xml文件的名称 generate 一个继承自 viewdatabinding 的类。

例如，这里 xml 的文件名叫 activity_basic.xml，那么生成的类就是 activitybasicbinding。

注意

java.lang.* 包中的类会被自动导入，可以直接使用，例如要定义一个 string 类型的变量：

<variable name="firstname" type="string" />

绑定 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="firstname" type=""
</data>

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

setfirstname(string firstname);
setlastname(string lastname);

使用 variable

数据与 variable 绑定之后，xml 的 ui 元素就可以直接使用了。

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

至此，一个简单的数据绑定就完成了，可参考完整代码

高级用法

使用类方法

首先为类添加一个静态方法

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.liangfeizc.databindingsamples.utils.mystringutils" />

使用方法与 java 语法一样：

<textview
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  android:text="@{stringutils.capitalize(user.firstname)}" />

类型别名

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

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

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

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

null coalescing 运算符

android:text="@{user.displayname ?? user.lastname}"

就等价于

android:text="@{user.displayname != null ? user.displayname : user.lastname}"

属性值

通过 ${} 可以直接把 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}"/>

使用资源数据

这个例子，官方教程有错误，可以参考android data binder 的一个bug，完整代码在此。

<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" />

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。