从零開始的Android新项目7 - Data Binding入门篇

2022-11-18 17:20:21

Data Binding自从去年的Google I/O公布到至今，也有近一年的时间了。这一年来，从Beta到如今比較完好的版本号。从Android Studio 1.3到如今2.1.2的支持，能够说Data Binding已经是一个可用度较高，也能带来实际生产力提升的技术了。

然而其实，真正使用到Data Binding的公司、项目仍然是比較少的。

可能是出于稳定性考虑，亦或是对Data Binding技术本身不够熟悉，又也许对新技术没什么追求。

我司在新的产品中就全面使用了Data Binding技术，不管是我，还是新来直接面对Data Binding上手的工程师也好，都对其爱不释手，用惯了后简直停不下来。

希望在看完本文的介绍后。会有很多其它的朋友产生兴趣。来使用Data Binding。參与它的讨论。

Demo源代码库：DataBindingSample

什么是Data Binding

Data Binding。顾名思义，数据绑定。是Google对MVVM在Android上的一种实现。能够直接绑定数据到xml中。并实现自己主动刷新。

如今最新的版本号还支持双向绑定。虽然使用场景不是那么多。

Data Binding能够提升开发效率（节省非常多以往须要手写的java代码）。性能高（甚至超越手写代码）。功能强（强大的表达式支持）。

用途

去掉Activities & Fragments内的大部分UI代码（setOnClickListener, setText, findViewById, etc.)
XML变成UI的唯一真实来源
降低定义view id的主要用途（数据绑定直接发生在xml）

开源方案

ButterKnife, Jake大神的知名库了。能够少些非常多findViewById，setOnClickListener。取而代之地用annotation去生成代码。
Android Annotations，相同通过annotation。大量的annotation。侵入性较强，须要遵循其规范写一些代码。像是@AfterViews凝视中才干对View进行操作。
RoboBinding，和Data Binding最相似的一个方案，相同非常多事情放在xml去做了，使用了aspectJ去做生成。

除了这些比較有名的，还有非常多各不相同的方案，但自从data binding公布后。能够说它们都再也没实用武之地了。由于不管从性能、功能，还是ide的支持上，data binding都更好。

优势

UI代码放到了xml中，布局和数据更紧密
性能超过手写代码
保证运行在主线程

劣势

IDE支持还不那么完好（提示、表达式）
报错信息不那么直接
重构支持不好（xml中进行重构。java代码不会自己主动改动）

使用

使用起来实在非常easy，在app模块的build.gradle中加上几行代码就可以了。

Gradle

android {

    …

    dataBinding {

        enabled = true

    }

}

layout tag

把一个普通的layout变成data binding layout也仅仅要几行的改动:

<layout>

    // 原来的layout

</layout>

在xml的最外层套上layout标签就可以，改动后就能够看到生成了该布局相应的*Binding类。

Binding生成规则

默认生成规则：xml通过文件名称生成，使用下划线切割大写和小写。

比方activity_demo.xml，则会生成ActivityDemoBinding，item_search_hotel则会生成ItemSearchHotelBinding。

view的生成规则相似，仅仅是由于是类变量，首字母不是大写。比方有一个TextView的id是first_name，则会生成名为firstName的TextView。

我们也能够自己定义生成的class名字，仅仅须要：

<data class=“ContactItem”>

…

</data>

这样生成的类就会变成ContactItem。

基础使用方法

生成Binding实例

全部Binding实例的生成都能够通过DataBindingUtil进行，方法名与该view的原inflate方法一致。如activity仍然为setContentView，仅仅是添加了參数由于须要获得activity。

去除findViewById

使用了Data Binding后，我们再也不须要findViewById，由于一切有id的view，都已经在Binding类中被初始化完毕了，仅仅须要直接通过binding实例訪问就可以。

变量绑定

使用data标签。我们就能够在xml中申明变量，在当中使用该变量的field，并通过binding实例set进来。

