📌Dagger-Hilt 어노테이션 정리

Android에서 Hilt를 활용한 의존성 주입(DI)을 효율적으로 사용하기 위한 어노테이션을 정리했습니다.

---

1. Hilt의 핵심 어노테이션

Hilt는 Dagger 2 기반의 의존성 주입 라이브러리로, Android에서 DI를 더 쉽게 사용할 수 있도록 도와줍니다.
다음은 Hilt에서 사용되는 주요 어노테이션과 역할을 정리한 내용입니다.

---

2. Hilt 컴포넌트 관련 어노테이션

이 어노테이션들은 Hilt가 관리하는 컴포넌트 및 의존성의 범위를 설정하는 역할을 합니다.

📌 @HiltAndroidApp

• Application 클래스에 선언해야 하며, Hilt의 진입점 역할을 합니다.
• Hilt가 자동으로 DI를 설정하고 관리합니다.

@HiltAndroidApp
class MyApplication : Application()

📌 @AndroidEntryPoint

• Activity에서 Hilt를 사용하려면 이 어노테이션을 추가해야 합니다.

@AndroidEntryPoint
class MainActivity : AppCompatActivity()

📌 @HiltViewModel

• ViewModel에서 Hilt를 사용하여 의존성을 주입받을 때 사용합니다.

@HiltViewModel
class MyViewModel @Inject constructor(private val repository: MyRepository) : ViewModel()

📌 @EntryPoint

• Hilt에서 관리되지 않는 클래스(예: WorkManager, BroadcastReceiver)에서 의존성을 주입받을 때 사용합니다.

@EntryPoint
@InstallIn(SingletonComponent::class)
interface WorkerEntryPoint {
    fun getRepository(): MyRepository
}

---

3. 모듈 및 바인딩 관련 어노테이션

Hilt에서 의존성을 제공하는 방법을 정의하는 어노테이션입니다.

📌 @Module

• Hilt에서 의존성을 제공하는 클래스를 정의하는 모듈로 사용됩니다.

@Module
@InstallIn(SingletonComponent::class)
object AppModule {
    @Provides
    fun provideString(): String = "Hello, Dagger Hilt!"
}

📌 @InstallIn

• 해당 모듈이 어느 컴포넌트에서 사용할지를 지정합니다.

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

📌 @Provides

• Hilt에서 직접 객체를 생성하여 반환할 때 사용됩니다.

@Provides
fun provideApiService(): ApiService = ApiServiceImpl()

📌 @Binds

• 인터페이스의 구현체를 연결할 때 사용되며, 반드시 abstract 메서드를 사용해야 합니다.

@Module
@InstallIn(SingletonComponent::class)
abstract class RepositoryModule {
    @Binds
    abstract fun bindRepository(impl: RepositoryImpl): Repository
}

📌 @BindsInstance

• Hilt 컴포넌트를 생성할 때 특정 값을 바인딩할 때 사용됩니다.

@BindsInstance
fun bindBaseUrl(@Named("BASE_URL") baseUrl: String): Builder

---

4. 의존성 주입 관련 어노테이션

실제 객체가 주입되는 방식과 관련된 어노테이션입니다.

📌 @Inject

• 생성자에 선언하여 생성자 주입을 사용할 수 있도록 합니다.

class Repository @Inject constructor(private val apiService: ApiService)

📌 @Named

• 같은 타입의 여러 의존성을 구분할 때 사용됩니다.

@Provides
@Named("API_URL")
fun provideApiUrl(): String = "https://example.com"

class ApiService @Inject constructor(@Named("API_URL") private val apiUrl: String)

📌 @Qualifier

• @Named와 유사하지만, 사용자 지정 어노테이션을 만들 때 사용됩니다.

@Qualifier
@Retention(AnnotationRetention.BINARY)
annotation class LocalDataSource

@Qualifier
@Retention(AnnotationRetention.BINARY)
annotation class RemoteDataSource

---

5. Hilt의 스코프 및 생명주기 관련 어노테이션

Hilt에서 특정 범위에 맞게 객체를 관리할 수 있도록 설정하는 어노테이션입니다.

📌 @Singleton

• 싱글톤 범위에서 객체를 관리할 때 사용됩니다.

@Provides
@Singleton
fun provideDatabase(): AppDatabase = Room.databaseBuilder(...)

📌 @ViewScoped

• View의 생명주기에 맞춰 객체를 유지할 때 사용됩니다. (Compose에서 유용)

@ViewScoped
@Provides
fun provideViewScopedRepository(): ViewScopedRepository

---

6. 기타 유용한 어노테이션

어노테이션	설명
@HiltWorker	WorkManager에서 Hilt를 사용할 때 사용
@EntryPoint	Hilt에서 관리되지 않는 클래스에서 DI를 사용할 때 사용
@ViewScoped	View의 생명주기에 맞춰 객체를 관리

---

7. Hilt 어노테이션 요약

