DataBinding 是google发布的一个数据绑定框架,用于降低布局和逻辑的耦合性,使代码逻辑更加清晰。大量减少 Activity 内的代码,数据能够单向或双向绑定到 layout 文件中,有助于防止内存泄漏,而且能自动进行空检测以避免空指针异常。

环境配置

  1. 详情内容请参考:https://developer.android.com/topic/libraries/data-binding/start

  2. 启用 DataBinding 的方法是在对应 Model 的 build.gradle 文件里加入以下代码,同步后就能引入对 DataBinding 的支持

    android {
        ...
       dataBinding {
           enabled = true
       }
    }
    
  3. 如果Android Studio的版本小于3.2的需要在gradle.properties中添加:

    android.databinding.enableV2=true
    

tips: 1. 推荐使用最新的Android Studio版本和AndroidX库。

​ 2.build.gradle中添加'apply plugin : 'kotlin-kapt'

基础入门

改变布局文件 layout

启用 DataBinding 后,打开原有的布局文件,选中根布局的 根布局,按住 Alt + 回车键,点击 “Convert to data binding layout”,就可以生成 DataBinding 需要的布局规则。

1560319999402.png

转换后的内容为:

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
    </data>
    <androidx.constraintlayout.widget.ConstraintLayout
            android:orientation="vertical"
            android:layout_width="match_parent"
            android:layout_height="match_parent">

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>
  • 和原始布局的区别在于多出了一个 layout 标签将原布局包裹了起来;
  • data 标签用于声明要用到的变量以及变量类型,它搭建了 View 和 Model 之间的通道。

创建Model

package com.github.ixiaow.databindingsample.model

data class User(val name:String, val password: String)

Model 与 布局文件关联

data 标签里声明要使用到的变量名、类的全路径

<data>
    <variable 
         name="user" 
         type="com.github.ixiaow.databindingsample.model.User"/>
</data>

在 相应部分使用User

<?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">

    <data>
        ...
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:orientation="vertical">

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

        <TextView
                   ...
                android:text="@{user.password}"/>

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

Model赋值

写好布局文件后,在 Android Studio中执行make project或者make app, 完成后,在Activity中:

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val dataBinding: ActivityMainBinding =
            DataBindingUtil.setContentView(this, R.layout.activity_main)
        // 给user初始化值
        dataBinding.user = User("zhangsan", "12345")
    }
}

运行App后就可以看到结果啦。

