阅读 16226

DataBinding最全使用说明

Google创建的数据绑定框架, 实现了类似于前端框架中MVVM架构.

DataBinding会自动在build目录下生成类. 因为被集成进AndroidStudio所以不需要你手动编译会实时编译, 并且支持大部分代码补全.

本文2019修改基于Kotlin

启用DataBinding

apply plugin: "kotlin-kapt"

android{
  /.../
      dataBinding {
        enabled = true;
    }
}
复制代码

因为怕你们没注意到我写在文章开头

  • Databinding不是替代ButterKnife之类的 FindByID只是他的一个小小的辅助功能而已, 我推荐使用Kotlin自带的.
  • Databinding的错误提示功能已经算是很全面了
  • 我想强调的是XML中的@{} 只做赋值或者简单的三元运算或者判空等不要做复杂运算, 否则违背解耦原则.
  • Model中进行逻辑和转换运算
  • Databinding生成类即MVVM中的ViewModel , 但是有时候你可以根据场景再创建一个类用于做ViewModel. 例如继承自JetPack中的ViewModel的一个类来实现数据持久化. 或者某些UI操作你觉得应该抽出也可以放到这个ViewModel中.

DataBinding是Android上MVVM实现最强大的是毋庸置疑, 我认为也是JetPack的核心, 只会更方便(抛弃MVP吧).

鉴于文章篇幅, 后面我将会出一篇文章以及开源库告诉大家如何实现DataBinding是如何让RecyclerView一行代码写通用适配器(无需写实现类)

一行代码实现多类型/添加头布局脚布局/点击事件;

布局

布局文件

<layout>
  
    <data>
        <variable
            name="user"
            type="com.liangjingkanji.databinding.pojo.UserBean"/>
    </data>

    <RelativeLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context="com.liangjingkanji.databinding.MainActivity">

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.userName}"
            />
        
    </RelativeLayout>
  
</layout>
复制代码

layout

布局根节点必须是<layout> . 同时layout只能包含一个View标签. 不能直接包含<merge>

data

<data>标签的内容即DataBinding的数据. data标签只能存在一个.

variable

通过<variable>标签可以指定类, 然后在控件的属性值中就可以使用

<data>
	<variable name="user" type="com.liangfeizc.databindingsamples.basic.User" />
</data>
复制代码

通过DataBinding的setxx()方法可以给Variable设置数据. name值不能包含_下划线

import

第二种写法(导入), 默认导入了java/lang包下的类(String/Integer). 可以直接使用被导入的类的静态方法.

<data>
  <!--导入类-->
    <import type="com.liangfeizc.databindingsamples.basic.User" />
  <!--因为User已经导入, 所以可以简写类名-->
    <variable name="user" type="User" />
</data>
复制代码

使用类

<TextView
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"
          android:text="@{user.userName}"
          />
<!--user就是在Variable标签中的name, 可以随意自定义, 然后就会使用type中的类-->
复制代码

Tip: user代表UserBean这个类, 可以使用UserBean中的方法以及成员变量. 如果是getxx()会自动识别为xx. 注意不能使用字符串android, 否则会报错无法绑定.

class

<data>标签有个属性<class>可以自定义DataBinding生成的类名以及路径

<!--自定义类名-->
<data class="CustomDataBinding"></data>

<!--自定义生成路径以及类型-->
<data class=".CustomDataBinding"></data> <!--自动在包名下生成包以及类-->
复制代码

Tip:注意没有代码自动补全. 自定义路径Module/build/generated/source/apt/debug/databinding/目录下, 基本上不需要自定义路径

默认:

public class MainActivity extends AppCompatActivity {

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // ActivityMainBinding这个类根据布局文件名生成(id+Binding)
    ActivityMainBinding viewDataBinding = DataBindingUtil.setContentView(this, R.layout.activity_main);

    UserBean userBean = new UserBean();
    userBean.setUserName("姜涛");

    // setUser这个方法根据Variable标签的name属性自动生成
    viewDataBinding.setUser(userBean);
  }
}
复制代码

alias

<variable>标签如果需要导入(import)两个同名的类时可以使用alias属性(别名属性)

<import type="com.example.home.data.User" />
<import type="com.examle.detail.data.User" alias="DetailUser" />
<variable name="user" type="DetailUser" />
复制代码

include

在include其他布局的时候可能需要传递变量(variable)值过去

