Base Station

Data Binding学习笔记

从零开始的Booklet(一)

Android Booklet
字数统计: 2.7k阅读时长: 11 min
2017/05/19

前言

DataBinding 出来很久了，不过现在连 MVP 都没有大规模被使用，别说写法用法更颠覆性的 DatatBinding 这样的了。但 DataBinding 这种面向 MVVM 的编程思想前端的使用已经非常普遍了，且确实给开发带来很大的便利。所以还是有必要学习和了解。

什么是 DataBinding?

简单的来说 DataBinding 是 Google 在 Android 上的一种 MVVM 的实现。MVVM 是Model-View-ViewModel的简写，它是 MVP(Model-View-Persenter) 模式与 WPF 结合的应用方式发展演变过来的一种新型架构。而 WPF 主要带来的特性就是数据绑定，这也是 Data Binding 所实现的功能。

数据绑定

数据绑定分为单项绑定和双向绑定;单向绑定就是将视图上的控件的属性绑定到一个对象的某个属性的方法，当对象的属性发生变化时直接影响到控件上；双向绑定的话就是可以互相影响——例如我们将User类的name属性绑定到TextView的setText属性上，这样当我们修改 name 的值时 setText 值也发生相应的改变，无需我们自己去 setText 更新属性。Data Binding 不仅可以帮我们在 Android 上实现这一机制，还为此附带了很多便利，减少了很多工具代码的编写。

  • 项目更加解耦，各个组件的依赖性进一步降低，增加可复用性
  • 去掉 Activities&Fragment 内的大部分 UI 代码，例如onClickListener、setText、findViewById等
  • xml 的功能增强。xml 不再只是声明 UI 的界面，还起到数据的绑定，赋值，逻辑判断等功能。
  • 性能提高，减少 view id 的定义。由于数据绑定直接在 xml 产生，所以不用绞尽脑汁的其大量的名称且在绑定的时候就一次性的通过 gruop 将 view 全部获取，比单个findViewById更加的迅速。

搭建环境

Data Binding 在 Android Studio 1.3 版本&Gradle1.5 后就内置在 IDE 中了，我们只需要在gradle.project中Android模块下声明开启 Data Binding 即可

1
2
3
4
5
6
android{
  ...
    dataBinding{
      enabled=true
    }
}

基础使用

编写 View

数据绑定需要在 xml 中声明各种关系，也可以写一些简单的运算。声明一个 data Binding Layout 只需要在原来的 layout xml 文件基础加一个标签即可:

1
2
3
<layout>
//...rootView
</layout>

这样在编译时，修改后即可搜索到布局生成的对应的*Binding 类。生成的规则默认是通过 xml 的文件名生成，例如activity_main.xml就会对应生成为ActivityMainBinding.java的文件。当然我们也可以指定自定生成的文件名称，需要在layout标签下加入data标签并指定class属性即可(生成 LoginBinding.java)，除此之外data也是我们声明变量的地方，稍后再详细介绍。

1
2
3
<data class="login">
....
</data>

我们来编写一个简单的登录界面:

先使用variable绑定我们所需要的对象。type为该对象的地址,name则随意命名。这里我们声明了一个Action和Presenter,Action用于绑定数据，Presenter则用来绑定一些事件和做逻辑处理。

1
2
3
4
5
6
7
8
9
10
11
12
13
<layout>
<data>
        <variable
            name="presenter"
            type="com.example.qhfax.databindingexample.presenter.MainPresenter" />

        <variable
            name="action"
            type="com.example.qhfax.databindingexample.bean.Action" />
    </data>

  //...rootView
  </layout>

声明好对象后，我们就开始将对象绑定到数据源上。在 Data Binding 中，我们绑定数据需要使用@{code}书写，向插件声明这是一个表达式。这里我们将name属性绑定到TextView的setText上。

1
2
3
4
5
6
7
8
<TextView
            android:layout_width="63dp"
            android:layout_height="wrap_content"
            android:layout_marginLeft="8dp"
            android:layout_marginRight="8dp"
            android:layout_marginTop="60dp"
            android:gravity="center"
            android:text="@{action.name}" />

