Android DataBinding 从入门到进阶（2）

时间 2019-11-08

标签 android databinding 入门进阶栏目 Android 繁體版

原文原文链接

半年多前写了一篇：Android DataBinding 从入门到进阶的文章，最近发现里面有些小错误，就修改了下文章，而且增添了几个 DataBinding 的使用例子，但愿对你全部帮助php

本文是我在学习 Google 的 DataBinding 框架的过程当中写的笔记，会不定时更新，最新一次的更新时间是在 2019-02-27，但愿对你有所帮助，也欢迎 Star

项目 GitHub 地址：DataBindingSamples

DataBinding 是谷歌官方发布的一个框架，顾名思义即为数据绑定，是 MVVM 模式在 Android 上的一种实现，用于下降布局和逻辑的耦合性，使代码逻辑更加清晰。MVVM 相对于 MVP，其实就是将 Presenter 层替换成了 ViewModel 层。DataBinding 可以省去咱们一直以来的 findViewById() 步骤，大量减小 Activity 内的代码，数据可以单向或双向绑定到 layout 文件中，有助于防止内存泄漏，并且能自动进行空检测以免空指针异常java

启用 DataBinding 的方法是在对应 Model 的 build.gradle 文件里加入如下代码，同步后就能引入对 DataBinding 的支持android

android {
    dataBinding {
        enabled = true
    }
}
复制代码

1、基础入门

启用 DataBinding 后，这里先来看下如何在布局文件中绑定指定的变量git

打开布局文件，选中根布局的 ViewGroup，按住 Alt + 回车键，点击 “Convert to data binding layout”，就能够生成 DataBinding 须要的布局规则github

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools">

    <data>

    </data>

    <android.support.constraint.ConstraintLayout android:layout_width="match_parent" android:layout_height="match_parent" tools:context=".MainActivity">
    </android.support.constraint.ConstraintLayout>
</layout>
复制代码

和原始布局的区别在于多出了一个 layout 标签将原布局包裹了起来，data 标签用于声明要用到的变量以及变量类型，要实现 MVVM 的 ViewModel 就须要把数据（Model）与 UI（View）进行绑定，data 标签的做用就像一个桥梁搭建了 View 和 Model 之间的通道数组

这里先来声明一个 Modleapp

/** * 做者：leavesC * 时间：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.com/u/9df45b87cfdf */
public class User {

    private String name;

    private String password;

    public User(String name, String password) {
        this.name = name;
        this.password = password;
    }

    ···

}
复制代码

在 data 标签里声明要使用到的变量名、类的全路径框架

<data>
        <variable
            name="userInfo"
            type="leavesc.hello.databindingsamples.model.User" />
    </data>
复制代码

若是 User 类型要多处用到，也能够直接将之 import 进来，这样就不用每次都指明整个包名路径了，而 java.lang.* 包中的类会被自动导入，因此能够直接使用dom

<data>
        <import type="leavesc.hello.databindingsamples.model.User"/>
        <variable
            name="userInfo"
            type="User"/>
    </data>
复制代码

若是存在 import 的类名相同的状况，可使用 alias 指定别名ide

<data>
        <import type="leavesc.hello.databindingsamples.model.User" />
        <import alias="TempUser" type="leavesc.hello.databindingsamples.model2.User" />
        <variable name="userInfo" type="User" />
        <variable name="tempUserInfo" type="TempUser" />
    </data>
复制代码

这里声明了一个 User 类型的变量 userInfo，咱们要作的就是使这个变量与两个 TextView 控件挂钩，经过设置 userInfo 的变量值同时使 TextView 显示相应的文本完整的布局代码以下所示

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <variable name="userInfo" type="User" />
    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:layout_margin="20dp" android:orientation="vertical">

        <TextView style="@style/titleTextStyle" android:text="单向数据绑定" />

        <TextView android:id="@+id/tv_userName" android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{userInfo.name}" />

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{userInfo.password}" />

    </LinearLayout>

</layout>
复制代码

