[hilt 2탄] hilt 를 사용한 종속 항목 삽입

1️⃣Hilt Application class

- Application 란?

전역 어플리케이션 상태를 유지하기 위한 베이스가 되는 클래스를 말한다.

안드로이드에서 application은 모든 액티비티나 서비스와 같은 컴포넌트를 포함하고 있는 안드로이드 내에서 기본클래스이다. 

Application 클래스 또는 Application 클래스의 하위 클래수는 다른 클래스보다 먼저 인스턴스화된다

Hilt를 사용하는 모든 앱은 @HiltAndroidApp으로 주석이 지정된 Application 클래스를 포함해야한다.

1. 이 어노테이션을 Application에 적용하면 해당 클래스가 Hilt에서 사용하는 Application의 기본 클래스 역할을 하게 된다.

2. Application 클래스는 의존성 주입을 관리하는데 사용되는 컨테이너를 설정하고 초기화하는데 필요한 코드를 포함한다.

 

생성된 이 Hilt 구성 요소는 Application 객체의 수명 주기에 연결되며 관련한 종속항목을 제공한다.

또한 이 Hilt 구성 요소는 앱의 상위 구성요소이므로 다른 구성 요소는 이 Application에서 제공하는 종속 항목에 액세스할 수 있다.

 

- 컨테이너란?

컨테이너는 다른 객체들을 담고 있는 객체를 말한다. 

 

컨테이너에는 여러 유형이 있는데 의존성 주입 컨테이너는 객체 간의 의존성을 주입하고 관리하는 데 사용된다.

 

우리 코드 살펴보기

@HiltAndroidApp
class App : Application() {

 

2️⃣Android 클래스에 종속 항목 삽입

Application 클래스에 Hilt를 설정하고 애플리케이션 수준 구성요소를 사용할 수 있게 되면

-> Hilt는 @AndroidEntryPoint 주석이 있는 다른 Android 클래스에 종속 항목을 제공할 수 있다.

 

- 애플리케이션 구성 요소

애플리케이션 구성요소란 애플리케이션 전체에서 사용되는 의존성을 관리하는데 필요한 설정을 포함한다. 

 

1. Application 클래스 : 안드로이드 애플리케이션의 진입점이며 어플리케이션 전반에서 공유되는 설정이나 상태를 관리한다.

 

2. Application 모듈 : 의존성 주입을 위해 필요한 객체들을 생성하고 관리하는 모듈이다. 네트워크 모듈이나 데이터베이스 모듈 ..

 

3. Application 컴포넌트 : 의존성 주입을 관리하는 컴포넌트로 애플리케이션 전체에서 사용되는 의존성을 주입하는데 사용된다. 

 

 

코드 

@AndroidEntryPoint
class MenuDusplayActivity : AppCompatActivity() {

