DataBinding最全使用说明

如果你要在Android实现MVVM架构, 那么DataBinding是你的不二选择. MVVM也是目前所有前端/iOS/Android领域主流发展方向

1. 更少的代码
2. 更强大的容错性
3. 更快的迭代速度
4. 更高的可读性

本文与2019基于Kotlin再编辑

前言

1. 不要企图使用LiveData取代DataBinding, DataBinding本身就兼容LiveData属性
2. 无论项目大小MVVM都优于M*3. 这是主流也是未来

启用 DataBinding会自动在build目录下生成类. 因为被集成进AndroidStudio所以不需要你手动编译会实时编译, 并且支持大部分代码补全.

apply plugin: "kotlin-kapt" // Kotlin 使用 Databinding必须添加

android{
  /.../
      dataBinding {
        enabled = true;
    }
}

开头

• Databinding不是替代ButterKnife之类的 findById只是他的一个小小的辅助功能而已, 我推荐使用Kotlin来解决这个需求;
• Databinding的大部分情况下错误提示很完善, 个别XML书写错误也易于排查
• 我想强调的是Xml中的@{} 只做赋值或者简单的三元运算或者判空等不要做复杂运算, 否则违背解耦原则.
• 业务逻辑应该尽量在Model中
• ViewModel属于DataBinding自动生成的类

MVP对比MVVM的劣势

1. MVP通过接口回调实现导致代码可读性差, 阅读顺序不连贯
2. MVP无法实现双向数据绑定
3. MVP的实现因人而异, 差异性导致阅读性差
4. MVP的代码量比MVC还要多, 属于通过提升代码量来解耦, 代码量比MVVM几何倍增
5. 前端任何平台都开始趋向于MVVM, Web领域MVVM属于最成熟的应用

我开源一个基于Kotlin和Databinding特性的RecyclerView库: BRV, 具备无与伦比的简洁和MVVM特性;

布局

布局文件

layout

布局根节点必须是 . 同时layout只能包含一个View标签. 不能直接包含

data

标签的内容即DataBinding的数据. data标签只能存在一个.

variable

通过标签可以指定类, 然后在控件的属性值中就可以使用

通过DataBinding的setxx()方法可以给Variable设置数据. name值不能包含_下划线

import

第二种写法(导入), 默认导入了java/lang包下的类(String/Integer). 可以直接使用被导入的类的静态方法.

使用类

Tip: user代表UserBean这个类, 可以使用UserBean中的方法以及成员变量. 如果是getxx()会自动识别为xx. 注意不能使用字符串android, 否则会报错无法绑定.

class

标签有个属性可以自定义DataBinding生成的类名以及路径

Tip:注意没有代码自动补全. 自定义路径Module/build/generated/source/apt/debug/databinding/目录下, 基本上不需要自定义路径

默认:

public class MainActivity extends AppCompatActivity {

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // ActivityMainBinding这个类根据布局文件名生成(id+Binding)
    ActivityMainBinding viewDataBinding = DataBindingUtil.setContentView(this, R.layout.activity_main);

    UserBean userBean = new UserBean();
    userBean.setUserName("drake");

    // setUser这个方法根据Variable标签的name属性自动生成
    viewDataBinding.setUser(userBean);
  }
}

alias

标签如果需要导入(import)两个同名的类时可以使用alias属性(别名属性)

include

在include其他布局的时候可能需要传递变量(variable)值过去

....

include\_demo

    

        
    

...

android:text="@{userName}"

两个布局通过include的bind:<变量名>值来传递. 而且两者必须有同一个变量

DataBinding不支持merge标签传递变量

自动布局属性

DataBinding对于自定义属性支持非常好, 只要View中包含setter方法就可以直接在布局中使用该属性(这是因为DataBinding的库中官方已经帮你写好了很多自定义属性)

public void setCustomName(@NonNull final String customName) {
    mLastName.setText("吴彦祖");
  }

然后直接使用(但是IDE没有代码补全)

app:customName="@{@string/wuyanzu}"

但是setter方法只支持单个参数. app:这个命名空间可以随意

数据双向绑定

数据刷新视图

BaseObservable

如果需要数据变化是视图也跟着变化则需要使用到以下两种方法

有两种方式:

继承BaseObservable

public class ObservableUser extends BaseObservable {
    private String firstName;
    private String lastName;

    @Bindable
    public String getFirstName() {
        return firstName;
    }

  // 注解才会自动在build目录BR类中生成entry, 要求方法名必须以get开头
    @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); // 需要手动刷新
    }
}

• 简化用法只需要数据模型继承BaseObservable即可, 然后每次变更数据后调用notify()函数既可以刷新视图. 不需要注解.

  observableUser.name
  observableUser.notifyChange()
  

• 如果你无法继承可以通过实现接口方式也可以. 查看BaseObservable实现的接口自己实现即可, 也可以复制代码示例

还可以监听属性改变事件

ObservableUser.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
  @Override
  public void onPropertyChanged(Observable observable, int i) {

  }
});

属性第一次改变时会回调两次, 之后都只回调一次. 如果使用notifyChange()不会得到id(即i等于0). 使用

notifyPropertyChanged(i)就可以在回调里面得到id.

BaseObservable和Observable的区别

1. BaseObservable是实现了Observable的类, 帮我们实现了监听器的线程安全问题.
2. BaseObservable使用了PropertyChangeRegistry来执行OnPropertyChangedCallback
3. 所以我不推荐你直接实现Observable.

ObservableField

这属于第二种方式, databinding默认实现了一系列实现Observable接口的字段类型

BaseObservable,
ObservableBoolean,
ObservableByte,
ObservableChar,
ObservableDouble,
ObservableField,
ObservableFloat,
ObservableInt,
ObservableLong,
ObservableParcelable,
ObservableShort,
ViewDataBinding

示例

public class PlainUser {
  public final ObservableField firstName = new ObservableField<>();
  public final ObservableField lastName = new ObservableField<>();
  public final ObservableInt age = new ObservableInt();
}

对于集合数据类型ObservableArrayMap/ObservableArrayLis/ObjservableMap等集合数据类型

ObservableArrayMap user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
user.put("age", 17);

使用

    
    

…

Tip:

1. 还支持ObservableParcelable