1、我的gradle版本是2.0.0,所以在app的build.gradle中配置
//开启DataBinding
dataBinding {
enabled true;
}
2、布局方式
使用 Data Binding 之后,xml的布局文件就不再单纯地展示 UI 元素,还需要定义 UI 元素用到的变量。所以,它的根节点不再是一个 ViewGroup
,而是变成了 layout
,并且新增了一个节点 data
。
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
<variable
name="user"
type="orm.mvp.mvp.bean.User"></variable>
<variable
name="userName"
type="String"></variable>
<variable
name="userPwd"
type="String"></variable>
</data>
<LinearLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<EditText
android:id="@+id/et_username"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:hint="请输入用户名"
android:text="@{user.userName}" />
<EditText
android:id="@+id/et_userpwd"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:hint="请输入密码"
android:text="@{user.userPwd}"
android:inputType="textPassword" />
<Button
android:id="@+id/btn_login"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:onClick="loginClick"
android:text="登录" />
</LinearLayout>
</layout>
要实现 MVVM 的 ViewModel 就需要把数据与UI进行绑定,data
节点就为此提供了一个桥梁,我们先在 data
中声明一个 variable
,这个变量会为 UI 元素提供数据,然后在 Java 代码中把”后台”数据与这个 variable
进行绑定。
2.1、定义Variable
<variable
name="user"
type="orm.mvp.mvp.bean.User"></variable>
其中 type
属性就是我们在 Java 文件中定义的 User
类。
当然,data
节点也支持 import
,所以上面的代码可以换一种形式来写。
<data>
<import type="orm.mvp.mvp.bean.User" />
<variable name="user" type="User" />
</data>
这里的XML文件名称是login_main.xml ,所以会生成LoginMainBinding
2.2、绑定Variable
LoginMainBinding binding = DataBindingUtil.setContentView(this, R.layout.login_main);
User user = new User();
user.setUserName("mvp");
user.setUserPwd("123456");
binding.setUser(user); binding.btnLogin.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
user.userName1.set("mvp123");
user.userPwd1.set("123456");
}
});
3、数据对象
public class User extends BaseObservable{
private String userName;
private String userPwd;
@Bindable
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
notifyPropertyChanged(BR.userName);
}
@Bindable
public String getUserPwd() {
return userPwd;
}
public void setUserPwd(String userPwd) {
this.userPwd = userPwd;
notifyPropertyChanged(BR.userPwd);
}
}
BR
是编译阶段生成的一个类,功能与 R.java
类似,用 @Bindable
标记过 getter
方法会在 BR
中生成一个 entry,当我们
通过代码可以看出,当数据发生变化时还是需要手动发出通知。 通过调用notifyPropertyChanged(BR.firstName)
来通知系统 BR.firstName
这个 entry
的数据已经发生变化,需要更新 UI。
4、高级用法
4.1、如果我们在 data
节点了导入了两个同名的类怎么办?
<import type="orm.mvp.mvp.bean.User" />
<import type="orm.mvp.detail.bean.User" />
<variable name="user" type="User" />
这样一来出现了两个 User
类,那 user
变量要用哪一个呢?不用担心,import
还有一个 alias
属性。
<import type="orm.mvp.mvp.bean.User" />
<import type="orm.mvp.detail.bean.User" alias="DetailUser"/>
<variable name="user" type="DetailUser" />
4.2、Null Coalescing 运算符
android:text="@{user.userName ?? user.userPwd}"
就等价于
android:text="@{user.userName != null ? user.userName : user.userPwd}"
4.3、更细粒度的绑定方式,可以绑定具体的成员
public class User {
public final ObservableField<String> userName = new ObservableField<>();
public final ObservableField<String> userPwd = new ObservableField<>();
}
Dynamic Variables
完整代码可以参考 dynamic
以 RecyclerView
为例,Adapter
的 DataBinding 需要动态生成,因此我们可以在 onCreateViewHolder
的时候创建这个 DataBinding,然后在 onBindViewHolder
中获取这个 DataBinding。
- public static class BindingHolder extends RecyclerView.ViewHolder {
- private ViewDataBinding binding;
- public BindingHolder(View itemView) {
- super(itemView);
- }
- public ViewDataBinding getBinding() {
- return binding;
- }
- public void setBinding(ViewDataBinding binding) {
- this.binding = binding;
- }
- }
- @Override
- public BindingHolder onCreateViewHolder(ViewGroup viewGroup, int i) {
- ViewDataBinding binding = DataBindingUtil.inflate(
- LayoutInflater.from(viewGroup.getContext()),
- R.layout.list_item,
- viewGroup,
- false);
- BindingHolder holder = new BindingHolder(binding.getRoot());
- holder.setBinding(binding);
- return holder;
- }
- @Override
- public void onBindViewHolder(BindingHolder holder, int position) {
- User user = users.get(position);
- holder.getBinding().setVariable(BR.user, user);
- holder.getBinding().executePendingBindings();
- }
注意此处 DataBindingUtil
的用法:
- ViewDataBinding binding = DataBindingUtil.inflate(
- LayoutInflater.from(viewGroup.getContext()),
- R.layout.list_item,
- viewGroup,
- false);
Attribute setters
有了 Data Binding,即使属性没有在 declare-styleable
中定义,我们也可以通过 xml 进行赋值操作。 为了演示这个功能,我自定义了一个 View - UserView,其中 R.styleable.UserView 中只定义了一个 age
属性,其中 firstName
和 lastName
只有对应的两个 setter
方法。
只要有 setter
方法就可以这样为属性赋值:
- <com.liangfeizc.databindingsamples.attributesetters.UserView
- android:layout_width="match_parent"
- android:layout_height="wrap_content"
- android:paddingLeft="@dimen/largePadding"
- app:onClickListener="@{activity.clickListener}"
- app:firstName="@{@string/firstName}"
- app:lastName="@{@string/lastName}"
- app:age="27" />
onClickListener
也是同样道理,只不过我们是在 Activity
中定义了一个 Listener
。
转换器 (Converters)
具体代码可参考 ConversionsActivity.java。
在 xml 中为属性赋值时,如果变量的类型与属性不一致,通过 DataBinding 可以进行转换。
- <Button
- android:onClick="toggleIsError"
- android:text="@{isError.get() ? @color/red : @color/white}"
- android:layout_width="match_parent"
- android:layout_height="wrap_content" />
只需要定义一个标记了 @BindingConversion
的静态方法即可:
- @BindingConversion
- public static int convertColorToString(int color) {
- switch (color) {
- case Color.RED:
- return R.string.red;
- case Color.WHITE:
- return R.string.white;
- }
- return R.string.app_name;
- }