- gradle配置
- xml配置
- “膨胀视图”
DataBinding是jetpack的一个库,其作用是扩充xml布局文件的功能,拉近xml和activity/fragment的距离。使开发进一步简便。下面就来介绍DataBinding。
1、gradle配置
在用之前我们得先有它。首先我们得在需要使用该库的模块(module)中的build.gradle
文件中相应位置加入相应的配置:
apply plugin: 'kotlin-kapt'//当需要用到注解时添加
android {
//code...
dataBinding {
enabled true //启用dataBinding
}
//dataBinding.enabled = true 这样也可以
//code...
}
同步之后就可以使用DataBinding了。
2、xml配置
xml配置是使用DataBinding第一步。往常我们的布局文件是这样的
<androidx.constraintlayout.widget.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<!—-code——>
</androidx.constraintlayout.widget.ConstraintLayout>
希望该xml使用Databinding就需要对它进行改造:
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data class=“MainLayoutBinding”><!——这里有个class属性——>
<import type="android.text.Html" alias="html"/>
<variable
name="demo"
type="String" />
</data>
<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<!—-code——>
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>
你可以将这两段xml代码做对比,多出来的部分就是DataBinding的配置了,接下来我们一点一点来分析这段配置。
2.1、<layout>
标签
该标签是必须的,只有被该标签包裹的布局才能被Databinding识别,所以<layout>
就是布局文件的根标签。在该标签下有且仅有两个标签,其中一个是<data>
,另外一个就是原本的布局文件顶级标签。
被DataBinding识别的布局文件都会自动生成一个绑定类,该类的名称由布局文件名转化而来———下划线语法变成驼峰语法+Binding:
activity_main.xml
得到的绑定类是:ActivityMainBinding
2.2、<data>
标签
故名思义,该标签是为DataBinding在该xml中提供数据用的,可以看到该标签有一个属性class
,这是为自动生成的绑定类提供名称用的,也就是说:
activity_main.xml
会得到这样的绑定类:MainLayoutBinding
建议在自定义绑定类名时遵循原本的语法:在末尾加上
Binding
,以表示是一个布局绑定类。
该标签下可以有两种标签:<import>
和<variable>
。
<import>
:导入标签,可以对具体的类进行导入,然后在DataBinding环境的xml中使用。
type
是需要导入的类的完整类名,alias
是别名。(你可以将<import>
等效于java/kotlin的imort关键字)
用法:主要用于导入一些类,并使用其中的静态方法
<variable>
:变量标签,通过在java/kotlin代码中调用相应方法传入具体的对象,使在xml中可以通过绑定表达式直接使用数据对象。
name
是变量名,type
是变量的类型。
到这,dataBinding在xml中的配置基本完成。
2.3、绑定表达式
在xml中使用在控件中使用Databinding的方式:@{//code…}
举个例子:
2.4、使用快捷键快速配置
你可以在xml布局中将光标放在根标签上,使用快捷键option+回车即可呼出以下界面:
选中第一个选项即可完成dataBinding的xml配置。
该快捷键对应的是:
可自行在As的keymap配置中进行查找和更改。
3、膨胀(inflate)视图
对于普通的布局xml视图,我们可以通过View.inflate()
、LayoutInflater.from(this).inflate()
等方法将xml膨胀为View以致可以在代码环境中访问布局。而DataBinding也给我们提供了这么一套方法,由DataBindingUtil提供,inflate原理和以前是一样的:
val binding = DataBindingUtil.inflate<ActivityMainBinding>(
layoutInflater,
R.layout.activity_main,
parent,
true
)
如果是给activity设置根视图可以这样:
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
//code…
val binding = DataBindingUtil.setContentView<ActivityMainBinding>(this,R.layout.activity_main)
//code…
}
还有一种简便的方法就是通过绑定类的静态方法进行inflate:
val binding = ActivityMainBinding.inflate(layoutInflater,parent,true)
这些方法都可以得到一个对应绑定类的对象binding
,通过这个对象我们就可以通过属性(不可变字段)的方式直接访问布局文件中的信息,这些属性就是根据布局文件中的控件id所生成的。(这样最大的好处就是摆脱了findViewById)。
3.1、结合LiveData
ViewDataBinding有一个设置LifecycleOwner
,这样在绑定表达式中直接绑定LiveData就可以了,无需在activity/fragment中监听。
3.2、bind方法的使用
在使用DataBindingUtil类时会发现有一个bind方法,该方法可以通过一个view重新得到对应的绑定类。
val binding = DataBindingUtil.inflate<ActivityMainBinding>(
//code…
) //得到一个绑定类
val root:View = binding.root //得到一个根View
Val bind:ActivityMainBinding = DataBindingUtil.bind(root)//通过根View再次得到绑定类
想象一下这个场景:
你拥有ActivityMainBinding
类(以下称为绑定类),但是在某个过程中你需要将他变成一个View使用,比如RecyclerView/ListView的Adapter。这时你可以通过绑定类的getRoot
方法获得对应的View。
但是到后面你发现你还需要绑定类来做一些处理,那么这时你可以通过bind方法重新通过(从getRoot
方法中得到的)View获得对应的绑定类。
这样的好处在于你无需一直维护绑定类,但是在需要的时候随时可以得到。
3.3、设置变量
还记得在xml中的<data>
标签吗?其中的<variable>
标签所代表的变量会在绑定类中生成一对get、set方法,我们可以直接设置:
binding.demo = “这是变量”//由于是kotlin,所以可以得到一个变量
除了上面的设置方法,还有另外一种设置方法:
binding.setVariable(BR.demo,”这是变量”)
这是因为DataBinding会根据<data>
标签中的<variable>
标签生成对应的BR值。而setVariable
方法并非属于特定的绑定类,而是属于他们的父类:ViewDataBinding。
两者可以得到相同的结果。
3.4、设置点击监听器
没错,用了dataBinding之后我们几乎可以不用在代码上写 setOnClickListener
方法了。我们可以通过DataBinding将点击事件直接绑定到xml上。
为了方便演示,我将需要绑定的事件就放在Activity上:
- 准备一个方法:
#Activity
fun onClick(view:View){
//code…
}
- 将activity绑定到DataBinding上
<data class=“MainLayoutBinding”>
<import type="android.text.Html" alias="html"/>
<variable
name="activity"
type="..Activity" /> <!—-activity的完整类名——>
</data>
<LinearLayout…>
<TextView
onClick=“@{view->activity.onClick(view)}”/><!——绑定点击监听器——>
</LinearLayout>
事实上,点击监听器绑定的方式还有其他:
<TextView
onClick=“@{activity.onClick}”/>
<TextView
onClick=“@{activity::onClick}”/>
<!——这两种和上面的是同样效果的—->
如果不需要view也可以省掉:
<TextView
onClick=“@{()->activity.onClick()}”/>
至于绑定其他的监听器也是一样的。
可以看出,对于绑定的方法,没有特殊的限制,所以点击事件绑定几乎可以绑定到任何方法上。
小结
Databinding是一个操作xml布局的库,我们可以通过绑定表达式,将一些属于View的操作从Activity/Fragment中转移到xml布局文件中,减轻了activity/fragment的负担。
可以直接绑定数据,甚至可以直接绑定一些事件,使得View在activity/fragment中出现的几率越来越低了。
当然这只是Databinding系列的第一篇,也是最简单的一篇,下一篇将介绍dataBinding在xml中具体用法、xml中String多种使用方式、xml中隐藏的那些资源以及绑定适配器(BindingAdapter)