  @Inject lateinit var breakfastProvider : BreakfastMenuDataProvider
  ...
}

 

Android 클래스에 @AndroidEntryPoint로 주석을 지정하면 이 클래스에 종속된 Android 클래스에도 주석을 지정해야한다.

예를 들어 프래그먼트에 주석을 지정한다면 이 프래그먼트를 사용하는 활동에도 주석을 지정해야한다.

 

@AndroidEntryPoint는 프로젝트의 각 Android 클래스에 관한 개별 Hilt 구성 요소를 생성한다.

이러한 개별 Hilt 구성요소는 해당하는 각 상위 클래스에서 종속 항목을 받을 수 있다.

 

@ AndroidEntryPoint 은 각각의 Android 클래스에 대해 Hilt 구성요소를 생성해준다.

즉 각 Android 클래스가 Hilt의 의존성 주입 메커니즘을 사용할 수 있게 해주는 것이다!

 

- 구성요소란 의존성 주입을 관리하는데 사용되는 객체를 의미한다. Dagger는 의존성을 제공하는 객체와 이를 요청받는 객체 사이를 연결하고 관리하는데 컴포넌트를 사용한다.

 

- Hilt 컴포넌트 계층 구조 : 애플리케이션 수준의 컴포넌트와 액티비티, 프래그먼트, 서비스 등의 Android 구성 요소마다 하위 컴포넌트를 생성한다. 이러한 계층 구조에서 각 하위 컴포넌트는 상위 컴포넌트에서 종속항목을 받을 수 있다.

 

즉 AndroidEntryPoint를 어노테이션으로 사용하면 이 클래스는  Hilt에서 관리하는 컴포넌트로 간주되고 객체를 생성할 때 필요한 객체를 직접 생성하는 것이 아니라 의존성 주입을 사용할 수 있다.

 

AndroidEntryPoint어노테이션이 적용된 액티비티나 프래그먼트에 필드로 선언된 객체에 Inject 어노테이션이 있다면 Hilt는 해당 객체를 자동으로 생성하고 필요한 의존성을 주입해준다!

즉 지금 액티비티에서 그 객체를 사용할 수 있다.

 

3️⃣Hilt binding (결합) 정의 : Hilt가 필요한 종속항목을 제공하는 방법 

필드 삽입이란 객체의 필드에 의존성을 주입하는 방법을 의미한다.

- 클래스에서 필드란 클래스에 포함된 변수라고 생각하면 된다!

 

binding 결합은 특정 유형의 인스턴스를 종속항목으로 제공하는 데 필요한 정보를 포함한다.

 

생성자 삽입

: 클래스의 생성자에서 @Inject 주석을 사용하여 클래스의 인스턴스를 제공하는 방법을 Hilt에게 알린다.

class MenuDisplayActivity @Inject constructor(
	private val breakfastProvider : BreakfastProvider
  )
  { ... }

 

4️⃣Hilt 모듈

생성자 삽입을 할 수 없는 경우도 있다. 

1. 인터페이스

2. 외부 라이브러리의 클래스

이런 경우 Hilt 모듈을 사용하여 Hilt에 바인딩 정보를 제공할 수 있다.

 

Hilt 모듈은 @Module로 주석이 지정된 클래스이다.

Hilt 모듈에 @InstallIn 주석을 사용하여 각 모듈을 사용하거나 서ㄹ치한 Android 클래스를 Hilt에 알려야한다.

Hilt 모듈에 제공하는 종속 항목은 Hilt 모듈을 설치하는 Android 클래스와 연결된다.

 

예를 들어서 이해해보자!!!

Menu를 보여주는 Class와 그 클래스에 아침 메뉴를 전달해주는 Breakfast 클래스가 있다고 해보자.

class Menu {

}

class BreakfastProvider {

	fun provideBreakfast() :String {
    
     	return "계란 후라이와 토스트"
    
    }

 

5️⃣@Binds를 사용하여 인터페이스의 인스턴스 삽입

인터페이스는 생성자 삽입을 할 수 없다. 이 경우에는 @Binds로 주석이 지정된 추상함수를 생성하여 바인드 정보를 제공할 수 있다.

 

@Binds 주석은 인터페이스의 인스턴스를 제공해야할 때 사용할 구현을 Hilt에 알려준다.

1. 함수 반환 유형은 함수가 어떤 인터페이스의 인스턴스를 제공하는지 Hilt에 알려준다.

2. 함수 매개변수는 제공할 구현을 Hilt에 알려준다.

 

@interfact MealService{
	fun getMealMethods()
    
}

class MealServiceImpl @Inject constructor(
...
) : MealService {...}

@Binds
abstract fun bindMealService(
	mealSerivceImpl : MealServiceImpl // 제공할 구현을 Hilt에게 알려준다.
) : MealService // 함수가 어떤 인터페이스의 인스턴스를 제공하는지 Hilt에게 알려준다.

 

 

 

6️⃣@Provides를 사용하여 인스턴스 삽입

클래스가 외부 라이브러리에서 제공되기 때문에 클래스를 소유하지 않은 Retrofit이나 OkHttpClient 또는 빌더 패턴으로 인스턴스를 생성하는 경우에도 생성자 삽입이 불가능하다.

 

1. 함수 반환 유형 : 함수가 어떤 유형의 인스턴스를 제공하는지 Hilt에 알려준다.

2. 함수 매개변수 : 해당 유형의 종속 항목을 Hilt에 알려준다.

3. 함수 본문: 해당 유형의 인스턴스를 제공하는 방법 Hilt에 알려준다.