Android从零开始搭建MVVM架构（1）——Databinding入门

老马的编程之旅

发布于 2022-06-22 13:03:21

1.1K0

发布于 2022-06-22 13:03:21

文章被收录于专栏：深入理解Android

1.简介

DataBinding是谷歌官方推出的一个库，DataBinding库来写声明的layouts文件，可以用最少的代码来绑定你的app逻辑和layouts文件。

Data Binding库不仅灵活而且广泛兼容- 它是一个support库，因此你可以在所有的Android平台最低能到Android 2.1（API等级7+）上使用它。

需求：Android Plugin for Gradle 1.5.0-alpha1 或更高版本。

2.搭建环境

在app.gradle下，需要添加Data Binding到gradle构建文件里，如下：

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

Data Binding插件将会在你的项目内添加必需提供的以及编译配置依赖。

3.编写layout文件

3.1 DataBinding表达式 Data Binding layout文件有点不同的是：起始根标签是layout，接下来一个data元素以及一个view的根元素。这个view元素就是你没有使用Data Binding的layout文件的根元素。

<?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="demo.com.databindingdemo.User"/>
    </data>

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


        <TextView
            android:id="@+id/user_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.mUserName}"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

        <TextView
            android:id="@+id/user_age"
            android:text='@{user.mUserage+""}'
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toBottomOf="@id/user_name" />
    </android.support.constraint.ConstraintLayout>
</layout>

在data内描述了一个名为user的变量属性，使其可以在这个layout中使用：

<variable name="user" type="demo.com.databindingdemo.User"/>

在layout的属性表达式写作@{}，下面是一个TextView的text设置为user的mUserName属性：

       <TextView
            android:id="@+id/user_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.mUserName}"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

2）Data对象上面我们创建了一个User对象

public class User {

    public final String mUserName;
    public final int mUserage;

    public User(String userName, int userAge) {
        this.mUserName = userName;
        mUserage = userAge;
    }


}

这种类型的对象具有无法改变的数据，它通常在应用中被读取一次数据后再也不会改变。也可以使用遵循一系列约定的对象，例如使用访问器方法（就是getter方法），如下所示：

public class User {

    public final String mUserName;
    public final int mUserage;

    public User(String userName, int userAge) {
        mUserName = userName;
        mUserage = userAge;
    }

    public String getUserName() {
        return mUserName;
    }

    public int getUserage() {
        return mUserage;
    }
}

从Data Binding的角度来看，这两个类是等价的。用于TextView中的android:text属性的表达式@{user.mUserName}将访问前者POJO对象中的mUserName和后者JavaBeans对象中的getUserName()方法。

3）Binding数据

默认情况下，一个Binding类会基于layout文件的名称而产生，将其转换为Pascal case（译注：首字母大写的命名规范）并且添加“Binding”后缀。上述的layout文件是activity_main.xml，因此生成的类名是ActivityMainBinding。此类包含从layout属性到layout的Views中所有的bindings（例如user变量），并且它还知道如何给Binding表达式分配数值。创建bindings的最简单的方式是在inflating（译注：layout文件与Activity/Fragment的“链接”）期间如下：

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMainBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_main);
        User user = new User("sam",11);
        binding.setUser(user);
    }
}

运行之后，数据将会自动绑定。

如果你在ListView或者RecyclerView adapter使用Data Binding时，你可能会使用：

ListItemBinding binding = ListItemBinding.inflate(layoutInflater, viewGroup,
false);
//or
ListItemBinding binding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false);

如果将上面User的属性改为私有，则会遇到如下错误

public class User {

    private final String mUserName;
    private final int mUserage;

    public User(String userName, int userAge) {
        mUserName = userName;
        mUserage = userAge;
    }

    public String getUserName() {
        return mUserName;
    }

    public int getUserage() {
        return mUserage;
    }
}

Found data binding errors.
****/ data binding error ****msg:Could not find accessor demo.com.databindingdemo.User.mUserName

