Extensions for Dagger Hilt
Hilt Extensions
Kotlin
dependencies {
implementation("com.google.dagger:hilt-android:2.36")
implementation("it.czerwinski.android.hilt:hilt-extensions:[VERSION]")
kapt("it.czerwinski.android.hilt:hilt-processor:[VERSION]")
}
Groovy
dependencies {
implementation 'com.google.dagger:hilt-android:2.36'
implementation 'it.czerwinski.android.hilt:hilt-extensions:[VERSION]'
kapt 'it.czerwinski.android.hilt:hilt-processor:[VERSION]'
}
Property Delegation
With this library, it is possible to delegate properties to additional objects.
dagger.Lazy
val lazy: dagger.Lazy<String>
val property: String by lazy
javax.inject.Provider
val intProvider: Provider<Int>
val property: Int by intProvider
Generating Hilt Modules
@Bound
and @BoundTo
Marks implementation bound to the given supertype in the given component.
@Bound
annotation (added in v1.1.0) works exactly like @BoundTo
annotation,
but it implicitly uses the direct supertype of the annotated class. It may only
annotate classes having exactly one direct supertype, excluding java.lang.Object
.
For example:
interface Repository
@BoundTo(supertype = Repository::class, component = SingletonComponent::class)
class RepositoryA @Inject constructor() : Repository
@BoundTo(supertype = Repository::class, component = SingletonComponent::class)
@Singleton
class RepositoryB @Inject constructor() : Repository
@Bound(component = SingletonComponent::class)
@Named("offline")
class RepositoryC @Inject constructor() : Repository
will generate module:
@Module
@InstallIn(SingletonComponent.class)
public interface Repository_SingletonComponent_BindingsModule {
@Binds
Repository bindRepositoryA(RepositoryA implementation);
@Binds
@Singleton
Repository bindRepositoryB(RepositoryB implementation);
@Binds
@Named("offline")
Repository bindRepositoryC(RepositoryC implementation);
}
Since release 1.1.0, component property is optional, and set to SingletonComponent
by default.
@FactoryMethod
Marks factory method for the class returned by the annotated function.
For example, for a Room database:
@Database(
entities = [
User::class
],
version = 1
)
abstract class AppDatabase : RoomDatabase() {
@FactoryMethod(component = SingletonComponent::class)
@Singleton
abstract fun usersDao(): UsersDao
}
and a database factory:
interface DatabaseFactory {
@FactoryMethod(component = SingletonComponent::class)
@Singleton
fun createDatabase(): AppDatabase
}
and a database factory provider:
object DatabaseFactoryProvider {
@FactoryMethod(component = SingletonComponent::class)
fun createDatabaseFactory(
@ApplicationContext context: Context
): DatabaseFactory =
if (BuildConfig.DEBUG) TestDatabaseFactory(context)
else ProductionDatabaseFactory(context)
}
annotation processor will generate modules:
@Module
@InstallIn(SingletonComponent.class)
public class UsersDao_SingletonComponent_FactoryMethodsModule {
@Provides
@Singleton
public UsersDao appDatabase_usersDao(AppDatabase factory) {
return factory.usersDao();
}
}
@Module
@InstallIn(SingletonComponent.class)
public class AppDatabase_SingletonComponent_FactoryMethodsModule {
@Provides
@Singleton
public AppDatabase databaseFactory_createDatabase(DatabaseFactory factory) {
return factory.createDatabase();
}
}
@Module
@InstallIn(SingletonComponent.class)
public class DatabaseFactory_SingletonComponent_FactoryMethodsModule {
@Provides
public DatabaseFactory databaseFactoryProvider_createDatabaseFactory(
@ApplicationContext Context context_0) {
return DatabaseFactoryProvider.INSTANCE.createDatabaseFactory(context_0);
}
}
Since release 1.1.0, component property is optional, and set to SingletonComponent
by default.
@TestBound
, @TestBoundTo
and @TestFactoryMethod
Version 1.1.0 introduces additional test annotations that can be used to generate modules
annotated with @TestInstallIn
, instead of @InstallIn
:
@TestBound
(instead of@Bound
)@TestBoundTo
(instead of@BoundTo
)@TestFactoryMethod
(instead of@FactoryMethod
)
Test module generated using @TestBound
and/or @TestBoundTo
will replace the module generated using
@Bound
and/or @BoundTo
.
Test module generated using @TestFactoryMethod
will replace the module generated with @FactoryMethod
.
Hilt Testing Extensions
Must be used as debugImplementation
dependency to properly register EmptyFragmentActivity
in manifest.
Kotlin
dependencies {
implementation("com.google.dagger:hilt-android:2.36")
androidTestImplementation("androidx.test:runner:1.3.0")
debugImplementation("it.czerwinski.android.hilt:hilt-fragment-testing:[VERSION]")
}
Groovy
dependencies {
implementation 'com.google.dagger:hilt-android:2.36'
androidTestImplementation 'androidx.test:runner:1.3.0'
debugImplementation 'it.czerwinski.android.hilt:hilt-fragment-testing:[VERSION]'
}
Testing Fragments With Hilt
HiltFragmentScenario
Works exactly like FragmentScenario, but supports Hilt dependency injection in fragments.