补充知识

  • import

    我们可以像使用java或者kotlin文件一样,导入需要的类名路径即可,比如说:

    1. 如果 User 类型要多处用到,也可以直接将之 import 进来,这样就不用每次都指明整个包名路径了,而 java.lang.* 包中的类会被自动导入,所以可以直接使用:

      <data>
         <import type="com.github.ixiaow.databindingsample.model.User"/>
         <variable
             name="user"
             type="User"/>
      </data>
      
    2. 导入javakotlin文件中的系统类,比如 import 集合 list

      <data>
          <import type="java.util.List"/>
          <import type="com.github.ixiaow.sample.model.User"/>
          <variable name="user" type="User"/>
          <variable name="users" type="List<User>"/>
       </data>
      

      ❤️ <需要被替换成&lt;

    3. 如果存在 import 的类名相同的情况,可以使用 alias 指定别名

      <data>
          <import type="com.github.ixiaow.sample.model1.User" />
          <import
             alias="TempUser"
             type="com.github.ixiaow.sample.model2.User" />
          <variable
             name="user"
             type="User" />
          <variable
             name="tempUserInfo"
             type="TempUser" />
      </data>
      
  • 预览添加默认值

    由于 @{user.name}在布局文件中并没有明确的值,所以在预览视图中什么都不会显示,不便于观察文本的大小和字体颜色等属性,此时可以为之设定默认值(文本内容或者是字体大小等属性都适用),默认值将只在预览视图中显示,且默认值不能包含引号

    android:text="@{userInfo.name,default=defaultValue}"
    

    此外,也可以通过 ActivityMainBinding 直接获取到指定 ID 的控件:

    dataBinding.mUserName.text = "lisi"
    
  • 自定义生成的绑定类的类名

    每个数据绑定布局文件都会生成一个绑定类,ViewDataBinding 的实例名是根据布局文件名来生成,采用驼峰命名法来命名,并省略布局文件名包含的下划线。控件的获取方式类似,但首字母小写。

    通过如下方式自定义 ViewDataBinding 的实例名

    <data class="CustomBinding"></data>
    
  • FragmentRecyclerView 中使用

    1. 在 Fragment 中的使用
    class BlankFragment : Fragment() {
    
        override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
            val blankFragmentBinding: BlankFragmentBinding =
                DataBindingUtil.inflate(inflater, R.layout.blank_fragment, container, false)
            return blankFragmentBinding.root
        }
    }
    
    1. 在RecyclerView中使用

      具体使用请参考:DataBinding 应用于RecyclerView

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerViewHolder {
            val itemMvvmBinding = DataBindingUtil.inflate<ViewDataBinding>(
                LayoutInflater.from(parent.context),
                R.layout.item_mvvm,
                parent,
                false
            )
            itemMvvmBinding.getRoot().setOnClickListener(this)
            return RecyclerViewHolder(itemMvvmBinding)
     }
    
    override fun onBindViewHolder(holder: RecyclerViewHolder, position: Int) {
            val itemMvvmBinding = holder.getBinding()
            val userBean = data.get(position)
            itemMvvmBinding.setUser(userBean)
            //将position保存在itemView的Tag中,以便点击时进行获取
            itemMvvmBinding.getRoot().setTag(position)
            itemMvvmBinding.btnUpdate.setOnClickListener(OnBtnClickListener(1, userBean))
            itemMvvmBinding.btnDelete.setOnClickListener(OnBtnClickListener(2, position))
            // 立刻执行绑定
            itemMvvmBinding.executePendingBindings()
    }
    

    以上实现数据绑定的方式,每当绑定的变量发生变化的时候,都需要重新向 ViewDataBinding 传递新的变量值才能刷新 UI 。接下来看如何实现自动刷新 UI

单向数据绑定

实现数据变化自动驱动 UI 刷新的方式有三种:BaseObservableObservableFieldObservableCollection

BaseObservable

一个简单的ViewModel 类被更新后,并不会让 UI 自动更新。而数据绑定后,我们自然会希望数据变更后 UI 会即时刷新,Observable 就是为此而生的概念。

BaseObservable 提供了 notifyChange()notifyPropertyChanged() 两个方法。

  • notifyChange()

它会刷新所有的值。

  • notifyPropertyChanged()