<variable
          name="userName"
          type="String"/>

....

<include
         layout="@layout/include_demo"
         bind:userName="@{userName}"/>
复制代码

include_demo

    <data>

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

...

android:text="@{userName}"
复制代码

两个布局通过includebind:<变量名>值来传递. 而且两者必须有同一个变量

DataBinding不支持merge标签

自动布局属性

DataBinding对于自定义属性支持非常好, 只要View中包含setter方法就可以直接在布局中使用该属性(这是因为DataBinding的库中官方已经帮你写好了很多自定义属性)

public void setCustomName(@NonNull final String customName) {
    mLastName.setText("吴彦祖");
  }
复制代码

然后直接使用(但是IDE没有代码补全)

app:customName="@{@string/wuyanzu}"
复制代码

但是setter方法只支持单个参数. app:这个命名空间可以随意

数据双向绑定

数据刷新视图

BaseObservable

如果需要数据变化是视图也跟着变化则需要使用到以下两种方法

有两种方式:

  1. 继承BaseObservable

    public class ObservableUser extends BaseObservable {
        private String firstName;
        private String lastName;
    
        @Bindable
        public String getFirstName() {
            return firstName;
        }
    
      // 注解才会自动在build目录BR类中生成entry, 要求方法名必须以get开头
        @Bindable
        public String getLastName() {
            return lastName;
        }
    
        public void setFirstName(String firstName) {
            this.firstName = firstName;
            notifyPropertyChanged(BR.firstName);
        }
    
        public void setLastName(String lastName) {
            this.lastName = lastName;
            notifyPropertyChanged(BR.lastName); // 需要手动刷新
        }
    }
    复制代码

还可以监听属性改变事件

ObservableUser.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {
  @Override
  public void onPropertyChanged(Observable observable, int i) {

  }
});
复制代码

属性第一次改变时会回调两次, 之后都只回调一次. 如果使用notifyChange()不会得到id(即i等于0). 使用

notifyPropertyChanged(i)就可以在回调里面得到id.

BaseObservable和Observable的区别:

  1. BaseObservable是实现了Observable的类, 帮我们实现了监听器的线程安全问题.
  2. BaseObservable使用了PropertyChangeRegistry来执行OnPropertyChangedCallback
  3. 所以我不推荐你直接实现Observable.

ObservableField

databinding默认实现了一系列实现Observable接口的字段类型

BaseObservable,
ObservableBoolean,
ObservableByte,
ObservableChar,
ObservableDouble,
ObservableField<T>,
ObservableFloat,
ObservableInt,
ObservableLong,
ObservableParcelable<T extends Parcelable>,
ObservableShort,
ViewDataBinding
复制代码

示例

public class PlainUser {
  public final ObservableField<String> firstName = new ObservableField<>();
  public final ObservableField<String> lastName = new ObservableField<>();
  public final ObservableInt age = new ObservableInt();
}
复制代码

对于集合数据类型ObservableArrayMap/ObservableArrayLis/ObjservableMap等集合数据类型

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
user.put("age", 17);
复制代码

使用

<data>
    <import type="android.databinding.ObservableMap"/>
    <variable name="user" type="ObservableMap<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"/>
复制代码

Tip:

  1. 还支持ObservableParcelable<Object>序列化数据类型
  2. 上面说的这两种只会视图跟随数据更新, 数据并不会跟随视图刷新.
  3. ObservableField同样支持addOnPropertyChangedCallback监听属性改变

如果数据为LiveData同样支持, 并且ViewDataBinding可以设置生命周期.

视图刷新数据

通过表达式使用@=表达式就可以视图刷新的时候自动更新数据, 但是要求数据实现以下两种方式修改才会触发刷新

<EditText
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:inputType="textNoSuggestions"
    android:text="@={model.name}"/>
复制代码

这种双向绑定存在一个很大的问题就是会死循环. 数据变化(回调监听器)触发视图变化, 然后视图又会触发数据变化(再次回调监听器), 然后一直循环, 设置相同的数据也视为数据变化.

所以我们需要判断当前变化的数据是否等同于旧数据

public class CustomBindingAdapter {

  @BindingAdapter("android:text") public static void setText(TextView view, CharSequence text) {
    CharSequence oldText = view.getText();

    if (!haveContentsChanged(text, oldText)) {
      return; // 数据没有变化不进行刷新视图
    }
    view.setText(text);
  }


