学而实习之 不亦乐乎

在 Android 中使用 ViewBinding

2024-01-03 20:40:38

Android 中的视图绑定是一项功能，可让你更轻松地编写与视图交互的代码。在模块中启用视图绑定后，它会为该模块中存在的每个 XML 布局文件生成一个绑定类。绑定类的实例包含对在相应布局中具有 ID 的所有视图的直接引用（使用 ViewBinding 可以替换掉 findViewById()）。

一、ViewBinding(视图绑定)

1、功能设置

视图绑定在一个模块一个模块的基础上启用。要在模块中启用视图绑定，请在 Module 级 build.gradle 文件中将 viewBinding 构建选项设置为true，如下例所示：

android {
    ...
    buildFeatures {
        viewBinding true
    }
}

如果你那个布局文件不需要生成绑定类(不想用这个功能)，可在该类对应的该布局文件的根视图中添加 tools:viewBindingIgnore="true" 属性：

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

2、功能使用

如果为Module启用了视图绑定，则会为Module包含的每个 XML 布局文件 生成一个绑定类。每个绑定类都包含对根视图和所有具有 ID 的视图的引用。绑定类的名称是通过将 XML 文件的名称转换为 Pascal 大小写并在末尾添加 Binding 一词来生成的。

例如，给定一个名为 activity_progressbar.xml 的布局文件：

<LinearLayout>
    ...

    <ProgressBar
        android:id="@+id/progress_1"/>

    <ProgressBar
        style="@android:style/Widget.ProgressBar.Small" />

    <ProgressBar
        android:id="@+id/progress_3"/>

    <ProgressBar
        style="@android:style/Widget.ProgressBar.Inverse" />

    <ProgressBar
        android:id="@+id/progress_5"/>

    <ProgressBar
    style="@android:style/Widget.ProgressBar.Large.Inverse" />

    ...
</LinearLayout>

布局文件中有6个ProgressBar，只有3个ProgressBar设置了android:id。

生成的绑定类称为ActivityProgressbarBinding。这个类有3个字段：progress_1、progress_3、progress_5。另外3个在布局具有没有ID，所以在绑定类没有提及。

每个绑定类还包含一个getRoot()方法，为相应布局文件的根视图提供直接引用。在这个例子中，类中的getRoot()方法ActivityProgressbarBinding返回 LinearLayout根视图。

三、用法实例

1、在Activity中使用视图绑定

要设置用于Activity的绑定类的实例，请在Activity的onCreate()方法中执行以下步骤 ：

  1. 调用inflate()包含在生成的绑定类中的静态方法。这会为要使用的活动创建绑定类的实例。
  2. 通过调用getRoot()方法获取对根视图的引用。
  3. 将根视图传递给以 setContentView() 使其成为屏幕上的活动视图。

实例如下：

private ActivityProgressbarBinding activityProgressbarBinding;

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    activityProgressbarBinding = ActivityProgressbarBinding.inflate(getLayoutInflater());

    //View view = activityProgressbarBinding.getRoot();
    //setContentView(view);
    //一步到位也可以
    setContentView(activityProgressbarBinding.getRoot());

    //使用绑定类的实例来引用任何View(XML中必须添加id)
    activityProgressbarBinding.progress1.setMax(120);
    activityProgressbarBinding.progress3.setProgress(20);
}

2、在Fragment中使用视图绑定

要设置与Fragment一起使用的绑定类的实例，请在Fragment的onCreateView()方法 中执行以下步骤 ：

  1. 调用inflate()包含在生成的绑定类中的静态方法。这会为要使用的Fragment创建绑定类的实例。
  2. 通过调用getRoot()方法获取对根视图的引用。
  3. 从onCreateView()方法返回根视图，使其成为屏幕上的活动视图。

注意： 该inflate()方法要求你传入布局充气器。如果布局已经inflated，你可以改为调用绑定类的静态bind()方法。

实例如下：

private FragmentMineBinding binding;

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    binding = FragmentMineBinding.inflate(inflater,container,false);
    View view = binding.getRoot();
    return view;
}

@Override
public void onDestroy() {
    super.onDestroy();
    binding = null;
}

3、提供不同配置的提示

当你跨多个配置声明视图时，有时根据特定布局使用不同的视图类型是有意义的。例如：

# in res/layout/example.xml
<TextView android:id="@+id/user_bio" />

# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" />

在这种情况下，你可能希望生成的类公开一个userBio type字段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的类。

该值必须是放置它的标签的超类。例如，以下值将不起作用：

<!-- ImageView is not related to TextView -->
<TextView tools:viewBindingType="ImageView" />

<!-- Button is not a superclass of TextView -->
<TextView tools:viewBindingType="Button" />

最终类型必须在所有配置中一致解析。

三、与 findViewById 的区别

与使用相比，ViewBinding 具有重要的优势 findViewById：

  • 空安全：由于视图绑定创建了对视图的直接引用，因此不存在因视图 ID 无效而导致空指针异常的风险。此外，当视图仅存在于布局的某些配置中时，绑定类中包含其引用的字段会标记为 @Nullable。
  • 类型安全：每个绑定类中的字段的类型与其在 XML 文件中引用的视图相匹配。这意味着没有类转换异常的风险。

这些差异意味着你的布局和代码之间的不兼容性将导致你的构建在编译时而不是运行时失败。

与数据绑定的比较 ViewBinding 和 DataBinding 都生成可用于直接引用视图的绑定类。但是，ViewBinding 旨在处理更简单的用例，并提供以下优于 DataBinding 的好处：

  • 更快的编译： 视图绑定不需要注释处理，因此编译时间更快。
  • 易用性： 视图绑定不需要特别标记的 XML 布局文件，因此在您的应用程序中采用它的速度更快。在模块中启用视图绑定后，它会自动应用于该模块的所有布局。
  • 相反，与数据绑定相比，视图绑定有以下限制：
  • 视图绑定不支持布局变量或布局表达式，因此它不能用于直接从 XML 布局文件声明动态 UI 内容。
  • 布局变量或布局表达式： 表达式语言允许您编写处理由视图调度的事件的表达式。数据绑定库会自动生成将布局中的视图与数据对象绑定所需的类。
  • 视图绑定不支持双向数据绑定。
  • 双向数据绑定： 单向数据绑定，你可以在属性上设置一个值并设置一个对该属性更改做出反应的listener，双向数据绑定提供了此过程的快捷方式。

由于这些考虑，在某些情况下最好在项目中同时使用ViewBinding和DataBinding。你可以在需要高级功能的布局中使用DataBinding，而在不需要高级功能的布局中使用ViewBinding。

注意： 在很多情况下，视图绑定可以提供与数据绑定相同的好处，但实现更简单，性能更好。如果您主要使用数据绑定来替换 findViewById() 调用，使用视图绑定更佳。