它只会根据对应的BRflag更新,该 BR 的生成通过注释 @Bindable 生成,可以通过 BR notify 特定属性关联的视图。

  • 由于kotlin的属性默认是public修饰,所以可以直接在属性上@Bindable, 如何设置了修饰符且不为public的话,则可使用@get BIndable(表示在get()方法上标记@Bindable
import androidx.databinding.BaseObservable
import androidx.databinding.Bindable
import com.github.ixiaow.sample.BR

class UserInfo : BaseObservable() {
    // 对name进行@Bindable标志,然后会生成BR.name
    @Bindable
    var name: String = ""
        set(value) {
            field = value
            // 当name,发生改变时只会刷新与name相关控件的值,不会刷新其他的值
            notifyPropertyChanged(BR.name)
        }

    @get: Bindable
    var password: String = ""
        set(value) {
            field = value
            // 当password 发生改变时,也会刷新其他属性相关的控件的值
            notifyChange()
        }
}

布局文件:

<?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="userInfo" type="com.github.ixiaow.sample.model.UserInfo"/>
    </data>
    <androidx.constraintlayout.widget.ConstraintLayout
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            tools:context=".MainActivity">

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

        <TextView
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="@{userInfo.password}"
                app:layout_constraintTop_toBottomOf="@id/mUserName"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"/>

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>
  1. OnPropertyChangedCallback

    实现了 Observable 接口的类允许注册一个监听器OnPropertyChangedCallback,当可观察对象的属性更改时就会通知这个监听器。

    当中 propertyId 就用于标识特定的字段

user.addOnPropertyChangedCallback(object : Observable.OnPropertyChangedCallback(){
     override fun onPropertyChanged(sender: Observable, propertyId: Int) {

     }
})

ObservableField

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

class ObservableUser {
    val name = ObservableField<String>()
    val password = ObservableField<String>()
}

ObservableUser属性值的改变都会立即触发 UI 刷新,概念上与Observable 区别不大,具体效果可看下面提供的源代码,这里不再赘述

ObservableCollection

dataBinding 也提供了包装类用于替代原生的 ListMap,分别是 ObservableListObservableMap,当其包含的数据发生变化时,绑定的视图也会随之进行刷新

<?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>
        <import type="androidx.databinding.ObservableList"/>
        <import type="androidx.databinding.ObservableMap"/>
        <import type="com.github.ixiaow.sample.model.User"/>
        <variable name="index" type="int"/>
        <variable name="key" type="String"/>
        <variable name="list" type="ObservableList<User>"/>
        <variable name="map" type="ObservableMap<String, User>"/>
    </data>
    <androidx.constraintlayout.widget.ConstraintLayout
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            tools:context=".MainActivity">

        <TextView
                app:layout_constraintVertical_chainStyle="spread"
                android:id="@+id/mUserName"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="@{list[index].name}"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"
                app:layout_constraintTop_toTopOf="parent"/>

        <TextView
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="@{map[key].password}"
                app:layout_constraintTop_toBottomOf="@id/mUserName"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"/>

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>
class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val dataBinding: ActivityMainBinding =
            DataBindingUtil.setContentView(this, R.layout.activity_main)

        dataBinding.map = ObservableArrayMap<String, User>().apply {
            "android" to User("android", "12367")
            "java" to User("java", "12534")
            "c" to User("c", "12344")
            "c++" to User("c++", "14423")
            "c#" to User("c#", "12334")
        }

        dataBinding.key = "c"

        dataBinding.list = ObservableArrayList<User>().apply {
            add(User("android", "123"))
            add(User("java", "1234"))
            add(User("c", "1235"))
            add(User("c++", "123447"))
        }

        dataBinding.index = 3
    }
}

双向数据绑定

双向绑定的意思即为当数据改变时同时使视图刷新,而视图改变时也可以同时改变数据

看以下例子,当 EditText的输入内容改变时,会同时同步到变量 user,绑定变量的方式比单向绑定多了一个等号:android:text="@={user.name}"

<?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="userInfo" type="com.github.ixiaow.sample.model.ObservableUser"/>
    </data>
    <androidx.constraintlayout.widget.ConstraintLayout
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            tools:context=".MainActivity">

        <EditText
                app:layout_constraintVertical_chainStyle="spread"
                android:id="@+id/mUserName"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="@={userInfo.name, default=`name`}"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"
                app:layout_constraintTop_toTopOf="parent"/>

        <EditText
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="@={userInfo.password, default=`1234`}"
                app:layout_constraintTop_toBottomOf="@id/mUserName"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"/>

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>
class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val dataBinding: ActivityMainBinding =
            DataBindingUtil.setContentView(this, R.layout.activity_main)
        val observableUser = ObservableUser()
        observableUser.name.set("我是name")
        observableUser.password.set("我是password")

        dataBinding.userInfo = observableUser
    }
}

事件绑定

严格意义上来说,事件绑定也是一种变量绑定,只不过设置的变量是回调接口而已。

