Android Databinding 详解

最新推荐文章于 2024-06-22 10:18:30 发布

lishutong1006

最新推荐文章于 2024-06-22 10:18:30 发布

阅读量2.2w

点赞数 9

分类专栏： Android DataBinding 文章标签： android

本文链接：https://blog.csdn.net/lixiong0713/article/details/109051409

版权

Android DataBinding 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

DataBinding 是Google官方发布的一个框架，用来进行数据绑定。DataBinding 能够省去我们一直以来的 findViewById() 步骤，大量减少 Activity / Fragment 内的代码，数据能够单向或双向绑定到 layout 文件中，有助于防止内存泄漏，而且能自动进行空检测以避免空指针异常。

使用DataBinding 的方法是在对应的 Module 的 build.gradle 文件里加入如下代码，同步之后就可以引入对DataBinding的支持。

android {
    dataBinding {
        enabled = true
    }
}

一、基础入门

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

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

在这里插入图片描述

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

首先我们声明一个Model，代码如下所示：

/**
 * create by lx
 * date 2020/10/12.
 * description：
 */
public class User {
    private String name;
    private String password;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
}

在布局文件的data标签里声明需要使用到的变量名、类的全路径，代码如下所示：

    <data>
        <variable
            name="userInfo"
            type="com.lx.databinding.model.User" />
    </data>

如果User类型要多出用到，也可以直接将它 import 进来，这样就不用每次都指明整个包路径了，而 java.lang.* 包中的类会被自动导入，所以可以直接使用，import 方式的代码如下所示：

    <data>
        <import type="com.lx.databinding.model.User"/>
        <variable
            name="userInfo"
            type="User" />
    </data>

如果存在 import 的类名相同的情况，可以使用 alias 指定别名

    <data>
        <import type="com.lx.databinding.model.User" />
        <import
            alias="TempUser"
            type="com.lx.databinding.model_2.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"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    <data>
        <import type="com.lx.databinding.model.User" />
        <variable
            name="userInfo"
            type="User" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity">
        <TextView
            android:id="@+id/tv_username"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{userInfo.name}" />
        <TextView
            android:id="@+id/tv_password"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{userInfo.password}" />
    </LinearLayout>
</layout>

通过 @{userInfo.name} 使 TextView 引用到相关的变量，DataBinding 会将之映射到相应的 getter 方法，然后可以在 Activity 中通过 DataBindingUtil 设置布局文件，省略原先 Activity 的 setContentView() 方法，并为变量 userInfo 赋值， MainActivity 的代码如下所示：

public class MainActivity extends AppCompatActivity {
    private User user;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMainBinding mainBinding = DataBindingUtil.setContentView(this, R.layout.activity_main);
        user = new User();
        user.setName("lx");
        user.setPassword("123456");
        mainBinding.setUserInfo(user);
    }
}

运行结果如下所示：

在这里插入图片描述

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

    android:text="@{userInfo.name,default=defaultValue}"

此外，也可以通过 ActivityMain2Binding 直接获取到指定 ID 的控件，代码如下所示：

	mainBinding.tvUsername.setText("test");

每个数据绑定布局文件都会生成一个绑定类，ViewDataBinding 的实例名是根据布局文件名来生成，将布局文件名改为首字母大写的驼峰命名法来命名并且去掉下划线(’_’)。控件的获取方式类似，但首字母小写。

也可以通过如下方式自定义 ViewDataBinding 的实例名

    <data class="CustomBinding">
    </data>

Databinding 同样是支持在 Fragment 和 RecyclerView 中使用。例如，可以看 Databinding 在 Fragment 中的使用，代码如下所示:

blank_fragment.xml

<?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>
        <variable
            name="hint"
            type="String" />
    </data>
    <FrameLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".BlankFragment">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:text="@{hint,default=defaultValue}" />
    </FrameLayout>
</layout>

BlankFragment.java

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

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

二、单向数据绑定

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

1. BaseObservable

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

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

/**
 * create by lx
 * date 2020/10/12.
 * description：
 */