어노테이션	역할
애플리케이션 & 엔트리 포인트
@HiltAndroidApp	Application에서 Hilt 설정
@AndroidEntryPoint	Activity, Fragment 등에서 DI 활성화
@HiltViewModel	ViewModel에서 Hilt 사용
@EntryPoint	Hilt에서 관리되지 않는 클래스에서 DI 사용
모듈 & 바인딩
@Module	의존성을 제공하는 클래스
@InstallIn	모듈이 주입될 컴포넌트 지정
@Provides	객체를 직접 생성하여 제공
@Binds	인터페이스 - 구현체 연결
@BindsInstance	런타임에 값을 주입
의존성 주입 & 스코프
@Inject	생성자 주입 사용
@Named	같은 타입의 여러 객체 주입
@Qualifier	커스텀 주입 어노테이션
@Singleton	싱글톤 범위 지정
@HiltWorker	WorkManager에서 Hilt 사용

---

8. Provides와 Binds 비교

공부하면서 문득 그런 생각이 들었다.
나는 지금까지 인터페이스 - 구현체 연결할 때 @Provides로 처리하고 있었는데,
@Binds가 해당 역할을 할 때 사용하는 어노테이션이라니! 그래서 비교를 하려한다.

1️⃣ @Provides를 사용하는 경우

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

    @Provides
    fun provideRepository(apiService: ApiService): Repository {
        return RepositoryImpl(apiService)
    }
}

2️⃣ @Binds를 사용하는 경우

@Module
@InstallIn(SingletonComponent::class)
abstract class RepositoryModule {

    @Binds
    abstract fun bindRepository(impl: RepositoryImpl): Repository
}

✔ @Provides vs @Binds 차이점

비교 항목	@Provides	@Binds
반환 방식	직접 객체를 생성해 반환	이미 생성된 객체를 바인딩
사용 가능 조건	생성자가 @Inject 없이도 가능	생성자 주입(@Inject constructor) 필수
코드 스타일	일반적인 팩토리 메서드 방식	추상 클래스를 사용하여 선언적 스타일 유지
필요한 키워드	일반 fun 메서드 사용	abstract fun 메서드 사용
사용 권장 시점	복잡한 로직이 필요한 경우	단순히 인터페이스 - 구현체 연결할 때

---

📌 그럼, @Provides만 써도 되는 걸까?

아니다. @Provides만 써도 동작은 하지만, 최신 트렌드에서는 @Binds를 사용할 수 있으면 @Binds를 쓰는 것이 더 권장되는 방식.

🚀 @Binds를 선호하는 이유

1. 보일러플레이트 코드 감소

   • @Provides는 직접 객체를 생성해야 해서 코드가 길어질 수 있음.
   • @Binds는 단순히 "이 구현체를 인터페이스로 사용할게!" 라고 선언하는 방식이므로 더 깔끔함.

2. Dagger가 최적화된 그래프를 구성할 수 있음

   • @Binds는 불필요한 객체 생성을 방지하고, 의존성 그래프가 더 효율적으로 동작하게 함.

3. 유지보수성 증가

   • @Binds를 사용하면 생성자 주입을 강제할 수 있어서 유지보수가 편리함.
   • @Provides를 사용하면 객체를 직접 생성하기 때문에, 의존성 변경 시 @Provides 메서드를 수정해야 할 수도 있음.

---

📌 @Provides를 써야 하는 경우

다음과 같은 경우에는 @Provides를 사용하는 것이 필수적이거나 더 적절.

1. 외부 라이브러리 객체를 제공해야 할 때

   • 예를 들어, Retrofit, OkHttpClient, Room Database 같은 객체들은 우리가 생성자를 수정할 수 없으므로 @Provides를 사용해야 함.

   @Module
   @InstallIn(SingletonComponent::class)
   object NetworkModule {
       @Provides
       fun provideRetrofit(): Retrofit {
           return Retrofit.Builder()
               .baseUrl("https://api.example.com")
               .build()
       }
   }

2. 객체 생성 시 복잡한 로직이 필요할 때

   • 만약 객체를 생성하는데 추가적인 로직(초기화, 설정)이 필요하다면 @Provides가 더 적절함.

   @Provides
   fun provideRepository(apiService: ApiService): Repository {
       return RepositoryImpl(apiService, enableLogging = true)
   }

   • @Binds는 단순한 인터페이스-구현체 연결을 위해 사용되므로, 이런 경우 @Provides가 필요함.

3. 생성자 주입이 불가능한 경우

   • @Binds는 생성자 주입(@Inject constructor)이 가능해야만 사용할 수 있음.
   • 생성자가 private이거나, object, sealed class 등의 경우 @Binds를 사용할 수 없기 때문에 @Provides가 필요함.

---

📌 정리: @Binds를 우선 사용하고, 필요할 때만 @Provides 사용

✅ 인터페이스 - 구현체 연결은 @Binds를 사용!
✅ 외부 라이브러리나 복잡한 객체 생성이 필요하면 @Provides를 사용!

// ✅ 권장되는 방식: @Binds 사용
@Module
@InstallIn(SingletonComponent::class)
abstract class RepositoryModule {
    @Binds
    abstract fun bindRepository(impl: RepositoryImpl): Repository
}

// ✅ 외부 라이브러리나 복잡한 로직이 필요할 경우 @Provides 사용
@Module
@InstallIn(SingletonComponent::class)
object NetworkModule {
    @Provides
    fun provideRetrofit(): Retrofit {
        return Retrofit.Builder()
            .baseUrl("https://api.example.com")
            .build()
    }
}

---

📝 더 자세한 내용이 궁금하다면 공식 문서를 참고하세요!
🔗 공식 문서

---