事件绑定可用于以下多种回调事件:

  • android:onClick
  • android:onLongClick
  • android:afterTextChanged
  • android:onTextChanged
  • ...

新建一个 UserPresenter 类来声明 onClick()afterTextChanged() 事件相应的回调方法

class UserPresenter {

    fun onUserNameClick(user: ObservableUser) {

    }

    fun afterTextChanged(s: Editable) {
    }

    fun saveUser(view: View, user: ObservableUser){

    }
}
<?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>
        <import type="com.github.ixiaow.sample.UserPresenter"/>
        <variable name="presenter" type="UserPresenter"/>
        <variable name="userInfo" type="com.github.ixiaow.sample.model.ObservableUser"/>
    </data>
    <androidx.constraintlayout.widget.ConstraintLayout
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            tools:context=".MainActivity">

        <EditText
                app:layout_constraintVertical_chainStyle="spread"
                android:id="@+id/mUserName"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:onClick="@{()-> presenter.onUserNameClick(userInfo)}"
                android:text="@={userInfo.name, default=`name`}"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"
                app:layout_constraintTop_toTopOf="parent"/>

        <EditText
                android:id="@+id/mPassword"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:afterTextChanged="@{presenter::afterTextChanged}"
                android:text="@={userInfo.password, default=`1234`}"
                app:layout_constraintTop_toBottomOf="@id/mUserName"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"/>

        <EditText
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:onClick="@{(theView)->presenter.saveUser(theView, userInfo)}"
                android:text="@={userInfo.password, default=`1234`}"
                app:layout_constraintTop_toBottomOf="@id/mPassword"
                app:layout_constraintBottom_toBottomOf="parent"
                app:layout_constraintLeft_toLeftOf="parent"
                app:layout_constraintRight_toRightOf="parent"/>

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

方法引用的方式与调用函数的方式类似,

  1. 可以选择保持事件回调方法的签名一致:@{presenter.afterTextChanged},此时方法名可以不一样,但方法参数和返回值必须和原始的回调函数保持一致。
  2. 可以引用不遵循默认签名的函数:@{()->presenter.onUserNameClick(userInfo)},这里用到了 Lambda 表达式,这样就可以不遵循默认的方法签名,将userInfo对象直接传回点击方法中。此外,也可以使用方法引用 :: 的形式来进行事件绑定

使用类方法

首先定义一个静态方法

object StringUtils {

   fun toUpperCase( str:String):String {
        return str.toUpperCase();
   }
}

在 data 标签中导入该工具类

 <import type="com.github.ixiaow.sample.StringUtils" />

然后就可以像对待一般的函数一样来调用了

<TextView
   android:layout_width="match_parent"
   android:layout_height="wrap_content"
   android:onClick="@{()->userPresenter.onUserNameClick(userInfo)}"
   android:text="@{StringUtils.toUpperCase(userInfo.name)}" />

运算符

基础运算符

DataBinding 支持在布局文件中使用以下运算符、表达式和关键字

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

目前不支持以下操作

  • this
  • super
  • new
  • 显示泛型调用

此外,DataBinding 还支持以下几种形式的调用:

Null Coalescing

空合并运算符 ?? 会取第一个不为 null 的值作为返回值

<TextView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:text="@{user.name ?? user.password}" />

等价于

android:text="@{user.name != null ? user.name : user.password}"

属性控制

可以通过变量值来控制 View 的属性

<TextView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:text="可见性变化"
    android:visibility="@{user.male  ? View.VISIBLE : View.GONE}" />

避免空指针异常

DataBinding 也会自动帮助我们避免空指针异常
例如,如果 "@{userInfo.password}"userInfonull 的话,userInfo.password 会被赋值为默认值 null,而不会抛出空指针异常

include 和 viewStub

include

对于 include 的布局文件,一样是支持通过 dataBinding 来进行数据绑定,此时一样需要在待 include 的布局中依然使用 layout 标签,声明需要使用到的变量

