在多模块应用中使用 Dagger

具有多个 Gradle 模块的项目称为多模块项目。在一个作为单个 APK 发布且不含功能模块的多模块项目中，通常有一个 app 模块，它可以依赖于项目的大多数模块，以及一个 base 或 core 模块，其他模块通常依赖于它。app 模块通常包含您的 Application 类，而 base 模块包含项目所有模块共享的所有通用类。

app 模块是声明您的应用组件（例如，下图中 ApplicationComponent）的好地方，该组件可以提供其他组件可能需要的对象以及您应用的单例。例如，core 模块中可能定义的 OkHttpClient、JSON 解析器、数据库访问器或 SharedPreferences 等类将由 app 模块中定义的 ApplicationComponent 提供。

在 app 模块中，您还可以有其他生命周期较短的组件。例如，一个在登录后具有用户特定配置（如 UserSession）的 UserComponent。

在项目的不同模块中，您可以定义至少一个子组件，其中包含特定于该模块的逻辑，如图 1 所示。

图 1. 多模块项目中的 Dagger 图示例

例如，在 login 模块中，您可以有一个使用自定义 @ModuleScope 注解进行作用域划分的 LoginComponent，它可以提供该功能共有的对象，例如 LoginRepository。在该模块内，您还可以有其他依赖于具有不同自定义作用域（例如 @FeatureScope）的 LoginComponent 的组件，例如 LoginActivityComponent 或 TermsAndConditionsComponent，您可以在其中作用域化更具功能特定的逻辑，例如 ViewModel 对象。

对于 Registration 等其他模块，您将进行类似的设置。

多模块项目的一般规则是相同级别的模块不应相互依赖。如果它们相互依赖，请考虑该共享逻辑（它们之间的依赖关系）是否应该成为父模块的一部分。如果是，则重构以将类移动到父模块；如果不是，则创建一个扩展父模块的新模块，并让这两个原始模块都扩展新模块。

作为最佳实践，您通常会在以下情况下在模块中创建组件：

  • 您需要执行字段注入，例如使用 LoginActivityComponent。

  • 您需要作用域化对象，例如使用 LoginComponent。

如果上述两种情况都不适用，并且您需要告诉 Dagger 如何从该模块提供对象，则创建并公开一个 Dagger 模块，其中包含 @Provides 或 @Binds 方法（如果这些类无法进行构造函数注入）。

使用 Dagger 子组件实现

在 Android 应用中使用 Dagger 文档页面介绍了如何创建和使用子组件。但是，您不能使用相同的代码，因为功能模块不知道 app 模块。例如，如果您考虑典型的登录流程和我们上一页中的代码，它将不再编译。

Kotlin

class LoginActivity: Activity() {
  ...

  override fun onCreate(savedInstanceState: Bundle?) {
    // Creation of the login graph using the application graph
    loginComponent = (applicationContext as MyDaggerApplication)
                        .appComponent.loginComponent().create()

    // Make Dagger instantiate @Inject fields in LoginActivity
    loginComponent.inject(this)
    ...
  }
}

Java

public class LoginActivity extends Activity {
    ...

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // Creation of the login graph using the application graph
        loginComponent = ((MyApplication) getApplicationContext())
                                .appComponent.loginComponent().create();

        // Make Dagger instantiate @Inject fields in LoginActivity
        loginComponent.inject(this);

        ...
    }
}

原因是 login 模块不知道 MyApplication 也不知道 appComponent。为了使其工作，您需要在功能模块中定义一个接口，该接口提供 FeatureComponent，而 MyApplication 需要实现该接口。

在以下示例中，您可以在 login 模块中为登录流程定义一个 LoginComponentProvider 接口，该接口提供 LoginComponent

Kotlin

interface LoginComponentProvider {
    fun provideLoginComponent(): LoginComponent
}

Java

public interface LoginComponentProvider {
   public LoginComponent provideLoginComponent();
}

现在，LoginActivity 将使用该接口而不是上面定义的代码片段

Kotlin

class LoginActivity: Activity() {
  ...

  override fun onCreate(savedInstanceState: Bundle?) {
    loginComponent = (applicationContext as LoginComponentProvider)
                        .provideLoginComponent()

    loginComponent.inject(this)
    ...
  }
}

