[Android] dagger hilt 기록

친구들과 프로젝트를 하면서 dagger hilt에 대한 필요성을 느끼고 이 포스팅을 작성한다

 

dagger hilt란?

dagger hilt는 안드로이드에서 클래스간 의존성을 주입할수 있는 라이브러리이다.

dagger hilt를 알아보기 전에 일단 의존성이 무엇인지 부터 알아보자.

 

의존성이란?

의존성이란 클래스간 의존 관계를 가지는 현상을 뜻한다.

 

예시

class B {
    val id = "dltntlro"
}

class A {
    val data = B()
}

A클래스 내부에 B클래스 객체가 생성되어 있음(의존적임)을 볼 수 있다

이러한 상황이 발생하면 A클래스가 호출될때마다 B클래스도 계속 생성되기 떄문에 비효율적이게 된다.

 

주입이란?

주입이란 클래스 외부에서 객체를 생성하는 것을 말한다.

 

예시 2

class B {
    val id = "dltntlro"
}

class A(bClass: B) {
    val data = bClass
}

예시 2에서는 A클래스 내부가 아니라 A클래스의 매개변수로 B클래스를 주입했다.

 

의존성 주입이란 클래스 외부에서 객체를 생성해 주입하는 것이다.

 

의존성 주입의 장점

• 코드의 재사용성이 높다
• 코드 변경이 자유롭다

 

dagger hilt

Google에서 발표한 안드로이드 전용 의존성 주입 라이브러리 를 뜻한다.

 

hlit는 dagger2를 기반으로 해 dagger2보다 러닝커브가 낮고, 의존성 주입 구축 시간을 줄일 수 있다.

 

이제부터 dagger hilt를 안드로이드에서 쓰는 방법을 알아보겠다.

 

add Dependency(2022.3.29 기준)

 

project/build.gradle

buildscript {
    ...
    dependencies {
        ...
        classpath 'com.google.dagger:hilt-android-gradle-plugin:2.38.1'
    }
}

 

app/build.gradle

plugins {
  id 'kotlin-kapt'
  id 'dagger.hilt.android.plugin'
}

android {
    ...
}

dependencies {
    implementation "com.google.dagger:hilt-android:2.38.1"
    kapt "com.google.dagger:hilt-compiler:2.38.1"
}

 

hilt 사용하기

 

@HiltAndroidApp

hilt를 사용하는 android app에 필수적으로 있어야 할 어노테이션이고,

의존성 주입의 시작점을 지정한다

 

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

 

@HiltAndroidApp이 들어간 클래스는 menifast에 name을 추가해 줘야 한다

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package=" ... ">
    <application
    	...
        android:name=".App">
        
        <activity
        	...

 

 

@AndroidEntryPoint

@AndroidEntryPoint을 추가해서 자동으로 생명주기에 따라 적절하게 hilt요소로 인스턴스화 되어 처리된다.

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

hlit가 지원하는 안드로이드 클래스는 다음과 같다.

- Activity

- Fragment

- View

- Service

- BroadcastReceiver

 

@Inject

@Inject으로 의존성을 주입받으려는 변수에 객체를 주입할 수 있다.

class MainActivity : AppCompatActivity() {
    @Inject lateinit var viewModel: MainViewModel
}

 

@Inject말고도 의존성을 생성할 수있는 방법이 있다.

- @Inject 에 생성자(constructor)

- Hilt 모듈들 (@Module, @Provides, @Binds)

 

@Inject constructor

클래스의 생성자에서 @Inject를 사용하여 의존성을 생성하는 방법이다.

class MainAdapter @Inject constructor(
  private val service: MainService
) { ... }

생성자의 파라미터로 의존성을 주입받을 수 있다.

 

Hilt 모듈

생성자의 파라미터로 의존성 주입을 하기가 힘든 경우 사용한다.(예: retrofit2, okhttp, room database 등)

이러한 모듈들은 hilt에게 의존성 인스턴스를 제공하는 방법을 알려준다.

 

@InstallIn

@InstallIn(component)형식으로 사용해 어떤 컴포넌트에 install할지 정해야 한다.

@InstallIn(ActivityComponent::class)
object MainModule { ... }

 

hlit에서 제공하는 컴포넌트들은 다음과 같다

hlit에서 제공하는 컴포넌트

각 컴포넌트들은 생성시점부터 파괴될 때까지 주입이 가능하다.

 

@Provides

개발자가 생성자를 삽입할 수 없을때 사용되는 어노테이션

object MainModule {

  @Provides
  fun provideMainService(): AnalyticsService {
      return Retrofit.Builder()
               .baseUrl("https://example.com")
               .build()
               .create(MainService::class.java)
  }
}

 

viewModel에 의존성 생성 방법

@HiltViewModel과 @Inject를 사용한다.

@HiltViewModel
class MainViewModel @Inject constructor(
    private val repository: MainRepository
    ) : ViewModel() { ... }

 

여기까지 의존성 주입에 대해 내가 공부한 내용을 정리해 보았다.

다른 블로그에 더 많은 정보들이 있을 거니 참고 바란다.

내가 작성한 내용들은 사실과 다를 수 있으니 양해 바란다.

혹시 지적할 내용이 있으면 댓글로 남겨주세요