view_include.xml

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <import type="com.github.ixiaow.databindingsample.model.User" />
        <variable
            name="userInfo"
            type="User" />
    </data>
    <android.support.constraint.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:background="#acc">

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="20dp"
            android:text="@{userInfo.name}" />
    </android.support.constraint.ConstraintLayout>
</layout>

在主布局文件中将相应的变量传递给 include 布局,从而使两个布局文件之间共享同一个变量

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:bind="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    <data>
        <import type="com.github.ixiaow.databindingsample.model.User" />
        <variable
            name="userInfo"
            type="User" />
    </data>
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".Main6Activity">
        <include
            layout="@layout/view_include"
            bind:userInfo="@{userInfo}" />
    </LinearLayout>
</layout>

viewStub

dataBinding 一样支持 ViewStub 布局

在布局文件中引用 viewStub 布局

<ViewStub
    android:id="@+id/view_stub"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout="@layout/view_stub"/>

获取到 ViewStub 对象,由此就可以来控制 ViewStub 的可见性

ActivityMain6Binding activityMain6Binding = DataBindingUtil.setContentView(this, R.layout.activity_main6);
View view = activityMain6Binding.viewStub.getViewStub().inflate();

如果需要为 ViewStub 绑定变量值,则 ViewStub 文件一样要使用 layout 标签进行布局,主布局文件使用自定义的 bind 命名空间将变量传递给 ViewStub

<ViewStub
    android:id="@+id/view_stub"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout="@layout/view_stub"
    bind:userInfo="@{userInfo}" />

如果在 xml 中没有使用 bind:userInfo="@{userInf}"对 ViewStub 进行数据绑定,则可以等到当 ViewStub Inflate 时再绑定变量,此时需要为 ViewStub 设置 setOnInflateListener回调函数,在回调函数中进行数据绑定

activityMain6Binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
    @Override
    public void onInflate(ViewStub stub, View inflated) {
        //如果在 xml 中没有使用 bind:userInfo="@{userInf}" 对 viewStub 进行数据绑定
        //那么可以在此处进行手动绑定
        ViewStubBinding viewStubBinding = DataBindingUtil.bind(inflated);
        viewStubBinding.setUserInfo(user);
        Log.e(TAG, "onInflate");
    }
});

BindingAdapter

dataBinding 提供了 BindingAdapter 这个注解用于支持自定义属性,或者是修改原有属性。注解值可以是已有的 xml 属性,例如 android:srcandroid:text等,也可以自定义属性然后在 xml 中使用

例如,对于一个 ImageView ,我们希望在某个变量值发生变化时,可以动态改变显示的图片,此时就可以通过 BindingAdapter 来实现

需要先定义一个静态方法,为之添加 BindingAdapter 注解,注解值是为 ImageView 控件自定义的属性名,而该静态方法的两个参数可以这样来理解:当 ImageView 控件的 url 属性值发生变化时,dataBinding 就会将 ImageView 实例以及新的 url 值传递给 loadImage() 方法,从而可以在此动态改变 ImageView 的相关属性

@BindingAdapter({"url"})
public static void loadImage(ImageView view, String url) {
    Log.d(TAG, "loadImage url : " + url);
}

在 xml 文件中关联变量值,当中,bind 这个名称可以自定义

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

    <data>
        <import type="com.github.ixiaow.databindingsample.model.Image" />
        <variable
            name="image"
            type="Image" />
    </data>

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

        <ImageView
            android:id="@+id/image"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:src="@drawable/ic_launcher_background"
            bind:url="@{image.url}" />
    </android.support.constraint.ConstraintLayout>
</layout>

BindingAdapter 更为强大的一点是可以覆盖 Android 原先的控件属性。例如,可以设定每一个 Button 的文本都要加上后缀:“-Button”

@BindingAdapter("android:text")
public static void setText(Button view, String text) {
    view.setText(text + "-Button");
}
<Button
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:onClick="@{()->handler.onClick(image)}"
    android:text='@{"改变图片Url"}'/>