public class Person extends BaseObservable {
    // 如果是 public 修饰符，则可以直接在成员变量上加上 @Bindable 注解
    @Bindable
    public String name;
    // 如果是 private 修饰符，则在成员变量的 get 方法上添加 @Bindable 注解
    private String address;
    private int age;
    public Person(String name, String address, int age) {
        this.name = name;
        this.address = address;
        this.age = age;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
        // 只更新本字段
        notifyPropertyChanged(BR.name);
    }
    @Bindable
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
        // 更新所有字段
        notifyChange();
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

在 setName() 方法中更新的只是本字段，而 setAddress() 方法中更新的是所有字段。

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

<?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>
        <import type="com.lx.databinding.model.Person" />
        <import type="com.lx.databinding.MainActivity2.PersonHandler" />
        <variable
            name="person"
            type="Person" />
        <variable
            name="personHandler"
            type="PersonHandler" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity2">
        <TextView
            android:id="@+id/tv_name"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{person.name}" />
        <TextView
            android:id="@+id/tv_address"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{person.address}" />
        <TextView
            android:id="@+id/tv_age"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{String.valueOf(person.age)}" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->personHandler.changePersonName()}"
            android:text="改变属性 name 和 age"
            android:textAllCaps="false" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->personHandler.changePersonAddress()}"
            android:text="改变属性 address 和 age"
            android:textAllCaps="false" />
    </LinearLayout>
</layout>

public class MainActivity2 extends AppCompatActivity {
    private Person person;
    private ActivityMain2Binding main2Binding;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main2Binding = DataBindingUtil.setContentView(this, R.layout.activity_main2);
        person = new Person("lx", "武汉", 23);
        main2Binding.setPerson(person);
        main2Binding.setPersonHandler(new PersonHandler());
    }
    public class PersonHandler {
        public void changePersonName() {
            person.setName("lx" + new Random().nextInt(100));
            person.setAge(new Random().nextInt(100));
        }
        public void changePersonAddress() {
            person.setAddress("北京：" + new Random().nextInt(100));
            person.setAge(new Random().nextInt(100));
        }
    }
}

运行结果如下：

在这里插入图片描述

可以看到，name 视图的刷新没有同时刷新 age 视图，而 address 视图刷新的同时也刷新了 age 视图。

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

其中 propertyId 就用于标识特定的字段，代码如下所示：

person.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
    @Override
    public void onPropertyChanged(Observable sender, int propertyId) {
        if (propertyId == BR.name) {
            Log.e(TAG, "BR.name");
        } else if (propertyId == BR.address) {
            Log.e(TAG, "BR.address");
        } else if (propertyId == 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 泛型来申明其他类型。

/**
 * create by lx
 * date 2020/10/12.
 * description：
 */
public class ObservableFieldPerson {
    private ObservableField<String> name;
    private ObservableField<String> address;
    private ObservableInt age;
    public ObservableFieldPerson(String name, String address, int age) {
        this.name = new ObservableField<>(name);
        this.address = new ObservableField<>(address);
        this.age = new ObservableInt(age);
    }
    public ObservableField<String> getName() {
        return name;
    }
    public void setName(ObservableField<String> name) {
        this.name = name;
    }
    public ObservableField<String> getAddress() {
        return address;
    }
    public void setAddress(ObservableField<String> address) {
        this.address = address;
    }
    public ObservableInt getAge() {
        return age;
    }
    public void setAge(ObservableInt age) {
        this.age = age;
    }
}

<?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>
        <import type="com.lx.databinding.model.ObservableFieldPerson" />
        <import type="com.lx.databinding.MainActivity3.PersonHandler" />
        <variable
            name="person"
            type="ObservableFieldPerson" />
        <variable
            name="personHandler"
            type="PersonHandler" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity3">
        <TextView
            android:id="@+id/tv_name"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{person.name}" />
        <TextView
            android:id="@+id/tv_address"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{person.address}" />
        <TextView
            android:id="@+id/tv_age"
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{String.valueOf(person.age)}" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->personHandler.changePersonName()}"
            android:text="改变属性 name"
            android:textAllCaps="false" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->personHandler.changePersonAddress()}"
            android:text="改变属性 address "
            android:textAllCaps="false" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->personHandler.changePersonAge()}"
            android:text="改变属性 age "
            android:textAllCaps="false" />
    </LinearLayout>
</layout>

public class MainActivity3 extends AppCompatActivity {
    private ObservableFieldPerson person;
    private ActivityMain3Binding main3Binding;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main3Binding = DataBindingUtil.setContentView(this, R.layout.activity_main3);
        person = new ObservableFieldPerson("lx", "武汉", 23);
        main3Binding.setPerson(person);
        main3Binding.setPersonHandler(new PersonHandler());
    }

    public class PersonHandler {
        public void changePersonName() {
            person.getName().set("lx" + new Random().nextInt(100));
        }
        public void changePersonAddress() {
            person.getAddress().set("北京：" + new Random().nextInt(100));
        }
        public void changePersonAge() {
            person.getAge().set(new Random().nextInt(100));
        }
    }
}