之后在 Activity 中我们需要使用DataBindingUtil获取ActivityMainDataBinding的实例

1
ActivityMainDataBinding mMainBind=DataBindingUtil.setContentView(this,R.layout.activity_main);

然后去绑定对象

1
2
3
4
Action action = new Action();
action.setName("用户名：");
mMainBind.setAction(action)
mMainBind.setPersenter(persenter);

运行后就可以发现TextView就直接被赋值啦。

绑定的原理

嗯….我们可以先观察一下目前的流程是怎么走下来的；

  1. 在xml文件中绑定控件，然后插件会根据layout生成对应的实体类。通过 DataBindingUtli 来构建对应的 Bind 实例，查看 DataBindingUtil 的代码会发现的工作实现十分简单，将属性和 view 集合传递给我们的 DataBinding:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    //查找到布局ViewGruop
    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);
    //遍历所有的View然后调用ViewDataBinding.Bind方法将数据传给我们的实体类`ActivityMainDataBinding`
    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);
        }
    }

    ​

  2. 通过 Bind 实例绑定数据源，关联控件发生改变。那么数据绑定与刷新又是如何发生的呢？在源码中我们可以发现最终应该是调用了ActivityMainBinding的executeBindings()方法来执行控件刷新的，源码并不复杂。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
protected void executeBindings() {
  //dirtyFlags的作用主要是通过位运算来判断控件的数据源对象是否被绑定，这里我们就不关心具体实现。
       long dirtyFlags = 0;
       synchronized(this) {
           dirtyFlags = mDirtyFlags;
           mDirtyFlags = 0;
       }
  		com.example.qhfax.databindingexample.bean.Action action = mAction;
  		java.lang.String actionName = null;
 		 if ((dirtyFlags & 0x6L) != 0) {
               if (action != null) {
                   // read action.name
                   actionName = action.getName();
               }
     	  }
   if ((dirtyFlags & 0x6L) != 0) {
     // 将我们的textView传递到bindAdapter中进行赋值，由于我们没有给TextView声明ID所有名称是由插件自己生成的名称。
    android.databinding.adapters.TextViewBindingAdapter.setText(this.mboundView2, actionName);
     }
}

可以见看出代码十分的简洁，功能实现都在适配器中进行，这样可以保证情况再复杂代码的可阅读性和适配性也不会层级递增。TextViewBindingAdapter.setText方法也就是让mboundView2调用setText方法显示actionName的值，至于 Adapter 的整体的具体实现等到自定义 Adapter 时候我们再解析。

1
2
3
4
5
6
7
8
@BindingAdapter("android:text")
  public static void setText(TextView view, CharSequence text) {
      final CharSequence oldText = view.getText();
      if (text == oldText || (text == null && oldText.length() == 0)) {
      //....各种约束判断
      }
      view.setText(text);
  }

真正的单向绑定

如果你也在写 Example 就会发现一个问题，当Action绑定后，后续Action的改变并不会让 UI 更新即 Observable(观察者模式)并没有实现。这显然不是我们想要达到的目的。

在 Data Binding 想要一个 View Model 被控件订阅就需要它继承BaseObservable，这样当Action每次改变的时候我们就通知控件数据被改变了，然后控件自己调用相关属性的方法去更新数据。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

public class Action extends BaseObservable{
    private String name;
  //通过在get方法上Bindable注解让BR生成对应的flag，确定如何刷新name值
    @Bindable
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
      //当我们改变值刷新UI，notifyChange()是通知所有订阅者，即使用了actino类中任意绑定了属性都会受到刷新的命令；notifyPropertyChanged()就很明显是通过flag进行单独刷新。
       //notifyChange();
        notifyPropertyChanged(BR.name);
    }

如果 View Model 已经有继承父类我们也可以通过对绑定的属性单独的声明 Observable。DataBinding 提供了除了基础类型外还有 ObservableParcalable 与 ObservableField 来解决大多数场景遇到的对象属性。

1
2
3
4
5
6
7
8
9
10
11
12
public class Action {
  private ObservableField<String> name =new ObservableField<>();
  private ObservableInt age =new ObservableInt();

