简述
Android databind技术实现了view -- model之间的绑定,在写Android界面的时候,可以省去大量的findviewbyid( )
、setOnClickListener( )
、textview.setText( )
等胶水代码。该技术的某些高级特性还可以快速的实现添加view属性。
Android databind技术采用 mvvm设计模式,该设计模式主要分为三个部分:model 、view 、viewmodel。其中view 为用户定义的layout布局, model 为用户定义的数据结构, viewmodel则是Android databing 根据layout生成的binding 类。
使用databind需要使用Gradle 的 Android Plugin 1.5 以上的版本。然后在app 模块的gradle文件中进行声明:
android {
....
dataBinding {
enabled = true
}
}
一个简单的例子###
- 首先,需要在layout.xml文件中声明使用databind
<?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}"/>
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="@{user.lastName}"/>
</LinearLayout>
</layout>
layout中的内容需要在最外层添加 <layout> </layout>
。
然后要声明 <data>
内容,其中<variable>
对应的是使用的mvvm中的model,即用户定义的数据结构。其中 name 声明变量名,type声明变量类型。
最后在view的参数中使用android:text="@{user.lastName}"
进行赋值。
- User类中的用于赋值的变量必须有对应的getter函数
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 this.firstName;
}
public String getLastName() {
return this.lastName;
}
}
- Android 的databind 工具会根据layout文件生成对应的binding 类 ,如mainacitivyt.xml 会生成
MainActivityBinding
.所有生成的banding类全部继承于android.databinding.ViewDataBinding
。
需要在加载layout的时候使用bingding类进行绑定,绑定方法有很多,例如
MainActivityBinding binding = DataBindingUtil.setContentView(this, R.layout.main_activity);
MainActivityBinding binding = MainActivityBinding.*inflate*(getLayoutInflater());
view绑定后,需要在合适的时候对model进行绑定,
User user = new User("Test", "User");
binding.setUser(user);
真正的数据绑定
上面的例子可以在binding.setUser(user);
的时候,将user的数据写到对应 view上。但是,当你在后面的代码中改user里的变量时,view 上的内容并不会进行相应的变化。如果想要user变化时,view上的内容“实时”更新,则需要以下几种方法:
- 继承BaseObservable
private static class User extends BaseObservable {
private String firstName;
private String lastName;
@Bindable
public String getFirstName() {
return this.firstName;
}
@Bindable
public String getLastName() {
return this.lastName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
notifyPropertyChanged(BR.firstName);
}
public void setLastName(String lastName) {
this.lastName = lastName;
notifyPropertyChanged(BR.lastName);
}
}
使用@Bindable
对getter
方法进行注解,并且在setter
方法的时候,显性调用 notifyPropertyChanged
方法,其中BR.xxx
变量为Android databind 工具生成。
- ObservableFields
上述方式比较麻烦,Android databind 提供了ObservableField<T>
类。以及一些基础类型的包装类,ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, ObservableParcelable
用法如下:
public final ObservableField<String> firstName = new ObservableField<>();
public final ObservableInt age = new ObservableInt();
user.firstName.set("Google");
int age = user.age.get();
Observable 定义的变量,必须使用 getter 和 setter进行取值赋值操作。
还可以定义Observable集合,ObservableArrayMap
。
Android databind 常见用法
databing最简单的用法就是上面例子中直接对view的属性进行赋值(前提是该属性有对应setter函数),下面介绍几种稍微复杂的用法。
-
表达式赋值
Android databind 支持大部分java语法(不支持 new),在对view的属性赋值时,可以直接使用表达式,例如:
<TextView android:text="@{user.age < 18 ? @string/redacted : user.name}"/>
<TextView android:text="@{String.valueOf(index + 1)}" />
-
事件监听
为View设置onClick ,如下
android:onClick="@{(view) -> presenter.onSaveClick()}"
需要在对应的Presenter类中有对应的函数,
public class Presenter {
public void onSaveClick(View view){
}
}
-
类型转换
对view赋值时有些类型需要转换,例如:
<View
android:background="@{isError ? @color/red : @color/white}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
color 为int值 ,view.setBackground 需要的是drawable参数,这个时候,需要定义类型转换,
@BindingConversion
public static ColorDrawable convertColorToDrawable(int color) {
return new ColorDrawable(color);
}
该方法可以定义在任何地方。
-
适配器
开发中一个比较常见的场景就是使用ImageLoader进行加载图片,在任何地方添加适配器代码:
@BindingAdapter("android:src")
public static void setImageUrl(ImageView view, String url) {
Picasso.with(view.getContext()).load(url).into(view);
}
这个时候可以使用下面代码进行数据绑定:
<ImageView …
android:src="@{data.url}" />
当进行bind的时候,会自动调用适配器定义的函数。适配器也可以用来添加view的属性。比如我想在Textview
中绑定long
型的时间戳,并且按照一个格式显示。
<TextView ···
app:date="@{appData.create_time}"
app:format='@{"yyyy年MM月dd日"}'
/>
@android.databinding.BindingAdapter(value = {"app:date", "app:format"}, requireAll = false)
public static void bindFormat(TextView view, String date, String format) {
if (date == null) {
return;
}
SimpleDateFormat formatter;
if (format != null) {
formatter = new SimpleDateFormat(format);
} else {
formatter = new SimpleDateFormat("yyyy-MM-dd");
}
Long timeStamp = Long.parseLong(date);
view.setText(formatter.format(new Date(timeStamp)));}
其中 requireAll = false
表示当参数不全时,也会调用适配器函数,补全的参数会传入空值,所以要自己判断。
-
findView
某些时候我们还是需要引用到布局中的view,但是不需要使用findview···
,databinding会根据布局中的view的ID,以及属性赋值自动生成布局中需要用的view引用。其中 binding.getRoot()
返回绑定的View
。
总结
- databind 可以减少编写各种胶水代码,同时也在开发中引入MVVM设计模式。也可以为MVP 、MVC等其他的设计模式提供支持。
- Android databind是在编译阶段进行代码生成,所以并不影响运行效率。
- 当前版本的databind的支持还是有些欠佳的,比如在布局文件中,使用
app:xxx
进行赋值的时候,是不能自动补全的。在比如说赋值drawable资源的时候,是不能使用 @mipmap 路径的。