Hilt 循环依赖

我正在使用 Hilt 创建一个宠物项目，也许我遇到这个问题是因为我安装一切都在SingletonComponent::class，也许我应该为每一个创建组件。

宠物项目有一个NetworkModule, UserPrefsModule，当我尝试创建一个时，问题出现了Authenticator for OkHttp3.

这是我的网络模块

@Module
@InstallIn(SingletonComponent::class)
object NetworkModule {

    @Singleton
    @Provides
    fun providesHttpLoggingInterceptor() = HttpLoggingInterceptor()
        .apply {
            if (BuildConfig.DEBUG) level = HttpLoggingInterceptor.Level.BODY
        }

    @Singleton
    @Provides
    fun providesErrorInterceptor(): Interceptor {
        return ErrorInterceptor()
    }

    @Singleton
    @Provides
    fun providesAccessTokenAuthenticator(
        accessTokenRefreshDataSource: AccessTokenRefreshDataSource,
        userPrefsDataSource: UserPrefsDataSource,
    ): Authenticator = AccessTokenAuthenticator(
        accessTokenRefreshDataSource,
        userPrefsDataSource,
    )

    @Singleton
    @Provides
    fun providesOkHttpClient(
        httpLoggingInterceptor: HttpLoggingInterceptor,
        errorInterceptor: ErrorInterceptor,
        authenticator: Authenticator,
    ): OkHttpClient =
        OkHttpClient
            .Builder()
            .authenticator(authenticator)
            .addInterceptor(httpLoggingInterceptor)
            .addInterceptor(errorInterceptor)
            .build()

}

Then my UserPrefsModule is :

@Module
@InstallIn(SingletonComponent::class)
object UserPrefsModule {

    @Singleton
    @Provides
    fun provideSharedPreference(@ApplicationContext context: Context): SharedPreferences {
        return context.getSharedPreferences("user_prefs", Context.MODE_PRIVATE)
    }

    @Singleton
    @Provides
    fun provideUserPrefsDataSource(sharedPreferences: SharedPreferences): UserPrefsDataSource {
        return UserPrefsDataSourceImpl(sharedPreferences)
    }
}

然后我有一个AuthenticatorModule

@Module
@InstallIn(SingletonComponent::class)
object AuthenticationModule {

    private const val BASE_URL = "http://10.0.2.2:8080/"

    @Singleton
    @Provides
    fun provideRetrofit(okHttpClient: OkHttpClient): Retrofit = Retrofit.Builder()
        .addConverterFactory(MoshiConverterFactory.create())
        .baseUrl(BASE_URL)
        .client(okHttpClient)
        .build()

    @Singleton
    @Provides
    fun provideApiService(retrofit: Retrofit): AuthenticationService =
        retrofit.create(AuthenticationService::class.java)


    @Singleton
    @Provides
    fun providesAccessTokenRefreshDataSource(
        userPrefsDataSource: UserPrefsDataSource,
        authenticationService: AuthenticationService,
    ): AccessTokenRefreshDataSource = AccessTokenRefreshDataSourceImpl(
        authenticationService, userPrefsDataSource
    )
}

当我创建时问题就开始发生AccessTokenRefreshDataSourceImpl我需要AuthenticationService and UserPrefsDataSource，我收到此错误：

错误：[Dagger/DependencyCycle] 发现依赖循环： 公共抽象静态类 SingletonC 实现 App_GenerateInjector，

对于每个功能，例如登录、登录、验证等。我正在创建一个新的@Module像这样：

@Module
@InstallIn(SingletonComponent::class)
interface SignInModule {

    @Binds
    fun bindIsValidPasswordUseCase(
        isValidPasswordUseCaseImpl: IsValidPasswordUseCaseImpl,
    ): IsValidPasswordUseCase

    @Binds
    fun bindIsValidEmailUseCase(
        isValidEmailUseCase: IsValidEmailUseCaseImpl,
    ): IsValidEmailUseCase

     //Here in that Datasource I'm using the AuthenticationService from AuthenticationModule and it works
    @Binds
    fun bindSignInDataSource(
        signInDataSourceImpl: SignInDataSourceImpl
    ): SignInDataSource
}

的构造函数AccessTokenAutenticator