4）事件处理数据绑定允许你编写表达式来处理view分派的事件。事件属性名字取决于监听器方法名字。例如View.OnLongClickListener有onLongClick()的方法，因此这个事件的属性是android:onLongClick。处理事件有两种方法： * Method References * Listener Bindings

4.深入Databinding用法

4.1 Import 零个或多个import元素可能在data元素中使用。这些只用在你的layout文件中添加引用，就像在Java中：

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

现在，View可以使用你的Binding表达式：

   <TextView
            android:id="@+id/user_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.mUserName}"
            android:visibility="@{user.isMan ? View.VISIBLE : View.GONE}"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

当类名有冲突时，其中一个类名可以重命名：

 <data>
        <import type="android.view.View"/>
        <import type="demo.com.databindingdemo.View"
            alias="test"/>
        <variable name="user" type="demo.com.databindingdemo.User"/>
    </data>

这样，在该layout文件中test对应demo.com.databindingdemo.View，而View对应android.view.View。导入的类型可以在Variable和表达式中使用作为引用来使用：

<import type="demo.com.databindingdemo.User"/>
        <variable  name="user" type="User"/>

导入的类型还可以在表达式中使用static属性和方法：

public class StringUtls {

    public static String translateStr(String str){
        return str+"haha";
    }

}

 <import type="demo.com.databindingdemo.StringUtls"/>

  <TextView
            android:id="@+id/user_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{StringUtls.translateStr(user.mUserName)}"
            android:visibility="@{user.isMan ? View.VISIBLE : View.GONE}"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

4.2 Variables 在data中可以使用任意数量的variable元素。每一个variable元素描述了一个用于layout文件中Binding表达式的属性。

  <data>
        <import type="demo.com.databindingdemo.StringUtls"/>
        <import type="android.view.View"/>
        <import type="demo.com.databindingdemo.View"
            alias="test"/>
        <import type="demo.com.databindingdemo.User"/>
        <variable  name="user" type="User"/>
        <variable  name="stringUtil" type="StringUtls"/>

    </data>

当对于多种配置有不同的layout文件时（如，横向或纵向），Variables会被合并。这些layout文件之间必须不能有冲突的Variable定义。

产生的Binding类对于每一个描述的Variables都会有setter和getter。这些Variables会使用默认的Java值 - null（引用类型）、0（int）、false（boolean）等等，直到调用setter时。

4.3 自定义Binding类名称 默认情况下，Binding类的命名是基于所述layout文件的名称，用大写开头，除去下划线（）以及（）后的第一个字母大写，然后添加“Binding”后缀。这个类将被放置在一个模块封装包里的databinding封装包下。例如，所述layout文件contact_item.xml将生成ContactItemBinding。如果模块包是com.demo.my.app，那么它将被放置在com.demo.my.app.databinding。

Binding类可通过调整data元素中的class属性来重命名或放置在不同的包中。例如：

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

在模块封装包的databinding包中会生成名为ContactItem的Binding类。如果要想让该类生成在不同的包种，你需要添加前缀.，如下：

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

在这个情况下，ContactItem类直接在模块包种生成。或者你可以提供整个包名：

<data class="com.demo.ContactItem">
    ...
</data>

4.4 表达式 常用表达式跟Java表达式很像，以下这些是一样的：

数学 + - / * %
字符串连接 +
逻辑 && ||
二进制 & | ^
一元运算 + - ! ~
移位 >> >>> <<
比较 == > < >= <=
instanceof
分组 ()
null
Cast
方法调用
数据访问 []

三元运算 ?:

示例：

android:text="@{String.valueOf(index + 1)}"
android:visibility="@{age < 13 ? View.GONE : View.VISIBLE}"
android:transitionName='@{"image_" + id}'

缺少的操作：

this
super
new
显式泛型调用

Null合并操作

?? - 左边的对象如果它不是null，选择左边的对象；或者如果它是null，选择右边的对象： android:text="@{user.displayName ?? user.lastName}"

函数上的写法如下：

android:text="@{user.displayName != null ? user.displayName : user.lastName}"