经过 @{userInfo.name} 使 TextView 引用到相关的变量，DataBinding 会将之映射到相应的 getter 方法以后能够在 Activity 中经过 DataBindingUtil 设置布局文件，省略原先 Activity 的 setContentView() 方法，并为变量 userInfo 赋值

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
         ActivityMain2Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main2);
        User user = new User("leavesC", "123456");
        binding.setUserInfo(user);
    }
复制代码

因为 @{userInfo.name}在布局文件中并无明确的值，因此在预览视图中什么都不会显示，不便于观察文本的大小和字体颜色等属性，此时能够为之设定默认值（文本内容或者是字体大小等属性都适用），默认值将只在预览视图中显示，且默认值不能包含引号

android:text="@{userInfo.name,default=defaultValue}"
复制代码

此外，也能够经过 ActivityMain2Binding 直接获取到指定 ID 的控件

activityMain2Binding.tvUserName.setText("leavesC");
复制代码

每一个数据绑定布局文件都会生成一个绑定类，ViewDataBinding 的实例名是根据布局文件名来生成，将之改成首字母大写的驼峰命名法来命名，并省略布局文件名包含的下划线。控件的获取方式相似，但首字母小写

也能够经过以下方式自定义 ViewDataBinding 的实例名

<data class="CustomBinding">

    </data>
复制代码

此外，在绑定表达式中会根据须要生成一个名为context的特殊变量，context的值是根 View 的getContext()方法返回的Context对象， context变量会被具备该名称的显式变量声明所覆盖

Databinding 一样是支持在 Fragment 和 RecyclerView 中使用。例如，能够看 Databinding 在 Fragment 中的使用

@Override
    public View onCreateView(@NonNull LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        FragmentBlankBinding binding = DataBindingUtil.inflate(inflater, R.layout.fragment_blank, container, false);
        binding.setHint("Hello");
        return binding.getRoot();
    }
复制代码

**以上实现数据绑定的方式，每当绑定的变量发生变化的时候，都须要从新向 ViewDataBinding 传递新的变量值才能刷新 UI 。接下来看如何实现自动刷新 UI **

2、单向数据绑定

实现数据变化自动驱动 UI 刷新的方式有三种：BaseObservable、ObservableField、ObservableCollection

2.一、BaseObservable

一个纯净的 ViewModel 类被更新后，并不会让 UI 自动更新。而数据绑定后，咱们天然会但愿数据变动后 UI 会即时刷新，Observable 就是为此而生的概念

BaseObservable 提供了 notifyChange() 和 notifyPropertyChanged() 两个方法，前者会刷新全部的值域，后者则只更新对应 BR 的 flag，该 BR 的生成经过注释 @Bindable 生成，能够经过 BR notify 特定属性关联的视图

/** * 做者：leavesC * 时间：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.com/u/9df45b87cfdf */
public class Goods extends BaseObservable {

    //若是是 public 修饰符，则能够直接在成员变量上方加上 @Bindable 注解
    @Bindable
    public String name;

    //若是是 private 修饰符，则在成员变量的 get 方法上添加 @Bindable 注解
    private String details;

    private float price;

    public Goods(String name, String details, float price) {
        this.name = name;
        this.details = details;
        this.price = price;
    }

    public void setName(String name) {
        this.name = name;
        //只更新本字段
        notifyPropertyChanged(leavesc.hello.databindingsamples.BR.name);
    }

    @Bindable
    public String getDetails() {
        return details;
    }

    public void setDetails(String details) {
        this.details = details;
        //更新全部字段
        notifyChange();
    }

    public float getPrice() {
        return price;
    }

    public void setPrice(float price) {
        this.price = price;
    }

    @Override
    public String toString() {
        return "Goods{" +
                "name='" + name + '\'' +
                ", details='" + details + '\'' +
                ", price=" + price +
                '}';
    }

}
复制代码

在 setName() 方法中更新的只是本字段，而 setDetails() 方法中更新的是全部字段

