DI - Hilt의 관하여

이 글에서 배울점

- 다른 DI와의 차이점

- Hilt의 관한 전반적인 지식

- Hilt를 사용하는 방법

- Hilt에서 자주 사용하는 Annotation

 

 

DI -> Dependency Inject 의존성 주입 이라고 한다.

이전의 Koin에 관한 블로그를 작성 했을 때도 공부를 했었지만 Hilt를 좀 더 많이 알아보려 다시금 글을 쓴다.

 

이전에 썼던 Koin에 관한 블로그

의존성 주입의 Koin🪙 한 닢을 - 1

 

의존성 주입의 Koin🪙 두 닢을 - 2

 

 

다른 DI와의 차이점

이전에도 작성했던 Koin과 Hilt, Dagger에 차이에 대해 잠깐 보여드리자면

	Hilt(Jetpack)	Dagger2	Koin
Java	O	O	X
Kotlin	O	O	O
러닝커브	낮음	높음	낮음
에러검출 시점	Compile Time	Compile Time	Runtime
실제 프로젝트 검증	beta버전(조금씩 보임) 이라고 썼었지만 이제는 정식 버전 무려 2.44 버전까지 출시	많은 앱에서 검증됨	많은 앱에서 검증됨

이런 차이를 보였었다. 

 

하지만 이전엔 러닝커브도 낮고 운영되고 있는 서비스에 추가해야하는 부분 때문에 검증된 Koin을 사용했었지만

Hilt가 점점 계속해서 업데이트도 되고 가장 맘에 드는 것은 Complie 단계에서 에러를 검출해주었기 때문에 앱 안정성에서도 훨씬 좋은 점을 보여주기 때문에 도입 및 사용하고 있다.

 

Hilt의 관한 전반적인 지식

Hilt의 뜻을 직역하면 

명사

1.(칼) 자루, (곡괭이의) 자루, (권총·단도 등의) 손잡이(haft)

로 되어있다. 기능을 이해하고 뜻을 다시보면 왜 Hilt라는 단어를 사용했는지 쉽게 알 수 있다.

 

먼저 DI, Hilt를 사용시 이점을 아래 google developer에서 설명해준 것은

 

• 클래스 재사용 가능 및 종속 항목 분리: 종속 항목 구현을 쉽게 교체할 수 있습니다. 컨트롤 반전으로 인해 코드 재사용이 개선되었으며 클래스가 더 이상 종속 항목 생성 방법을 제어하지 않지만 대신 모든 구성에서 작동합니다.
• 리팩터링 편의성: 종속 항목은 API 노출 영역의 검증 가능한 요소가 되므로 구현 세부정보로 숨겨지지 않고 객체 생성 시간 또는 컴파일 시간에 확인할 수 있습니다.
• 테스트 편의성: 클래스는 종속 항목을 관리하지 않으므로 테스트 시 다양한 구현을 전달하여 다양한 모든 사례를 테스트할 수 있습니다.

으로 설명한다.

Android의 종속 항목 삽입  |  Android 개발자  |  Android Developers

 

 

Hilt는 Dagger가 제공하는 컴파일 시간 정확성, 런타임 성능, 확장성 및 Android 스튜디오 지원의 이점을 누리기 위해 인기 있는 DI 라이브러리인 Dagger를 기반으로 빌드되었습니다.

 

Hilt를 사용하는 간단한 방법

1. PlugIn 및 Gradle 추가

 

build.gradle 파일

plugins {
  ...
  id("com.google.dagger.hilt.android") version "2.44" apply false
}

app/build.gradle

plugins {
  ...
  kotlin("kapt")
  id 'dagger.hilt.android.plugin'
}

android {
  ...
}

dependencies {
  implementation("com.google.dagger:hilt-android:2.44")
  kapt("com.google.dagger:hilt-android-compiler:2.44")
}

// 생성된 코드에 대한 참조 허용
kapt {
  correctErrorTypes = true
}

 

2. Application Class 파일 생성

 

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

@HiltAndroidApp은 애플리케이션 수준 종속 항목 컨테이너 역할을 하는 애플리케이션의 기본 클래스를 비롯하여 Hilt의 코드 생성을 트리거합니다.

 

@HiltAndroidApp
class ExampleApplication : Application() { ... }

 

생성된 이 Hilt 구성요소는 Application 객체의 수명 주기에 연결되며 이와 관련한 종속 항목을 제공합니다. 또한 이는 앱의 상위 구성요소이므로 다른 구성요소는 이 상위 구성요소에서 제공하는 종속 항목에 액세스할 수 있습니다.

 

