DataBinding·常用注解说明

幺鹿

发布于 2018-08-21 15:21:11

8210

发布于 2018-08-21 15:21:11

文章被收录于专栏：Java呓语

android.databinding

@Bindable

Observable接口提供给开发者添加/移除监听者的机制。为了使开发更便捷，我们创建了BaseObservable类，它已经实现了Observable接口中的注册监听者的机制。

继承自BaseObservable的数据类，仍需手动的通知监听者们数据已发生变更。你可以在setter方法中发出变更消息，记住同时在getter方法上标记注解@Bindable。

@Bindable 注解的推荐用法是修饰继承自Observable类中的getter accessor方法，但其实getter accessor的属性也是可以应用该注解的。
注解@Bindable在编译期间生成一个BR类，以此持有对应的实例，作用同R类。

private static class User extends BaseObservable {
   private String firstName;
   @Bindable
   public String getFirstName() {
       return this.firstName;
   }
   public void setFirstName(String firstName) {
       this.firstName = firstName;
       notifyPropertyChanged(BR.firstName);
   }
}

@BindingAdapter

应用于用于操作表达式的值如何设置为视图的方法。

@BindingAdapter用于修饰方法。

一些属性需要定制绑定逻辑，一个用@BindingAdapter修饰的静态方法可以自定义属性的setter操作。

android自身实现了大量的Adapter，你可以在项目module的android.databinding.adapters包下找到这些代码。

public class CardViewBindingAdapter {
    @BindingAdapter("contentPadding")
    public static void setContentPadding(CardView view, int padding) {
        view.setContentPadding(padding, padding, padding, padding);
    }
}

1、默认的你的自定义的命名空间，在匹配时会被忽略。

@BindingAdapter("contentPadding")

2、允许重写android的命名空间。

@BindingAdapter("android:contentPadding")

app:contentPadding与android:contentPadding处理行为可以不一样。 app:contentPadding与custom:contentPadding处理行为是一致的。（仅android是特殊的命名空间）。

需要注意，当你创建的适配器属性与系统默认的产生冲突时，你的自定义适配器将会覆盖掉系统原先定义的注解，这将会产生一些意外的问题。

假设需要对下面接口，做适配。

public interface ILogAction{
      void login();
      void logout();
}

则需要一个方法一个接口，这么做的原因是避免login()的修改影响到logout()。所以根据业务需要，可能需要排列组合适配这两个接口。

1、适配 login 2、适配 logout 3、适配 login + logout

@BindingBuildInfo

@BindingBuildInfo(
buildId="3fefc6ba-1e95-4dcf-8ffa-278fe0f449bd",
modulePackage="com.ipudong.library",
sdkRoot="/Users/robert/Library/Android/sdk",
layoutInfoDir="/Users/robert/android/develops/pudong-d-android/lib_basic/build/intermediates/data-binding-info/debug",
exportClassListTo="/Users/robert/android/develops/pudong-d-android/lib_basic/build/intermediates/data-binding-info/debug/_generated.txt",
isLibrary=true,
minSdk=14,
enableDebugLogs=false,
printEncodedError=true
)
public class DataBindingInfo {}

在SOURCE阶段会自动生成DataBindingInfo.class，并标记注解如上。

@BindingConversion

Annotate methods that are used to automatically convert from the expression type to the value used in the setter.

有时候会遇到类型不匹配的问题，比如R.color.white是int，但是通过Data Binding赋值给android:background属性后，需要把int转换为ColorDrawable。

@BindingConversion
public static Drawable convertColorToDrawable(int drawable) {
  return new ColorDrawable(drawable);
}

@BindingMethod && @BindingMethods

Used within an BindingMethods annotation to describe a renaming of an attribute to the setter used to set that attribute. Used to enumerate attribute-to-setter renaming.

@BindingMethods用于修饰类。

一些属性虽然拥有setters但是并不与名字相匹配，这些方法的属性可以通过 @BindingMethod && @BindingMethods 注释 setters。

@BindingMethods({
       @BindingMethod(type = "android.widget.ImageView",
                      attribute = "android:tint",
                      method = "setImageTintList"),
})

开发人员不太可能需要重命名 setters ，因为android框架属性已经实现了这一部分。

@InverseBindingAdapter

