之前介绍了如何使用 DataBinding ,其中涉及到ViewModel
的定义,这期我们就详细解析一下如何定义及使用ViewModel
Observable Objects
在 DataBinding 中有个接口Observable
,实现这个接口可以添加一个监听器来绑定观察类中的属性是否有变化。有个实现了Observable
的父类BaseObservable
,由 DataBinding 提供,代码如下
public class BaseObservable implements Observable {
private transient PropertyChangeRegistry mCallbacks;
public BaseObservable() {
}
@Override
public synchronized void addOnPropertyChangedCallback(OnPropertyChangedCallback callback) {
if (mCallbacks == null) {
mCallbacks = new PropertyChangeRegistry();
}
mCallbacks.add(callback);
}
@Override
public synchronized void removeOnPropertyChangedCallback(OnPropertyChangedCallback callback) {
if (mCallbacks != null) {
mCallbacks.remove(callback);
}
}
public synchronized void notifyChange() {
if (mCallbacks != null) {
mCallbacks.notifyCallbacks(this, 0, null);
}
}
public void notifyPropertyChanged(int fieldId) {
if (mCallbacks != null) {
mCallbacks.notifyCallbacks(this, fieldId, null);
}
}
}
可以看到这个类帮我们实现了Observable
接口里的方法,并且添加了notifyChange()
和notifyPropertyChanged(int fieldId)
方法供子类调用。这里会让人联想到JDK中的java.util.Observable
,它是个类不是接口,也没有实现任何接口,这个设计有点糟糕,因为Java是不支持多继承的,如果子类需要java.util.Observable
和另一个超类的行为,就会陷入两难境界。DataBinding 的设计有效的避免了这种问题,它提供一个接口定义了规范,并提供一个实现了接口的超类供继承,如果觉得BaseObservable
占了继承位也可以自己定义超类实现Observable
接口。
现在我们重新观察BaseObservable
这个类,notifyPropertyChanged(int fieldId)
是一个非常有用的方法,在子类的setter
中调用,能够更新View中的数据。例如
public class MainViewModel extends BaseObservable {
private String phone;
public MainViewModel(String phone) {
this.phone = phone;
}
public void setPhone(String phone) {
this.phone = phone;
notifyPropertyChanged(BR.phone);
}
@Bindable
public String getPhone() {
return phone;
}
上面的MainViewModel
中的getter
加入注解@Bindable
,这样会在编译时在BR
中生成一个标识,这样能够鉴定这个属性是否被修改过。BR
是编译时生成的类似于Android中的R.class
的文件,其中也是标识了所有你在DataBinding 中定义的类和属性。而在自动生成的MainBinding.class
中也印证了这一点,当调用mainBinding.setUser(user)
时MainBinding
也有调用notifyPropertyChanged(BR.user)
public class MainBinding extends android.databinding.ViewDataBinding {
public void setUser(com.winter.huang.databinding.viewmodel.MainViewModel user) {
updateRegistration(0, user);
this.mUser = user;
synchronized(this) {
mDirtyFlags |= 0x1L;
}
notifyPropertyChanged(BR.user);
super.requestRebind();
}
}
颗粒度更小的ObservableField
如果觉得只需要部分数据需要进行数据绑定,无需继承这么麻烦,可以使用ObservableField
包括 ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, ObservableParcelable, ObservableArrayMap, ObservableArrayList
具体可见
绑定事件
先定义一个ActionHandler
类,定义两个方法,用来体现绑定事件的两种方式
public class ActionHandler {
public void showPhone(MainViewModel viewModel) {
Toast.makeText(AppApplication.getAppContent(), viewModel.getPhone(), Toast.LENGTH_SHORT).show();
}
public void showPhone(View view) {
}
}
可以在xml
中定义并使用
<import type="com.winter.huang.databinding.utils.ActionHandler" alias="ActionHandler"/>
<variable
name="actionHandler"
type="ActionHandler"/>
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="New Button"
android:id="@+id/button"
android:onClick="@{actionHandler.showPhone}"/>
上面这种方法会调用showPhone(View view)
,DataBinding 会默认传入当前View
的实例进入方法体,所以直接写actionHandler.showPhone
就可以。另一种用法是使用λ表达式。
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="New Button"
android:id="@+id/button"
android:onClick="@{() -> actionHandler.showPhone(user)}"/>
两种方式是有本质区别的,第一种方式和以往在xml
中声明android:onClick=showPhone
,之后在Activity
中定义是相同的。
public void showPhone(View view) {
//do something
}
第二种方式可以理解为此处使用了一个OnClickListener
匿名内部类的方式调用actionHandler.showPhone(user),通常情况推荐第二种,因为点击事件可能会引起数据的改变,第二种方式直接传入ViewModel
,更方便操作数据。
@BindingAdapter 自定义属性值
假如需要为EidtText
设置TextWatcher
,在xml
中是不支持该属性的,这时我们可以自定义属性,使用@BindingAdapter
注解,定义公有静态方法传入需要操作的View
和其他参数即可,下面的代码为EditText
设置属性android:afterTextChanged
@BindingAdapter({"android:afterTextChanged"})
public static void showViewModel(final EditText editText, final MainViewModel viewModel) {
editText.addTextChangedListener(new TextWatcher() {
@Override
public void beforeTextChanged(CharSequence s, int start, int count, int after) {
}
@Override
public void onTextChanged(CharSequence s, int start, int before, int count) {
}
@Override
public void afterTextChanged(Editable s) {
if (!s.toString().equals(viewModel.getPhone())) {
viewModel.setPhone(s.toString());
}
}
});
}
由于DataBinding 默认第一个参数必须是View
,而且可以缺省传入,所以xml
中可以写为
<EditText
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:afterTextChanged="@{user}"/>
@BindingAdapter({"android:afterTextChanged"})
中定义了命名空间和属性名,关于命名空间可以参考stackoverflow这个问题ianhanniballake的回答。
对于相对复杂的交互,可能需要多个属性值协作,@BindingAdapter
也支持传入多个属性,需要在定义时传入数组即可
public class ActionHandler implements View.OnClickListener{
@BindingAdapter({"android:onClick", "android:clickable"})
public static void setOnClick(View view, View.OnClickListener onClickListener, boolean clickable) {
view.setOnClickListener(onClickListener);
view.setClickable(clickable);
}
@Override
public void onClick(View v) {
Toast.makeText(AppApplication.getAppContent(), "onClick", Toast.LENGTH_SHORT).show();
}
}
在xml
中
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:clickable="@{true}"
android:onClick="@{actionHandler}" />
属性的顺序可以不依赖定义的顺序,同样View
是默认传入,此处每个属性传入一个参数即可,如果某个属性未定义,则由默认值决定,如android:clickable="@{true}"
不声明,并不影响Button
是否可以点击。关于@BindingAdapter的工作原理可以参考这里
之后会尝试写一个基于DataBinding 的小项目,如果遇到什么坑会及时分享出来。