添加两个按钮用于改变 goods 变量的三个属性值，由此能够看出两个 notify 方法的区别。当中涉及的按钮点击事件绑定，在下面也会讲到

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <import type="leavesc.hello.databindingsamples.model.Goods" />

        <import type="leavesc.hello.databindingsamples.Main3Activity.GoodsHandler" />

        <variable name="goods" type="Goods" />

        <variable name="goodsHandler" type="GoodsHandler" />

    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical" android:padding="20dp">

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{goods.name}" />

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{goods.details}" />

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{String.valueOf(goods.price)}" />

        <Button android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="@{()->goodsHandler.changeGoodsName()}" android:text="改变属性 name 和 price" android:textAllCaps="false" />

        <Button android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="@{()->goodsHandler.changeGoodsDetails()}" android:text="改变属性 details 和 price" android:textAllCaps="false" />

    </LinearLayout>
</layout>
复制代码

/** * 做者：leavesC * 时间：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.com/u/9df45b87cfdf */
public class Main3Activity extends AppCompatActivity {

    private static final String TAG = "Main3Activity";

    private Goods goods;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMain3Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main3);
        goods = new Goods("code", "hi", 24);
        binding.setGoods(goods);
        binding.setGoodsHandler(new GoodsHandler());
    }

    public class GoodsHandler {

        public void changeGoodsName() {
            goods.setName("code" + new Random().nextInt(100));
            goods.setPrice(new Random().nextInt(100));
        }

        public void changeGoodsDetails() {
            goods.setDetails("hi" + new Random().nextInt(100));
            goods.setPrice(new Random().nextInt(100));
        }

    }

}

复制代码

能够看到，name 视图的刷新没有同时刷新 price 视图，而 details 视图刷新的同时也刷新了 price 视图

实现了 Observable 接口的类容许注册一个监听器，当可观察对象的属性更改时就会通知这个监听器，此时就须要用到 OnPropertyChangedCallback

当中 propertyId 就用于标识特定的字段

goods.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
            @Override
            public void onPropertyChanged(Observable sender, int propertyId) {
                if (propertyId == com.leavesc.databinding_demo.BR.name) {
                    Log.e(TAG, "BR.name");
                } else if (propertyId == com.leavesc.databinding_demo.BR.details) {
                    Log.e(TAG, "BR.details");
                } else if (propertyId == com.leavesc.databinding_demo.BR._all) {
                    Log.e(TAG, "BR._all");
                } else {
                    Log.e(TAG, "未知");
                }
            }
        });
复制代码

2.二、ObservableField

继承于 Observable 类相对来讲限制有点高，且也须要进行 notify 操做，所以为了简单起见能够选择使用 ObservableField。ObservableField 能够理解为官方对 BaseObservable 中字段的注解和刷新等操做的封装，官方原生提供了对基本数据类型的封装，例如 ObservableBoolean、ObservableByte、ObservableChar、ObservableShort、ObservableInt、ObservableLong、ObservableFloat、ObservableDouble 以及 ObservableParcelable ，也可经过 ObservableField 泛型来申明其余类型

/** * 做者：leavesC * 时间：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.com/u/9df45b87cfdf */
public class ObservableGoods {

    private ObservableField<String> name;

    private ObservableField<String> details;

    private ObservableFloat price;

    public ObservableGoods(String name, String details, float price) {
        this.name = new ObservableField<>(name);
        this.details = new ObservableField<>(details);
        this.price = new ObservableFloat(price);
    }

    ···

}
复制代码

对 ObservableGoods 属性值的改变都会当即触发 UI 刷新，概念上与 Observable 区别不大，具体效果可看下面提供的源代码，这里再也不赘述

2.三、ObservableCollection

DataBinding 也提供了包装类用于替代原生的 List 和 Map，分别是 ObservableList 和 ObservableMap,当其包含的数据发生变化时，绑定的视图也会随之进行刷新

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <import type="android.databinding.ObservableList" />

        <import type="android.databinding.ObservableMap" />

        <variable name="list" type="ObservableList&lt;String&gt;" />

        <variable name="map" type="ObservableMap&lt;String,String&gt;" />

        <variable name="index" type="int" />

        <variable name="key" type="String" />

    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical">

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:padding="20dp" android:text="@{list[index]}" />

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="20dp" android:padding="20dp" android:text="@{map[key]}" />

        <Button android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="onClick" android:text="改变数据" />

    </LinearLayout>
</layout>
复制代码