Java

public class LoginActivity extends Activity {
    ...

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        loginComponent = ((LoginComponentProvider) getApplicationContext())
                                .provideLoginComponent();

        loginComponent.inject(this);

        ...
    }
}

现在，MyApplication 需要实现该接口并实现所需的方法

Kotlin

class MyApplication: Application(), LoginComponentProvider {
  // Reference to the application graph that is used across the whole app
  val appComponent = DaggerApplicationComponent.create()

  override fun provideLoginComponent(): LoginComponent {
    return appComponent.loginComponent().create()
  }
}

Java

public class MyApplication extends Application implements LoginComponentProvider {
  // Reference to the application graph that is used across the whole app
  ApplicationComponent appComponent = DaggerApplicationComponent.create();

  @Override
  public LoginComponent provideLoginComponent() {
    return appComponent.loginComponent.create();
  }
}

这就是您在多模块项目中使用 Dagger 子组件的方式。对于功能模块，由于模块之间相互依赖的方式不同，解决方案也不同。

带功能模块的组件依赖

对于功能模块，模块之间相互依赖的方式通常是反向的。功能模块依赖于 app 模块，而不是 app 模块包含功能模块。图 2 显示了模块的结构。

图 2. 带功能模块的项目中的 Dagger 图示例

在 Dagger 中，组件需要了解其子组件。此信息包含在添加到父组件的 Dagger 模块中（例如在 Android 应用中使用 Dagger 中的 SubcomponentsModule 模块）。

不幸的是，由于应用和功能模块之间的反向依赖关系，子组件在 app 模块中不可见，因为它不在构建路径中。例如，在 login 功能模块中定义的 LoginComponent 不能是 app 模块中定义的 ApplicationComponent 的子组件。

Dagger 有一种称为组件依赖的机制，您可以使用它来解决此问题。子组件不是父组件的子组件，而是依赖于父组件。这样就没有父子关系了；现在组件依赖于其他组件来获取某些依赖项。组件需要从图中公开类型，以便依赖组件能够使用它们。

例如：一个名为 login 的功能模块想要构建一个 LoginComponent，该组件依赖于 app Gradle 模块中可用的 AppComponent。

下面是作为 app Gradle 模块一部分的类和 AppComponent 的定义

Kotlin

// UserRepository's dependencies
class UserLocalDataSource @Inject constructor() { ... }
class UserRemoteDataSource @Inject constructor() { ... }

// UserRepository is scoped to AppComponent
@Singleton
class UserRepository @Inject constructor(
    private val localDataSource: UserLocalDataSource,
    private val remoteDataSource: UserRemoteDataSource
) { ... }

@Singleton
@Component
interface AppComponent { ... }

Java

// UserRepository's dependencies
public class UserLocalDataSource {

    @Inject
    public UserLocalDataSource() {}
}

public class UserRemoteDataSource {

    @Inject
    public UserRemoteDataSource() { }
}

// UserRepository is scoped to AppComponent
@Singleton
public class UserRepository {

    private final UserLocalDataSource userLocalDataSource;
    private final UserRemoteDataSource userRemoteDataSource;

    @Inject
    public UserRepository(UserLocalDataSource userLocalDataSource, UserRemoteDataSource userRemoteDataSource) {
        this.userLocalDataSource = userLocalDataSource;
        this.userRemoteDataSource = userRemoteDataSource;
    }
}

@Singleton
@Component
public interface ApplicationComponent { ... }

在包含 app Gradle 模块的 login Gradle 模块中，您有一个 LoginActivity，它需要注入一个 LoginViewModel 实例

Kotlin

// LoginViewModel depends on UserRepository that is scoped to AppComponent
class LoginViewModel @Inject constructor(
    private val userRepository: UserRepository
) { ... }

Java

// LoginViewModel depends on UserRepository that is scoped to AppComponent
public class LoginViewModel {

    private final UserRepository userRepository;

    @Inject
    public LoginViewModel(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
}

LoginViewModel 依赖于 UserRepository；并且为了让 LoginComponent 能够从 AppComponent 访问它，让我们创建一个依赖于 AppComponent 的 LoginComponent 来注入 LoginActivity

Kotlin

// Use the dependencies attribute in the Component annotation to specify the
// dependencies of this Component
@Component(dependencies = [AppComponent::class])
interface LoginComponent {
    fun inject(activity: LoginActivity)
}

Java

// Use the dependencies attribute in the Component annotation to specify the
// dependencies of this Component
@Component(dependencies = AppComponent.class)
public interface LoginComponent {