对 ObservableFieldPerson 属性值的改变都会立即触发 UI 刷新，概念上与 Observable 区别不大，具体效果同学们可以自己复制代码运行测试，这里不再赘述。

3. ObservableCollection

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

<?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="androidx.databinding.ObservableList" />
        <import type="androidx.databinding.ObservableMap" />
        <import type="com.lx.databinding.MainActivity4.CollectionHandler" />
        <variable
            name="list"
            type="ObservableList&lt;String&gt;" />
        <variable
            name="map"
            type="ObservableMap&lt;String,String&gt;" />
        <variable
            name="collectionHandler"
            type="CollectionHandler" />
        <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=".MainActivity4">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{list[index]}" />
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{map[key]}" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->collectionHandler.changeList()}"
            android:text="改变list"
            android:textAllCaps="false" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{()->collectionHandler.changeMap()}"
            android:text="改变map"
            android:textAllCaps="false" />
    </LinearLayout>
</layout>

public class MainActivity4 extends AppCompatActivity {
    private ObservableList<String> list;
    private ObservableMap<String, String> map;
    private ActivityMain4Binding main4Binding;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main4Binding = DataBindingUtil.setContentView(this, R.layout.activity_main4);
        list = new ObservableArrayList<>();
        list.add("databinding");
        main4Binding.setList(list);
        map = new ObservableArrayMap<>();
        map.put("name", "lx");
        map.put("age", "23");
        main4Binding.setMap(map);
        main4Binding.setIndex(0);
        main4Binding.setKey("name");
        main4Binding.setCollectionHandler(new CollectionHandler());
    }
    public class CollectionHandler {
        public void changeList() {
            list.set(0, "databinding " + new Random().nextInt(100));
        }
        public void changeMap() {
            map.put("name", "lx " + new Random().nextInt(100));
        }
    }
}

运行结果如下图所示：

在这里插入图片描述

三、双向数据绑定

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

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

<?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="com.lx.databinding.model.ObservableFieldPerson" />
        <variable
            name="person"
            type="ObservableFieldPerson" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity5">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{person.name}" />
        <EditText
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@={person.name}" />
    </LinearLayout>
</layout>

public class MainActivity5 extends AppCompatActivity {
    private ActivityMain5Binding main5Binding;
    private ObservableFieldPerson person;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main5Binding = DataBindingUtil.setContentView(this, R.layout.activity_main5);
        person = new ObservableFieldPerson("lx", "北京", 23);
        main5Binding.setPerson(person);
    }
}

运行结果如下图所示：
在这里插入图片描述

四、事件绑定

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

android:onClick
android:onLongClick
android:afterTextChanged
android:onTextChanged
…

在 Activity 内部新建一个 UserPresenter 类来声明 onClick() 和 afterTextChanged() 事件相应的回调方法，代码如下所示：

<?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="com.lx.databinding.model.User" />
        <import type="com.lx.databinding.MainActivity6.UserPresenter" />
        <variable
            name="user"
            type="User" />
        <variable
            name="userPresenter"
            type="UserPresenter" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity6">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:onClick="@{()->userPresenter.onUserNameClick(user)}"
            android:text="@{user.name}" />
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{user.password}" />
        <EditText
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:hint="用户名"
            android:afterTextChanged="@{userPresenter.afterTextChanged}"
            android:paddingLeft="5dp" />
        <EditText
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:afterTextChanged="@{userPresenter.afterTestPasswordChanged}"
            android:hint="密码"
            android:paddingLeft="5dp" />
    </LinearLayout>
</layout>

public class MainActivity6 extends AppCompatActivity {
    private ActivityMain6Binding main6Binding;
    private User user;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main6Binding = DataBindingUtil.setContentView(this, R.layout.activity_main6);
        user = new User();
        user.setName("lx");
        user.setPassword("123456");
        main6Binding.setUser(user);
        main6Binding.setUserPresenter(new UserPresenter());
    }
    public class UserPresenter {
        public void onUserNameClick(User user) {
            Toast.makeText(MainActivity6.this, "用户名：" + user.getName(), Toast.LENGTH_SHORT).show();
        }
        public void afterTextChanged(Editable s) {
            user.setName(s.toString());
            main6Binding.setUser(user);
        }
        public void afterTestPasswordChanged(Editable s) {
            user.setPassword(s.toString());
            main6Binding.setUser(user);
        }
    }
}

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

运行结果如下图所示：

在这里插入图片描述

五、使用类方法

首先定义一个StringUtils工具类，然后在这个工具类中定义一个静态方法，代码如下所示：

public class StringUtils {
    public static String addHead(String str) {
        return "head:" + str;
    }
}

