1.开启dataBinding
在build.gradle 文件中添加 dataBinding 元素
android {
...
dataBinding {
enabled true
}
}
AS4.0版本请使用
buildFeatures {
dataBinding true
}
2.在布局中绑定表达式
数据绑定布局文件略有不同,以根标记 layout 开头,后跟 data 元素和 view 根元素。
此视图元素是非绑定布局文件中的根。以下代码展示了示例布局文件:
<?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>
用于 android:text 特性的表达式 @{user.firstName} 访问User类中的 firstName 字段和后或者 getFirstName() 方法.
也可以使用import关键词,当类名相同时可以使用alias关键词建立别名.
<data>
<import type="com.example.study.util.Task"/>
<import type="com.example.study.vm.FirstViewModel"/>
<import type="com.example.study.vm.FirstObservableViewModel"
alias="example"/>
<variable
name="task" type="Task" />
<variable
name="vm" type="FirstViewModel" />
<variable
name="observableVm" type="example" />
</data>
系统会为每个布局文件生成一个绑定类。默认情况下,类名称基于布局文件的名称,它会转换为 Pascal 大小写形式并在末尾添加 Binding 后缀。以上布局文件名为 activity_main.xml,因此生成的对应类为 ActivityMainBinding。此类包含从布局属性(例如,user 变量)到布局视图的所有绑定,并且知道如何为绑定表达式指定值。建议的绑定创建方法是在扩充布局时创建,如以下示例所示:
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ActivityMainBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_main);
// 或者
ActivityMainBinding binding = ActivityMainBinding.inflate(getLayoutInflater());
User user = new User("Test", "User");
binding.setUser(user);
}
如果您要在 Fragment、ListView或 RecyclerView 适配器中使用数据绑定项,您可能更愿意使用绑定类或DataBindingUtil类的 inflate() 方法,如以下代码示例所示:
ListItemBinding binding = ListItemBinding.inflate(layoutInflater, viewGroup, false);
// or
ListItemBinding binding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false);
3.绑定监听器和适配器
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="vertical">
<CheckBox
android:id="@+id/cb_driving"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:background="@drawable/switch_track_selector"
android:button="@null"
android:checked="@={observableVm.checkBoxState}" />
<Button
android:id="@+id/button_first"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:bg="@{@drawable/gen_btn_toggle_off}"
android:onClick="@{(theView) -> vm.onButtonClick(theView, task)}"/>
<!--android:onClick="@{(view) -> vm.onButtonClick(view)}"/>-->
<!--android:onClick="@{vm :: onButtonClick}"-->
</LinearLayout>
可以在xml中绑定监听器,如onClick,代码如下:
@BindingAdapter("android:bg")
public static void setButtonBg(Button view, Drawable bg) {
view.setBackground(bg);
}
public void onButtonClick(View view) {
//do something
}
public void onButtonClick(View view, Task task) {
//run task
}
简单的自定义的适配器如上代码android:bg属性.
绑定适配器对其他类型的自定义很有用。例如,可以通过工作器线程调用自定义加载程序来加载图片。
出现冲突时,您定义的绑定适配器会替换由 Android 框架提供的默认适配器。
可以使用接收多个属性的适配器,如以下示例所示
@BindingAdapter({"imageUrl", "error"})
public static void loadImage(ImageView view, String url, Drawable error) {
Picasso.get().load(url).error(error).into(view);
}
可以在布局中使用适配器,如以下示例所示。请注意,@drawable/venueError 引用应用中的资源。使用 @{} 将资源括起来可使其成为有效的绑定表达式。
<ImageView app:imageUrl="@{venue.imageUrl}" app:error="@{@drawable/venueError}" />
如果 ImageView对象同时使用了 imageUrl 和 error,并且 imageUrl 是字符串,error 是 Drawable,就会调用适配器。如果您希望在设置了任意属性时调用适配器,则可以将适配器的可选 requireAll标志设置为 false,如以下示例所示:
@BindingAdapter(value={"imageUrl", "placeholder"}, requireAll=false)
public static void setImageUrl(ImageView imageView, String url, Drawable placeHolder) {
if (url == null) {
imageView.setImageDrawable(placeholder);
} else {
MyImageLoader.loadInto(imageView, url, placeholder);
}
}
4.双向绑定
如上代码为双向数据绑定.注意表达式为@={}其中重要的是包含“=”符号)可接收属性的数据更改并同时监听用户更新。
android:checked="@={observableVm.checkBoxState}"
为了对后台数据的变化作出反应,您可以将您的布局变量设置为 Observable(通常为 BaseObservable的实现,并使用@Bindable注释,如以下代码段所示
public class FirstPresenter extends BaseObservable {
private Boolean mCheckBoxState;
public FirstPresenter() {
//init mCheckBoxState
}
public void setCheckBoxState(Boolean b){
if (mCheckBoxState == b) {
return;
}
mCheckBoxState = b;
//do something
notifyPropertyChanged(BR.checkBoxState);
}
@Bindable
public Boolean getCheckBoxState(){
return mCheckBoxState;
}
public void setCheckBoxStateForm(Boolean b){
if (mCheckBoxState == b) {
return;
}
mCheckBoxState = b;
notifyPropertyChanged(BR.checkBoxState);
}
}
当用户点击checkbox会自动调用setCheckBoxState方法,然后notify调用getCheckBoxState设置ui.
当然我们也可以使用实现 Observable
的 ViewModel
组件,向其他应用组件发出数据变化通知,这与使用 LiveData
对象的方式类似.
public class ObservableViewModel extends ViewModel implements Observable {
private PropertyChangeRegistry registry = new PropertyChangeRegistry();
@Override
public void addOnPropertyChangedCallback(OnPropertyChangedCallback callback) {
registry.add(callback);
}
@Override
public void removeOnPropertyChangedCallback(OnPropertyChangedCallback callback) {
registry.remove(callback);
}
void notifyChange() {
registry.notifyCallbacks(this,0 ,null);
}
void notifyPropertyChanged(int fieldId) {
registry.notifyCallbacks(this, fieldId, null);
}
}
其实只是自己实现了BaseObservable.