  //这样做的弊端是我们无法直接访问到属性值，需要通过Observable的get/set方法
  public void setName(String name){
    this.name.set(name);
  }
  public String getName(){
    return this.name.get();
  }
}

这样的话，当我们运行时候控件和数据的联系就建立起来了，更新name的同时 TextView 的text也会同时发生变化。

数据源一定要写个实体类吗，那么不是需要成吨的 bean ? 我们可以通过 ObservableArrayMap 和 ObservableArrayList 来创建观察者和需要观察的数据。

1
2
3
4
5
6
ObservableArrayMap<String,Object> action = new ObseravbleArryMap<>();
action.put("name","just");
action.put("password","gbk")
ObservableArryList list =new ObservableArryList<>();
list.add("first");
list.add("second")

在 xml 中我们通过 key 和 index 访问他们

1
2
3
4
5
6
7
8
9
10
11
12
13
<variable name="action"
          type="android.databinding.ObserableMap"></variable>
<ariable name="user"
         type="android.databing.ObservableList"></ariable>

<TextView
          android:text="@{action["name"]"
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"/>
<TextView
          android:text="@{user[1]"
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"/>

事件绑定

我们除了可以绑定 View 各种属性外，我们也可以在 xml 中直接绑定事件，而不用通过 View 转发。

我们在 Presenter 中创建一个监听文本的方法，然后在 xml 中设置onTextChanged属性，方法名必须和对应的 listener 对应.

1
2
3
4
5
6
<EditText
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  android:onTextChanged="@{presenter::onTextChanged}"
  />

将 Presenter 绑定在 Activity 上后，就可以接受到 EditText 的改变了

1
2
3
4
5
public class Presenter{
  public void onTextChanged(charSequence s,in start ,int before,int count){
    mView.show(s.toString())
  }
}

表达式

在 xml 中的 dataBinding 表达式支持 Java 中的大部分语法，具体如下：

  • 算数 +-*/%
  • 字符串合并+
  • 逻辑运算 &&||
  • 二元&|^
  • 一元+-!~
  • 位移>> >>> >>
  • 比较== > <> = <=
  • instanceof 操作符
  • Grouping（）
  • 文字
  • Cast 类型转换
  • 方法调用
  • 属性访问
  • 数组访问
  • 三目运算符？：

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

同时由于在表达式在字符串中声明的，一些特殊字符的转义也是不可避免的。

结果 转义字符
空格 &nbsp;
< &t;
> &gt;
& &amp;
“ &quot;
` &apos;
x &divide

除此 java 的这些语法支持外还有一些特殊的支持。

  • 空合并运算符——使用??来连接两个式子，如果左边的式子为空就取右边的。

    1
    android:text="@{user.name??user.realName}"

  • 直接访问资源文件——可以通过`@resource/name 的形式访问资源文件来直接使用

    1
    2
    3
    android:text="@{@String/name(name)}"

    <string name="name">我的名字是%s</string>

include

在使用 include 布局时候需要将该布局使用的数据通过bind:xxx=@{}传递进去，并在布局中进行二次绑定。

1
<include layout="@layout/empty" bind:info="@{info}"/>

原文作者：Nutcracker

原文链接：https://czj-dev.github.io/2017/05/19/2017-05-19-android_databinding/

发表日期：May 19th 2017, 4:03:00 pm

更新日期：December 18th 2021, 9:07:07 pm

版权声明：本文采用知识共享署名-非商业性使用 4.0 国际许可协议进行许可

CATALOG
  1. 1. 前言
  2. 2. 什么是 DataBinding?
  3. 3. 数据绑定
  4. 4. 搭建环境
  5. 5. 基础使用
    1. 5.1. 编写 View
    2. 5.2. 绑定的原理
    3. 5.3. 真正的单向绑定
    4. 5.4. 事件绑定
    5. 5.5. 表达式
    6. 5.6. include
Total : 26
2023
2021
2020
2019
2018
2017
生活 Android 基础 Booklet Note Gradle HTTP Flutter Book Dart RecyclerView