Android DataBinding小结

转载： https://www.jianshu.com/p/2c4ac24761f5

一、基础入门

1.在app的build.gradle内添加

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

2.新建DataBindingActivity，并修改其布局文件

<?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>
        <variable
            name="user"
            type="com.example.myapplication.databind.User" />
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:padding="50dp"
        tools:context=".databind.DataBindingActivity">

        <TextView
            android:id="@+id/tv_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.name,default=he}"
            android:textSize="16sp"
            app:layout_constraintBottom_toTopOf="@id/tv_age"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent" />

        <TextView
            android:id="@+id/tv_age"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="10dp"
            android:text="@{user.age,default=13}"
            android:textSize="16sp"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@id/tv_name" />

        <TextView
            android:id="@+id/tv_school"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="10dp"
            android:text="@{user.school,default=beijing}"
            android:textSize="16sp"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toBottomOf="@id/tv_age" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

在原始布局前使用<layout></layout>包裹起来，其中还包含数据<data></data>。同时新建实体类User，其包含name、age、school三个属性。此时就可在布局内的控件可直接引用user实体类的数据，如android:text="@{user.school}"，同时也可以赋一默认值android:text="@{user.school,default=beijing}"（{}内也可以用三元表达式显示)。当使用格式化字符串时：

1.先定义字符串
<string name="formatStr">我是来自%1$s点击事件，现在身处%2$s今年%3$d啦</string>
2.在xml中直接使用
android:text="@{@string/formatStr(user.name,user.city,user.age)}"

需要注意的是XML中的TextView不能直接使用Integer类型，需要转化成String类型。假如user.age为int类型，在xml内可以这么表示：

android:text="@{String.valueOf(user.age)}"

当<data>内类名重复时，可以使用alias指定别名，如下所示：

<data>
        <import type="com.example.myapplication.databind.User" />
        <import
            alias="TempUser"
            type="com.example.myapplication.databind.model.User" />
        <variable
            name="userInfo"
            type="User" />
        <variable
            name="tempUserInfo"
            type="TempUser" />
    </data>

3. Activity内绑定数据

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    ActivityDataBindingBinding dataBindingBinding= DataBindingUtil.setContentView(this,R.layout.activity_data_binding);
    User user=new User("CHANG","12","HANGZHOU");
    dataBindingBinding.setUser(user);
    dataBindingBinding.tvSchool.setText("BEIJING");
}

其中忽略了原setContentview()方法；默认情况下，一个Binding类会基于layout文件的名称产生，类名一般为布局文件名+Binding,采用驼峰命名法,也可自定义命名,当采用自定义时，需在xml布局内改动

<data class="XXXXXBinding">
..........
</data>

当使用DataBingding时，此时我们可以告别findViewById()这个方法了，我们可以直接通过binding这个类直接找到布局内各控件id，如：

 dataBindingBinding.tvSchool.setText("BEIJING");

DataBinding不单单只在Activity内使用，同时也能在Fragment、RecyclerView等使用

Fragment内使用： 
    @Override
    public View onCreateView(@NonNull LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        FragmentOneBinding fragmentOneBinding = DataBindingUtil.inflate(inflater, R.layout.fragment_One, container, false);
        fragmentOneBinding.setHint("Hello");
        return fragmentOneBinding.getRoot();
    }

RecyclerView内使用：
    @NonNull
    @Override
    public TestViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        ItemTextBinding itemTextBinding = DataBindingUtil.inflate(LayoutInflater.from(parent.getContext()), R.layout.item_text, parent, false);
        return new TestViewHolder(itemTextBinding);
    }

     public static class TestViewHolder extends RecyclerView.ViewHolder {
        ItemTextBinding itemTextBinding;

        public TestViewHolder(@NonNull ItemTextBinding itemView) {
            super(itemView.getRoot());
            this.itemTextBinding = itemView;
        }

    }

以上的使用方式不便之处在于：当数据发生变化时，需要重新想ViewDataBinding传递新的变量才能刷新数据。

二.数据绑定，并自动刷新UI

DataBinding自动刷新数据的方式主要有三种：BaseObservable、ObservableField、ObservableCollection

1.BaseObservable

新建实体类并继承BaseObservable

public class User extends BaseObservable {

    private String name;
    private String age;
    public String school;

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

    @Bindable
    public String getName() {
        return name;
    }


    @Bindable
    public String getAge() {
        return age;
    }

    @Bindable
    public String getSchool() {
        return school;
    }

    public void setName(String name) {
        this.name = name;
        //更新所有字段
        notifyChange();
    }

    public void setAge(String age) {
        this.age = age;
        //只更新本字段
        notifyPropertyChanged(BR.age);
    }

    public void setSchool(String school) {
        this.school = school;
    }
}

BaseObservable 提供了 notifyChange() 和 notifyPropertyChanged() 两个方法，前者会刷新所有的值域，后者则只更新对应 BR 的 flag，该 BR 的生成通过注释 @Bindable 生成,所以在setAge()方法更新的只是本字段，而在setName()更新的是所有字段。在Activity内的更新操作为：

button.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        user.setName("CHNAHE" + (int) (1 + Math.random() * (10 - 1 + 1)));
        user.setSchool("北京" + (int) (1 + Math.random() * (10 - 1 + 1)));
    }
});

button1.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        user.setAge(String.valueOf((int) (1 + Math.random() * (10 - 1 + 1))));
        user.setSchool("北京" + (int) (1 + Math.random() * (10 - 1 + 1)));
    }
});