属性引用当一个表达式引用一个类的属性，它仍使用同样的格式对于字段、getters以及ObservableFields。

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

避免 NullPointerException Data Binding代码生成时自动检查是否为nulls来避免出现null pointer exceptions错误。例如，在表达式@{user.name}中，如果user是null，user.name会赋予它的默认值（null）。如果你引用user.age，age是int类型，那么它的默认值是0。

集合常用的集合：arrays、lists、sparse lists以及maps，为了简便都可以使用[]来访问。

<data>
<import type="android.util.SparseArray"/>
<import type="java.util.Map"/>
<import type="java.util.List"/>
<variable name="list" type="List<String>"/>
<variable name="sparse" type="SparseArray<String>"/>
<variable name="map" type="Map<String, String>"/>
<variable name="index" type="int"/>
<variable name="key" type="String"/>
</data>
…
android:text="@{list[index]}"
…
android:text="@{sparse[index]}"
…
android:text="@{map[key]}"

字符串当使用单引号包含属性值时，在表达式中使用双引号很容易：

android:text='@{map["firstName"]}'

使用双引号来包含属性值也是可以的。字符串前后需要使用”`“：

android:text="@{map[`firstName`]}"
android:text="@{map["firstName"]}"

Resources 使用正常的表达式来访问resources也是可行的：

android:padding="@{large? @dimen/largePadding : @dimen/smallPadding}"

格式化字符串和复数可以通过提供参数来判断

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

5.Data 对象

DataBinding库允许我们创建可观察的对象、字段或集合，当我们的数据发生改变时需要通知其他对象就可以使用DataBinding，它主要有三种不同类型的可观察类型，分别为：对象、字段或集合。当这些可观察的数据对象绑定到 UI ，并且数据对象的属性发生改变时，UI 也将自动更新。

5.1 Observable 对象 实现android.databinding.Observable接口的类可以允许附加一个监听器到Bound对象以便监听对象上的所有属性的变化。

Observable接口有一个机制来添加和删除监听器，但通知与否由开发人员管理。为了使开发更容易，一个BaseObservable的基类为实现监听器注册机制而创建。Data实现类依然负责通知当属性改变时。这是通过指定一个Bindable注解给getter以及setter内通知来完成的。

public class UserObserve extends BaseObservable {

    private String name;


    public void setName(String name) {
        this.name = name;
        notifyPropertyChanged(BR.name);
    }
    @Bindable
    public String getName() {
        return name;
    }
}

在编译期间，Bindable注解在BR类文件中生成一个Entry。BR类文件会在模块包内生成。如果用于Data类的基类不能改变，Observable接口通过方便的PropertyChangeRegistry来实现用于储存和有效地通知监听器。

5.2 Observable 字段 一些小工作会涉及到创建Observable类，因此那些想要节省时间或者几乎没有几个属性的开发者可以使用ObservableFields。ObservableFields是自包含具有单个字段的observable对象。它有所有基本类型和一个是引用类型。要使用它需要在data对象中创建public final字段：

public class UserObserverField {

    public final ObservableField<String> name =
            new ObservableField<>();
    public final ObservableInt age = new ObservableInt();

    

}

user.firstName.set("Google");
int age = user.age.get();

5.3 Observable 集合 一些app使用更多的动态结构来保存数据。Observable集合允许键控访问这些data对象。ObservableArrayMap用于键是引用类型,如String。

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();
user.put("name", "Jack");
user.put("age", 17);

在layout文件中，通过String键可以访问map：

<data>
    <import type="android.databinding.ObservableMap"/>
    <variable name="user" type="ObservableMap<String, Object>"/>
</data>
…
<TextView
   android:text='@{user["name"]}'
   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"/>

ObservableArrayList用于键是整数：

ObservableArrayList<Object> user = new ObservableArrayList<>();
user.add("Jack");
user.add(17);

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2019-01-04，如有侵权请联系 cloudcommunity@tencent.com 删除

tcp/ip

android

textview

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

tcp/ip

android

textview

登录后参与评论

0 条评论

热度