【Android Jetpack】DataBinding 从入门到精通(1)

2401_84010402

于 2024-05-08 16:08:10 发布

阅读量822

点赞数 12

本文链接：https://blog.csdn.net/2401_84010402/article/details/138576108

版权

程序员专栏收录该内容

238 篇文章 1 订阅

订阅专栏

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val activityBinding: ActivityMainBinding = DataBindingUtil.setContentView(this,R.layout.activity_main)
activityBinding.lifecycleOwner = this
activityBinding.userInfo = TestInfo(“lsm”,“lsj”)
}

TestInfo 的定义如下：

public class TestInfo extends BaseObservable { //继承 BaseObservable
private String age;
private String name;
public TestInfo(String age,String name){
this.name = name;
this.age = age;
}
public void setAge(String age) {
this.age = age;
notifyPropertyChanged(BR.age); //需要变更的变量的 set 方法中加上 notifyPropertyChanged
}
public void setName(String name) {
this.name = name;
notifyPropertyChanged(BR.name); //需要变更的变量的 set 方法中加上 notifyPropertyChanged
}
@Bindable //需要变更的变量还要加上 @Bindable 注解
public String getAge() {
return age;
}
@Bindable //需要变更的变量还要加上 @Bindable 注解
public String getName() {
return name;
}
}

TestInfo需要继承BaseObservable，同时对于需要监听变化的变量加上@Bindable 注解，同时该变量的set方法还要加上notifyPropertyChanged，BR.xxx 是注解生成的。

数据的双向绑定

使用单向数据绑定时，您可以为特性设置值，并设置对该特性的变化作出反应的监听器：

双向数据绑定为此过程提供了一种快捷方式：

@={} 表示法（其中重要的是包含“=”符号）可接收属性的数据更改并同时监听用户更新。其他的设置和前面的单向数据绑定一致。

结合 LiveData 使用

内容参考自这里，我们上面在使用 DataBinding 时，TestInfo 还要继承 BaseObserble，使用注解、notifyPropertyChanged()，使用起来其实挺复杂，而且还有侵入性。LiveData 结合 DataBinding 的使用步骤如下：

使用 LiveData 对象作为数据绑定来源，需要设置 LifecycleOwner。
xml 中定义变量 ViewModel，并使用 ViewModel。
binding 设置变量 ViewModel。

//结合DataBinding使用的ViewModel
//1. 要使用LiveData对象作为数据绑定来源，需要设置LifecycleOwner
binding.setLifecycleOwner(this);

ViewModelProvider viewModelProvider = new ViewModelProvider(this);
mUserViewModel = viewModelProvider.get(UserViewModel.class);
//3. 设置变量ViewModel
binding.setVm(mUserViewModel);

xml 文件的定义如下：

这样就ok了，你会发现我们不需要在 Activity 中拿到 LivaData 去 observe(owner，observer)了，DataBinding 自动生成的代码，会帮我们去做这操作，所以需要设置LifecycleOwner。

使用自定义特性的双向数据绑定

例如，如果要在名为 MyView 的自定义视图中对 "time" 特性启用双向数据绑定，请完成以下步骤：

使用 @BindingAdapter，对用来设置初始值并在值更改时进行更新的方法进行注释：

@BindingAdapter(“time”)
@JvmStatic fun setTime(view: MyView, newValue: Time) {
// Important to break potential infinite loops.
if (view.time != newValue) {
view.time = newValue
}
}

使用 @InverseBindingAdapter 对从视图中读取值的方法进行注释：

@InverseBindingAdapter(“time”)
@JvmStatic fun getTime(view: MyView) : Time {
return view.getTime()
}

更多内容请参考这里。

源码分析

我们在路径app/build/intermediates/data_binding_layout_info_type_merge/debug/out/activity_main-layout.xml查看文件

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

false

可以看到<Targets>标签下面的就是我们布局，分成具体的子<Target>标签对应具体的 ConstraintLayout、TextView等，activity_main_0 对应我们的ConstraintLayout，再来路径app/build/intermediates/incremental/mergeDebugResources/stripped.dir/layout/activity_main.xml下

<?xml version="1.0" encoding="utf-8"?>

<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width=“match_parent”
android:layout_height=“match_parent”
tools:context=“.MainActivity” android:tag=“layout/activity_main_0” 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”>