InverseBindingAdapter用于关联某个用于接收View变更的方法，典型的例子EditText.TextWatcher接收输入字符的变更。这与BindingAdapters有一定的相似性：

 @InverseBindingAdapter(attribute = "android:text", event = "android:textAttrChanged")
 public static String captureTextValue(TextView view, CharSequence originalValue) {
     CharSequence newValue = view.getText();
     CharSequence oldValue = value.get();
     if (oldValue == null) {
         value.set(newValue);
     } else if (!contentEquals(newValue, oldValue)) {
         value.set(newValue);
     }
 }

事件的默认值是带有AttrChanged的属性名称。在上面的例子中，默认值是android:textAttrChanged，即使它没有提供。

事件属性用于通知数据绑定系统值已更改。开发人员通常会创建一个BindingAdapter来分配事件。比如：

@BindingAdapter(value = {"android:beforeTextChanged", "android:onTextChanged",
                          "android:afterTextChanged", "android:textAttrChanged"},
                          requireAll = false)
 public static void setTextWatcher(TextView view, final BeforeTextChanged before,
                                   final OnTextChanged on, final AfterTextChanged after,
                                   final InverseBindingListener textAttrChanged) {
     TextWatcher newValue = new TextWatcher() {
         ...
         @Override
         public void onTextChanged(CharSequence s, int start, int before, int count) {
             if (on != null) {
                 on.onTextChanged(s, start, before, count);
             }
             if (textAttrChanged != null) {
                 textAttrChanged.onChange();
             }
         }
     }
     TextWatcher oldValue = ListenerUtil.trackListener(view, newValue, R.id.textWatcher);
     if (oldValue != null) {
         view.removeTextChangedListener(oldValue);
     }
     view.addTextChangedListener(newValue);
 }

如同BindingAdapters一样， InverseBindingAdapter方法也可以将 DataBindingComponent作为第一个参数，可以是具有从DataBindingComponent检索的实例的实例方法。

InverseBindingListener 非常有用。参考 InverseBindingListener

@InverseBindingMethod

InverseBindingMethod用于标识如何监听对View属性的更改以及要调用的getter方法。 InverseBindingMethod 应该与InverseBindingMethods的部分方法相关联。

@InverseBindingMethods({@InverseBindingMethod(
     type = android.widget.TextView.class,
     attribute = "android:text",
     event = "android:textAttrChanged",
     method = "getText")})
 public class MyTextViewBindingAdapters { ... }

@InverseBindingMethods中的属性method 是可选的。

如果其没有提供，属性名称会查找如下几种可能性：方法名称，前缀为is或者get的方法名称。如属性android:text, 数据绑定框架会在TextView中搜索public CharSequence getText() 方法。

@InverseBindingMethods中的属性event是可选的。

如果其没有提供，默认会使用属性名+AttrChanged后缀。如属性android:text, 默认的事件名称android:textAttrChanged。

这个事件也需要配置相关的@BindingAdapter，如下：

 @BindingAdapter(value = {"android:beforeTextChanged", "android:onTextChanged",
                          "android:afterTextChanged", "android:textAttrChanged"},
                          requireAll = false)
 public static void setTextWatcher(TextView view, final BeforeTextChanged before,
                                   final OnTextChanged on, final AfterTextChanged after,
                                   final InverseBindingListener textAttrChanged) {
     TextWatcher newValue = new TextWatcher() {
         ...
         @Override
         public void onTextChanged(CharSequence s, int start, int before, int count) {
             if (on != null) {
                 on.onTextChanged(s, start, before, count);
             }
             if (textAttrChanged != null) {
                 textAttrChanged.onChange();
             }
         }
     }
     TextWatcher oldValue = ListenerUtil.trackListener(view, newValue, R.id.textWatcher);
     if (oldValue != null) {
         view.removeTextChangedListener(oldValue);
     }
     view.addTextChangedListener(newValue);
 }

@InverseBindingMethods

用于枚举属性，getter和事件关联。

@Untaggable

Data Binding相关的jar包由四部分组成，

baseLibrary-2.1.0-rc1.jar 作为运行时类库被打进APK中；
DataBinderPlugin（gradle plugin）在编译期使用，利用gradle-api（之前叫transform-api，1.5生，2.0改名）处理xml文件，生成DataBindingInfo.java；
compiler-2.1.0-rc1.jar 在编译器使用，入口类继承自AbstractProcessor，用于处理注解，并生成Binding类，DataBindingCompoent.java，DataBinderMapper.java类；
compilerCommon-2.1.0-rc1.jar 被DataBinderPlugin和compiler-2.1.0-rc1.jar所依赖