멀티모듈 도입기(2) - Hilt

멀티모듈을 사용하기 위해서는 종속성 삽입(DI: Dependency Injection)을 해줘야하는데 이때 사용되는 라이브러리가 Hilt다.

종속성 삽입은 의존성 주입이라고도 하는데 특정 객체의 인스턴스를 사용해야될 때 외부에서 생성된 객체를 전달해서 사용하는 방식이다. 즉 객체 끼리는 객체 생성과 무관하고, 객체를 사용하는 부분과 객체가 생성되는 부분이 분리된 것이라고 이해했다.

 

DI 관련해서 Hilt는 이번 게시글 말고 따로 다뤄서 더 깊게 연구해보도록 하겠다.

Hilt 탐구

원래 사용되던 Dagger를 활용해 프로젝트의 모든 Android 구성요소에 컨테이너를 제공하고, 해당 컨테이너 수명주기를 Hilt가 자동으로 관리한다.

Dagger를 기반으로 빌드된 Hilt가 좋은 점은 아래와 같다

• 객체생성 방법과 주입위치만 정의하면 되므로 보일러 플레이트 감소
• 빌드 의존성 분리
• 리팩토링, 테스트 편의성
• 안드로이드 클래스를 사용함에 따라 표준화 된 컴포넌트

마지막 줄은 Activity, Fragment와 같은 안드로이드 클래스에 자동으로 맞는 의존성을 주입해준다는 의미다. 이때 사용되는 어노테이션이 @AndroidEntryPoint.

프로젝트에 Hilt 추가

Project수준 build.gradle파일에 아래 코드를 추가해준다. buildscript 코드블럭은 항상 plugins 블럭 위에 있어야한다. 코드랩에는 2.28-alpha버전인데 현재 stable로 2.44까지 나왔으니 2.44로 지정했다.

buildscript {
    ext.hilt_version = '2.44'
    dependencies {

        classpath "com.google.dagger:hilt-android-gradle-plugin:$hilt_version"
    }
}

app모듈에서 gradle 플러그인을 쓰기위해서 kapt를 app수준 build.gradle에 넣어준다.

id 'kotlin-kapt'
id 'dagger.hilt.android.plugin'

동일 파일 하단에 dependencies에 이것까지 추가한 뒤 sync해주면 세팅 끝이다.

dependencies {
    //hilt
    implementation "com.google.dagger:hilt-android:$hilt_version"
    kapt "com.google.dagger:hilt-android-compiler:$hilt_version"
}

이걸 추가하지 않고 sync 먼저하면 당연히 가져올 라이브러리 주소가 없으니 hilt가 없다고 나온다.(삽질경험)

간단한 사용법

앱의 수명주기에 연결된 컨테이너를 추가하려면 @HiltAndroidApp을 달면 된다.

@HiltAndroidApp
class SuChelinApp: Application() {

}

이 컨테이너는 최상위 컨테이너이므로 여기서 제공하는 종속항목에 다른 컨테이너가 접근할 수 있다. 컨테이너는 종속항목을 제공하는 클래스로 인스턴스를 생성하고 수명주기를 관리하는 도구다.

Fragment나 Activity에서 Hilt를 사용하려면 @AndroidEntryPoint로 어노테이션을 달면 된다.

@AndroidEntryPoint
class LogsFragment : Fragment() {

}

이러면 Activity, Fragment의 수명주기를 따라가는 종속항목 컨테이너가 생성된다. 또 인스턴스를 삽입할 수 있게 되는데, 아래 코드를 보자.

@AndroidEntryPoint
class LogsFragment : Fragment() {
    @Inject lateinit var logger: LoggerLocalDataSource
    @Inject lateinit var dateFormatter: DateFormatter
}

외부에서 생성해둔 인스턴스를 받아오는 코드다.

class LoggerLocalDataSource @Inject constructor(private val logDao: LogDao) {
    ...
}

이런식으로 하면 특정 클래스에 종속되지않은 인스턴스가 주입된다.

인스턴스 범위는 @Singleton을 붙여서 전역으로 만들어 항상 동일한 인스턴스를 제공하거나, 싱글톤으로 만들지않고 항상 다르게 만들 수 있다.

@Singleton
class LoggerLocalDataSource @Inject constructor(private val logDao: LogDao) {
    ...
}

Hilt 모듈

생성자가 삽입될 수 없는 유형(인터페이스와 같은)은 Hilt 모듈을 사용해야한다.

모듈은 @Module과 @InstallIn 어노테이션을 달아둔 클래스다. @Module은 말 그대로 모듈임을 Hilt에 알리는 역할이고 @InstallIn은 어떤 컨테이너에서 Hilt요소를 지정해 결합을 사용할지를 Hilt에 알린다.

지정할수있는 Hilt 구성요소는 아래 그림을 보면된다.

이게 Hilt 구성요소 계층 구조다. 상위 요소에 하위요소가 접근 할 수 있다.

@Module
@InstallIn(SingletonComponent::class)
object NetworkModule {
    const val BASEURL = ""

}

이 코드는 SingletonComponent를 지정해서 사용하겠다는 의미다. 네트워크 통신은 어차피 계속 할 것이므로 매번 인스턴스를 만드는 것보다 싱글톤으로 만들어서 접근이 쉽게 하는게 낫기 때문이다.

모듈 안의 함수에 @Provides를 달면 인스턴스 생성시 필요한 것을 Hilt에 알릴 수 있다.

@Module
object DatabaseModule {

    @Provides
    fun provideLogDao(database: AppDatabase): LogDao {
        return database.logDao()
    }
}

Hilt에게 provideLogDao메서드를 실행하는 경우 LogDao 인스턴스를 제공하는데 database.logDao()를 실행해야된다고 알리는 코드다.

추상클래스의 인터페이스 메서드는 @Binds 를 붙여 사용하면된다

@InstallIn(ActivityComponent::class)
@Module
abstract class NavigationModule {

    @Binds
    abstract fun bindNavigator(impl: AppNavigatorImpl): AppNavigator
}

---

참조:

https://developer.android.com/codelabs/android-hilt?hl=ko&authuser=1#0

https://developer.android.com/training/dependency-injection?authuser=1&hl=ko#choosing-right-di-tool

https://developer.android.com/training/dependency-injection/hilt-android?authuser=1&hl=ko#component-default

도움이 됐다면 댓글이나 공감 버튼 한 번씩 누르고 가주세요! 로그인 안해도 됩니다 ^_^