Migrar do Dagger2 para o Hilt em um projeto multimódulo

May 10 2023

Um guia passo a passo para migrar do Dagger para o Hilt em um projeto de vários módulos. Estrutura do Projeto Para visualizar o projeto, ele contém vários módulos NetworkModule, StorageModule, CommonModule, FeatureModule etc.

Um guia passo a passo para migrar de Daggerpara Hiltum projeto de vários módulos.

Foto de Saif71.com no Unsplash

Estrutura do Projeto

Para visualizar o projeto, ele contém vários módulos NetworkModule, StorageModule, CommonModule, FeatureModule etc. Em projetos reais, pode haver muito mais módulos, mas estamos limitando os seguintes módulos.

Estratégia de Migração

Queremos migrar totalmente Daggerpara, Hiltmas na prática precisamos de uma abordagem incremental onde primeiro migraremos nosso appprojeto para Hilte depois outros módulos, ou seja, Daggere Hiltdevemos trabalhar em paralelo por algum tempo até que a migração completa seja concluída.

Versões

Esta história fará uma migração de Dagger 2.24para Hilt 2.45.

Contente

Configuração/Preparação
Migrar componente de aplicativo e singleton
Migrar classe de aplicativo
Migrar classe de atividade
Migrar fragmento
Migrar ViewModel
Limpeza pós-migração
Resumo e conclusões

Para integrar, adicione as seguintes dependências ao arquivo Hiltdo aplicativo Gradlebuild.gradle

Configure também kaptpara definir correctErrorType como trueno build.gradlearquivo

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 {
    ....
}

Migrar componente de aplicativo

O Dagger Singleton Componentinclui todos os módulos do Dagger criados no aplicativo ou outros módulos do projeto e isso normalmente é feito na AppComponentclasse criada para Dagger.

Vamos ver o arquivo AppComponent.kt atual

Para migrar, Singleton Componentprecisamos instalar cada módulo, por exemplo, NetworkModule , StorageModule etc em SingletonComponentfor Hilt, você pode fazer isso anotando todos esses módulos individuais com @InstallIn(SingletonComponent::class)Mas se você tiver muitos módulos mudar todos eles de uma vez não será uma boa idéia, mas você pode crie um AggregatedModule que será anotado com @InstallIn(SingletonComponent::class)e inclua todos esses Daggermódulos anotados com @Module(includes = [ <all of these modules > ]).

Execute o projeto, ele gerará um erro

Erro DisableModuleHasInstallInCheck

Depois de executar, o projeto Hilttentará encontrar @InstallIna anotação para cada módulo incluído no AggregatedModuleanotado com @Module. Hiltgerará um erro se encontrar um módulo que não esteja anotado com @InstallComo não anotamos todos os módulos @InstallInporque estamos no meio da migração, podemos desativar esse erro usando o seguinte sinalizador

-Adagger.hilt.disableModulesHaveInstallInCheck=true.

você pode especificar no nível do aplicativo build.gradleconforme abaixo, mas devemos remover esse sinalizador assim que toda a migração for concluída.

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

Migrar classe de aplicativo

Para adicionar o Hilt ao aplicativo, vamos anotar a Applicationclasse com @HiltAndroidApp. Você deve remover @Componente @Component.Builderquais estavam presentes na AppComponentaula conforme mencionado acima.

Se você Applicationestende DaggerApplicationou implementa, HasAndroidInjectorainda precisa manter algum código conforme mostrado abaixo em ambos os casos. Isso é para oferecer suporte a ambos Daggere Hiltem paralelo até que toda a migração seja concluída.

Se suas Applicationextensões de DaggerApplicationsua classe de aplicativo se parecerem com isso.

E se seus Applicationimplementos HasAndroidInjector, então seu aplicativo deve se parecer com isso

Depois que toda a migração for concluída, você precisará remover esse código de sua Applicationclasse e sua Applicationaparência ficará como abaixo. (Mas esse seria um dos últimos passos, por favor não o faça agora)

Execute o projeto, ele deve construir seu projeto com sucesso e o aplicativo deve ser iniciado sem exceções de tempo de execução.

Migrar classe de atividade

O Dagger fornece @ContributesAndroidInjectorpara especificar qualquer Activity/Fragment como colaborador do Android Injector, em nosso projeto feito em MainActivityModule, um dos módulos incluídos emAggregatedModule

MainActivityModuleparece com isso antes da migração

MainActivityparece com isso antes da migração

Para migrar nosso MainActivitypara Hilt, nos livraremos completamente da MainActivityModuleclasse do módulo e adicionaremos a anotação @AndroidEntryPointpara MainActivity. Como o nosso MainActivitytambém está se estendendo, DaggerAppCompatActivityprecisamos estender nossa atividade do correspondente, AppCompatActivityentão, após a migração, nosso MainActivityficará como abaixo.

Execute seu projeto, ele deve ser bem-sucedido com MainActivitya migração para Hilt

Migrar Fragment/View/BroadcastReceiver

A migração de qualquer fragmento Hiltserá feita com as mesmas etapas que fizemos para migrar MainActivitypara o Hilt. As etapas estão abaixo

Remova o código onde você está anotando seu Fragment com @ContributesAndroidInjectora probabilidade de ser um módulo
Remova o módulo do SingletonComponentqual estava lidando @ContributesAndroidInjectorcom o seu fragmento
Anote seu fragmento com@AndroidEntryPoint
se o seu fragmento for estendido, DaggerFragmententão você precisa estender seu fragmento da Fragmentclasse

Migrar ViewModel

A migração do ViewModel requer algumas etapas.

Em primeiro lugar, anote seu viewModel com@HiltViewModel

Para ser FeatureViewModelinjetado, Hiltusaremos a extensão de fragmento viewModels()fornecida na dependência de extensão de fragmento que adicionaremos no build.gradlearquivo correspondente conforme abaixo

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

Agora remova os correspondentes @Binde @IntoMapas @ViewModelKeyligações para FeatureViewModelas quais usamos para Dagger.

Na adaga para injetar um ViewModel, também teríamos lateinit varpropriedades que estarão injectedem tempo de execução usando algumas ViewModelFactoryque também não são mais necessárias ViewModelModule, então você pode excluir ViewModelProviderFactorye o código relacionado se não houver outro ViewModel/Fragmento ainda na Dagger.

Execute seu projeto, ele deve ser bem-sucedido com Fragment and ViewModela migração para Hilt

Migrar outros módulos.

Até agora estávamos migrando // Componentsno módulo app. Mas temos que migrar outros módulos agora. Iremos um módulo por vez e migraremos totalmente para o Hilt usando as etapas a seguirModulesActivityFragment