Переход с Dagger2 на Hilt в многомодульном проекте

May 10 2023

Пошаговое руководство по переходу с Dagger на Hilt в многомодульном проекте. Структура проекта Для визуализации проекта он содержит несколько модулей NetworkModule, StorageModule, CommonModule, FeatureModule и т. д.

Пошаговое руководство по миграции с Daggerмногомодульного Hiltпроекта.

Фото Saif71.com на Unsplash

Структура проекта

Для визуализации проекта он содержит несколько модулей NetworkModule, StorageModule, CommonModule, FeatureModule и т. д. В реальных проектах может быть намного больше модулей, но мы ограничиваемся следующими модулями.

Стратегия миграции

Мы хотим полностью перейти Daggerна, Hiltно на практике нам нужен поэтапный подход, при котором мы сначала перенесем наш appпроект, Hiltа затем другие модули, что означает, что Daggerони Hiltдолжны работать параллельно в течение некоторого времени, пока не будет выполнена полная миграция.

Версии

Эта история выполнит миграцию с Dagger 2.24на Hilt 2.45.

Содержание

Конфигурация/Подготовка
Перенос компонента приложения и синглтона
Перенести класс приложения
Перенос класса активности
Перенести фрагмент
Перенос ViewModel
Очистка после миграции
Резюме и выводы

Для интеграции добавьте следующие зависимости в файл Hiltприложения Gradle.build.gradle

Также настройте kaptдля установки correctErrorType trueв build.gradleфайле

dependencies {
  implementation 'com.google.dagger:hilt-android:2.45'
  kapt 'com.google.dagger:hilt-compiler:2.45'
}
// Allow references to generated code
kapt {
    correctErrorTypes = true
}

plugins {
    // other plugins
    id 'com.google.dagger.hilt.android' version '2.45' apply false
}

plugins {
    // other plugins
    id 'com.google.dagger.hilt.android'
}
android {
    ....
}

Перенос компонента приложения

Dagger включает Singleton Componentв себя все модули Dagger, созданные в приложении или других модулях проекта, и обычно это делается в AppComponentклассе, созданном для Dagger.

Давайте посмотрим на текущий файл AppComponent.kt

Для миграции Singleton Componentнам нужно установить каждый модуль, например NetworkModule , StorageModule и т. д., в SingletonComponentfor Hilt, вы можете сделать это, аннотировав все эти отдельные модули с помощью @InstallIn(SingletonComponent::class)Но если у вас много модулей, изменение их всех сразу не будет хорошей идеей, но вы можете создайте AggregatedModule , который будет аннотирован @InstallIn(SingletonComponent::class)и включает все эти Daggerмодули, аннотированные с помощью @Module(includes = [ <all of these modules > ]).

Запустите проект, он выдаст ошибку

Ошибка DisableModuleHasInstallInCheck

После запуска проект Hiltпопытается найти @InstallInаннотацию для каждого модуля, входящего в AggregatedModuleаннотированный файл @Module. Hiltвызовет ошибку, если найдет модуль, который не аннотирован с помощью @InstallПоскольку мы не аннотировали каждый модуль, @InstallInпотому что мы находимся в середине миграции, мы можем отключить эту ошибку, используя следующий флаг

-Adagger.hilt.disableModulesHaveInstallInCheck=true.

вы можете указать на уровне приложения build.gradle, как показано ниже, но мы должны удалить этот флаг после завершения миграции.

defaultConfig {
   
    //TODO: remove this after migration to Hilt
    javaCompileOptions {
        annotationProcessorOptions {
            arguments["dagger.hilt.disableModulesHaveInstallInCheck"]="true"
        }
    }
}

Перенести класс приложения

Чтобы добавить Hilt в приложение, давайте аннотируем Applicationкласс с помощью @HiltAndroidApp. Вы должны удалить @Componentи @Component.Builderкоторые присутствовали в AppComponentклассе, как указано выше.

Если вы Applicationрасширяете DaggerApplicationили реализуете, HasAndroidInjectorвам все равно нужно сохранить некоторый код, как показано ниже, в обоих этих случаях. Это должно поддерживать оба Daggerи Hiltпараллельно, пока вся миграция не будет завершена.

Если ваши Applicationрасширения из DaggerApplicationвашего класса приложения будут выглядеть так.

И если ваши Applicationинструменты HasAndroidInjector, ваше приложение должно выглядеть так