  // 本工具类截取自官方源码
  private static boolean haveContentsChanged(CharSequence str1, CharSequence str2) {
    if ((str1 == null) != (str2 == null)) {
      return true;
    } else if (str1 == null) {
      return false;
    }
    final int length = str1.length();
    if (length != str2.length()) {
      return true;
    }
    for (int i = 0; i < length; i++) {
      if (str1.charAt(i) != str2.charAt(i)) {
        return true;
      }
    }
    return false;
  }
}
复制代码

Tip:

  1. 根据我上面说的, 监听器至少回调两次(数据->视图, 视图-> 数据)

  2. 以下这种是无效的, 因为String参数传递属于引用类型变量并不是常量, 需要用equals()

    // 本段截取官方源码, 我也不知道这sb为什么这么写
    if (text == oldText || (text == null && oldText.length() == 0)) {
      return; 
    }
    
    /**/
    复制代码

    正确

    if (text == null || text.equals(oldText) || oldText.length() == 0) {
      return;
    }
    复制代码

总结就是如果没有默认实行的控件属性使用双向数据绑定 就需要你自己实现BindingAdapter注解

注解

@Bindable

用于数据更新自动刷新视图. 后面的数据绑定提到.

@BindingAdapter

创建一个XML属性和函数, 然后在属性中进行设置数据操作会进入该函数.

图片加载框架可以方便使用此方法.

@BindingAdapter(value = { "imageUrl", "error" }, requireAll = false)
  public static void loadImage(ImageView view, String url, Drawable error) {
    Glide.with(view.getContext()).load(url).into(view);
  }
复制代码
  1. 修饰方法, 要求方法必须public static
  2. 第一个参数必须是控件或其父类
  3. 方法名随意
  4. 最后这个boolean类型是可选参数. 可以要求是否所有参数都需要填写. 默认true.
  5. 如果requireAll为false, 你没有填写的属性值将为null. 所以需要做非空判断.

使用:

<ImageView
           android:layout_width="match_parent"
           android:layout_height="200dp"
           app:error="@{@drawable/error}"
           wuyanzu:imageUrl="@{imageUrl}"
           app:onClickListener="@{activity.avatarClickListener}"
           />
复制代码

可以看到命名空间可以随意, 但是如果在BindingAdapter的数组内你定义了命名空间就必须完全遵守

例如:

// 这里省略了一个注解参数.   
@BindingAdapter({ "android:imageUrl", "error" })
  public static void loadImage(ImageView view, String url, Drawable error) {
    if(url == null) return;
    Glide.with(view.getContext()).load(url).into(view);
  }
复制代码

Tip: 如果你的数据初始化是在异步的. 会回调方法但是数据为null(成员默认值). 所以我们必须要首先进行判空处理.

Kotlin实现有两种方法

单例类+@JvmStatic注解

object ProgressAdapter {

    @JvmStatic
    @BindingAdapter("android:bindName")
    fun setBindName(view: View, name:String){

    }
}
复制代码

顶级函数

@BindingAdapter("android:bindName")
fun setBindName(view: View, name:String){

}

// 由于顶级函数太多影响代码补全建议使用顶级扩展函数, 之后也可以在代码中方便使用

@BindingAdapter("android:bindName")
fun View.setBindName( name:String){
   
}
复制代码

@BindingMethods

如果你想创建一个XML属性并且和View中的函数关联(即会自动使用属性值作为参数调用该函数). 就应该使用@BindingMethods注解一个类(该类无限制甚至可以是一个接口).

如果说@BindingAdapter是创建一个新的函数功能给控件使用, 那么BindingMethod就是引导DataBinding使用控件自身的函数.

该注解属于一个容器. 内部参数是一个@BindingMethod数组, 只能用于修饰类;

任意类或接口, 不需要覆写任何函数

官方示例:

@BindingMethods({
        @BindingMethod(type = android.widget.ProgressBar.class, attribute = "android:indeterminateTint", method = "setIndeterminateTintList"),
        @BindingMethod(type = android.widget.ProgressBar.class, attribute = "android:progressTint", method = "setProgressTintList"),
        @BindingMethod(type = android.widget.ProgressBar.class, attribute = "android:secondaryProgressTint", method = "setSecondaryProgressTintList"),
})
public class ProgressBarBindingAdapter {
}
复制代码