class AccessTokenAuthenticator @Inject constructor(
    private val accessTokenRefreshDataSource: AccessTokenRefreshDataSource,
    private val userPrefsDataSource: UserPrefsDataSource,
) : Authenticator {

的构造函数AccessTokenRefreshDatasource

class AccessTokenRefreshDataSourceImpl @Inject constructor(
    private val authenticationService: AuthenticationService,
    private val userPrefsDataSource: UserPrefsDataSource,
) : AccessTokenRefreshDataSource {

注意我的所有内容都在@Module按功能分开，以便将来能够模块化应用程序。

在大多数编程语言中，如果您需要 B 的实例来构造 A，并需要 A 的实例来构造 B，那么您将无法构造其中任何一个。

Here:

• AccessTokenRefreshDataSource 需要 AuthenticationService
• AuthenticationService 需要 Retrofit
• 改造需要OkHttpClient
• OkHttpClient 需要验证器
• 身份验证器需要 AccessTokenRefreshDataSource

...因此，无论您的模块或组件结构如何，Dagger 都无法首先创建任何这些实例.

但是，如果您的 AccessTokenRefreshDataSourceImpl 不需要在构造函数本身内使用其 AuthenticationService 实例，则可以将其替换为Provider<AuthenticationService>：匕首自动让你注射Provider<T>对于图中的任意 T，其他有用的绑定。这允许 Dagger 创建 AccessTokenRefreshDataSource，而无需首先创建 AuthenticationService，并承诺一旦创建了对象图，您的 AccessTokenRefreshDataSource 就可以接收它所需的单例 AuthenticationService 实例。注入提供程序后，只需调用authenticationServiceProvider.get()在您需要的地方获取实例（大概在构造函数之外）。

当然，您可以在您控制的图表中的其他任何地方使用相同的重构来解决您的问题。 AccessTokenAuthenticator 也是一个合理的重构点，假设您自己编写了它，因此可以修改它的构造函数。

评论中讨论的要点：

• You can always inject a Provider<T> instead of any binding T in your graph. In addition to being valuable for breaking dependency cycles, it can also be handy if your dependency-injected class needs to instantiate an arbitrary number of that object, or if creating the object takes a lot of memory or classloading and you want to delay it until later. Of course, if the object is cheap to construct without dependency cycles and you expect to call get() exactly once, then you can skip that and directly inject T as you've done here.

  • Provider<T>是一个单方法对象。呼唤get()它与调用类型的 getter 相同T在组件本身上。如果该对象没有作用域，您将得到一个新对象；如果该对象是有作用域的，您将获得 Dagger 存储在组件中的对象。

  • 一般来说，您只需注入 Provider 并调用即可get直接在上面：

    class AccessTokenRefreshDataSourceImpl @Inject constructor(
      private val authenticationServiceProvider:
        Provider<AuthenticationService>,
      private val userPrefsDataSource: UserPrefsDataSource,
    ) : AccessTokenRefreshDataSource {
    

    ...然后而不是使用this.authenticationService.someMethod()直接使用this.authenticationServiceProvider.get().someMethod()。 Ma3x在评论中指出，如果你声明val authenticationService get() = authenticationServiceProvider.get()作为一个类字段，Kotlin 可以抽象出以下事实：get()涉及，您不需要对 AccessTokenRefreshDataSourceImpl 进行任何其他更改。

  • 您还需要更改@Provides方法在你的模块中，但只是因为你没有充分利用@InjectAccessTokenRefreshDataSourceImpl 上的注释如下。

    @Singleton
    @Provides
    fun providesAccessTokenRefreshDataSource(
        userPrefsDataSource: UserPrefsDataSource,
        authenticationServiceProvider: Provider<AuthenticationService>,  // here
    ): AccessTokenRefreshDataSource = AccessTokenRefreshDataSourceImpl(
        authenticationServiceProvider /* and here */, userPrefsDataSource
    )
    

• It is generally not necessary to use @Provides to refer to an @Inject-annotated constructor. @Provides is useful when you can't change the constructor to make it @Inject. @Inject can be less maintenance because then you don't need to copy @Provides method arguments to your constructor; Dagger will do that for you. Read more here.
  • 如果你使用@Inject并删除你的@Provides方法，您可能仍然想使用@Binds指示您的 AccessTokenRefreshDataSource 应绑定到 AccessTokenRefreshDataSourceImpl，不过您需要决定如何放置@Binds and @Provides在同一模块中。在 Java 8 中，你可以通过使你的@Provides方法static并将它们放在一个界面上，但在 Kotlin 中，创建一个嵌套界面并使用它安装可能会更容易@Module(includes = ...). 在这里阅读更多内容。