Kotlin中Dagger 2 @Named注解构建异常排查与解决求助

Problem Overview #

你遇到的问题是：相同的Dagger 2模块代码在Java中可以正常编译运行，但在Kotlin中抛出构建异常，错误提示：

[dagger.android.AndroidInjector.inject(T)] @javax.inject.Named("LOGGING_INTERCEPTOR") okhttp3.Interceptor cannot be provided without an @Provides-annotated method

你的API模块代码片段如下：

@Provides @Named(LOGGING_INTERCEPTOR) fun provideLoggingInterceptor() = HttpLoggingInterceptor().apply { level = HttpLoggingInterceptor.Level.BODY }
@Provides @Named(CONNECTIVITY_INTERCEPTOR) fun provideConnectivityInterceptor(): Interceptor = ConnectivityInterceptor()
@Singleton @Provides fun provideOkHttpClient(
    @Named(CONNECTIVITY_INTERCEPTOR) connectivityInterceptor: Interceptor,
    @Named(LOGGING_INTERCEPTOR) loggingInterceptor: Interceptor
): OkHttpClient = OkHttpClient.Builder()
    .connectTimeout(CONNECT_TIMEOUT, TimeUnit.SECONDS)
    .writeTimeout(WRITE_TIMEOUT, TimeUnit.SECONDS)
    .readTimeout(READ_TIMEOUT, TimeUnit.SECONDS)
    .addInterceptor(connectivityInterceptor)
    .apply { if (BuildConfig.DEBUG) addInterceptor(loggingInterceptor) }
    .build()

Root Causes #

这个问题主要是Kotlin和Java在注解处理、常量声明上的差异导致的，常见原因有两个：

1. Non-constant String for @Named Parameter
   Dagger要求@Named注解的参数必须是编译时常量。在Java中，普通的static final String就是编译时常量，但在Kotlin中，只有用const val声明的变量才会被当作编译时常量传递给注解参数。如果你只是用val声明LOGGING_INTERCEPTOR和CONNECTIVITY_INTERCEPTOR，Dagger在编译时无法解析到正确的字符串值，导致依赖匹配失败。

2. Implicit Return Type Inference
   Kotlin的类型推断虽然方便，但Dagger的注解处理器对某些隐式推断的返回类型可能识别不充分。比如你的provideLoggingInterceptor()方法没有显式指定返回类型为Interceptor，Dagger可能无法正确关联到需要@Named("LOGGING_INTERCEPTOR") Interceptor的依赖。

Solutions #

针对这些原因，你可以按以下步骤解决：

1. 使用const val声明注解常量

修改你的常量声明，确保它们是编译时常量：

import javax.inject.Named

const val LOGGING_INTERCEPTOR = "LOGGING_INTERCEPTOR"
const val CONNECTIVITY_INTERCEPTOR = "CONNECTIVITY_INTERCEPTOR"
const val CONNECT_TIMEOUT = 30L
const val WRITE_TIMEOUT = 30L
const val READ_TIMEOUT = 30L

2. 显式指定@Provides方法的返回类型

给provideLoggingInterceptor()方法加上明确的返回类型Interceptor，让Dagger清晰识别提供的依赖类型：

@Provides @Named(LOGGING_INTERCEPTOR) fun provideLoggingInterceptor(): Interceptor = 
    HttpLoggingInterceptor().apply { level = HttpLoggingInterceptor.Level.BODY }

3. 验证注解导入

确保你在Kotlin文件中导入的是正确的@Named注解：

import javax.inject.Named
import javax.inject.Provides
import javax.inject.Singleton

4. 清理并重新构建项目

有时候Android Studio的缓存会导致Dagger代码生成异常，执行以下操作：

• 点击Build -> Clean Project
• 然后点击Build -> Rebuild Project
• 或者在终端运行Gradle命令：./gradlew clean build

Verification #

完成以上步骤后，重新构建项目，Dagger应该能正确识别你的@Named依赖，解决构建异常。

内容的提问来源于stack exchange，提问作者Near1999