private ObservableMap<String, String> map;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMain5Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main5);
        map = new ObservableArrayMap<>();
        map.put("name", "leavesC");
        map.put("age", "24");
        binding.setMap(map);
        ObservableList<String> list = new ObservableArrayList<>();
        list.add("Ye");
        list.add("leavesC");
        binding.setList(list);
        binding.setIndex(0);
        binding.setKey("name");
    }

    public void onClick(View view) {
        map.put("name", "leavesC,hi" + new Random().nextInt(100));
    }
复制代码

3、双向数据绑定

双向绑定的意思即为当数据改变时同时使视图刷新，而视图改变时也能够同时改变数据

看如下例子，当 EditText 的输入内容改变时，会同时同步到变量 goods,绑定变量的方式比单向绑定多了一个等号：android:text="@={goods.name}"

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    
    <data>
        <import type="leavesc.hello.databindingsamples.model.ObservableGoods" />
        <variable name="goods" type="ObservableGoods" />
    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:layout_margin="20dp" android:orientation="vertical">

        <TextView style="@style/titleTextStyle" android:layout_marginTop="10dp" android:text="双向数据绑定" />

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{goods.name}" />

        <EditText android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@={goods.name}" />

    </LinearLayout>

</layout>
复制代码

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMain2Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main2);
        ObservableGoods goods = new ObservableGoods("code", "hi", 23);
        binding.setGoods(goods);
    }
复制代码

4、事件绑定

严格意义上来讲，事件绑定也是一种变量绑定，只不过设置的变量是回调接口而已事件绑定可用于如下多种回调事件

android:onClick
android:onLongClick
android:afterTextChanged
android:onTextChanged
...

在 Activity 内部新建一个 UserPresenter 类来声明 onClick() 和 afterTextChanged() 事件相应的回调方法

public class UserPresenter {

        public void onUserNameClick(User user) {
            Toast.makeText(Main6Activity.this, "用户名：" + user.getName(), Toast.LENGTH_SHORT).show();
        }

        public void afterTextChanged(Editable s) {
            user.setName(s.toString());
            binding.setUserInfo(user);
        }

        public void afterUserPasswordChanged(Editable s) {
            user.setPassword(s.toString());
            binding.setUserInfo(user);
        }

    }
复制代码

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <import type="leavesc.hello.databindingsamples.Main6Activity.UserPresenter" />

        <import type="leavesc.hello.databindingsamples.StringUtils" />

        <variable name="userInfo" type="User" />

        <variable name="userPresenter" type="UserPresenter" />
    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:layout_margin="20dp" android:orientation="vertical">

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="@{()->userPresenter.onUserNameClick(userInfo)}" android:text="@{StringUtils.toUpperCase(userInfo.name)}" />

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{userInfo.password}" />

        <EditText android:layout_width="match_parent" android:layout_height="wrap_content" android:afterTextChanged="@{userPresenter.afterTextChanged}" android:hint="用户名" />

        <EditText android:layout_width="match_parent" android:layout_height="wrap_content" android:afterTextChanged="@{userPresenter.afterUserPasswordChanged}" android:hint="密码" />

    </LinearLayout>

</layout>
复制代码

方法引用的方式与调用函数的方式相似，既能够选择保持事件回调方法的签名一致：@{userPresenter.afterTextChanged}，此时方法名能够不同，但方法参数和返回值必须和原始的回调函数保持一致。也能够引用不遵循默认签名的函数：@{()->userPresenter.onUserNameClick(userInfo)}，这里用到了 Lambda 表达式，这样就能够不遵循默认的方法签名，将userInfo对象直接传回点击方法中。此外，也可使用方法引用 :: 的形式来进行事件绑定

5、使用类方法

首先定义一个静态方法

public class StringUtils {

    public static String toUpperCase(String str) {
        return str.toUpperCase();
    }

}
复制代码

在 data 标签中导入该工具类

<import type="leavesc.hello.databindingsamples.StringUtils" />
复制代码

而后就能够像对待通常的函数同样来调用了

<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="@{()->userPresenter.onUserNameClick(userInfo)}" android:text="@{StringUtils.toUpperCase(userInfo.name)}" />
复制代码