如:

<data>

    <variable

        name="employee"

        type="com.github.markzhai.databindingsample.Employee"/>

</data>

<LinearLayout

    android:layout_width="match_parent"

    android:layout_height="match_parent"

    android:gravity="center_horizontal"

    android:orientation="vertical"

    tools:context=".DemoActivity">

    <TextView

        android:layout_width="wrap_content"

        android:layout_height="wrap_content"

        android:text="@{employee.lastName}"

        android:layout_marginLeft="5dp"/>

</LinearLayout>

然后我们就能够在java代码中使用

binding.setEmployee(employee);

// 或者直接通过setVariable

binding.setVariable(BR.employee, employee);

事件绑定

严格意义上来说。事件绑定也是一种变量绑定。我们能够在xml中直接绑定

android:onClick
android:onLongClick
android:onTextChanged
…

方法引用

一般会在java代码中定义一个名为Handler或者Presenter的类，然后set进来，方法签名需和相应listener方法一致。

<layout

    xmlns:android="http://schemas.android.com/apk/res/android"

    xmlns:tools="http://schemas.android.com/tools"

    xmlns:bind="http://schemas.android.com/apk/res-auto">

    <data>

        <import type="android.view.View"/>

        <variable

            name="employee"

            type="com.github.markzhai.databindingsample.Employee"/>

        <variable

            name="presenter"

            type="com.github.markzhai.databindingsample.DemoActivity.Presenter"/>

    </data>

    <LinearLayout

        android:layout_width="match_parent"

        android:layout_height="match_parent"

        android:gravity="center_horizontal"

        android:orientation="vertical"

        tools:context=".DemoActivity">

        <EditText

            android:layout_width="match_parent"

            android:layout_height="wrap_content"

            android:hint="输入 First Name"

            android:onTextChanged="@{presenter::onTextChanged}"/>

        <TextView

            android:layout_width="wrap_content"

            android:layout_height="wrap_content"

            android:onClick="@{presenter.onClick}"

            android:text="@{employee.firstName}"/>

    </LinearLayout>

</layout>

在Java代码中:



    @Override

    protected void onCreate(Bundle savedInstanceState) {

        ...

        binding.setPresenter(new Presenter());

        ...

    }

    public class Presenter {

        public void onTextChanged(CharSequence s, int start, int before, int count) {

            employee.setFirstName(s.toString());

            employee.setFired(!employee.isFired.get());

        }

        public void onClick(View view) {

            Toast.makeText(DemoActivity.this, "点到了", Toast.LENGTH_SHORT).show();

        }

    }

监听器绑定（lambda）

能够不遵循默认的方法签名：

<TextView

    android:layout_width="wrap_content"

    android:layout_height="wrap_content"

    android:layout_margin="5dp"

    android:visibility="@{employee.isFired ? View.GONE : View.VISIBLE}"

    android:onClick="@{() -> presenter.onClickListenerBinding(employee)}"/>

public class Presenter {

    public void onClickListenerBinding(Employee employee) {

        Toast.makeText(DemoActivity.this, employee.getLastName(),

                Toast.LENGTH_SHORT).show();

    }

}

Data Binding原理

狭义原理

狭义上，我们能够直接通过调用的接口以及生成的一些类，来观察其工作原理。

作为切入口，我们来看看DataBindingUtil的接口:

public static <T extends ViewDataBinding> T setContentView(Activity activity, int layoutId,

        DataBindingComponent bindingComponent) {

    activity.setContentView(layoutId);

    View decorView = activity.getWindow().getDecorView();

    ViewGroup contentView = (ViewGroup) decorView.findViewById(android.R.id.content);

    return bindToAddedViews(bindingComponent, contentView, 0, layoutId);

}