@BindingMethod

注解参数(必选)

  1. type: 字节码 即你的控件类
  2. attribute: XML属性
  3. method: 函数名 即控件中的函数名称

注意

  • 如果属性名和@BindingAdapter定义的XML属性相同会冲突报错
  • 如果控件类中已经存在一个和你定义的属性相关联的函数(例setName函数和android:name属性就相关联)则会优先执行该函数

@BindingConversion

属性值自动进行类型转换

  1. 只能修饰public static方法.
  2. 任意位置任意方法名都不限制
  3. DataBinding自动匹配被该注解修饰的方法和匹配参数类型
  4. 返回值类型必须和属性setter方法匹配, 且参数只能有一个
  5. 要求属性值必须是@{}DataBinding表达式

官方示例:

public class Converters {
    @BindingConversion
    public static ColorDrawable convertColorToDrawable(int color) {
        return new ColorDrawable(color);
    }
    @BindingConversion
    public static ColorStateList convertColorToColorStateList(int color) {
        return ColorStateList.valueOf(color);
    }
}
复制代码

我写的Kotlin示例

@BindingConversion
fun int2string(integer:Int):String{
    Log.d("日志", "(CusView.kt:92) int2string ___ integer = [$integer]")

    return integer.toString()
}
复制代码

XML

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

    <data>

        <variable
            name="m"
            type="com.example.architecture.Model" />

    </data>

    <FrameLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">


       <com.example.architecture.CusView
           android:bindName="@={m.age}"
           android:layout_width="wrap_content"
           android:layout_height="wrap_content" />


    </FrameLayout>

</layout>
复制代码

我这代码实际上会报错, 因为涉及到双向数据绑定, @BindingConversion只会在数据设置视图的时候生效. 但是如果是视图设置数据则会走其他函数(get), 如果该函数返回的类型和Model中的类型不匹配则会报异常, 除非你将那个函数改为类型匹配的.

或者去掉=符号不使用双向数据绑定

android:text不能使用int转为string, 因为他本身能正常接收int(作为resourceID). 然后会报

android.content.res.Resources$NotFoundException: String resource ID #0xa
复制代码

@InverseMethod

在android studio3.0提供的inverse系列的新注解, 全部都是针对数据双向绑定.

在数据和视图的数据不统一时可以使用该注解@InverseMethod解决数据转换的问题

例如数据模型存储用户的id但是视图不显示id而是显示用户名(数据和视图的类型不一致), 我们就需要在两者之间转换.

我们需要两个函数: 设置数据到视图的函数 称为set / 设置视图变更到数据的函数 称为get

  • set和get都至少要有一个参数
  • 自身参数必须和另一个函数的返回值对应(不然怎么叫转换)

简单示例:

在用户id和用户名之间转换. 存储id但是显示的时候显示用户名

class Model {
  
  var name = "设计师"
  
   @InverseMethod("ui2data")
    fun data2ui():String{

        return "设计师金城武"
    }

    fun ui2data():String{

        return "设计师吴彦祖"
    }
}
复制代码

使用

<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="m"
            type="com.example.architecture.Model" />

    </data>

    <FrameLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">


       <com.example.architecture.CusView
           android:text="@{m.data2ui(m.name)}"
           android:layout_width="wrap_content"
           android:layout_height="wrap_content" />


    </FrameLayout>

</layout>
复制代码

@InverseBindingAdapter

参数:

  • String attribute 属性值(必填)
  • String event 非必填, 默认值 属性值 + AttrChanged后缀

他和@BindingAdapter配合实现双向数据绑定

完全的双向数据绑定需要三个函数

  1. set (数据到视图)
  2. get (视图到数据)
  3. notify (通知Databinding视图已经刷新可以更新数据(Model)了)

set函数之前已经写过了

@BindingAdapter("android:bindName")
fun TextView.setBindName(name:String?){
    if (name.isNullOrEmpty() && name != text) {
        text = name
    }
}
复制代码

get函数

@InverseBindingAdapter(attribute = "android:bindName", event = "cus_event")
fun TextView.getBindName():String{

	// 这里你可以对视图上的数据进行处理最终设置给Model层

    return text.toString()
}
复制代码
  • 不允许存在更多参数
  • 返回值类型必须是绑定的数据类型

notify 视图变化后要通知Databinding开始设置Model层, 同样要用到@BindingAdapter