Как только вся миграция будет завершена, вам нужно будет удалить такой код из вашего Applicationкласса, и ваш код Applicationбудет выглядеть так, как показано ниже. (Но это будет один из последних шагов, пожалуйста, не делайте этого сейчас)

Запустите проект, он должен успешно собрать ваш проект, и приложение должно запуститься без исключений во время выполнения.

Перенос класса активности

Dagger позволяет @ContributesAndroidInjectorуказать любое действие/фрагмент в качестве участника для Android Injector, в нашем проекте, который выполняется в MainActivityModule, один из модулей, включенных вAggregatedModule

MainActivityModuleтак выглядит до миграции

MainActivityтак выглядит до миграции

Чтобы перейти MainActivityна Hilt, мы полностью избавимся от MainActivityModuleкласса модуля и добавим аннотацию @AndroidEntryPointдля MainActivity. Поскольку наш MainActivityтакже расширяется, DaggerAppCompatActivityнам нужно расширить нашу деятельность из соответствующего, AppCompatActivityпоэтому после миграции наша MainActivityбудет выглядеть так, как показано ниже.

Запустите свой проект, он должен быть успешно MainActivityперенесен в Hilt

Перенести фрагмент/представление/BroadcastReceiver

Миграция любого фрагмента в Hiltбудет выполняться с теми же шагами, что и для миграции MainActivityв Hilt. Шаги ниже

Удалите код, в котором вы аннотируете свой фрагмент, который, @ContributesAndroidInjectorвероятно, будет модулем.
Удалить модуль, из SingletonComponentкоторого обрабатывался @ContributesAndroidInjectorваш фрагмент
Аннотируйте свой фрагмент с помощью@AndroidEntryPoint
если ваш фрагмент расширен, DaggerFragmentвам нужно расширить свой фрагмент из Fragmentкласса

Перенос ViewModel

Миграция ViewModel требует некоторых шагов.

Сначала аннотируйте свою модель представления с помощью@HiltViewModel

Для FeatureViewModelвнедрения Hiltмы будем использовать расширение фрагмента, viewModels()указанное в зависимости расширения фрагмента, которую мы добавим в соответствующий build.gradleфайл, как показано ниже.

implementation "androidx.fragment:fragment-ktx:1.5.6"

Теперь удалите соответствующие @Bind, @IntoMapи @ViewModelKeyпривязки, FeatureViewModelкоторые мы использовали для Dagger.

В кинжале для внедрения ViewModel у нас также будет lateinit varсвойство, которое будет использоваться injectedво время выполнения, используя некоторые из них ViewModelFactory, которые также больше не требуются, поэтому вы можете удалить ViewModelModuleи ViewModelProviderFactoryсвязанный код, если на кинжале нет другой ViewModel/Fragment.

Запустите свой проект, он должен быть успешно Fragment and ViewModelперенесен в Hilt

Перенос других модулей.

До сих пор мы мигрировали Components// Modules/ Activityв Fragmentмодуль приложения. Но сейчас нам нужно перенести другие модули. Мы будем переходить по одному модулю за раз и полностью переносить его в Hilt, выполнив следующие шаги.

Добавить Hiltзависимость в build.gradleфайл модуля
Аннотируйте каждую @Moduleаннотацией @InstallIn.
Удалите @JvmStaticаннотацию для каждой @Provideаннотации, если она у вас есть, потому что она больше не требуется вHilt
Аннотируйте свой Fragment/ Activityс @AndroidEntryPointи удалите соответствующий@ContributesAndroidInjector
Перенесите ваши ViewModels, аннотируя их @HiltViewModel, и используйте расширение фрагмента viewModels()для внедрения этих моделей представлений.
Продолжайте удалять все те модули, которые больше не потребуются в AggregatedModule. AggregatedModule мы создали выше в нашем первом шаге.

После переноса каждого модуля проекта в Hilt. Нужно время на уборку

Удалить disableModuleInstallInCheck = true, который мы добавили в начале на уровне приложения или любом другом, build.gradleи удалить @DisableInstallInCheckаннотацию, если она была добавлена к любому@Module

defaultConfig {
   
    //TODO: remove this after migration to Hilt
    javaCompileOptions {
        annotationProcessorOptions {
            arguments["dagger.hilt.disableModulesHaveInstallInCheck"]="true"
        }
    }
}

4. Удалите все Daggerзависимости во всех ваших модулях.

Запустите свой проект, он должен быть успешно запущен, ваш проект полностью перенесен в Hilt