Android Databinding使用-基础用法

demo地址：https://github.com/TonyDash/DataBinding

一、基本数据类绑定

1.在项目对应的module中，增加代码开关

android {
    ...
    //引入对 DataBinding 的支持
    dataBinding{
        enabled = true
    }
}

2.新建一个布局文件，把光标移动到根布局，然后快捷键option+return（MacOS系统）。在弹出的菜单中选择Convert to data binding layout image.png

之后会自动转成如下代码：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>

    </data>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">

    </LinearLayout>
</layout>

3.新建数据类、数据类与布局文件绑定、activity中增加数据显示的逻辑。

package com.example.cjy.databinding.bean

class User(
    val name:String,
    val age:Int
)

<?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.cjy.databinding.bean.User" />
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">

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

        <TextView
            android:id="@+id/tvAge"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="10dp"
            android:text="@{String.valueOf(user.age)}"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toBottomOf="@id/name" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

package com.example.cjy.databinding

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.databinding.DataBindingUtil
import com.example.cjy.databinding.bean.User
import com.example.cjy.databinding.databinding.ActivityMainBinding

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        val activityMainBinding:ActivityMainBinding = DataBindingUtil.setContentView(this,R.layout.activity_main)
        val user = User("chen jy",20)
        activityMainBinding.user = user
    }
}

这里唯一需要解释的是：当你的xml布局使用了dataBinding，系统会自动帮你生成一个对应的类，类名就是xml的名称，这里我的布局名称是activity_main.xml，所以在MainActivity中，使用的时候，就是activityMainBinding。

二、添加import类

有时候，我们需要在“@{}”的内部，使用一些类或者对象，这时候就需要导入对应的类。例如我们的view，经常需要控制显示或者隐藏，如果需要利用databinding中的数据来控制，我们就需要导入View这个类。

<data>
        <variable
            name="user"
            type="com.example.cjy.databinding.bean.User" />
        <import type="android.view.View"/>
    </data>
<TextView
            android:id="@+id/tvAge"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="10dp"
            android:text="@{String.valueOf(user.age)}"
            android:visibility="@{user.age>0?View.VISIBLE:View.GONE}"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toBottomOf="@id/name" />

这样就达到了利用数据直接控制显示或者隐藏的目的了；同时你可能有注意到，为什么上面的String就不需要import，那是因为databinding自带了基本类型，这些都不需要我们自己手动导入就可以直接使用。

三、添加自定义的import类

class StringUtil {
    companion object {
        fun uppercaseString(string: String): String {
            return string.toUpperCase()
        }

        fun lowercaseString(string: String): String {
            return string.toLowerCase()
        }
    }
}

<?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.cjy.databinding.bean.User" />
        <import type="android.view.View"/>
        <import type="com.example.cjy.databinding.util.StringUtil"/>
        <variable
            name="stringUtil"
            type="StringUtil" />
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">

        <TextView
            android:id="@+id/name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{stringUtil.Companion.uppercaseString(user.name),default = tony}"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

这里我import之后，同时也定义声明为stringUtil，这样的写法有一个用处就是，如果多个声明的type都是使用同一个类，就省掉重复写完整包路径；
另外，如果还有另一个自定义类也叫StringUtil，这时候可以使用别名来区分。

<import type="com.example.cjy.databinding.util.StringUtil"/>
        <variable
            name="stringUtil"
            type="StringUtil" />
<import type="com.example.cjy.databinding.util2.StringUtil"
    alias="StringUtil2"/>
        <variable
            name="stringUtil2"
            type="StringUtil2" />

四、集合的使用

在xml中使用list，其实跟上面的用法没太大区别，都是先引入需要使用的包，然后定义变量，最后在控件中使用定义的属性。

<?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="com.example.cjy.databinding.bean.User"/>
        <variable
            name="userList"
            type="List&lt;User&gt;" />
        <variable
            name="index"
            type="Integer" />
    </data>

    <RelativeLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
        <TextView
            android:id="@+id/tvName"
            android:text="@{userList.get(index).name,default = cjy}"
            android:layout_centerInParent="true"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"/>
        <TextView
            android:layout_below="@id/tvName"
            android:layout_centerHorizontal="true"
            android:layout_marginTop="15dp"
            android:id="@+id/tvSize"
            android:text="@{String.valueOf(userList.size())}"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"/>
    </RelativeLayout>
</layout>

class ListActivity:AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_list)
        val activityListBinding:ActivityListBinding =
            DataBindingUtil.setContentView(this,R.layout.activity_list)
        val userList:List<User> = mutableListOf(User("chen JY",20),
            User("luo YZ",18),
            User("chen YR",2))
        activityListBinding.userList = userList
        activityListBinding.index = 1
    }
}

到这里，DataBinding的基础部分，已经有个大概的介绍， 下一篇介绍DataBinding的数据绑定和刷新的方法。