private static <T extends ViewDataBinding> T bindToAddedViews(DataBindingComponent component,

        ViewGroup parent, int startChildren, int layoutId) {

    final int endChildren = parent.getChildCount();

    final int childrenAdded = endChildren - startChildren;

    if (childrenAdded == 1) {

        final View childView = parent.getChildAt(endChildren - 1);

        return bind(component, childView, layoutId);

    } else {

        final View[] children = new View[childrenAdded];

        for (int i = 0; i < childrenAdded; i++) {

            children[i] = parent.getChildAt(i + startChildren);

        }

        return bind(component, children, layoutId);

    }

}

能够看到，然后会跑到详细Binding类中:

public ItemFeedRecommendUserBinding(android.databinding.DataBindingComponent bindingComponent, View root) {

    super(bindingComponent, root, 9);

    final Object[] bindings = mapBindings(bindingComponent, root, 5, sIncludes, sViewsWithIds);

    this.mboundView0 = (android.widget.LinearLayout) bindings[0];

    this.mboundView0.setTag(null);

    this.recommendUserFirst = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[1];

    this.recommendUserFourth = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[4];

    this.recommendUserSecond = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[2];

    this.recommendUserThird = (com.amokie.stay.databinding.IncludeRecommendUserBinding) bindings[3];

    setRootTag(root);

    // listeners

    invalidateAll();

}

能够看到全部view是一次完毕的初始化，比起一个个进行findViewById，显然这样一次性会更快。

除了view的初始化，在executeBindings中，会通过mDirtyFlags去推断各个field是否须要更新，而其置位则通过各个set函数去更新。

流程原理

从零開始的Android新项目7 - Data Binding入门篇

处理layout文件 -> 变为没有data binding的layout文件

解析表达式 -> 确保表达式语法正确

解析依赖 -> user.isAdmin, isAdmin是field还是method…

Setter -> 如visibility

性能

0反射
findViewById须要遍历整个viewgroup。而如今仅仅须要做一次就能够初始化全部须要的view
使用位标记来检验更新（dirtyFlags）
数据改变在下一次批量更新才会触发操作
表达式缓存，同一次刷新中不会反复计算

进阶使用方法

表达式

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

尚且不支持this, super, new, 以及显示的泛型调用。

值得一提的是还有空合并运算符。如

android:text=“@{user.displayName ??

user.lastName}”

会取第一个非空值作为结果。

这里举一个常见的样例，某个view的margin是其左側ImageView的margin加上该ImageView的宽度，以往我们可能须要再定义一个dimension来放这两个值的合，如今仅仅须要

android:marginLeft="@{@dimen/margin + @dimen/avatar_size}"

就搞定了。

我们甚至还能够直接组合字符串。如:

android:text="@{@string/nameFormat(firstName, lastName)}"

<string name="nameFormat">%s, %s</string>

避免空指针

data binding会自己主动帮助我们进行空指针的避免。比方说@{employee.firstName}。假设employee是null的话，employee.firstName则会被赋默认值（null）。

int的话，则是0。

须要注意的是数组的越界。毕竟这儿是xml而不是java。没地方让你去推断size的。

include

<include layout=“@layout/name” bind:user="@{user}"/>

对于include的布局。使用方法相似。只是须要在里面绑定两次，外面include该布局的layout使用bind:user给set进去。

这里须要注意的一点是，被include的布局必须顶层是一个ViewGroup，眼下Data Binding的实现，假设该布局顶层是一个View，而不是ViewGroup的话，binding的下标会冲突（被覆盖），从而产生一些预料外的结果。

ViewStubs

ViewStub比較特殊。在被实际inflate前是不可见的。所以使用了特殊的方案。用了final的ViewStubProxy来代表它，并监听了ViewStub.OnInflateListener:

private OnInflateListener mProxyListener = new OnInflateListener() {

    @Override

    public void onInflate(ViewStub stub, View inflated) {

        mRoot = inflated;

        mViewDataBinding = DataBindingUtil.bind(mContainingBinding.mBindingComponent,

                inflated, stub.getLayoutResource());

        mViewStub = null;

        if (mOnInflateListener != null) {

            mOnInflateListener.onInflate(stub, inflated);

            mOnInflateListener = null;

        }

        mContainingBinding.invalidateAll();

        mContainingBinding.forceExecuteBindings();

    }

};