@BindingAdapter("cus_event")
fun TextView.notifyBindName( inverseBindingListener: InverseBindingListener){

  // 这个函数是监听TextWatch 官方源码 不是我写的
   doAfterTextChanged {
       inverseBindingListener.onChange() 
   }

}
复制代码
  • 不允许存在更多参数

InverseBindingListener 是个接口只有一个函数, 他是notify函数必要的参数.

public interface InverseBindingListener {
    /**
     * Notifies the data binding system that the attribute value has changed.
     */
    void onChange();
}
复制代码

@InverseBindingMethods

@BindingMethods相似, 但是@InverseBindingMethods是视图变更数据(get函数), 而BindingMethods是数据到视图(set函数)

参数

public @interface InverseBindingMethod {

    /**
     * 控件的类字节码
     */
    Class type();

    /**
     * 自定义的属性
     */
    String attribute();

    /**
     * nitify函数的名称 即用于通知数据更新的函数
     */
    String event() default "";

    /**
     * 控件自身的函数名称, 如果省略即自动生成为 {attribute}AttrChange
     */
    String method() default "";
}
复制代码

如果说BindingMethods是关联setter方法和自定义属性, 那么InverseBindingMethods就是关联getter方法和自定义属性;

setter是更新视图的时候使用, 而getter方法是更新数据时候使用的

@BindingMethods要多一个函数即notify函数用于通知更新

@BindingAdapter("cus_event")
fun TextView.notifyBindName( inverseBindingListener: InverseBindingListener){

   doAfterTextChanged {
       inverseBindingListener.onChange()
   }

}
复制代码

示例:

@InverseBindingMethods(
    InverseBindingMethod(
        type = CusView::class,
        attribute = "android:bindName",
        method = "getName", event = "cus_event"
    )
)
object Adapter {

}
复制代码

查看下生成类中的视图更新数据的实现源码

    private android.databinding.InverseBindingListener ivandroidTextAttr = new android.databinding.InverseBindingListener() {
        @Override
        public void onChange() {
            // Inverse of data.name
            //         is data.setName((java.lang.String) callbackArg_0)
            java.lang.String callbackArg_0 = com.liangjingkanji.databinding.MyInverseBindingAdapter.getTextString(iv);  // 拿到变化的属性
            // localize variables for thread safety
            // data != null
            boolean dataJavaLangObjectNull = false;
            // data.name
            java.lang.String dataName = null;
            // data
            com.liangjingkanji.databinding.Bean data = mData; // 拿到数据



            dataJavaLangObjectNull = (data) != (null);
            if (dataJavaLangObjectNull) {




                data.setName(((java.lang.String) (callbackArg_0))); // 存储到数据
            }
        }
    };
复制代码

所以如果你没用重写Inverse的数据变更方法将无法让视图通知数据刷新.

// 该方法会在绑定布局的时候回调
    @Override
    protected void executeBindings() {
        long dirtyFlags = 0;
        synchronized(this) {
            dirtyFlags = mDirtyFlags;
            mDirtyFlags = 0;
        }
        java.lang.String dataName = null;
        com.liangjingkanji.databinding.Bean data = mData;

        if ((dirtyFlags & 0x1aL) != 0) {



                if (data != null) {
                    // read data.name
                    dataName = data.getName();
                }
        }
        // batch finished
        if ((dirtyFlags & 0x1aL) != 0) {
            // api target 1

            com.liangjingkanji.databinding.MyInverseBindingAdapter.setText(this.iv, dataName);
        }
        if ((dirtyFlags & 0x10L) != 0) {
            // api target 1

          // 重点是这段代码, 将上面创建的监听器传入setTextWatcher方法
            com.liangjingkanji.databinding.MyInverseBindingAdapter.setTextWatcher(this.iv, (com.liangjingkanji.databinding.MyInverseBindingAdapter.BeforeTextChanged)null, (com.liangjingkanji.databinding.MyInverseBindingAdapter.OnTextChanged)null, (com.liangjingkanji.databinding.MyInverseBindingAdapter.AfterTextChanged)null, ivandroidTextAttr);
        }
    }
复制代码

总结

