Dagger2: Optional bindings, 解析和最佳实践

2023-09-16 21:49:53

导言

Java 中的 Optional 类型是一种强大的工具，可帮助避免恼人的空指针异常。它包裹一个对象，该对象可能是空或非空的，并提供诸如 isPresent() 之类的实用方法来安全地访问其内部值。

Dagger2，流行的 Android 和 Java 依赖注入框架，通过 @BindsOptionalOf 注解提供了对 Optional 类型的一流支持。它允许您注入 Optional 类型的变量，并提供了一种优雅的方式来处理可能为 null 的依赖项。

Optional Bindings 的工作原理

当您在 Dagger2 模块中使用 @BindsOptionalOf 注解时，Dagger 会生成一个 Provider，该 Provider 可以返回 Optional 实例。如果相应的依赖项存在，则该实例将包含该依赖项，否则将为空。

例如，以下模块绑定了一个 Optional 类型的 User 变量：

@Module
public class UserModule {

    @BindsOptionalOf
    abstract User provideUser(SharedPreferences preferences);
}

现在，您可以像这样注入 User 变量：

@Inject
Optional<User> user;

最佳实践

使用 Optional bindings 时，请遵循以下最佳实践：

明智地使用： 并非每个依赖项都适合用 Optional 绑定。将 Optional bindings 保留给可能为 null 的依赖项，例如从持久化存储或远程服务中获取的对象。
明确处理 null： 使用 Optional.isPresent() 方法始终检查 Optional 实例是否为空。在访问内部值之前，请明确处理 null 情况。
避免嵌套 Optional： 如果可能，请避免将 Optional 实例嵌套在其他 Optional 实例中。这会使代码难以阅读和维护。
考虑使用 @Nullable： 在某些情况下，使用 @Nullable 注解可能比使用 Optional bindings 更合适。这表明一个变量可以为 null，但不需要注入 Optional 实例。

与传统绑定对比

与传统的 Dagger2 绑定相比，Optional bindings 提供了几个优势：