1. 概述
在DataBinding的布局文件当中,可以引入各种变量,并在布局文件中使用变量表达式,达到数据绑定的效果。
引入的变量可以使用完整类名,或者使用标签导包。与Java一样,java.lang的包是默认导入的。具体格式及使用方法如下:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
<variable name="user" type="com.example.User"/>
</data>
<LinearLayout
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="@{user.firstName}"/>
<EditText
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="@={user.lastName}"/>
</LinearLayout>
</layout>
注意在控件属性中使用表达式的格式是@{表达式}
,而双向绑定则是使用@={表达式}
的格式(双向绑定即控件属性的改变可以反映到所绑定变量上)。
2. 变量声明
变量声明需要使用完整变量名,或者使用标签进行导包,可以添加alias属性区分同名不同包的类:
<layout>
<data>
<import type="android.view.View"/>
<import type="com.example.real.estate.View" alias="Vista"/>
</data>
<TextView
android:visibility="@{user.isAdult?View.VISIBLE:View.GONE}"/>
</layout>
对于变量声明中涉及到泛型的部分,因为<>在HTML是特殊字符,需要使用字符实体进行声明,例如<
表示<,>
表示>:
<data>
<import type="java.util.List"/>
<variable name="userList" type="List<User>"/>
</data>
生成的binding类会给每个变量都生成一个getter和setter方法,同时变量会设置一个默认值,即其类型的默认值。另外DataBinding会自动生成一个Context类型的变量context,取值是根布局的getContext(),我们如果声明同名变量context可以覆盖掉这个值。
注意引用变量属性时,DataBinding必须要有办法获取到这个属性值,因此变量的属性必须是public或者提供getter或者以字段名为名的方法来获取属性值,否则会报错。
android:text="@{user.lastName}"
变量
可以在主布局中传递变量到被包含的布局当中,传递方式是通过res-auto命名空间定义变量名属性,传入变量名,然后在被包含布局对该变量进行使用:
主布局文件:
<?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="user" type="com.example.User"/>
</data>
<LinearLayout
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<include layout="@layout/name"
app:user="@{user}"/>
</LinearLayout>
</layout>
name.xml:
<?xml version="1.0" encoding="utf-8"?>
<layout>
<data>
<variable name="user" type="com.example.User"/>
</data>
<TextView
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:textColor="@color/colorPrimaryDark"
android:layout_height="wrap_content"
android:text="@{user.name}">
</TextView>
</layout>
注意标签不能包含在标签当中:
<!-- 错误做法 -->
<merge>
<include layout="@layout/name" bind:user="@{user}"/>
</merge>
3. 表达式
DataBinding中表达式可以使用java大部分运算符及关键字,还可以调用方法,例如:
android:text="@{String.valueOf(index + 1)}"
android:visibility="@{age < 13 ? View.GONE : View.VISIBLE}"
android:transitionName='@{"image_" + id}'
不支持的运算符:this、super、new、显式的泛型调用。
DataBinding新增了一个双目运算符 ??,如果左边表达式结果非空,则使用左边表达式结果,否则使用右边表达式结果。
android:text="@{user.displayName ?? user.lastName}"
DataBinding表达式中是可以自动避免空指针异常的,比如@{user.name}
,如果user为空,不会抛出异常,而是返回默认值,如null、0、false。
如果表达式当中需要使用到字符串,可以直接把属性值的双引号改为单引号,或者字符串常量使用单引号’或者反引号`:
android:text='@{map["firstName"]}'
android:text="@{map[`firstName`]}"
android:text="@{map['firstName']}"
集合元素的元素获取使用[]进行获取:
<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>
<TextView
android:text="@{list[index]}"
android:text="@{sparse[index]}"
android:text="@{map[key]}" />
资源引用的方式除了特殊情况外使用正常语法引用即可:
android:padding="@{large? @dimen/largePadding : @dimen/smallPadding}"
特殊情况如下:
字符串格式化的方式:
android:text="@{@string/nameFormat(firstName, lastName)}"
android:text="@{@plurals/banana(bananaCount)}"
字符串资源文件声明:
<string name="nameFormat">nameFormat with %1$s and %2$s</string>
原生Android XML属性的运行方式是View当中提供自定义属性,然后View会从XML中获取属性值再进行操作。
而当XML属性中使用了DataBinding表达式时,则运行方式就变为从View当中去查找属性对应的setter方法并进行调用,如果找不到就会报错,例如:
android:layout_marginLeft="@{isError?@dimen/wide:@dimen/narrow}"
android:padding="@{isError?@dimen/wide:@dimen/narrow}"
因为View当中有setPadding()方法,第二行可以编译成功,而没有setMarginLeft()方法,第一行会编译失败。