@BindingBuildInfo@Untaggable这两个注解是DataBinding自动生成Java类时使用的.

  • Bindable

    设置数据刷新视图. 自动生成BR的ID

  • BindingAdapter

    设置自定义属性. 可以覆盖系统原有属性

  • BindingMethod/BindingMethods

    关联自定义属性到控件原有的setter方法

  • BindingConversion

    如果属性不能匹配类型参数将自动根据类型参数匹配到该注解修饰的方法来转换

  • InverseMethod

    负责实现视图和数据之间的转换

  • InverseBindingAdapter

    视图通知数据刷新的

  • InverseBindingMethod/InverseBindingMethods

    视图通知数据刷新的(如果存在已有getter方法可用的情况下)

  • BindingMethods系优先级高于BindingAdapter系列

  • 所有注解的功能都是基于XML属性值为Databinding表达式才生效(即@{})

建议参考官方实现源码:

DataBindingAdapter

表达式

@{}里面除了可以执行方法以外还可以写表达式, 并且支持一些特有表达式

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

避免空指针

variable的值即使设置null或者没有设置也不会出现空指针异常.

这是因为官方已经用DataBinding的@BindingAdapter注解重写了很多属性. 并且里面进行了判空处理.

<variable
	name="userName"
	type="String"/>

.....

android:text="@{userName}"
复制代码

不会出现空指针异常.

dataBinding.setUserName(null);
复制代码

并且还支持特有的非空多元表达式

android:text="@{user.displayName ?? user.lastName}"
复制代码

就等价于

android:text="@{user.displayName != null ? user.displayName : user.lastName}"
复制代码

还是需要注意数组越界的

集合

集合不属于java.lang*下, 需要导入全路径.

<variable
          name="list"
          type="java.util.List&lt;String&gt;"/>

<variable
          name="map"
          type="java.util.Map<String, String>"/>
复制代码

上面这种写法会报错

Error:与元素类型 "variable" 相关联的 "type" 属性值不能包含 '<' 字符。
复制代码

因为<符号需要转义.

常用转义字符

空格 &nbsp; &#160;

< 小于号 &lt; &#60;

> 大于号 &gt; &#62;

& 与号 &amp; &#38; " 引号 &quot; &#34; ‘ 撇号 &apos; &#39; × 乘号 &times; &#215; ÷ 除号 &divide; &#247;

正确写法

<variable
          name="list"
          type="java.util.List&lt;String&gt;"/>

<variable
          name="map"
          type="java.util.Map&lt;String, String&gt;"/>
复制代码

集合和数组都可以用[]来得到元素

android:text="@{map["firstName"]}"
复制代码

字符串

如果想要在@{}中使用字符串, 可以使用三种方式

第一种:

android:text='@{"吴彦祖"}'
复制代码

第二种:

android:text="@{`吴彦祖`}"
复制代码

第三种:

android:text="@{@string/user_name}"
复制代码

同样支持@color或@drawable

格式化字符串

首先在strings中定义<string>

<string name="string_format">名字: %s  性别: %s</string>
复制代码

然后就可以使用DataBinding表达式

android:text="@{@string/string_format(`吴彦祖`, `男`)}"
复制代码

输出内容:

名字: 吴彦祖 性别: 男
复制代码

默认值

如果Variable还没有复制就会使用默认值显示.

android:text="@{user.integral, default=`30`}"
复制代码

上下文

DataBinding本身提供了一个名为context的Variable. 可以直接使用. 等同于View的getContext().

android:text="@{context.getApplicationInfo().toString()}"
复制代码

引用其他控件

          <TextView
              android:id="@+id/datingName"
              android:layout_width="wrap_content"
              android:layout_height="wrap_content"
              android:layout_centerVertical="true"
              android:layout_marginLeft="8dp"
              android:layout_toRightOf="@id/iv_dating"
              android:text="活动"
              />

/...
<TextView
              android:layout_width="wrap_content"
              android:layout_height="wrap_content"
              android:layout_centerVertical="true"
              android:layout_marginLeft="8dp"
              android:layout_toRightOf="@id/iv_order"
              android:text="@{datingName.text}"
              />
复制代码

引用包含_的控件id是可以直接忽略该符号. 例如tv_name直接写tvName.

谢谢 lambda 指出错误

不论顺序都可以引用

使用Class

如果想用Class作为参数传递, 那么该Class不能直接通过静态导入来使用. 需要作为字段常量来使用

事件绑定

事件绑定分为两种:

  1. 方法引用
  2. 监听绑定