6、运算符

6.一、基础运算符

DataBinding 支持在布局文件中使用如下运算符、表达式和关键字

算术 + - / * %
字符串合并 +
逻辑 && ||
二元 & | ^
一元 + - ! ~
移位 >> >>> <<
比较 == > < >= <=
Instanceof
Grouping ()
character, String, numeric, null
Cast
方法调用
Field 访问
Array 访问 []
三元 ?:

目前不支持如下操做

this
super
new
显示泛型调用

此外，DataBinding 还支持如下几种形式的调用

6.二、Null Coalescing

空合并运算符 ?? 会取第一个不为 null 的值做为返回值

<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@{user.name ?? user.password}" />
复制代码

等价于

android:text="@{user.name != null ? user.name : user.password}"
复制代码

6.三、属性控制

能够经过变量值来控制 View 的属性

<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="可见性变化" android:visibility="@{user.male ? View.VISIBLE : View.GONE}" />
复制代码

6.四、避免空指针异常

DataBinding 也会自动帮助咱们避免空指针异常例如，若是 "@{userInfo.password}" 中 userInfo 为 null 的话，userInfo.password 会被赋值为默认值 null，而不会抛出空指针异常

7、include 和 viewStub

7.一、include

对于 include 的布局文件，同样是支持经过 dataBinding 来进行数据绑定，此时同样须要在待 include 的布局中依然使用 layout 标签，声明须要使用到的变量

view_include.xml

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <variable name="userInfo" type="User" />
    </data>

    <android.support.constraint.ConstraintLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:background="#acc">

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:gravity="center" android:padding="20dp" android:text="@{userInfo.name}" />

    </android.support.constraint.ConstraintLayout>
</layout>
复制代码

在主布局文件中将相应的变量传递给 include 布局，从而使两个布局文件之间共享同一个变量

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:bind="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools">

    <data>
     	<import type="leavesc.hello.databindingsamples.model.User" />
        <variable name="userInfo" type="User" />
    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical">
        
        <include layout="@layout/view_include" bind:userInfo="@{userInfo}" />
        
    </LinearLayout>
</layout>
复制代码

7.二、viewStub

dataBinding 同样支持 ViewStub 布局

在布局文件中引用 viewStub 布局

<ViewStub android:id="@+id/view_stub" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout="@layout/view_stub"/>
复制代码

获取到 ViewStub 对象，由此就能够来控制 ViewStub 的可见性

ActivityMain7Binding binding = DataBindingUtil.setContentView(this, R.layout.activity_main7);
	View view = binding.viewStub.getViewStub().inflate();
复制代码

若是须要为 ViewStub 绑定变量值，则 ViewStub 文件同样要使用 layout 标签进行布局，主布局文件使用自定义的 bind 命名空间将变量传递给 ViewStub

<ViewStub android:id="@+id/view_stub" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout="@layout/view_stub" bind:userInfo="@{userInfo}" />
复制代码

若是在 xml 中没有使用 bind:userInfo="@{userInf}"对 ViewStub 进行数据绑定，则能够等到当 ViewStub Inflate 时再绑定变量，此时须要为 ViewStub 设置 setOnInflateListener回调函数，在回调函数中进行数据绑定

binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
            @Override
            public void onInflate(ViewStub stub, View inflated) {
                //若是在 xml 中没有使用 bind:userInfo="@{userInf}" 对 viewStub 进行数据绑定
                //那么能够在此处进行手动绑定
                ViewStubBinding viewStubBinding = DataBindingUtil.bind(inflated);
                viewStubBinding.setUserInfo(user);
                Log.e(TAG, "onInflate");
            }
        });
复制代码

8、BindingAdapter

dataBinding 提供了 BindingAdapter 这个注解用于支持自定义属性，或者是修改原有属性。注解值能够是已有的 xml 属性，例如 android:src、android:text等，也能够自定义属性而后在 xml 中使用

例如，对于一个 ImageView ，咱们但愿在某个变量值发生变化时，能够动态改变显示的图片，此时就能够经过 BindingAdapter 来实现

