[Kotlin][Android] 안드로이드 Hilt를 통한 의존성 주입방법

안녕하세요 👋

오늘은 안드로이드 Hilt의 사용법에 대해 알아보려고 합니다.

Hilt를 시작하기 전에 먼저

의존성 주입이란 무엇인지 알아보도록 하겠습니다.

의존성 주입(Dependency Injection)이란?

의존성 주입이란 class와class 간 의존성에 대한 주입을 외부에서 함으로써 class 간 결합도를 낮추어 

코드의 안정성을 높이는 프로그래밍 기법을 의미 합니다.

/** 의존성이 주입되지 않은 코드 **/
class Foo(){
	val noDI = NoDepedency()
    
    fun somethingTodo() {
    	noDI.foo()
    }
}

class NoDependency(){
	fun foo()
}

의존성이 주입되지 않은 코드는 위 코드와 같이 NoDepedency라는 class를 Foo에서 사용하기 위해 Foo class 내부에서 생성하게 되어

코드의 결합도가 증가하게 되는 것을 볼 수 있습니다.

/** 의존성이 주입된 코드 **/
class Foo(private val di : Dependency) {
	
    fun somethingTodo() {
    	di.foo()
    }
}

class Dependency {
	fun foo()
}

반면에 의존성을 주입 시에는 위 코드와 같이 Foo에서 사용할 Dependency라는 class를 외부에서 전달받음으로 Dependency라는 class와 결합도가 낮아진 것을 확인할 수 있습니다. ( Dependency를 수정하게 되어도 Foo에서는 할 일이 없다. )

---

DI의 장점

•  각각이 독립되어 있기 때문에 결합도를 낮추고 유지보수에 용이하다.
•  Boilerplate code를 줄일 수 있다.
• 코드의 재사용성이 증가한다.

---

그렇다면 Hilt는 무엇일까요?

Hilt란?

class를 외부에서 주입하기 위해서는 인스턴스에 대한 생명주기(생성~소멸되기까지)의 관리가 필요합니다.

이를 자동으로 관리해 주기해주기 위해 Google에서는 Dagger 기반의 라이브러리를 만들게 되었는데 그것이 바로 

Dagger Hilt입니다.

 즉 , 각 instance의 생명주기를 관리해 주어 의존성 주입을 보다 쉽게 만든 google의 라이브러리입니다.

 

그렇다면 사용 방법은 어떻게 될까요? 🤔

 

Hilt는 Annotaion을 통해 앱을 설정하고 의존성을 주입합니다.

각각의 Annotaion들과 설명 및 사용법을 알아보도록 하겠습니다.

---

시작하기에 앞서 Hilt를 사용하기 위한 프로젝트 설정 부터 알아보도록 하겠습니다.

build.gradle 설정

// Project
plugins {
	...
    id 'com.google.dagger.hilt.android' version '2.44' apply false // Hilt
}

// Module

plugins {
	...
    // Hilt
    id 'kotlin-kapt'
    id 'com.google.dagger.hilt.android'
}

dependencies {
	...
    // Hilt
    implementation "com.google.dagger:hilt-android:2.44"
    kapt "com.google.dagger:hilt-compiler:2.44"
    implementation "androidx.activity:activity-ktx:1.6.1"
    implementation "androidx.fragment:fragment-ktx:1.5.5"
}

@HiltAndroidApp

Hilt는 Application 생명 주기를 따르며 컴파일 단계 시 DI에 필요한 구성요소들을 초기화하기 위해 이 어노테이션을 사용합니다.

즉, Hilt에게 Application 의존성 주입의 시작점을 알려주는 역할을 합니다.

@HiltAndroidApp
class MainApplication : Application() {
}

@AndroidEntryPoint

@HiltAndroidApp과 마찬가지로 Android 컴포넌트들의 의존성 주입 시작점을 알려주는 어노테이션입니다. 사용 가능한 컴포넌트들은 아래와 같습니다.

• Activity
• Fragment
• View
• Service
• BroadcastReceiver

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

@Inject

해당 어노테이션을 통해 의존성을 주입할 수 있습니다.

class MyRepositoryImpl @Inject constructor(
    private val myApi: MyApi
) : MyRepository {

}

위 코드와 같이 @Inject constructor를 활용하면 생성자에서 의존성을 주입받을 수 있으며 변수에 어노테이션을 붙여 바로 의존성을 주입할 수도 있습니다. 

 

하지만 외부 라이브러리 혹은 interface들의 경우 Hilt에게 어떻게 인스턴스화를 하여 객체를 주입해 줄 것인지 알려주어야 하는데 그 역할이 바로 @Module입니다.

 

@Module

Hilt에게 어떻게 해당 객체를 주입하면 되는지 알려주는 역할로 의존성 제공 방법으로는 @Provides와 @Binds가 있습니다.

@InstallIn

Hilt에게 해당 모듈이 어느 Scope에서 사용할 수 있는지 알려주는 역할을 합니다.

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

}

Hilt의 Components 

각각의 Component들은 생명주기를 가지며 아래 표를 통해 언제 생성~소멸되는지 알 수 있습니다.

Component들의 생명주기

@ Binds

Hilt에게 객체를 어떻게 인스턴스화하여 제공해 줄 것인지 알려주는 어노테이션으로 프로젝트에서 소유하고 있는 객체에 대해 제공해 줄 때 사용합니다. (만든 interface나 추상 class 등)

 

1. 인터페이스 생성

interface MyRepository {
    suspend fun doNetworkCall() : Response<T>
}

2. 인터페이스 구현

class MyRepositoryImpl @Inject constructor(
    private val myApi: MyApi
) : MyRepository {
    override suspend fun doNetworkCall(): Response<T> {
        return myApi.doNetworkCall()
    }
}

3. Binds를 통한 인터페이스 제공방법을 Hilt에게 알려줌

@Module
@InstallIn(SingletonComponent::class)
abstract class RepositoryModule {
    @Binds
    @Singleton
    abstract fun bindMyRepository(myRepositoryImpl: MyRepositoryImpl) : MyRepository
}

4. 의존성 주입

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

}

 

@Provides

@Binds와 마찬가지로 Hilt에게 의존성 주입 방법을 알려주는 어노테이션이지만, 주로 외부라이브러리 객체를 필요로 할 때 많이 사용합니다. ( Room , Retrofit , OkHttp 등 )

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

    @Provides
    @Singleton
    fun provideMyApi() : MyApi {
        return Retrofit.Builder()
            .baseUrl(BEACH_CONGESTION_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .build()
            .create(MyApi::class.java)
    }
}

 

 

해당 포스팅에서는 다루지 않겠지만 이 외에도 많은 어노테이션들이 존재합니다 🤩

Hilt는 매우 편리하고 다른 DI라이브러리에 비해 배우기 쉬운 장점이 있는 것 같습니다.

조금 더 공부하여 익숙하게 만든다면 아주 좋은 무기가 될 것으로 보입니다.

 

이상으로 Hilt 포스팅을 마치겠습니다.

 

오늘도 즐코 하세요 :)