[TOC]
# 1. 说明
视图绑定在大多数情况下,视图绑定会替代`findViewById`。而其实我们自己也可以定义一些注解,通过反射来完成对应的`findViewById`工作,比如`Xutils`和`ButterKnife`中都提供了这个功能。使用的时候比较简单,比如:
```java
@BindView(R.id.id_test)
TextView tvTest;
```
但是上面两种使用注解及反射方式的查找控件实例的方式本质上都是调用`findViewById`自身。`Google`在`Jetpack`中推出视图绑定,首先看看二者有何不同。
## 1.1 与 findViewById 的区别
* **Null 安全**:由于视图绑定会创建对视图的直接引用,因此不存在因视图 `ID` 无效而引发 Null 指针异常的风险。此外,如果视图仅出现在布局的某些配置中,则绑定类中包含其引用的字段会使用`@Nullable`标记。
* **类型安全**:每个绑定类中的字段均具有与它们在 `XML` 文件中引用的视图相匹配的类型。这意味着不存在发生类转换异常的风险。
# 2. 使用
## 2.1 环境配置
首先检查一下`Android Studio`的版本,视图绑定在[Android Studio 3.6 Canary 11 及更高版本](https://developer.android.google.cn/studio/preview)中可用。
要在某个模块中启用视图绑定,请将`viewBinding`元素添加到其`build.gradle`文件中,如下例所示:
~~~
android {
...
viewBinding {
enabled = true
}
}
~~~
如果您希望在生成绑定类时忽略某个布局文件,请将`tools:viewBindingIgnore="true"`属性添加到相应布局文件的根视图中:
~~~
<LinearLayout
...
tools:viewBindingIgnore="true" >
...
</LinearLayout>
~~~
## 2.1 用法
为某个模块启用视图绑定功能后,系统会为该模块中包含的每个 `XML` 布局文件生成一个绑定类。每个绑定类均包含对根视图以及具有 `ID` 的所有视图的引用。系统会通过以下方式生成绑定类的名称:将 `XML` 文件的名称转换为驼峰式大小写,并在末尾添加“Binding”一词。
例如,假设某个布局文件的名称为`result_profile.xml`:
~~~
<LinearLayout ... >
<TextView android:id="@+id/name" />
<ImageView android:cropToPadding="true" />
<Button android:id="@+id/button" />
</LinearLayout>
~~~
所生成的绑定类的名称就为`ResultProfileBinding`。此类具有两个字段:一个是名为`name`的`TextView`,另一个是名为`button`的`Button`。该布局中的`ImageView`没有 `ID`,因此绑定类中不存在对它的引用。
每个绑定类还包含一个`getRoot()`方法,用于为相应布局文件的根视图提供直接引用。在此示例中,`ResultProfileBinding`类中的`getRoot()`方法会返回`LinearLayout`根视图。
### 2.1.1 在 Activity 中使用视图绑定
请在 Activity 的`onCreate()`方法中执行以下步骤:
1. 调用生成的绑定类中包含的静态`inflate()`方法。此操作会创建该绑定类的实例以供 Activity 使用。
2. 通过调用`getRoot()`方法或使用Kotlin 属性语法获取对根视图的引用。
3. 将根视图传递到`setContentView()`,使其成为屏幕上的活动视图。
~~~kotlin
private lateinit var binding: ActivityMainBinding
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// R.layout.activity_main
// ViewBinding
binding = ActivityMainBinding.inflate(layoutInflater)
val rootView = binding.root
setContentView(rootView)
// TextView -> id=@+id/textView
binding.textView
// Button -> id=@+id/update
binding.update
}
~~~
### 2.1.2 在 Fragment 中使用视图绑定
请在 Fragment 的[`onCreateView()`](https://developer.android.google.cn/reference/kotlin/androidx/fragment/app/Fragment#oncreateview)方法中执行以下步骤:
1. 调用生成的绑定类中包含的静态`inflate()`方法。此操作会创建该绑定类的实例以供 Fragment 使用。
2. 通过调用`getRoot()`方法或使用Kotlin 属性语法获取对根视图的引用。
3. 从`onCreateView()`方法返回根视图,使其成为屏幕上的活动视图。
~~~kotlin
class BlankFragment : Fragment() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
}
private var binding: FragmentBlankBinding? = null
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup?,
savedInstanceState: Bundle?
): View? {
// R.layout.fragment_blank
binding = FragmentBlankBinding.inflate(inflater, container, false)
val rootView = binding?.root
return rootView
}
override fun onDestroy() {
super.onDestroy()
binding = null
}
}
~~~