这样,整个工程中使用到了 "android:text" 这个属性的控件,其显示的文本就会多出一个后缀

BindingConversion

dataBinding 还支持对数据进行转换,或者进行类型转换

与 BindingAdapter 类似,以下方法会将布局文件中所有以@{String}方式引用到的String类型变量加上后缀-conversionString

@BindingConversion
public static String conversionString(String text) {
    return text + "-conversionString";
}

xml 文件

<TextView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:text='@{"xxx"}'
    android:textAllCaps="false"/>

可以看到,对于 Button 来说,BindingAdapter 和 BindingConversion 同时生效了,而 BindingConversion 的优先级要高些, 此外,BindingConversion 也可以用于转换属性值的类型

看以下布局,此处在向 backgroundtextColor 两个属性赋值时,直接就使用了字符串,按正常情况来说这自然是会报错的,但有了 BindingConversion 后就可以自动将字符串类型的值转为需要的 DrawableColor

<TextView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:background='@{"红色"}'
    android:padding="20dp"
    android:text="红色背景蓝色字"
    android:textColor='@{"蓝色"}'/>

<TextView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_marginTop="20dp"
    android:background='@{"蓝色"}'
    android:padding="20dp"
    android:text="蓝色背景红色字"
    android:textColor='@{"红色"}'/>
@BindingConversion
public static Drawable convertStringToDrawable(String str) {
    if (str.equals("红色")) {
        return new ColorDrawable(Color.parseColor("#FF4081"));
    }

    if (str.equals("蓝色")) {
        return new ColorDrawable(Color.parseColor("#3F51B5"));
    }
    return new ColorDrawable(Color.parseColor("#344567"));
}

@BindingConversion
public static int convertStringToColor(String str) {
    if (str.equals("红色")) {
        return Color.parseColor("#FF4081");
    }

    if (str.equals("蓝色")) {
        return Color.parseColor("#3F51B5");
    }
    return Color.parseColor("#344567");
}

Array、List、Set、Map ...

dataBinding 也支持在布局文件中使用 数组、Lsit、Set 和 Map,且在布局文件中都可以通过 list[index] 的形式来获取元素

而为了和 variable 标签的尖括号区分开,在声明 Lsit< String > 之类的数据类型时,需要使用尖括号的转义字符

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

    <data>
        <import type="java.util.List" />
        <import type="java.util.Map" />
        <import type="java.util.Set" />
        <import type="android.util.SparseArray" />
        <variable
            name="array"
            type="String[]" />

        <variable
            name="list"
            type="List<String>" />

        <variable
            name="map"
            type="Map<String, String>" />

        <variable
            name="set"
            type="Set<String>" />

        <variable
            name="sparse"
            type="SparseArray<String>" />

        <variable
            name="index"
            type="int" />

        <variable
            name="key"
            type="String" />
    </data>

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

        <TextView
            ···
            android:text="@{array[1]}" />

        <TextView
            ···
            android:text="@{sparse[index]}" />

        <TextView
            ···
            android:text="@{list[index]}" />

        <TextView
            ···
            android:text="@{map[key]}" />

        <TextView
            ···
            android:text='@{map["leavesC"]}' />

        <TextView
            ···
            android:text='@{set.contains("xxx")?"xxx":key}' />
    </LinearLayout>
</layout>

资源引用

dataBinding 支持对尺寸和字符串这类资源的访问

dimens.xml

<dimen name="paddingBig">190dp</dimen>
<dimen name="paddingSmall">150dp</dimen>

string.xml

<string name="format">%s is %s</string>

layout.xml

<data>
    <variable
       name="flag"
       type="boolean" />
</data> 

<Button
      android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:paddingLeft="@{flag ? @dimen/paddingBig:@dimen/paddingSmall}"
    android:text='@{@string/format("leavesC", "Ye")}'
    android:textAllCaps="false" />