须要先定义一个静态方法，为之添加 BindingAdapter 注解，注解值是为 ImageView 控件自定义的属性名，而该静态方法的两个参数能够这样来理解：当 ImageView 控件的 url 属性值发生变化时，dataBinding 就会将 ImageView 实例以及新的 url 值传递给 loadImage() 方法，从而能够在此动态改变 ImageView 的相关属性

@BindingAdapter({"url"})
    public static void loadImage(ImageView view, String url) {
        Log.e(TAG, "loadImage url : " + url);
    }
复制代码

在 xml 文件中关联变量值，当中，bind 这个名称能够自定义

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:bind="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools">

    <data>
        <import type="leavesc.hello.databindingsamples.model.Image" />
        <variable name="image" type="Image" />
    </data>

    <android.support.constraint.ConstraintLayout android:layout_width="match_parent" android:layout_height="match_parent">

        <ImageView android:id="@+id/image" android:layout_width="wrap_content" android:layout_height="wrap_content" android:src="@drawable/ic_launcher_background" bind:url="@{image.url}" />
        
    </android.support.constraint.ConstraintLayout>
</layout>
复制代码

BindingAdapter 更为强大的一点是能够覆盖 Android 原先的控件属性。例如，能够设定每个 Button 的文本都要加上后缀：“-Button”

@BindingAdapter("android:text")
    public static void setText(Button view, String text) {
        view.setText(text + "-Button");
    }
复制代码

<Button android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="@{()->handler.onClick(image)}" android:text='@{"改变图片Url"}'/>
复制代码

这样，整个工程中使用到了 "android:text" 这个属性的控件，其显示的文本就会多出一个后缀

9、BindingConversion

dataBinding 还支持对数据进行转换，或者进行类型转换

与 BindingAdapter 相似，如下方法会将布局文件中全部以@{String}方式引用到的String类型变量加上后缀-conversionString

@BindingConversion
    public static String conversionString(String text) {
        return text + "-conversionString";
    }
复制代码

xml 文件

<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text='@{"xxx"}' android:textAllCaps="false"/>
复制代码

能够看到，对于 Button 来讲，BindingAdapter 和 BindingConversion 同时生效了，而 BindingConversion 的优先级要高些

此外，BindingConversion 也能够用于转换属性值的类型

看如下布局，此处在向 background 和 textColor 两个属性赋值时，直接就使用了字符串，按正常状况来讲这天然是会报错的，但有了 BindingConversion 后就能够自动将字符串类型的值转为须要的 Drawable 和 Color 了

<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:background='@{"红色"}' android:padding="20dp" android:text="红色背景蓝色字" android:textColor='@{"蓝色"}'/>

        <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="20dp" android:background='@{"蓝色"}' android:padding="20dp" android:text="蓝色背景红色字" android:textColor='@{"红色"}'/>
复制代码

@BindingConversion
    public static Drawable convertStringToDrawable(String str) {
        if (str.equals("红色")) {
            return new ColorDrawable(Color.parseColor("#FF4081"));
        }
        if (str.equals("蓝色")) {
            return new ColorDrawable(Color.parseColor("#3F51B5"));
        }
        return new ColorDrawable(Color.parseColor("#344567"));
    }

    @BindingConversion
    public static int convertStringToColor(String str) {
        if (str.equals("红色")) {
            return Color.parseColor("#FF4081");
        }
        if (str.equals("蓝色")) {
            return Color.parseColor("#3F51B5");
        }
        return Color.parseColor("#344567");
    }
复制代码

10、Array、List、Set、Map ...

dataBinding 也支持在布局文件中使用 数组、Lsit、Set 和 Map，且在布局文件中均可以经过 list[index] 的形式来获取元素