对于默认的事件需要书写同样的参数的方法才能接受到, 否则报错. 例如onClick()方法必须有View参数.

方法引用

public class MyHandlers {
  // 注意必须要传View参数
    public void onClickFriend(View view) { ... }
}
复制代码

直接通过View的属性来调用类方法

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
  <data>
    <variable
              name="activity"
              type="com.liangjingkanji.databinding.MainActivity"/>
  </data>
  
  <LinearLayout
                android:orientation="vertical"
                android:layout_width="match_parent"
                android:layout_height="match_parent">
    
    <TextView android:layout_width="wrap_content"
              android:layout_height="wrap_content"
              android:text="@{user.firstName}"
              android:onClick="@{activit::click}"/>
    
  </LinearLayout>
</layout>
复制代码

Tip: activity.clickactivity::click都属于方法调用, 但是如果是activity.click()就会报错. 因为对于默认事件需要统一参数. 必须加上activity.click(View v)

监听绑定

上面提到的都不能向回调里面传递自定义参数. 而如果使用

android:onClick="@{()->activity.click(text)}"
复制代码

就可以自定义回调参数了

ActivityMainBinding dataBinding = DataBindingUtil.setContentView(this, R.layout.activity_main); 

dataBinding.setActivity(this);
dataBinding.setText("吴彦祖"); // 顺序无所谓
复制代码

然后在布局文件中使用Lambda

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
  <data>
    <variable
              name="text"
              type="String"/>

    <variable
              name="activity"
              type="com.liangjingkanji.databinding.MainActivity"/>
  </data>
  <LinearLayout 
                android:layout_width="match_parent" 						    
                android:layout_height="match_parent">
    <Button 
            android:layout_width="wrap_content" 									        android:layout_height="wrap_content"
            android:onClick="@{()->activity.click(text)}" />
  </LinearLayout>
</layout>
复制代码

DataBinding组件

ViewDataBinding

自动生成的DataBinding类都继承自该类. 所以都拥有该类的方法

void	addOnRebindCallback(OnRebindCallback listener)
// 添加绑定监听器, 可以在Variable被设置的时候回调

void	removeOnRebindCallback(OnRebindCallback listener)
// 删除绑定监听器

View	getRoot()
// 返回被绑定的视图对象
  
abstract void	invalidateAll()
// 使所有的表达式无效并且立刻重新设置表达式. 会重新触发OnRebindCallback回调(可以看做重置)


abstract boolean	setVariable(int variableId, Object value)
// 可以根据字段id来设置变量

void	unbind()
// 解绑布局, ui不会根据数据来变化, 但是监听器还是会触发的
复制代码

这里有三个方法需要重点讲解:

abstract boolean	hasPendingBindings()
// 当ui需要根据当前数据变化时就会返回true(数据变化后有一瞬间)

void	executePendingBindings()
// 强制ui立刻刷新数据, 
复制代码

当你改变了数据以后(在你设置了Observable观察器的情况下)会马上刷新ui, 但是会在下一帧才会刷新UI, 存在一定的延迟时间. 在这段时间内hasPendingBindings()会返回true. 如果想要同步(或者说立刻)刷新UI可以马上调用executePendingBindings().

OnRebindCallback:

该监听器可以监听到布局绑定的生命周期

    mDataBinding.addOnRebindCallback(new OnRebindCallback() {
      /**
       * 绑定之前
       * @param binding
       * @return 如果返回true就会绑定布局, 返回false则取消绑定
       */
      @Override public boolean onPreBind(ViewDataBinding binding) {
        return false;
      }

      /**
       * 如果取消绑定则回调该方法(取决于onPreBind的返回值)
       * @param binding
       */
      @Override public void onCanceled(ViewDataBinding binding) {
        super.onCanceled(binding);
      }

      /**
       * 绑定完成
       * @param binding
       */
      @Override public void onBound(ViewDataBinding binding) {
        super.onBound(binding);
      }
    });
复制代码

DataBinding也有个数据变更监听器, 可以监听Variable的设置事件

mDataBinding.addOnPropertyChangedCallback(new Observable.OnPropertyChangedCallback() {

  /**
       * 会在DataBinding设置数据的时候回调
       * @param sender DataBinding生成的类
       * @param propertyId Variable的id
       */
  @Override public void onPropertyChanged(Observable sender, int propertyId) {
    ActivityMainBinding databinding = (ActivityMainBinding) sender;
    switch (propertyId) {
      case BR.data:
        Log.d("日志", "(MainActivity.java:54) ___ Result = " + databinding.getData().getName());
        break;
      case BR.dataSecond:

        break;
    }
  }
});
复制代码