<TextView
android:id=“@+id/txtUserName”
android:layout_width=“match_parent”
android:layout_height=“wrap_content”
android:gravity=“center”
android:tag=“binding_1”
app:layout_constraintTop_toBottomOf=“@+id/btnGetUserInfo”
android:layout_marginTop=“30dp”
android:textSize=“30dp”

</androidx.constraintlayout.widget.ConstraintLayout>

这个文件其实就是移除了<layout>、<data>标签的布局文件，里面的 tag 就是我们上面对应<Target>标签中的tag，Expression attribute="android:text" text="userInfo.age" <Expression>中的具体属性对应具体的值。

初始化

再来从val activityBinding: ActivityMainBinding = DataBindingUtil.setContentView(this,R.layout.activity_main)来分析源码，

//DataBindingUtil.java
public static T setContentView(@NonNull Activity activity,
int layoutId, @Nullable DataBindingComponent bindingComponent) {
activity.setContentView(layoutId); //还是需要setContentView
View decorView = activity.getWindow().getDecorView();
ViewGroup contentView = (ViewGroup) decorView.findViewById(android.R.id.content);
return bindToAddedViews(bindingComponent, contentView, 0, layoutId);
}

我们设置的activity_xxx.xml其实是在android.R.id.content下面的，继续来看bindToAddedViews方法

//DataBindingUtil.java
private static T bindToAddedViews(DataBindingComponent component,
ViewGroup parent, int startChildren, int layoutId) {
final int endChildren = parent.getChildCount();
final int childrenAdded = endChildren - startChildren;
if (childrenAdded == 1) {
final View childView = parent.getChildAt(endChildren - 1);
return bind(component, childView, layoutId); //调用bind
} else {
final View[] children = new View[childrenAdded];
for (int i = 0; i < childrenAdded; i++) {
children[i] = parent.getChildAt(i + startChildren);
}
return bind(component, children, layoutId); //调用bind
}
}
}

最终会调到bind方法

//DataBindingUtil.java
static T bind(DataBindingComponent bindingComponent, View root,
int layoutId) {
return (T) sMapper.getDataBinder(bindingComponent, root, layoutId);
}

sMapper是DataBinderMapper，其真正实现类是通过 APT 生成的DataBinderMapperImpl（app/build/generated/ap_generated_sources/debug/out/com/jackie/jetpackdemo/DataBinderMapperImpl.java）