而为了和 variable 标签的尖括号区分开，在声明 Lsit 之类的数据类型时，须要使用尖括号的转义字符

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools">

    <data>
        <import type="java.util.List" />
        <import type="java.util.Map" />
        <import type="java.util.Set" />
        <import type="android.util.SparseArray" />
        <variable name="array" type="String[]" />
        <variable name="list" type="List&lt;String&gt;" />
        <variable name="map" type="Map&lt;String, String&gt;" />
        <variable name="set" type="Set&lt;String&gt;" />
        <variable name="sparse" type="SparseArray&lt;String&gt;" />
        <variable name="index" type="int" />
        <variable name="key" type="String" />
    </data>

    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical" tools:context=".Main7Activity">

        <TextView ··· android:text="@{array[1]}" />
        <TextView ··· android:text="@{sparse[index]}" />
        <TextView ··· android:text="@{list[index]}" />
        <TextView ··· android:text="@{map[key]}" />
        <TextView ··· android:text='@{map["leavesC"]}' />
        <TextView ··· android:text='@{set.contains("xxx")?"xxx":key}' />
    </LinearLayout>
</layout>
复制代码

11、资源引用

dataBinding 支持对尺寸和字符串这类资源的访问

dimens.xml

<dimen name="paddingBig">190dp</dimen>
    <dimen name="paddingSmall">150dp</dimen>
复制代码

strings.xml

<string name="format">%s is %s</string>
复制代码

<data>
        <variable name="flag" type="boolean" />
    </data>       
	<Button android:layout_width="match_parent" android:layout_height="wrap_content" android:paddingLeft="@{flag ? @dimen/paddingBig:@dimen/paddingSmall}" android:text='@{@string/format("leavesC", "Ye")}' android:textAllCaps="false" />
复制代码

12、与 RecyclerView 搭配使用

dataBinding 与 RecyclerView 搭配使用的话可让代码更加简洁明了

先声明须要的 item 布局文件

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

        <import type="leavesc.hello.databindingsamples.model.User" />

        <variable
            name="user"
            type="User" />

    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical"
        android:paddingLeft="10dp">

        <TextView
            android:id="@+id/tvName"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="8dp"
            android:text="@{user.name}" />

        <TextView
            android:id="@+id/tvPassword"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="8dp"
            android:text="@{user.password}" />

        <View
            android:layout_width="match_parent"
            android:layout_height="1dp"
            android:background="#c6cdd4" />

    </LinearLayout>

</layout>
复制代码

对应的 RecyclerView.Adapter

/** * 做者：leavesC * 时间：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.com/u/9df45b87cfdf */
public class UserAdapter extends RecyclerView.Adapter<UserAdapter.UserAdapterHolder> {

    private List<User> userList;

    public UserAdapter(List<User> userList) {
        this.userList = userList;
    }

    @NonNull
    @Override
    public UserAdapterHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        ItemUserBinding binding = DataBindingUtil.inflate(LayoutInflater.from(parent.getContext()), R.layout.item_user, parent, false);
        return new UserAdapterHolder(binding);
    }

    @Override
    public void onBindViewHolder(@NonNull UserAdapterHolder holder, int position) {
        holder.getBinding().setUser(userList.get(position));
    }

    @Override
    public int getItemCount() {
        if (userList == null) {
            return 0;
        }
        return userList.size();
    }

    class UserAdapterHolder extends RecyclerView.ViewHolder {

        private ItemUserBinding binding;

        UserAdapterHolder(ItemUserBinding binding) {
            super(binding.getRoot());
            this.binding = binding;
        }

        public ItemUserBinding getBinding() {
            return binding;
        }
    }

}

复制代码

十3、RecyclerView Adapter 高效率刷新

前文讲到了 ObservableList ，此处就能够经过 ObservableList 的实现类 ObservableArrayList 来实现 RecyclerView Adapter 的高效刷新，而不是每次都是直接 notifyDataSetChanged

能够先看下 ObservableArrayList 的源码，能够发如今每次增删改数据时，都会触发到 ListChangeRegistry 内的 OnListChangedCallback 回调，且 OnListChangedCallback 是把每次改动到的数据位置都给透传到外部，咱们能够经过这些信息来只刷新 Adapter 的特定位置，从而实现高效刷新，而且得到一些动画效果

public class ObservableArrayList<T> extends ArrayList<T> implements ObservableList<T> {
   
    private transient ListChangeRegistry mListeners = new ListChangeRegistry();

   	···

    @Override
    public boolean add(T object) {
        super.add(object);
        notifyAdd(size() - 1, 1);
        return true;
    }
    
