[TIL] 🌼24/04/27🌼#Hilt @Binds @Provides

[TIL] 🌼24/04/27🌼#Hilt @Binds @Provides

Hilt @Binds @Provides

📌참고자료

• Dependency injection with Hilt | Android Developers
• [Android, Kotlin] Hilt에서 @Binds와 @Provides의 차이점

• Hilt를 사용할 때 프로젝트 내에서 constructor를 통해 클래스의 인스턴스를 생성할 수 있는 경우, 바로 종속성을 제공할 수 있음 (= constructor-injection)
  -> 그렇지 않은 경우, Hilt Module을 추가하여 종속성을 제공해야

• Hilt Module을 통해 제공해야 하는 종속성의 종류에 따라 @Binds 또는 @Provides 사용
• @Binds
  • 인터페이스에 대한 종속성 삽입에 사용
  • abstract class 모듈 안에 abstract function 정의
    • 함수 return 타입: 제공하는 인스턴스의 인터페이스
    • 함수 parameter: Hilt가 제공할 인터페이스의 구현 객체

@Module
@InstallIn(ViewModelComponent::class)
abstract class RepositoryModule {
    @Binds
    abstract fun bindsItemRepository(repositoryImpl: ItemRepositoryImpl): ItemRepository
}

• @Provides
  • 외부 라이브러리에서 제공되는 클래스이므로 프로젝트 내에서 소유할 수 없는 경우/Builder 패턴을 통해 인스턴스를 생성해야 하는 경우 사용
  • object 모듈 안에 function 정의
    • 함수 return 타입: 제공하는 인스턴스의 타입
    • 함수 parameters: 해당 타입의 종속성
    • 함수 body: 제공하는 인스턴스 생성 방법, Hilt가 해당 타입의 인스턴스를 제공해야할 때마다 실행됨

@Module
@InstallIn(SingletonComponent::class)
object RemoteSourceModule {
    @Singleton
    @Provides
    fun provideKakaoSearchApi() = KakaoSearchRetrofit.kakaoSearchApi
}

• @Provides만 포함되는 Module의 경우 object로 생성
  -> providers get optimized & almost in-lined in generated code