Import 引入
data元素中可以引入0个或多个import元素,便于后续再布局文件中引用这些类。
<data>
<import type="android.view.View"/>
</data>
经过上述定义,可在binding表达式中引用View。
<TextView
android:text="@{user.lastName}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:visibility="@{user.isAdult ? View.VISIBLE : View.GONE}"/>
当class名字存在冲突时,可对其中一个类进行重命名alias。
<import type="android.view.View"/>
<import type="com.example.real.estate.View"
alias="Vista"/>
上例中布局文件中,可用Vista引用com.example.real.estate.View,而View则标识引用android.view.View。Import类型可在variables和表达式中作为引用类型使用。示例如下:
<data>
<import type="com.example.User"/>
<import type="java.util.List"/>
<variable name="user" type="User"/>
<variable name="userList" type="List<User>"/>
</data>
Android Studio目前尚未处理imports,所以自动完成引入variables可能在IDE中不可行。通过在variable定义中使用全称可以规避该问题。
<TextView
android:text="@{((User)(user.connection)).lastName}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
当在表达式中引用静态域或者方法时,也可以使用引入类型。
<data>
<import type="com.example.MyStringUtils"/>
<variable name="user" type="com.example.User"/>
</data>
…
<TextView
android:text="@{MyStringUtils.capitalize(user.lastName)}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
同Java一样,java.lang.*被自动引入。
Variables 变量
data元素内可以使用任意数量的variable,每个variable描述了可在布局中使用的属性,用于在布局文件中写binding表达式
<data>
<import type="android.graphics.drawable.Drawable"/>
<variable name="user" type="com.example.User"/>
<variable name="image" type="Drawable"/>
<variable name="note" type="String"/>
</data>
这些变量类型在编译时注入,如果一个变量实现Observable接口或者是一个observable集合,那么应该在类型中reflected。如果variable是一个基类或者一个未实现Observerable*接口的接口,这个variables将不会被observed!
当针对不同的配置有多个不同布局文件时(e.g.横屏和竖屏),这些variables将会被combined。在这些布局文件中不能存在冲突的variable定义。
生成的binding类对每个声明的variables都有一个setter和getter方法。在setter被调用前,variable保持Java默认值——引用类型为null,整形为0,布尔类型为false等
一个名为context的特殊variable在binding表达式需要时产生,conntext变量的值为根View的getContext()值。这个context变量可以被显示的同名变量声明所覆盖。
定制Binding类名
默认情况下,Binding类名根据布局文件的名字产生。使用大写字母开头,去掉下划线并大写下划线后的第一个字母,最终以Binding结尾。这个类被放置在模块package下的databinding包。例如布局文件名为contact_item.xml,则会生成ContactItemBinding类。如果模块包名为com.example.my.app,则Binding类被放在com.example.my.app.databinding。
通过调整data元素中的class属性,可以将Binding类重命名或者放置在不同的包目录下。例如
<data class="ContactItem">
...
</data>
上例中生成的Binding类名为ContactItem,并位于模块包名下的databinding包(eg.com.example.my.app.databinding.ContactItem)。如果需要将类放置在不同的包名中,可以使用前缀“.”
<data class=".ContactItem">
...
</data>
上例中ContactItem在模块包名目录下生成该Binding类(eg.com.example.my.app.ContactItem)。如果使用package全称,则可以指定任意包名,下例中该Binding类包名为com.example,类名全称为com.example.ContactItem。
<data class="com.example.ContactItem">
...
</data>
Includes
variable可以被传递到布局文件中include布局的binding,通过使用应用命名空间以及属性中的变量名。
<?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.example.User"/>
</data>
<LinearLayout
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<include layout="@layout/name"
bind:user="@{user}"/>
<include layout="@layout/contact"
bind:user="@{user}"/>
</LinearLayout>
</layout>
上例中在name.xml和contact.xml布局文件中必须有一个user变量。
Data Binding不支持include作为merge元素的直接子类使用。下例中的布局是不支持的
<?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.example.User"/>
</data>
<merge>
<include layout="@layout/name"
bind:user="@{user}"/>
<include layout="@layout/contact"
bind:user="@{user}"/>
</merge>
</layout>
表达式语言
Data Binding的表达式语言和Java表达式有很多相似的地方。下面列举的是一致的地方:
Mathematical + - / * %
String concatenation +
Logical && ||
Binary & | ^
Unary + - ! ~
Shift >> >>> <<
Comparison == > < >= <=
instanceof
Grouping ()
Literals - character, String, numeric, null
Cast
Method calls
Field access
Array access []
Ternary operator ?:
//示例
android:text="@{String.valueOf(index + 1)}"
android:visibility="@{age < 13 ? View.GONE : View.VISIBLE}"
android:transitionName='@{"image_" + id}'
注意,Java中的this,super,new等不能在Data Binding中使用。
空联合操作符??
空联合操作符??在左边的操作非空时选择左边,否则选择右边。
android:text="@{user.displayName ?? user.lastName}"
//等同于
android:text="@{user.displayName != null ? user.displayName : user.lastName}"
属性引用
当表达式中引用类的一个属性时,这和fields、getters、setters和ObservableFields的引用方式一致。
android:text="@{user.lastName}"
避免NullPointerException
生成Data Binding代码时,自动检查null并避免出现NullPointerException。e.g.在表达式 @{user.name}中,如果user为null,则user.name会分配默认值(null);如果引用user.age,其中age为int类型,则默认值为0.
集合
常用的集合: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']}"
资源
使用常规的语法,可以在表达式中访问资源文件。
android:padding="@{large? @dimen/largePadding : @dimen/smallPadding}"
格式字符串和复数可以通过提供参数来定义
android:text="@{@string/nameFormat(firstName, lastName)}"
android:text="@{@plurals/banana(bananaCount)}"
当复数存在多个参数时,所有的参数都必须传递。
Have an orange
Have %d oranges
android:text="@{@plurals/orange(orangeCount, orangeCount)}"
一些资源需要显示的类型评估。
参考:
https://developer.android.google.cn/topic/libraries/data-binding/index.html#layout_details