在onInflate的时候才会进行真正的初始化。

Observable

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

BaseObservable

类继承BaseObservable:

private static class User extends BaseObservable {

   private String firstName;

   private String lastName;

   @Bindable

   public String getFirstName() {

       return this.firstName;

   }

   @Bindable

   public String getLastName() {

       return this.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函数（其实就是notifyChange和notifyPropertyChanged），前者会刷新全部的值域，后者则仅仅更新相应BR的flag，该BR的生成通过凝视@Bindable生成。在上面的实例代码中，我们能够看到两个get方法被凝视上了。所以我们能够通过BR訪问到它们并进行特定属性改变的notify。

Observable Fields

假设全部要绑定的都须要创建Observable类，那也太麻烦了。所以Data Binding还提供了一系列Observable，包含 ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, 和ObservableParcelable。

我们还能通过ObservableField泛型来申明其它类型，如：

private static class User {

   public final ObservableField<String> firstName =

       new ObservableField<>();

   public final ObservableField<String> lastName =

       new ObservableField<>();

   public final ObservableInt age = new ObservableInt();

}

而在xml中。使用方法和普通的String，int一样。仅仅是会自己主动刷新，但在java中訪问则会相对麻烦：

user.firstName.set("Google");

int age = user.age.get();

相对来说，每次要get/set还是挺麻烦，私以为还不如直接去继承BaseObservable。

Observable Collections

有一些应用使用更动态的结构来保存数据，这时候我们会希望使用Map来存储数据结构。Observable提供了ObservableArrayMap:

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();

user.put("firstName", "Google");

user.put("lastName", "Inc.");

user.put("age", 17);

而在xml中，我们能够直接通过下标key訪问它们：

<data>

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

    <variable name="user" type="ObservableMap&lt;String, Object>"/>

</data>

…

<TextView

   android:text='@{user["lastName"]}'

   android:layout_width="wrap_content"

   android:layout_height="wrap_content"/>

<TextView

   android:text='@{String.valueOf(1 + (Integer)user["age"])}'

   android:layout_width="wrap_content"

   android:layout_height="wrap_content"/>

当我们不想定义key的时候，能够使用ObservableArrayList:

ObservableArrayList<Object> user = new ObservableArrayList<>();

user.add("Google");

user.add("Inc.");

user.add(17);

layout中直接通过数字下标进行訪问。

动态变量

有时候。我们并不知道详细生成的binding类是什么。比方在RecyclerView中，可能有多种ViewHolder，而我们拿到的holder仅仅是一个基类（这个基类详细怎么写下篇中会提到），这时候，我们能够在这些item的layout中都定义名字相同的variable，比方item。然后直接调用setVariable：

public void onBindViewHolder(BindingHolder holder, int position) {

   final T item = mItems.get(position);

   holder.getBinding().setVariable(BR.item, item);

   holder.getBinding().executePendingBindings();

}

executePendingBindings会强制马上刷新绑定的改变。

參考资料

https://developer.android.com/topic/libraries/data-binding/index.html

欢迎关注我们的公众号：魔都三帅，欢迎大家来投稿~

从零開始的Android新项目7 - Data Binding入门篇

码农公寓

什么是Data Binding

用途

开源方案

优势

劣势

使用

Gradle

layout tag

Binding生成规则

基础使用方法

生成Binding实例

去除findViewById

变量绑定

事件绑定

方法引用

监听器绑定（lambda）

Data Binding原理

狭义原理

流程原理

性能

进阶使用方法

表达式

避免空指针

include

ViewStubs

Observable

BaseObservable

Observable Fields

Observable Collections

动态变量

參考资料

相关文章