Что такое @Singleton в Dagger?

Что такое аннотация @Singleton в Dagger?

В контексте Dagger, одной из самых популярных библиотек для dependency injection (DI) в Android и Java, аннотация @Singleton играет ключевую роль в управлении жизненным циклом создаваемых объектов (dependency). Она указывает Dagger, что конкретный тип должен иметь единственный экземпляр (синглтон) на протяжении всего времени жизни соответствующего графа зависимостей (Component).

Основная цель и механизм работы

Главная цель @Singleton — гарантировать, что внедряемый объект будет инстанциирован только один раз, и этот же экземпляр будет предоставлен всем клиентам (классам, полям, методам), которые запрашивают зависимость данного типа внутри одного компонента.

Как это работает:

1. Когда Dagger встречает аннотацию @Singleton на классе (в сочетании с @Inject для конструктора) или на методе @Provides внутри модуля (@Module), он помечает этот тип как "синглтон" для текущего компонента.
2. Компонент (@Component), который должен предоставлять этот тип, также должен быть аннотирован @Singleton. Это создает контракт: "Этот компонент управляет синглтонными объектами".
3. При каждом запросе данного типа (например, через @Inject поля) Dagger не создает новый объект, а возвращает один и тот же, ранее созданный экземпляр, который он хранит внутри себя.

Пример использования

Рассмотрим классический пример синглтона — объект, содержащий конфигурацию или общие данные.

1. Объявление синглтонного класса:

@Singleton
class AppSettings @Inject constructor() {
    var themeMode: String = "Light"
    // ... другие настройки
}

2. Модуль, который может предоставить синглтон (альтернативный способ):

@Module
class AppModule {
    @Provides
    @Singleton
    fun provideNetworkClient(): NetworkClient {
        return RetrofitClient()
    }
}

3. Компонент, который склеивает всё вместе:

@Singleton
@Component(modules = [AppModule::class])
interface AppComponent {
    fun inject(activity: MainActivity)
    // Функция для предоставления синглтона явно, если нужно
    fun getSettings(): AppSettings
}

4. Использование в Activity:

class MainActivity : AppCompatActivity() {
    @Inject
    lateinit var settings: AppSettings // Внедряется тот же экземпляр, что и всем другим классам

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // ... получение компонента и инжекция
        settings.themeMode = "Dark"
        // Изменение отразится для всех остальных клиентов settings
    }
}

Ключевые особенности и важные замечания

• Синглтонность ограничена компонентом: Объект, аннотированный @Singleton, является синглтоном только внутри графа конкретного компонента, которому он принадлежит. Если вы создаете два отдельных компонента с аннотацией @Singleton, каждый из них будет иметь свой собственный экземпляр данного типа. Это отличает @Singleton от классического паттерна Singleton в Java, где экземпляр глобальный для всего JVM.
• Не требует статических методов или полей: Dagger полностью управляет созданием и хранением экземпляра, что делает код чище и более тестируемым.
• Синхронизация и безопасность в многопоточности: Dagger по умолчанию гарантирует безопасное создание синглтона даже в многопоточной среде (например, если несколько потоков одновременно запрашивают инжекцию). Однако дальнейшая безопасность работы с самим объектом — ответственность разработчика.
• Не путать с @Scope: @Singleton — это конкретная, предопределенная реализация более общей концепции @Scope в Dagger. Scope позволяет создавать собственные, кастомные области жизни объектов (например, @ActivityScope, @UserSessionScope). @Singleton — это просто scope с самым широким временем жизни в компоненте.
• Потенциальные проблемы: Как и любой синглтон, объекты с такой аннотацией могут становиться источниками глобального состояния, что затрудняет тестирование и может приводить к утечке памяти, если компонент живет слишком долго (например, привязанный к Application). Важно продумать архитектуру и правильно разделять компоненты (Application, Activity, Fragment уровни).

Заключение

Аннотация @Singleton в Dagger — это мощный инструмент для управления зависимостями, которые должны существовать в единственном экземпляре и быть доступными в различных частях приложения. Она обеспечивает эффективное использование памяти, согласованность состояния и централизованное управление для таких объектов, как репозитории, источники данных, менеджеры конфигурации или клиенты API. Однако ее использование должно быть обоснованным, чтобы избежать негативных сторон, связанных с глобальным состоянием и нарушением принципов чистой архитектуры. Правильное применение @Singleton в сочетании с другими scope помогает построить четкую, модульную и поддерживаемую систему внедрения зависимостей.