在布局文件的 data 标签中导入该工具类，代码如下所示：

<import type="com.lx.databinding.utils.StringUtils" />

然后就可以像对待一般的方法一样来调用了，代码如下所示：

<TextView
    android:layout_width="match_parent"
    android:layout_height="40dp"
    android:background="@color/colorAccent"
    android:gravity="center_vertical"
    android:onClick="@{()->userPresenter.onUserNameClick(user)}"
    android:paddingLeft="5dp"
    android:text="@{StringUtils.addHead(user.name)}" />

六、运算符

1. 基础运算符

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

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

目前不支持以下操作

this
super
new
显示泛型调用

2. Null Coalescing

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

     android:text="@{user.name ?? user.password}" />

等价于

    android:text="@{user.name != null ? user.name : user.password}"

3. 属性控制

可以通过变量值来控制 View 的属性

 <TextView
     android:layout_width="match_parent"
     android:layout_height="wrap_content"
     android:text="可见性变化"
     android:visibility="@{visible ? View.VISIBLE : View.GONE}" />

4. 避免空指针异常

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

七、include 和 viewStub

1. 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="com.lx.databinding.model.User" />
        <variable
            name="user"
            type="User" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{user.name}" />
    </LinearLayout>
</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="com.lx.databinding.model.User" />
        <variable
            name="user"
            type="User" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity7">
        <include
            layout="@layout/view_include"
            bind:user="@{user}" />
    </LinearLayout>
</layout>

public class MainActivity7 extends AppCompatActivity {
    private ActivityMain7Binding main7Binding;
    private User user;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main7Binding = DataBindingUtil.setContentView(this,R.layout.activity_main7);
        user = new User();
        user.setName("lx");
        user.setPassword("123456");
        main7Binding.setUser(user);
    }
}

2. viewStub

dataBinding 一样支持 ViewStub 布局。

view_stub.xml

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <import type="com.lx.databinding.model.User" />
        <variable
            name="user"
            type="User" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{user.password,default=defaultValue}" />
    </LinearLayout>
</layout>

在布局文件中引用 viewStub 布局，然后通过点击按钮显示这个ViewStub。

<ViewStub
    android:id="@+id/view_stub"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_marginTop="10dp"
    android:layout="@layout/view_stub" />

<Button
    android:id="@+id/btn_show"
    android:layout_width="match_parent"
    android:layout_height="40dp"
    android:onClick="@{click::onClick}"
    android:text="显示ViewStub" />

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

ActivityMain7Binding main7Binding = DataBindingUtil.setContentView(this, R.layout.activity_main7);
if (!main7Binding.viewStub.isInflated()) {
    main7Binding.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_marginTop="10dp"
    android:layout="@layout/view_stub"
    bind:user="@{user}" />

如果在 xml 中没有使用 bind:user="@{user}"对 ViewStub 进行数据绑定，则可以等到当 ViewStub Inflate 完成时再绑定变量，此时需要为 ViewStub 设置 setOnInflateListener回调方法，在回调方法中进行数据绑定，代码如下所示：

main7Binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
    @Override
    public void onInflate(ViewStub stub, View inflated) {
        //如果在 xml 中没有使用 bind:user="@{user}" 对 viewStub 进行数据绑定
        //那么可以在此处进行手动绑定
        ViewStubBinding viewStubBinding = DataBindingUtil.bind(inflated);
        viewStubBinding.setUser(user);
    }
});

八、BindingAdapter

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

例如，对于一个 ImageView ，我们希望在某个变量值发生变化时，可以动态改变显示的图片，此时就可以通过 BindingAdapter 来实现。

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

<?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="com.lx.databinding.MainActivity8.ClickHandler" />
        <variable
            name="url"
            type="String" />
        <variable
            name="click"
            type="ClickHandler" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity8">
        <ImageView
            android:id="@+id/image"
            android:layout_width="300dp"
            android:layout_height="300dp"
            android:scaleType="centerCrop"
            android:src="@drawable/ic_launcher_background"
            bind:url="@{url}" />
        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:onClick="@{click::onClick}"
            android:text="改变图片的URL" />
    </LinearLayout>
</layout>

public class MainActivity8 extends AppCompatActivity {
    private ActivityMain8Binding main8Binding;
    private int index = 0;
    private static int[] urls = new int[]{R.drawable.image1, R.drawable.image2,
            R.drawable.image3, R.drawable.image4, R.drawable.image5,
            R.drawable.image6, R.drawable.image7};
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main8Binding = DataBindingUtil.setContentView(this, R.layout.activity_main8);
        main8Binding.setUrl("0");
        main8Binding.setClick(new ClickHandler());
    }
    @BindingAdapter("url")
    public static void loadImage(ImageView view, String url) {
        view.setImageResource(urls[Integer.parseInt(url)]);
    }
    public class ClickHandler {
        public void onClick(View view) {
            index++;
            if (index >= 7) {
                index = 0;
            }
            main8Binding.setUrl("" + index);
        }
    }
}