public class DataBinderMapperImpl extends DataBinderMapper {
···
@Override
public ViewDataBinding getDataBinder(DataBindingComponent component, View view, int layoutId) {
int localizedLayoutId = INTERNAL_LAYOUT_ID_LOOKUP.get(layoutId);
if(localizedLayoutId > 0) {
final Object tag = view.getTag();
if(tag == null) {
throw new RuntimeException(“view must have a tag”);
}
switch(localizedLayoutId) {
case LAYOUT_ACTIVITYMAIN: {
if (“layout/activity_main_0”.equals(tag)) {
return new ActivityMainBindingImpl(component, view); //关键代码，new ActivityMainBindingImpl
}
···

接下来我们来分析ActivityMainBindingImpl（app/build/generated/ap_generated_sources/debug/out/com/jackie/jetpackdemo/databinding/ActivityMainBindingImpl.java）这个类，它也是 APT 生成的，

//ActivityMainBindingImpl.java
public ActivityMainBindingImpl(@Nullable androidx.databinding.DataBindingComponent bindingComponent, @NonNull View root) {
this(bindingComponent, root, mapBindings(bindingComponent, root, 3, sIncludes, sViewsWithIds));
}
private ActivityMainBindingImpl(androidx.databinding.DataBindingComponent bindingComponent, View root, Object[] bindings) {
super(bindingComponent, root, 1
, (android.widget.Button) bindings[2]
, (android.widget.TextView) bindings[1]
);
this.mboundView0 = (androidx.constraintlayout.widget.ConstraintLayout) bindings[0];
this.mboundView0.setTag(null);
this.txtUserName.setTag(null);
setRootTag(root);
// listeners
invalidateAll();
}

我们调用了第一个方法，里面的这个 3 代表着我们布局文件中有三个节点（ConstraintLayout，Button，TextView），但是我们前面的布局中明明还有一个TextView，为什么没有呢？因为我们这个TextView我们并没有设置它的 Id，所以没有生成，如果设置后重新 build 下 3 就会变成 4 了。

继续来看mapBindings方法：

protected static Object[] mapBindings(DataBindingComponent bindingComponent, View root,
int numBindings, IncludedLayouts includes, SparseIntArray viewsWithIds) {
Object[] bindings = new Object[numBindings];
mapBindings(bindingComponent, root, bindings, includes, viewsWithIds, true);
return bindings;
}

它首先是 new 一个大小为 3 的对象数组，然后把这三个标签解析完放到该数组中。上面的ActivityMainBindingImpl公有构造器会调用私有构造器，再回过头来看

val activityBinding: ActivityMainBinding = DataBindingUtil.setContentView(this,R.layout.activity_main)

执行完这个代码，activityBinding中已经有这 3 个对象了，所以可以进行这样的调用

activityBinding.txtUserName
activityBinding.btnGetUserInfo

到目前为止，初始化已经完成了。

调用流程

接下来我们从这个调用开始分析

activityBinding.userInfo = TestInfo(“lsm”,“lsj”)

这个activityBinding.userInfo调用的实际上是ActivityMainBinding中的setUserInfo方法

//ActivityMainBinding.java
public void setUserInfo(@Nullable com.jackie.jetpackdemo.data.TestInfo UserInfo) {
updateRegistration(0, UserInfo);
this.mUserInfo = UserInfo;
synchronized(this) {
mDirtyFlags |= 0x1L;
}
notifyPropertyChanged(BR.userInfo);
super.requestRebind();
}

这里的updateRegistration方法如下

//localFieldId 为 BR 文件中的Id，observable 就是观察者
protected boolean updateRegistration(int localFieldId, Observable observable) {
return updateRegistration(localFieldId, observable, CREATE_PROPERTY_LISTENER);
}
/**

Method object extracted out to attach a listener to a bound Observable object.
*/
private static final CreateWeakListener CREATE_PROPERTY_LISTENER = new CreateWeakListener() {
@Override
public WeakListener create(ViewDataBinding viewDataBinding, int localFieldId) {
return new WeakPropertyListener(viewDataBinding, localFieldId).getListener();
}
};

CREATE_PROPERTY_LISTENER名字也很直白，表示创建一个属性的监听器，也就是说属性发生变化的时候WeakPropertyListener监听器会被回调。

localFieldId 为 BR 文件中的 Id，BR 文件是什么呢？

public class BR {
public static final int _all = 0;
public static final int age = 1;
public static final int name = 2;
public static final int userInfo = 3;
}

因为我们的 xml 文件中导入了TestInfo(userInfo)，我们也在age和name属性上加上了@Bindable注解，所以生成了上面的BR文件。因为我们是上面调用的是setUserInfo方法，所以传入的是 0。

用该方式设置name也可以

activityBinding.setVariable(BR.name,“Jackie”)

而updateRegistration中的observable就是我们传入的(TestInfo)UserInfo，再来看看updateRegistration方法

//ViewDataBinding
private boolean updateRegistration(int localFieldId, Object observable,
CreateWeakListener listenerCreator) {
if (observable == null) {
return unregisterFrom(localFieldId);
}
WeakListener listener = mLocalFieldObservers[localFieldId];
if (listener == null) {
registerTo(localFieldId, observable, listenerCreator);
return true;
}
if (listener.getTarget() == observable) {
return false;//nothing to do, same object
}
unregisterFrom(localFieldId);
registerTo(localFieldId, observable, listenerCreator);
return true;
}

mLocalFieldObservers数组中绑定了每一个属性对应的监听器，比如我们上面的 BR 中的四个值。

如果监听器为空，调用registerTo创建监听器并注册

protected void registerTo(int localFieldId, Object observable,
CreateWeakListener listenerCreator) {
if (observable == null) {
return;
}
WeakListener listener = mLocalFieldObservers[localFieldId];
if (listener == null) {
listener = listenerCreator.create(this, localFieldId);
mLocalFieldObservers[localFieldId] = listener;
if (mLifecycleOwner != null) {
listener.setLifecycleOwner(mLifecycleOwner);
}
}
listener.setTarget(observable);
}

setTarget就是给被观察者添加监听器

public void setTarget(T object) {
unregister();
mTarget = object;
if (mTarget != null) {
mObservable.addListener(mTarget);
}
}

这里的mObservable的实现类是WeakPropertyListener，也就是每个属性发生变化后都会进行回调

@Override