    void inject(LoginActivity loginActivity);
}

LoginComponent 通过将其添加到组件注解的依赖参数来指定对 AppComponent 的依赖。由于 LoginActivity 将由 Dagger 注入，因此将 inject() 方法添加到接口。

创建 LoginComponent 时，需要传入 AppComponent 的实例。使用组件工厂来完成此操作

Kotlin

@Component(dependencies = [AppComponent::class])
interface LoginComponent {

    @Component.Factory
    interface Factory {
        // Takes an instance of AppComponent when creating
        // an instance of LoginComponent
        fun create(appComponent: AppComponent): LoginComponent
    }

    fun inject(activity: LoginActivity)
}

Java

@Component(dependencies = AppComponent.class)
public interface LoginComponent {

    @Component.Factory
    interface Factory {
        // Takes an instance of AppComponent when creating
        // an instance of LoginComponent
        LoginComponent create(AppComponent appComponent);
    }

    void inject(LoginActivity loginActivity);
}

现在，LoginActivity 可以创建 LoginComponent 的实例并调用 inject() 方法。

Kotlin

class LoginActivity: Activity() {

    // You want Dagger to provide an instance of LoginViewModel from the Login graph
    @Inject lateinit var loginViewModel: LoginViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        // Gets appComponent from MyApplication available in the base Gradle module
        val appComponent = (applicationContext as MyApplication).appComponent

        // Creates a new instance of LoginComponent
        // Injects the component to populate the @Inject fields
        DaggerLoginComponent.factory().create(appComponent).inject(this)

        super.onCreate(savedInstanceState)

        // Now you can access loginViewModel
    }
}

Java

public class LoginActivity extends Activity {

    // You want Dagger to provide an instance of LoginViewModel from the Login graph
    @Inject
    LoginViewModel loginViewModel;

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

        // Gets appComponent from MyApplication available in the base Gradle module
        AppComponent appComponent = ((MyApplication) getApplicationContext()).appComponent;

        // Creates a new instance of LoginComponent
        // Injects the component to populate the @Inject fields
        DaggerLoginComponent.factory().create(appComponent).inject(this);

        // Now you can access loginViewModel
    }
}

LoginViewModel 依赖于 UserRepository；并且为了让 LoginComponent 能够从 AppComponent 访问它，AppComponent 需要在其接口中公开它

Kotlin

@Singleton
@Component
interface AppComponent {
    fun userRepository(): UserRepository
}

Java

@Singleton
@Component
public interface AppComponent {
    UserRepository userRepository();
}

带依赖组件的作用域规则与子组件的作用域规则相同。因为 LoginComponent 使用 AppComponent 的实例，所以它们不能使用相同的范围注解。

如果您想将 LoginViewModel 作用域化到 LoginComponent，您可以像以前一样使用自定义的 @ActivityScope 注解来完成。

Kotlin

@ActivityScope
@Component(dependencies = [AppComponent::class])
interface LoginComponent { ... }

@ActivityScope
class LoginViewModel @Inject constructor(
    private val userRepository: UserRepository
) { ... }

Java

@ActivityScope
@Component(dependencies = AppComponent.class)
public interface LoginComponent { ... }

@ActivityScope
public class LoginViewModel {

    private final UserRepository userRepository;

    @Inject
    public LoginViewModel(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
}

最佳实践

  • ApplicationComponent 应该始终位于 app 模块中。

  • 如果您需要在该模块中执行字段注入，或者需要为应用程序的特定流程作用域对象，则在模块中创建 Dagger 组件。

  • 对于旨在作为实用程序或辅助工具的 Gradle 模块，并且不需要构建图（这就是您需要 Dagger 组件的原因），请创建并公开带有 @Provides 和 @Binds 方法的公共 Dagger 模块，用于那些不支持构造函数注入的类。

  • 要在带功能模块的 Android 应用中使用 Dagger，请使用组件依赖项来访问 app 模块中定义的 ApplicationComponent 提供的依赖项。