3. Android 클래스에 종속 항목 삽입

Application 클래스에 Hilt를 설정하고 애플리케이션 수준 구성요소를 사용할 수 있게 되면 Hilt는 @AndroidEntryPoint 주석이 있는 다른 Android 클래스에 종속 항목을 제공할 수 있습니다.

@AndroidEntryPoint
class ExampleActivity : AppCompatActivity() { ... }

Hilt는 현재 다음 Android 클래스를 지원합니다.

• Application(@HiltAndroidApp을 사용하여)
• ViewModel(@HiltViewModel을 사용하여)
• Activity
• Fragment
• View
• Service
• BroadcastReceiver

4. Class 안에서 항목 사용하기

@Qualifier // 뜻 : 수식어
@Retention(AnnotationRetention.RUNTIME)
annotation class DebugState

@Module
@InstallIn(SingletonComponent::class)
class SomeModule {
  @Provides // 뜻 : 제공하다.
  @Singleton
  @DebugState
  fun getDebugState(): String {
      return if (BuildConfig.DEBUG) DEBUG_STATE else RELEASE_STATE
  }
  
  ...
}

@AndroidEntryPoint // 뜻 : 안드로이드 진입점
class ExampleActivity : AppCompatActivity() {
  @Inject // 뜻 : 주입하다
  @DebugState
  lateinit var debugState: String // 예시입니다.
  ...
}

@AndroidEntryPoint는 프로젝트의 각 Android 클래스에 관한 개별 Hilt 구성요소를 생성합니다. 이러한 구성요소는 구성요소 계층 구조에 설명된 대로 해당하는 각 상위 클래스에서 종속 항목을 받을 수 있습니다.

구성요소에서 종속 항목을 가져오려면 다음과 같이 @Inject 주석을 사용하여 필드 삽입을 실행합니다.

 

import androidx.activity.viewModels

@AndroidEntryPoint // 뜻 : 안드로이드 진입점
class ExampleActivity : AppCompatActivity() {
  private val viewModel: ExampleViewModel by viewModels()
  ...
}

---------------------------------------------------------------

@HiltViewModel // ViewModel은 @HiltViewModel 어노테이션을 써야한다.
class ExampleViewModel @Inject constructor(
    @DebugState private val debugState: String
) : ViewModel() {
  ...
}

위처럼 ViewModel에서 따로 사용할 때 사용할 수 있다.

Activity에서 보면 ViewModel을 생성할 때 파라미터를 직접 주입해주지 않아도 constructor에 넣어서 사용할 수 있다.

 

이 글은  2023년 7월 9일에 작성되었기에 버전 확인 및 적용은 아래 링크를 확인 후 도입하시기 바랍니다

Hilt를 사용한 종속 항목 삽입  |  Android 개발자  |  Android Developers

 

Hilt에서 자주 사용하는 Annotation

- @HiltAndroidApp : 힐트 코드 생성을 시작합니다. 응용 프로그램 클래스에 주석을 달아야 합니다.

@HiltAndroidApp
class MyApplication : Application() { ... }

 

- @AndroidEntryPoint : DI 컨테이너에 주석이 달린 Android 클래스에 DI 컨테이너를 추가합니다. 이렇게 하려면 Hilt의 Gradle 플러그인을 사용해야 합니다.

@AndroidEntryPoint
class MyActivity : AppCompatActivity() { ... }

 

- @Inject :

   1. Constructor Injection(생성자 주입). 인스턴스를 제공하는 데 사용할 생성자와 유형에 포함된 종속성을 지정합니다.

class AnalyticsAdapter @Inject constructor( 
  private val service: AnalyticsService
) { ... }

 

  2. Field Injection(현장 주입). @AndroidEntryPoint 주석이 달린 클래스의 필드를 채웁니다. 필드는 private 일 수 없습니다.

@AndroidEntryPoint
class MyActivity : AppCompatActivity() {
  @Inject lateinit var adapter: AnalyticsAdapter
  ... 
}

 

- @HiltViewModel : Hilt에게 Architecture Component View Model의 인스턴스를 제공하는 방법을 알려줍니다.

class MyViewModel @Inject constructor(
  private val adapter: AnalyticsAdapter,
  private val state: SavedStateHandle
): ViewModel() { ... }

 

- @Module : 생성자를 주입할 수 없는 형식에 바인딩을 추가할 수 있는 클래스입니다.

- @Installn : Hilt 생성 DI 컨테이너(코드의 Singleton Component) 모듈 바인딩을 사용할 수 있어야 함을 나타냅니다.