运行结果如下图所示：
在这里插入图片描述

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="40dp"
    android:text='@{"Hello World"}' />
<Button
    android:layout_width="match_parent"
    android:layout_height="40dp"
    android:onClick="@{click::onClick}"
    android:text='@{"改变图片Url"}' />

这样，整个工程中使用到了 “android:text” 这个属性的Button控件，其显示的文本就会多出一个后缀。
在这里插入图片描述

九、BindingConversion

dataBinding 还支持对数据进行转换，或者进行类型转换，与 BindingAdapter 类似，以下方法会将布局文件中所有以@{String}方式引用到的String类型变量加上后缀-conversionString。

<?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">
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity9">

        <Button
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:textAllCaps="false"
            android:text='@{"Hello World"}' />


        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center"
            android:text='@{"xxx"}'/>
    </LinearLayout>
</layout>

public class MainActivity9 extends AppCompatActivity {
    private ActivityMain9Binding main9Binding;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main9);
        main9Binding = DataBindingUtil.setContentView(this, R.layout.activity_main9);
    }

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

运行结果如下图所示：
在这里插入图片描述

可以看到，对于 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");
    }

运行结果如下图所示：
在这里插入图片描述

十、Array、List、Set、Map …

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

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

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <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 xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity8">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{array[index]}" />
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{sparse[index]}" />
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{list[index]}" />
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text="@{map[key]}" />
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:layout_marginTop="10dp"
            android:background="@color/colorAccent"
            android:gravity="center_vertical"
            android:paddingLeft="5dp"
            android:text='@{set.contains("set1")?"set1":key}' />
    </LinearLayout>
</layout>

public class MainActivity10 extends AppCompatActivity {
    private ActivityMain10Binding main10Binding;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main10Binding = DataBindingUtil.setContentView(this, R.layout.activity_main10);
        String[] array = new String[]{"hello", "world"};
        main10Binding.setArray(array);
        List<String> list = new ArrayList<>();
        list.add("list1");
        list.add("list2");
        main10Binding.setList(list);
        Map<String, String> map = new HashMap<>();
        map.put("name", "lx");
        map.put("address", "北京");
        main10Binding.setMap(map);
        Set<String> set = new HashSet<>();
        set.add("set1");
        set.add("set2");
        main10Binding.setSet(set);
        SparseArray<String> sparse = new SparseArray<>();
        sparse.put(1, "sparse1");
        sparse.put(3, "sparse2");
        main10Binding.setSparse(sparse);
        main10Binding.setIndex(1);
        main10Binding.setKey("name");
    }
}

运行结果如下图所示：
在这里插入图片描述

十一、资源引用

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

dimens.xml

<dimen name="paddingTop">10dp</dimen>
<dimen name="paddingBottom">20dp</dimen>

strings.xml

<string name="format">%s is %s</string>

<?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>
        <variable
            name="flag"
            type="boolean" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity11">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="40dp"
            android:gravity="center_vertical"
            android:background="@color/colorAccent"
            android:paddingLeft="@{flag ? @dimen/margin1:@dimen/margin2}"
            android:text='@{@string/format("lx", "菜鸟")}' />
    </LinearLayout>
</layout>

public class MainActivity11 extends AppCompatActivity {
    private ActivityMain11Binding main11Binding;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        main11Binding =  DataBindingUtil.setContentView(this,R.layout.activity_main11);
        main11Binding.setFlag(true);
    }
}

运行结果如下图所示：
在这里插入图片描述

对 DataBinding 的介绍到这里也就结束了。

lishutong1006

关注

9
点赞
踩
38

收藏

觉得还不错? 一键收藏
0
评论
Android Databinding 详解

Android Databinding 详解 DataBinding 是Google官方发布的一个框架，用来进行数据绑定。DataBinding 能够省去我们一直以来的 findViewById() 步骤，大量减少 Activity / Fragment 内的代码，数据能够单向或双向绑定到 layout 文件中，有助于防止内存泄漏，而且能自动进行空检测以避免空指针异常。使用DataBinding 的方法是在对应的 Module 的 build.gradle 文件里加入如下代码，同步之后就可以引
复制链接

扫一扫

专栏目录