Что такое Multibinding?

Что такое Multibinding в Dagger 2

Multibinding (множественная привязка) — это мощная функция Dagger 2, которая позволяет собирать несколько зависимостей одного типа в коллекцию (например, Set, Map или List) и инжектировать эту коллекцию как единый объект. Это особенно полезно в сценариях, где вам нужно реализовать паттерны типа Plugin, Observer или стратегий, которые могут меняться или расширяться.

Зачем это нужно?

Представьте, что у вас есть система обработки платежей, где разные провайдеры (Google Pay, банковская карта, PayPal) должны быть доступны в runtime. Вместо явного перечисления каждого провайдера вручную, Multibinding позволяет Dagger автоматически собрать всех доступных провайдеров в Set<PaymentProvider>.

Типы Multibinding

Dagger поддерживает два основных типа:

1. Set Multibinding: Сбор уникальных элементов в Set<T>.
2. Map Multibinding: Сбор элементов в Map<K, V>, где ключ K может быть произвольным (например, String, Class<?>) или специальным аннотированным ключом Dagger.

Реализация на примере Set Multibinding

Допустим, у нас есть интерфейс Logger и несколько его реализаций. Мы хотим получить все доступные логгеры.

1. Определяем "контрибьюшн" (вклад) в множество. Каждый модуль, который предоставляет реализацию Logger, должен пометить метод с @IntoSet (или @ElementsIntoSet для коллекций).

// Интерфейс зависимости
interface Logger {
    fun log(message: String)
}

// Модули, предоставляющие реализации
@Module
class LoggingModule {
    @Provides
    @IntoSet // Ключевая аннотация!
    fun provideFileLogger(): Logger {
        return FileLogger()
    }
}

@Module
class AnalyticsModule {
    @Provides
    @IntoSet // Еще один элемент того же типа в тот же Set
    fun provideCloudLogger(): Logger {
        return CloudLogger()
    }
}

2. Инжектим готовый Set<Logger>.

Dagger автоматически соберет все элементы, отмеченные @IntoSet для типа Logger, в один Set.

class LoggingManager @Inject constructor(
    // Dagger предоставит Set из FileLogger и CloudLogger
    private val loggers: Set<@JvmSuppressWildcards Logger>
) {
    fun broadcastLog(message: String) {
        loggers.forEach { it.log(message) }
    }
}

Реализация Map Multibinding

Позволяет создавать карты, где ключ определяется аннотацией @MapKey. Например, для фабрик или стратегий, доступных по строковому ключу.

1. Определяем аннотацию @MapKey.

@MapKey
annotation class LoggerKey(val value: String)

2. В модуле предоставляем элементы для Map с аннотацией @IntoMap и указанием ключа.

@Module
class LoggingModule {
    @Provides
    @IntoMap
    @LoggerKey("file") // Ключ для этого элемента в Map
    fun provideFileLogger(): Logger {
        return FileLogger()
    }

    @Provides
    @IntoMap
    @LoggerKey("cloud")
    fun provideCloudLogger(): Logger {
        return CloudLogger()
    }
}

3. Инжектим Map<String, Logger>.

class LoggerFactory @Inject constructor(
    private val loggerMap: Map<String, @JvmSuppressWildcards Logger>
) {
    fun getLogger(key: String): Logger? {
        return loggerMap[key]
    }
}

Ключевые преимущества и сценарии использования

• Расширяемость архитектуры: Новые реализации (плагины, стратегии, хендлеры) можно добавлять, просто создавая новые модули с @IntoSet/@IntoMap, не модифицируя существующий код ядра приложения.
• Инкапсуляция: Каждый модуль знает только о своих собственных зависимостях.
• Упрощение кода: Избавляет от необходимости создавать ручные фабрики или провайдеры для сбора множества объектов.
• Идеально для паттернов:

    *   **Посетитель (Visitor) или Цепочка обязанностей (Chain of Responsibility)**: `Set` обработчиков событий.
    *   **Плагины (Plugin)**: `Set` плагинов для расширения функциональности.
    *   **Стратегия (Strategy)**: `Map` стратегий, доступных по ключу.
    *   **Фабрика (Factory)**: `Map` фабрик для создания объектов разных типов.

Важные технические детали

• @JvmSuppressWildcards в Kotlin: Критически важная аннотация при работе с дженериками в Kotlin для корректной резолюции зависимостей Dagger. Без нее Dagger может не найти привязки для коллекций.
• Уникальность: Для Set Dagger гарантирует уникальность элементов. Два одинаковых связывания (одинаковый тип и квалификатор) вызовут ошибку компиляции.
• Пустые коллекции: Если нет ни одного привязывания в коллекцию, Dagger инжектирует пустую коллекцию, а не null. Это поведение по умолчанию делает код безопаснее.

Итог: Multibinding — это декларативный и типобезопасный механизм Dagger для управления группами зависимостей. Он перекладывает ответственность за сборку сложных составных объектов с программиста на компилятор DI-фреймворка, следуя принципу Inversion of Control и делая код чище, тестируемее и легче в поддержке.