DataBindingUtil

DataBinding不仅可以绑定Activity还可以绑定视图内容(View)


// 视图
static <T extends ViewDataBinding> T	bind(View root)

static <T extends ViewDataBinding> T	bind(View root, 
                                             DataBindingComponent bindingComponent)

  
// 布局
static <T extends ViewDataBinding> T	inflate(LayoutInflater inflater, 
                                                int layoutId, 
                                                ViewGroup parent, 
                                                boolean attachToParent, DataBindingComponent bindingComponent) // 组件

static <T extends ViewDataBinding> T	inflate(LayoutInflater inflater,
                                                int layoutId, 
                                                ViewGroup parent, 
                                                boolean attachToParent)

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

static <T extends ViewDataBinding> T	setContentView(Activity activity,
                                                       int layoutId, DataBindingComponent bindingComponent)
复制代码

还有两个不常用的方法, 检索视图是否被绑定, 如果没有绑定返回nul

static <T extends ViewDataBinding> T	getBinding(View view)

// 和getBinding不同的是如果视图没有绑定会去检查父容器是否被绑定
static <T extends ViewDataBinding> T	findBinding(View view)
复制代码

其他的方法

// 根据传的BR的id来返回字符串类型. 可能用于日志输出
static String	convertBrIdToString(int id)
复制代码

例如BR.name这个字段对应的是4, 就可以使用该方法将4转成"name"

DataBindingComponent

每个DataBinding都可以拥有一个组件或者说设置一个默认的全局组件

创建一个Component的步骤:

  1. 创建一个类, 类中写入@BindingAdapter注解(无需静态), 这个时候AndroidStudio会扫描自动生成对应的DatabindingComponent接口.
  2. 创建一个类实现DatabindingComponent, 这个时候会提示有方法要求覆写. 如果你省略第一部则不会有.

第一步

class PinkComponent {

    @BindingAdapter("android:bindName")
    fun TextView.setBindName(name:String?){

        if (!name.isNullOrEmpty() && name != text) {
            text = "数据体"
        }
    }

    @BindingAdapter("android:bindNameAttrChanged")
    fun TextView.notifyBindName(inverseBindingListener: InverseBindingListener){

        doAfterTextChanged {
            inverseBindingListener.onChange()
        }

    }

    @InverseBindingAdapter(attribute = "android:bindName")
    fun TextView.getBindName():String{

        return text.toString()
    }
}
复制代码

第二步

class CusComponent : DataBindingComponent {

    override fun getPinkComponent(): PinkComponent {
        return PinkComponent() // 此处不能返回null
    }
}
复制代码

设置默认组件都是由DataBindingUtils设置, 但是方法也有所不同

static void	setDefaultComponent(DataBindingComponent bindingComponent)

static DataBindingComponent	getDefaultComponent()
复制代码

以上这种设置必须在绑定视图之前设置, 并且是默认全局的, 只需要设置一次.

static <T extends ViewDataBinding> T	setContentView(Activity activity,
                                                       int layoutId, DataBindingComponent bindingComponent)
复制代码

如果你没有执行setDefaultComponent则选择通过函数单独传入, 则每次都要传入否则报错.

或者你可以将@BindingAdapter注解的方法变为static修饰.

DatabindingComponent只能使用@BindingAdapter注解

注意

  1. 可以使用include不过不能作为root布局. merge不能使用
  2. 如果没有自动生成DataBinding类可以先写个variable(或者make module下)
  3. 即使你没有绑定数据(你可能会在网络请求成功里面绑定数据), 但是只要视图创建完成就会自定绑定数据. 这个时候数据是空对象. 空对象的字段也会有默认值(String的默认值是NULL, TextView就会显示NULL); 并且如果你用了三元表达式, 空对象的三元表达式都为false; 所以建议不要考虑空对象的情况;
  4. 如果你给一个要求值是布尔类型值的自定义属性(BindingAdapter)赋值一个函数, 空指针的情况会返回false;

推荐插件

DataBindingSupport

通过代码补全快捷键自动生成DataBinding所需的XML格.

关注下面的标签,发现更多相似文章
评论