Jetpack架构之DataBinding简述
为什么写?
网上可能已经有很多系列的教程和文章,侧重点都不同。有的一上来就直接上源码分析,初步入门的程序员可能很难上手。本人在此再重新整理一下。
本文主要讲述DataBinding组件。
MVVM架构
MVVM的架构想必大家都很熟悉,此处不累述。简单来说,就是视图与模块双向绑定。
DataBinding
导入配置:
dependencies {
implementation 'androidx.appcompat:appcompat:1.1.0'
implementation 'androidx.lifecycle:lifecycle-extensions:2.0.0'
}
开启dataBinding
dataBinding {
enabled = true
}
简单新建一个界面
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".ui.main.AboutActivity">
</androidx.constraintlayout.widget.ConstraintLayout>
使用Databing的话,需要把跟布局修改成layout,打开布局文件,选中根布局的 ViewGroup,按住 Alt + 回车键,点击 “Convert to data binding layout”,就可以生成 DataBinding 需要的布局规则。
<?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 class=".AboutActivityDataBinding">
<variable name="company" type="java.lang.String" />
</data>
<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="com.example.tests.ui.about.AboutActivity">
<TextView
android:id="@+id/tv_company"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="50dp"
android:text="company"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<ImageView
android:id="@+id/imageView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="30dp"
android:src="@mipmap/ic_launcher"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toBottomOf="@+id/tv_company" />
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>
写完编译一下,系统就会生成文件AboutActivityDataBindingImpl
先来看下生成的实现类实现的功能:
package com.example.tests;
import com.example.tests.R;
import com.example.tests.BR;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import android.view.View;
@SuppressWarnings("unchecked")
public class AboutActivityDataBindingImpl extends AboutActivityDataBinding {
@Nullable
private static final androidx.databinding.ViewDataBinding.IncludedLayouts sIncludes;
@Nullable
private static final android.util.SparseIntArray sViewsWithIds;
static {
sIncludes = null;
sViewsWithIds = new android.util.SparseIntArray();
sViewsWithIds.put(R.id.tv_company, 1);//保存到数组中
sViewsWithIds.put(R.id.imageView, 2);
}
// views
@NonNull
private final androidx.constraintlayout.widget.ConstraintLayout mboundView0;
// variables
// values
// listeners
// Inverse Binding Event Handlers
public AboutActivityDataBindingImpl(@Nullable androidx.databinding.DataBindingComponent bindingComponent, @NonNull View root) {
this(bindingComponent, root, mapBindings(bindingComponent, root, 3, sIncludes, sViewsWithIds));
}
private AboutActivityDataBindingImpl(androidx.databinding.DataBindingComponent bindingComponent, View root, Object[] bindings) {
super(bindingComponent, root, 0
, (android.widget.ImageView) bindings[2]
, (android.widget.TextView) bindings[1]
);
this.mboundView0 = (androidx.constraintlayout.widget.ConstraintLayout) bindings[0];
this.mboundView0.setTag(null);
setRootTag(root);
// listeners
invalidateAll();
}
@Override
public void invalidateAll() {
synchronized(this) {
mDirtyFlags = 0x2L;
}
requestRebind();
}
@Override
public boolean hasPendingBindings() {
synchronized(this) {
if (mDirtyFlags != 0) {
return true;
}
}
return false;
}
@Override
public boolean setVariable(int variableId, @Nullable Object variable) {
boolean variableSet = true;
if (BR.company == variableId) {
setCompany((java.lang.String) variable);
}
else {
variableSet = false;
}
return variableSet;
}
public void setCompany(@Nullable java.lang.String Company) {
this.mCompany = Company;
}
@Override
protected boolean onFieldChange(int localFieldId, Object object, int fieldId) {
switch (localFieldId) {
}
return false;
}
@Override
protected void executeBindings() {
long dirtyFlags = 0;
synchronized(this) {
dirtyFlags = mDirtyFlags;
mDirtyFlags = 0;
}
// batch finished
}
// Listener Stub Implementations
// callback impls
// dirty flag
private long mDirtyFlags = 0xffffffffffffffffL;
/* flag mapping
flag 0 (0x1L): company
flag 1 (0x2L): null
flag mapping end*/
//end
}
继续改造AboutActivity
package com.example.tests.ui.about;
import androidx.appcompat.app.AppCompatActivity;
import androidx.databinding.DataBindingUtil;
import android.os.Bundle;
import com.example.tests.AboutActivityDataBinding;
import com.example.tests.R;
public class AboutActivity extends AppCompatActivity {
AboutActivityDataBinding dataBinding;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//此处修改下引入布局的方式
//setContentView(R.layout.activity_about);
dataBinding = DataBindingUtil.setContentView(this,R.layout.activity_about);
//此处可以直接引用XML文件里面的变量名字。
dataBinding.tvCompany.setText("hello");
}
}
源码分析:
public static <T extends ViewDataBinding> T setContentView(@NonNull Activity activity,
int layoutId, @Nullable DataBindingComponent bindingComponent) {
activity.setContentView(layoutId);//先设置布局
View decorView = activity.getWindow().getDecorView();//取出根布局
ViewGroup contentView = (ViewGroup) decorView.findViewById(android.R.id.content);//取出界面contentView
return bindToAddedViews(bindingComponent, contentView, 0, layoutId);
}
static <T extends ViewDataBinding> T bind(DataBindingComponent bindingComponent, View[] roots,
int layoutId) {
return (T) sMapper.getDataBinder(bindingComponent, roots, layoutId);
}
static <T extends ViewDataBinding> T bind(DataBindingComponent bindingComponent, View root,
int layoutId) {
return (T) sMapper.getDataBinder(bindingComponent, root, layoutId);
}
@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_ACTIVITYABOUT: {
if ("layout/activity_about_0".equals(tag)) {
return new AboutActivityDataBindingImpl(component, view);
}
throw new IllegalArgumentException("The tag for activity_about is invalid. Received: " + tag);
}
case LAYOUT_MAINFRAGMENT: {
if ("layout/main_fragment_0".equals(tag)) {
return new MainFragmentDataBindingImpl(component, view);
}
throw new IllegalArgumentException("The tag for main_fragment is invalid. Received: " + tag);
}
}
}
return null;
}
以上是最简单的用法,可以代替ButterKnife,直接方便的进行ID查找。
如果要双向绑定变量,怎么做呢?
假设有个对象CompanyInfo
package com.example.tests.ui.about.bean;
public class CompanyInfo {
private String name;
private int peopleCnt;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getPeopleCnt() {
return peopleCnt;
}
public void setPeopleCnt(int peopleCnt) {
this.peopleCnt = peopleCnt;
}
}
在布局文件里面添加:
<data class=".AboutActivityDataBinding">
<variable name="company" type="com.example.tests.ui.about.bean.CompanyInfo" />
</data>
那么在文本里面可以直接引用android:text="@{company.name}",Java中调用dataBinding.setCompany(companyInfo)可以直接把java中的变量映射到XML中。但是想实时变化,得不断设置。
如果在XML中设置android:text="@={company.name}",那么界面控件的数值变化,是会实时写入到变量中的。
比如用户在EditText中输入文本,可以实时保存到变量中。
CompanyInfo companyInfo = new CompanyInfo();
companyInfo.setName("公司名字");
dataBinding.setCompany(companyInfo); //此处设置完后界面就显示出来了。
AsyncTask.THREAD_POOL_EXECUTOR.execute(new Runnable() {
@Override
public void run() {
for (int i = 0; i < 20; i++) {
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
companyInfo.setName("dfd" + i);
//此处需要不断的对dataBinding的变量赋值,XML界面才会发送改变。
dataBinding.setCompany(companyInfo);
}
}
});
那假如要做到两边实时同步变化,怎么处理呢?
类继承BaseObservable就可以了。
package com.example.tests.ui.about.bean;
import androidx.databinding.BaseObservable;
import androidx.databinding.Bindable;
public class CompanyInfo extends BaseObservable {
private String name;
private int peopleCnt;
private String phone;
@Bindable
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
notifyPropertyChanged(com.example.tests.BR.phone);
}
public CompanyInfo(String name) {
this.name = name;
}
@Bindable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
notifyPropertyChanged(com.example.tests.BR.name);
}
@Bindable
public int getPeopleCnt() {
return peopleCnt;
}
public void setPeopleCnt(int peopleCnt) {
this.peopleCnt = peopleCnt;
notifyPropertyChanged(com.example.tests.BR.peopleCnt);
}
}
另外xml可以绑定点击事件,可以指定任意类。
android:onClick="@{()->abouthandler.checkUpdate()}"
还有另一种方法,就是变量赋值为ObservableField。
package com.example.tests.ui.about.bean;
import androidx.databinding.ObservableField;
import androidx.databinding.ObservableInt;
public class AppInfo {
ObservableField<String> url;
ObservableInt versionCode;
public AppInfo(String url, int versionCode) {
this.url = new ObservableField<String>(url);
this.versionCode = new ObservableInt(versionCode);
}
public String getUrl() {
return url.get();
}
public void setUrl(String url) {
this.url.set(url);
}
public Integer getVersionCode() {
return versionCode.get();
}
public void setVersionCode(int versionCode) {
this.versionCode.set(versionCode);
}
}