Data Objects
任何的POJO对象都能用于数据绑定,但是当修改POJO对象并不会对UI进行更新。而DataBinding真正强大之处是在于修改POJO对象会通知UI的变换。实现的机制在于:
- Observable Objects
- Observable Fields
- Observable Collections
Observable Objects
一个实体类只要实现了Observable
接口,binding class就会为该实体类添加一个监听器,只要该实体类的的任何一个属性发生变换,binding class就会通知UI进行更新。
public interface Observable {
void addOnPropertyChangedCallback(Observable.OnPropertyChangedCallback var1);
void removeOnPropertyChangedCallback(Observable.OnPropertyChangedCallback var1);
public abstract static class OnPropertyChangedCallback {
public OnPropertyChangedCallback() {
}
public abstract void onPropertyChanged(Observable var1, int var2);
}
}
Observable
接口定义了添加、删除回调方法以及通知属性更改的回调。为了简化开发提供了该接口的一个实现类,BaseObservable
。所以为了让pojo对象属性变换相应更新UI只需要继承该类即可。
接下来看看用法:
public class User extends BaseObservable{
private String firstName;
private String lastName;
public User(String firstName, String lastName) {
this.firstName = firstName;
this.lastName = lastName;
}
@Bindable
public String getFirstName() {
return firstName;
}
@Bindable
public String getLastName() {
return lastName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
notifyPropertyChanged(BR.firstName);
}
public void setLastName(String lastName) {
this.lastName = lastName;
notifyPropertyChanged(BR.lastName);
}
}
在以上代码可以看到,在getter方法添加@Bindable
注解,在setter调用notifyPropertyChanged(BR.lastName);
方法即可实现。
ObservableFields
继承BaseObservable
有时候还是会带来不便,因此data binding为我们提供了一个便捷类ObservableField
以及它的派生类:ObservableBoolean
, ObservableByte
, ObservableChar
, ObservableShort
, ObservableInt
, ObservableLong
, ObservableFloat
, ObservableDouble
以及ObservableParcelable
。来看一下它们的用法:
public class User{
public final ObservableField<String>firstName = new ObservableField<>();
public final ObservableField<String>lastName = new ObservableField<>();
}
只要在实体类中定义public final修饰的ObservablerField变量就可以实现和继承BaseObservable
一样的效果。
然后可以通过调用setter和getter方法来获得数据
user.firstName.set("Google");
int age = user.age.get();
Observable Collections
对于集合提供了两个类,一个是ObservableArrayMap
和ObservableArrayList
。看后缀大概就能猜到这两个集合类的用法,一个是类似于Map
存储键值对,另一个类似List
一样存储数据。
举个例子:
在Java代码中定义数据并且调用binding的set方法
ObservableArrayMap<String, String> user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
binding.setMaps(maps);
xml中的布局:
<import type="android.databinding.ObservableMap"/>
<variable
name="maps"
type="ObservableMap<String,String>"/>
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text='@{maps["firstName"]}'/>
生成绑定
自动生成的Binding类都继承了ViewDataBinding类,它们是连接layout的variables和Views的桥梁。
Views With IDs
在xml布局中如果view控件定义了id则对应的会在binding class中生成一个public final类型的引用,进而我们可以通过binding class的引用获取该变量进行相应的操作。
举个例子:
activity_main.xml
布局中定义了一个Button并且指定了Button的id为test
<Button
android:id="@+id/test"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="Test" />
接下来在Activity中可以直接通过Binding Class的引用获取相应的引用,比findViewById方法更加方便MainActivity.java
中的代码:
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
UserBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_main);
binding.test.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Toast.makeText(MainActivity.this,"test",Toast.LENGTH_SHORT).show();
}
});
}
ViewStubs
ViewStub不同于其他控件。在需要时才会将自身替换成特定的布局。所以data binding提供了一个ViewStubProxy类来代替ViewStub,开发者可以通过这个类来操作ViewStub。
举个例子:
新建一个ActivityViewStubActivity
,其中xml定义为activity_view_stub.xml
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
</data>
<LinearLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="inflate view_stub"
android:onClick="onClick"/>
<ViewStub
android:id="@+id/view_stub"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout="@layout/include" />
</LinearLayout>
</layout>
xml只定义了一个Button和一个ViewStub,逻辑是要在按钮点击的时候替换掉ViewStub。
layout下的include.xml
的代码如下:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
<variable
name="user"
type="com.example.chenyichao.databindingdemoproject.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}"/>
</LinearLayout>
</layout>
再看看Activity中的代码:
public class ViewStubActivity extends AppCompatActivity {
private ActivityViewStubBinding mBinding;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mBinding = DataBindingUtil.setContentView(this,R.layout.activity_view_stub);
//ViewStub需要在inflate时候创建一个binding,故需要设置监听ViewStub.OnInflateLister
mBinding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
@Override
public void onInflate(ViewStub stub, View inflated) {
IncludeBinding includeBinding = DataBindingUtil.bind(inflated);
User user = new User();
user.firstName.set("hhh");
includeBinding.setUser(user);
}
});
}
public void onClick(View view) {
if (!mBinding.viewStub.isInflated()) {
mBinding.viewStub.getViewStub().inflate();
}
}
}
属性设置
自动setter
即使没有对应的xml属性,只要有setter方法就可以在layout中使用该属性。例如v4包下的DrawerLayout
没用定义xml属性但是有大量的setter方法,所以可以这样使用:
<android.support.v4.widget.DrawerLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:scrimColor="@{@color/scrim}"/>
有个注意的点就是data binding表达式的返回值类型要跟setter方法参数类型一致。
Custom Setters
举个例子介绍一下@BindingAdapter
注解的用法。
ImageView,我们能够设置一个xml属性imageUrl
使得ImageView能够加载url对应的图片,看看DataBinding是如何帮我们实现的。
首先在任何一个类中定义一个静态方法,使用@BindingAdapter
注解。并在方法中处理加载图片的逻辑。
@BindingAdapter({"imageUrl"})
public static void loadImage(ImageView view,String url){
Glide.with(view.getContext()).load(url).into(view);
}
接着在xml中定义ImageView
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto">
<data>
<variable
name="url"
type="String"/>
</data>
<LinearLayout
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<ImageView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:imageUrl="@{url}"/>
</LinearLayout>
</layout>
最后在binding class的引用中设置url
binding.setUrl("http://owz363p0a.bkt.clouddn.com/beauty.jpg");