Hilt(3) - 멀티 바인딩

# 멀티바인딩 `@IntoSet` `@IntoMap` `@Multibinds`

멀티바인딩은 여러 바인딩을 하나의 컬렉션으로 관리하는 구조다. Set, Map 컬렉션을 지원하며  중복바인딩이랑은 결이 좀 다르다고 볼 수 있을 것 같다. 

Set을 이용한 방식은 기존 @Provides하던 바인딩에 `@IntoSet`을 달아주면 된다. 그렇게 하면 컴파일 타임에서 Set안에 @IntoSet이 선언된 바인딩을 묶어서 갖고 있게 된다. 근데 컬렉션으로 바인딩을 관리하면 문제가 하나 생긴다.

 

단독 바인딩일 때는 EntryPoint에서 @Inject할 때 알아서 가져갔는데, 반환타입이 Set<T>으로 감싸져있어서 그냥 @Inject하면 MissingBinding을 오류로 내뿜게 된다.

 

단독 바인딩이 Set<T>으로 되어있다면 @IntoSet말고 `@ElementsIntoSet`을 달아줘야된다. 그러면 단독 바인딩 된 Set의 원소들이 Set 멀티 바인딩 돼서 들어온다.

@Module
@InstallIn(SingletonComponent::class)
class MultiBindModule {
    @Provides
    @IntoSet
    fun provideString(): String{
        return "test"
    }
}

// 사용은 아래처럼 Set으로
@Inject
lateinit var str: Set<String>

Set을 반환하는 바인딩을 쓴 건 아래와 같다.

@Module
@InstallIn(SingletonComponent::class)
class MultiBindModule {
    @Provides
    @IntoSet
    fun provideString(): String {
        return "test"
    }

    @Provides
    @ElementsIntoSet
    fun provideStrings(): Set<String> {
        return setOf("a", "b", "c")
    }
}

그럼 위에서 str은 Set을 받아오는데, 결과가 어떻게 나올까?

다 담겨서 들어온다. Set 말고 Map으로도 멀티바인딩이 가능하다.

Map은 기본적으로 Key - Value 형식이라 키를 지정해줘야하는데, String, Int, Long, Class로 키를 지정해줄 수 있다. 사용방법은 Set과 비슷한데, @IntoMap과 @"타입"Key("키 값")을 지정해주면 된다.

@Provides
@IntoMap @IntKey(1)
fun provideName(): String{
    return "one"
}

@Provides
@IntoMap @ClassKey(Test::class)
fun provideNameOfClass(): String{
    return "Test Value"
}

Test클래스를 키로 쓴건데 키 타입이 `Class<*>`가 된다. Map을 사용한 멀티바인딩은 키값이 가장 중요해서 조심해야된다.

@Inject
lateinit var mapInt: Map<Int, String>

@Inject
lateinit var mapClass: Map<Class<*>, String>

mapClass 값은 `mapClass[Test::class.java]`로 꺼내쓴다.

 

지정된 타입 말고도 키를 설정할 수 있다. `@MapKey`를 사용한 방식인데 키가 될 enum class 같은 걸 annotation class로 커스텀 키 어노테이션 선언해주고, @MapKey를 붙여서 쓰면된다.

@MapKey
annotation class CustomMapKey(val value: Keys)

enum class Keys {
    ONE,
    TWO,
    THREE
}

// 모듈에서는 아래 처럼
@Provides
@IntoMap
@CustomMapKey(Keys.ONE)
fun provideCK(): String{
    return "CK"
}

Inject 부분에서는 Enum 클래스를 Key에 넣어주면 된다.

 

`@Multibinds`는 바인딩 된지 안된지 모르는 상태이거나 빈컬렉션이 필요할 때 사용하면 된다.

 

 

도움이 됐다면 댓글이나 공감 버튼 한 번씩 누르고 가주세요!