此页面由 Cloud Translation API 翻译。

视图绑定 Android Jetpack 的一部分。

视图绑定功能可让您更轻松地编写在模块中启用视图绑定后，它会生成绑定 class。绑定的实例类包含对在相应布局。

在大多数情况下，视图绑定会替代 findViewById。

设置

视图绑定是按模块启用的。要在模块，请在模块级别将 viewBinding 构建选项设置为 true build.gradle 文件，如以下示例所示：

Groovy

android {
    ...
    buildFeatures {
        viewBinding true
    }
}

Kotlin

android {
    ...
    buildFeatures {
        viewBinding = true
    }
}

如果您希望在生成绑定类时忽略某个布局文件，请添加将 tools:viewBindingIgnore="true" 属性添加到该布局的根视图文件：

<LinearLayout
        ...
        tools:viewBindingIgnore="true" >
    ...
</LinearLayout>

用法

如果为模块启用了视图绑定，系统会为每个模块生成绑定类模块包含的 XML 布局文件。每个绑定类都包含引用根视图及所有具有 ID 的视图。绑定类的名称为将 XML 文件的名称转换为 Pascal 大小写形式并添加字词“绑定”。

例如，假设有一个名为 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() 使其成为屏幕上的活动视图

这些步骤如以下示例所示：

Kotlin

private lateinit var binding: ResultProfileBinding

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    binding = ResultProfileBinding.inflate(layoutInflater)
    val view = binding.root
    setContentView(view)
}

Java

private ResultProfileBinding binding;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    binding = ResultProfileBinding.inflate(getLayoutInflater());
    View view = binding.getRoot();
    setContentView(view);
}

您现在即可使用该绑定类的实例来引用任何视图：

Kotlin

binding.name.text = viewModel.name
binding.button.setOnClickListener { viewModel.userClicked() }

Java

binding.name.setText(viewModel.getName());
binding.button.setOnClickListener(new View.OnClickListener() {
    viewModel.userClicked()
});

在 Fragment 中使用视图绑定

如需设置绑定类的实例以与 fragment 搭配使用，请执行执行下面这个 fragment 的 onCreateView() 方法：

调用生成的绑定类中包含的静态 inflate() 方法。此操作会创建该绑定类的实例以供 Fragment 使用。
通过调用 getRoot() 方法或使用 Kotlin 属性语法。
从 onCreateView() 方法返回根视图，使其成为 Active View

。

Kotlin

private var _binding: ResultProfileBinding? = null
// This property is only valid between onCreateView and
// onDestroyView.
private val binding get() = _binding!!

override fun onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
): View? {
    _binding = ResultProfileBinding.inflate(inflater, container, false)
    val view = binding.root
    return view
}

override fun onDestroyView() {
    super.onDestroyView()
    _binding = null
}

Java

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;
}

您现在即可使用该绑定类的实例来引用任何视图：

Kotlin

binding.name.text = viewModel.name
binding.button.setOnClickListener { viewModel.userClicked() }

Java

binding.name.setText(viewModel.getName());
binding.button.setOnClickListener(new View.OnClickListener() {
    viewModel.userClicked()
});

针对不同配置提供提示

在跨多个配置声明视图时，偶尔会造成根据特定布局使用不同的视图类型。以下代码段举例说明了这一情况：

# in res/layout/example.xml

<TextView android:id="@+id/user_bio" />

# in res/layout-land/example.xml

<EditText android:id="@+id/user_bio" />

在这种情况下，您可能希望生成的类公开字段 userBio 类型为 TextView，因为 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 文件中引用的视图。这意味着没有转换异常。

这些差异意味着您的布局与代码之间不兼容会导致构建在编译时（而非运行时）失败。

与数据绑定的对比

视图绑定和数据绑定都会生成可用于直接引用视图的绑定类。不过，查看绑定旨在处理更简单的用例，并提供以下功能：相比数据绑定的优势：

编译速度更快：视图绑定不需要处理注解，因此编译时间更短。
易于使用：视图绑定不需要特殊标记的 XML 布局加快应用采用速度。在 YAML 文件中一个模块，则它会自动应用于该模块的所有布局。

另一方面，与数据相比，视图绑定存在以下限制绑定：

视图绑定不支持布局变量或布局表达式，因此不能使用直接通过 XML 布局文件声明动态界面内容。
视图绑定不支持双向数据绑定。

考虑到这些因素，在某些情况下，最好同时使用这两种视图，绑定和数据绑定您可以在布局中使用数据绑定需要使用高级功能，并在不需要高级功能的布局中使用视图绑定。

其他资源

如需详细了解视图绑定，请参阅下面列出的其他资源：

视图绑定 Android Jetpack 的一部分。

设置

Groovy

Kotlin

用法

在 Activity 中使用视图绑定

Kotlin

Java

Kotlin

Java

在 Fragment 中使用视图绑定

Kotlin

Java

Kotlin

Java

针对不同配置提供提示

与 findViewById 的区别

与数据绑定的对比

其他资源

示例

博客

视频

为您推荐