视图绑定功能可让您更轻松地编写与视图交互的代码。在模块中启用视图绑定后,它会为该模块中显示的每个 XML 布局文件生成一个绑定类。绑定类的实例包含对在相应布局中具有 ID 的所有视图的直接引用。
在大多数情况下,视图绑定会替代 findViewById
。
初始设置
视图绑定是按模块启用的。如需在模块中启用视图绑定,请在模块级 build.gradle
文件中将 viewBinding
构建选项设置为 true
,如以下示例所示:
android { ... buildFeatures { viewBinding true } }
如果您希望在生成绑定类时忽略某个布局文件,请将 tools:viewBindingIgnore="true"
属性添加到该布局文件的根视图中:
<LinearLayout
...
tools:viewBindingIgnore="true" >
...
</LinearLayout>
用法
如果为某个模块启用了视图绑定,系统会为该模块包含的每个 XML 布局文件生成一个绑定类。每个绑定类都包含对根视图以及具有 ID 的所有视图的引用。系统会通过以下方式生成绑定类的名称:将 XML 文件的名称转换为 Pascal 大小写形式,并在末尾添加“Binding”一词。
例如,假设有一个名为 result_profile.xml
的布局文件,其中包含以下内容:
<LinearLayout ... >
<TextView android:id="@+id/name" />
<ImageView android:cropToPadding="true" />
<Button android:id="@+id/button"
android:background="@drawable/rounded_button" />
</LinearLayout>
所生成的绑定类的名称就为 ResultProfileBinding
。此类有两个字段:一个是名为 name
的 TextView
,另一个是名为 button
的 Button
。布局中的 ImageView
没有 ID,因此绑定类中没有对其的引用。
每个绑定类还包含一个 getRoot()
方法,用于提供相应布局文件的根视图的直接引用。在此示例中,ResultProfileBinding
类中的 getRoot()
方法会返回 LinearLayout
根视图。
以下部分演示了如何在 activity 和 fragment 中使用生成的绑定类。
在 Activity 中使用视图绑定
如需设置绑定类的实例以用于 activity,请在 activity 的 onCreate() 方法中执行以下步骤:
- 调用生成的绑定类中包含的静态
inflate()
方法。此操作会创建该绑定类的实例以供 Activity 使用。 - 通过调用
getRoot()
方法或使用 Kotlin 属性语法获取对根视图的引用。 - 将根视图传递给 setContentView(),使其成为屏幕上的活动视图。
这些步骤如以下示例所示:
private ResultProfileBinding binding; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); binding = ResultProfileBinding.inflate(getLayoutInflater()); View view = binding.getRoot(); setContentView(view); }
您现在即可使用该绑定类的实例来引用任何视图:
binding.name.setText(viewModel.getName()); binding.button.setOnClickListener(new View.OnClickListener() { viewModel.userClicked() });
在 Fragment 中使用视图绑定
如需设置绑定类的实例,以便与 fragment 配合使用,请在 fragment 的 onCreateView() 方法中执行以下步骤:
- 调用生成的绑定类中包含的静态
inflate()
方法。此操作会创建该绑定类的实例以供 Fragment 使用。 - 通过调用
getRoot()
方法或使用 Kotlin 属性语法获取对根视图的引用。 - 从
onCreateView()
方法返回根视图,使其成为屏幕上的活动视图。
注意 :inflate()
方法需要您传入布局膨胀器。如果布局已膨胀,您可以改为调用绑定类的静态 bind()
方法。如需了解详情,请参阅视图绑定 GitHub 示例中的示例。
private ResultProfileBinding binding; @Override public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { binding = ResultProfileBinding.inflate(inflater, container, false); View view = binding.getRoot(); return view; } @Override public void onDestroyView() { super.onDestroyView(); binding = null; }
您现在即可使用该绑定类的实例来引用任何视图:
binding.name.setText(viewModel.getName()); binding.button.setOnClickListener(new View.OnClickListener() { viewModel.userClicked() });
注意:Fragment 的存在时间比其视图长。请务必在 fragment 的 onDestroyView() 方法中清理对绑定类实例的任何引用。
针对不同配置提供提示
当您通过多种配置声明视图时,有时根据特定布局使用不同的视图类型是合理的。以下代码段显示了一个示例:
# in res/layout/example.xml
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" />
在这种情况下,您可能希望生成的类公开 TextView
类型的字段 userBio
,因为 TextView
是通用基类。由于技术限制,视图绑定代码生成器无法确定情况,而是改为生成 View
字段。这需要稍后使用 binding.userBio as TextView
转换字段。
为了绕过此限制,视图绑定支持 tools:viewBindingType
属性,可让您告知编译器在生成的代码中使用什么类型。在前面的示例中,您可以使用此属性让编译器将字段生成为 TextView
:
# in res/layout/example.xml (unchanged)
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" tools:viewBindingType="TextView" />
在另一个示例中,假设您有两个布局,一个包含 BottomNavigationView
,另一个包含 NavigationRailView
。这两个类都会扩展 NavigationBarView
,其中包含大部分实现细节。如果您的代码不需要确切地知道当前布局中存在哪个子类,您可以使用 tools:viewBindingType
在两个布局中将生成的类型设置为 NavigationBarView
:
# in res/layout/navigation_example.xml
<BottomNavigationView android:id="@+id/navigation" tools:viewBindingType="NavigationBarView" />
# in res/layout-w720/navigation_example.xml
<NavigationRailView android:id="@+id/navigation" tools:viewBindingType="NavigationBarView" />
视图绑定在生成代码时无法验证此属性的值。为避免编译时错误和运行时错误,该值必须满足以下条件:
- 该值必须是继承自
android.view.View
的类。 -
该值必须是放置它的代码的父类。例如,以下值不起作用:
<TextView tools:viewBindingType="ImageView" /> <!-- ImageView is not related to TextView. --> <TextView tools:viewBindingType="Button" /> <!-- Button is not a superclass of TextView. -->
-
最终类型必须在所有配置中一致地解析。
与 findViewById 的区别
与使用 findViewById
相比,视图绑定具有一些很显著的优点:
- Null 安全:由于视图绑定会创建对视图的直接引用,因此不存在因视图 ID 无效而引发 null 指针异常的风险。此外,当视图仅存在于布局的某些配置中时,绑定类中包含其引用的字段会标记为
@Nullable
。 - 类型安全:每个绑定类中的字段都具有与其在 XML 文件中引用的视图相匹配的类型。这意味着不存在发生类转换异常的风险。
这些差异意味着布局和代码不兼容,会导致 build 在编译时(而不是运行时)失败。
与数据绑定的对比
视图绑定和数据绑定都会生成可用于直接引用视图的绑定类。不过,视图绑定旨在处理更简单的用例,并且比数据绑定具有以下优势:
- 加快编译速度:视图绑定不需要处理注解,因此编译时间更短。
- 易于使用:视图绑定不需要特别标记的 XML 布局文件,因此在您的应用中采用的速度更快。在模块中启用视图绑定后,它会自动应用于该模块的所有布局。
另一方面,与数据绑定相比,视图绑定具有以下限制:
- 视图绑定不支持布局变量或布局表达式,因此它不能用于直接从 XML 布局文件声明动态界面内容。
- 视图绑定不支持双向数据绑定。
考虑到这些因素,在某些情况下,最好在项目中同时使用视图绑定和数据绑定。您可以在需要高级功能的布局中使用数据绑定,在不需要高级功能的布局中使用视图绑定。