    @Override
    public void clear() {
        int oldSize = size();
        super.clear();
        if (oldSize != 0) {
            notifyRemove(0, oldSize);
        }
    }

    @Override
    public T remove(int index) {
        T val = super.remove(index);
        notifyRemove(index, 1);
        return val;
    }

    @Override
    public T set(int index, T object) {
        T val = super.set(index, object);
        if (mListeners != null) {
            mListeners.notifyChanged(this, index, 1);
        }
        return val;
    }

    private void notifyAdd(int start, int count) {
        if (mListeners != null) {
            mListeners.notifyInserted(this, start, count);
        }
    }

    private void notifyRemove(int start, int count) {
        if (mListeners != null) {
            mListeners.notifyRemoved(this, start, count);
        }
    }
    
    ···
    
}

复制代码

此处经过 DynamicChangeCallback 来实现对 Adapter 的刷新操做

/** * 做者：leavesC * 时间：2019/2/27 21:36 * 描述： * GitHub：https://github.com/leavesC * Blog：https://www.jianshu.com/u/9df45b87cfdf */
public class DynamicChangeCallback<T> extends ObservableList.OnListChangedCallback<ObservableList<T>> {

    private RecyclerView.Adapter adapter;

    public DynamicChangeCallback(RecyclerView.Adapter adapter) {
        this.adapter = adapter;
    }

    @Override
    public void onChanged(ObservableList<T> sender) {
        adapter.notifyDataSetChanged();
    }

    @Override
    public void onItemRangeChanged(ObservableList<T> sender, int positionStart, int itemCount) {
        adapter.notifyItemRangeChanged(positionStart, itemCount);
    }

    @Override
    public void onItemRangeInserted(ObservableList<T> sender, int positionStart, int itemCount) {
        adapter.notifyItemRangeInserted(positionStart, itemCount);
    }

    @Override
    public void onItemRangeMoved(ObservableList<T> sender, int fromPosition, int toPosition, int itemCount) {
        adapter.notifyItemRangeRemoved(fromPosition, itemCount);
        adapter.notifyItemRangeInserted(toPosition, itemCount);
    }

    @Override
    public void onItemRangeRemoved(ObservableList<T> sender, int positionStart, int itemCount) {
        adapter.notifyItemRangeRemoved(positionStart, itemCount);
    }

}
复制代码

经过几个按钮来分别测试 Adapter 的数据刷新状况

public class Main13Activity extends AppCompatActivity {

    private ObservableArrayList<User> userObservableArrayList;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main13);
        RecyclerView rvList = findViewById(R.id.rvList);
        rvList.setLayoutManager(new LinearLayoutManager(this));
        initData();
        UserAdapter userAdapter = new UserAdapter(userObservableArrayList);
        userAdapter.notifyDataSetChanged();
        userObservableArrayList.addOnListChangedCallback(new DynamicChangeCallback(userAdapter));
        rvList.setAdapter(userAdapter);
    }

    private void initData() {
        userObservableArrayList = new ObservableArrayList<>();
        for (int i = 0; i < 20; i++) {
            User user = new User("user_" + i, String.valueOf(new Random().nextInt() * 4));
            userObservableArrayList.add(user);
        }
    }

    public void addItem(View view) {
        if (userObservableArrayList.size() >= 3) {
            User user = new User("user_" + 100, String.valueOf(new Random().nextInt() * 4));
            userObservableArrayList.add(1, user);
        }
    }

    public void addItemList(View view) {
        if (userObservableArrayList.size() >= 3) {
            List<User> userList = new ArrayList<>();
            for (int i = 0; i < 3; i++) {
                User user = new User("user_" + 100, String.valueOf(new Random().nextInt() * 4));
                userList.add(user);
            }
            userObservableArrayList.addAll(1, userList);
        }
    }

    public void removeItem(View view) {
        if (userObservableArrayList.size() >= 3) {
            userObservableArrayList.remove(1);
        }
    }

    public void updateItem(View view) {
        if (userObservableArrayList.size() >= 3) {
            User user = userObservableArrayList.get(1);
            user.setName("user_" + new Random().nextInt());
            userObservableArrayList.set(1, user);
        }
    }

}
复制代码