@InstallIn(SingletonComponent::class)
@Module
class AnalyticsModule { ... }

 

- @Provides : 생성자를 주입할 수 없는 형식에 대한 바인딩을 추가합니다:

   - 반환 형식은 바인딩 형식입니다.
   - 매개 변수는 종속성입니다.
   - 인스턴스가 필요할 때마다
함수 본문은 형식 범위가 지정되지 않은 경우 실행됩니다.

@InstallIn(SingletonComponent::class)
@Module
class AnalyticsModule {
    @Provides
    fun providesAnalyticsService(
        converterFactory: GsonConverterFactory
    ): AnalyticsService {
        return Retrofit.Builder()
            .baseUrl("https://example.com")
            .addConverterFactory(converterFactory)
            .build()
            .create(AnalyticsService::class.java)
    }
}

 

- @Binds : 인터페이스 유형을 바인딩하기 위한 단축형:
   - Method는 @Module에 있어야 합니다.
   - @Binds에 Annotation이 달린 Method는 abstract class이여야 합니다.
   - 반환 형식은 바인딩 형식입니다.
   - 매개 변수는 구현 유형입니다.

@InstallIn(SingletonComponent::class)
@Module
abstract class AnalyticsModule {
  @Binds 
  abstract fun bindsAnalyticsService(
    analyticsServiceImpl: AnalyticsServiceImpl
  ): AnalyticsService
}

 

- Scope Annotations: @Singleton @ActivityScoped 등등...

컨테이너에 개체 범위를 지정합니다.
해당 유형을 종속성으로 사용하거나 필드 주입을 위해 또는 계층 구조 아래의 컨테이너에서 필요한 경우 컨테이너에서 동일한 유형 인스턴스를 제공합니다.

@Singleton
class AnalyticsAdapter @Inject constructor(
  private val service: AnalyticsService
) { ... }

 

- @ApplicationContext @ActivityContext : 미리 정의된 바인딩의 한정자(Qualifiers Annotation)

해당 컨테이너에서 종속성으로 사용할 수 있는 미리 정의된 바인딩입니다.

- @Singleton : 컴포넌트 인스턴스가 존재할 경우 해당 인스턴스가 하나뿐임을 나타내는 어노테이션. ApplicationScope(범위)를 갖는다

@Singleton
class AnalyticsAdapter @Inject constructor(
  @ApplicationContext val context: Context
  private val service: AnalyticsService
) { ... }

 

- @Entry Point : Hilt에서 직접 지원하지 않거나 Hilt를 사용할 수 없는 클래스의 종속성을 가져옵니다.
@EntryPoint로 주석이 달린 인터페이스에도 해당 종속성을 가져온 Hilt 미리 정의된 구성 요소를 전달하는 @InstallIn으로 주석을 달아야 합니다.
DI 컨테이너(@InstallIn 주석의 값과 일치)와 항목이 있는 클래스의 인스턴스를 전달하는 EntryPointAccessor에서 적절한 정적 메서드를 사용하여 바인딩에 액세스합니다

 

class MyContentProvider(): ContentProvider {

    @InstallIn(SingletonComponent::class)
    @EntryPoint
    interface MyContentProviderEntryPoint {
        fun analyticsService(): AnalyticsService
    }
    
    override fun query(...): Cursor {
        val appContext = context?.applicationContext ?: throw IllegalStateException()
        val entryPoint = EntryPointAccessors.fromApplication(
            appContext, 
            MyContentProviderEntryPoint::class.java
        )
        
        val analyticsService = entryPoint.analyticsService()
        ...     
    }
}

 

- @Qualifier : 동일한 유형(타입)이 여러개일 때 구분하기 위해 이름을 지정해줌.

- @Retention : 뜻 -> 보유, 유지 라는 뜻을 가지고 있는데 이 어노테이션이 달린 타입의 어노테이션이 유지되는 기간을 나타낸다. 기본값은 AnnotationRetention.Runtime이다

 

@Qualifier
@Retention(AnnotationRetention.RUNTIME)
annotation class DebugState

@Qualifier
@Retention(AnnotationRetention.RUNTIME)
annotation class UtilDebugState

public enum class AnnotationRetention {
    /** Annotation isn't stored in binary output */
    SOURCE,
    /** Annotation is stored in binary output, but invisible for reflection */
    BINARY,
    /** Annotation is stored in binary output and visible for reflection (default retention) */
    RUNTIME
}

 

해당 본문을 번역 및 추가한 것

 

끝.

 

참조.

Hilt를 사용한 종속 항목 삽입  |  Android 개발자  |  Android Developers

 

[Android] Hilt에 대한 고찰