user.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
    @Override
    public void onPropertyChanged(Observable sender, int propertyId) {
        if (propertyId == BR.age) {
            Log.d(TAG, "onPropertyChanged: " + "更新了age");
        } else if (propertyId == BR.name) {
            Log.d(TAG, "onPropertyChanged: " + "更新了name");
        } else if (propertyId == BR.school) {
            Log.d(TAG, "onPropertyChanged: " + "更新了school");
        }
    }
});

2.ObservableField

更新方式与BaseObservable相似，其继承于 Observable 类相对来说限制有点高，且也需要进行 notify 操作，因此为了简单起见可以选择使用 ObservableField。ObservableField 可以理解为官方对 BaseObservable 中字段的注解和刷新等操作的封装，官方原生提供了对基本数据类型的封装，例如 ObservableBoolean、ObservableByte、ObservableChar、ObservableShort、ObservableInt、ObservableLong、ObservableFloat、ObservableDouble 以及 ObservableParcelable ，也可通过 ObservableField 泛型来申明其他类型。其中实体类可以如下定义：

public class ObservableUser {
    private ObservableField<String> name;
    private ObservableField<String> school;
    private ObservableField<String> city;

    public ObservableUser(String name, String school, String city) {
        this.name = new ObservableField<>(name);
        this.school = new ObservableField<>(school);
        this.city = new ObservableField<>(city);
    }

    public ObservableField<String> getName() {
        return name;
    }

    public void setName(String name) {
        this.name = new ObservableField<>(name);
    }

    public ObservableField<String> getSchool() {
        return school;
    }

    public void setSchool(String school) {
        this.school = new ObservableField<>(school);
    }

    public ObservableField<String> getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = new ObservableField<>(city);
    }
}

3.ObservableCollection

DataBinding提供了ObservableMap与ObservableList来替代原生的List与Map，在xml布局内如下使用：

<data>
    <import type="androidx.databinding.ObservableMap" />

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

    <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" />
        ........

<TextView
    android:id="@+id/tv_name2"
    ......
    android:text="@{map[key],default=13}"/>

<TextView
    android:id="@+id/tv_city"
    ......
    android:text='@{map["李四"],default=beijing}' />

<TextView
    android:id="@+id/tv_city1"
    ........
    android:text="@{list[index],default=tianjin}"/>
           ............
</data>

其中可以通过java代码控制key值，也可直接在xml内使用具体的key值来访问map。其更新的方式为：

final ObservableMap<String, String> map = new ObservableArrayMap<>();
map.put("张三", "北京");
map.put("李四", "深圳");
dataBindingBinding.setMap(map);
dataBindingBinding.setKey("张三");

final ObservableList<String> list = new ObservableArrayList<>();
list.add("杭州");
list.add("西安");
dataBindingBinding.setList(list);
dataBindingBinding.setIndex(1);

button3.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        map.put("张三", "杭州" + (int) (1 + Math.random() * (10 - 1 + 1)));
        list.set(1, "西安" + (int) (1 + Math.random() * (10 - 1 + 1)));
    }
});

三.双向数据绑定

当视图发生改变时，数据也发生改变。相对于绑定数据，只需在xml文件内修改西一句话，如下所示将android:text="@{user.name}"改为android:text="@={user.name}"即可。

<EditText
            .........
            android:text="@={user.name}" />

四.使用类方法

与普通使用辅助类方法相似，首先定义一个静态方法，然后在xml内的data标签内导入该类，之后就可以像普通使用方式相同，像对待一般函数来调用

1.定义静态方法
public class StringUtils {
    public static String toUpperCase(String str) {
        return str.toUpperCase();
    }
}
2.导入标签
<import type="com.example.myapplication.databind.StringUtils" />
3.调用
<TextView
       ........
       android:text="@{StringUtils.toUpperCase(user.name)}" />

五.BindingAdapter

该注解支持自定义属性或修改原有属性。如android:text、android:src等，如下增加自定义属性：

1.定义静态方法，添加BindingAdapter注解
@BindingAdapter(value={"arc_progress"})
    public static void setProgress(ArcSeekBar arcSeekBar, int progress) { 
       arcSeekBar.setProgress(progress); 
      }
2.在data标签内关联变量值
<data>
        <import type="android.view.View"/>
        <variable
            name="viewModel"
            type="com.demo.viewmodel.TestViewModel" />
    </data>
3.引用
<com.example.myapplication.databind.ArcSeekBar
            .........
            binding:arc_progress="@{viewModel.currentProgress}"
            />

六.绑定事件

在对应的activity中声明一个事件的内部类，在内部类中定义对应的事件方法，在xml布局中通过新增variable节点，对它的name和type属性进行设置，也是用过@{}的方式绑定事件

1.Activity内
dataBindingBinding.setEventListener(new EventListener());
public class EventListener {
    public void onUserAgeClick(View view) {
        user.setAge(String.valueOf((int) (1 + Math.random() * (10 - 1 + 1))));
        Toast.makeText(DataBindingActivity.this, "点击了button并给age赋新值", Toast.LENGTH_SHORT).show();
    }
}

2.xml内
<data>
<variable
    name="eventListener"
    type="com.example.myapplication.databind.DataBindingActivity.EventListener" />
</data>

<Button
    ........
    android:onClick="@{eventListener::onUserAgeClick}"/>