跳到主要内容

安卓

本教程将引导你编写一个 Android 应用程序，并使用 Koin 依赖注入来检索你的组件。 完成本教程大约需要 10 分钟。

备注

更新 - 2024-10-21

获取代码​

信息

源代码可在 Github 上找到

Gradle 设置​

添加 Koin Android 依赖，如下所示：

dependencies {

    // Koin for Android
    implementation("io.insert-koin:koin-android:$koin_version")
}

应用概览​

该应用程序的想法是管理一个用户列表，并在我们的 MainActivity 类中使用 Presenter 或 ViewModel 显示它：

Users -> UserRepository -> (Presenter or ViewModel) -> MainActivity

“User”数据​

我们将管理一个用户集合。 这是数据类：

data class User(val name : String)

我们创建一个“Repository”（仓库）组件来管理用户列表（添加用户或按名称查找）。 下面是 UserRepository 接口及其实现：

interface UserRepository {
    fun findUser(name : String): User?
    fun addUsers(users : List<User>)
}

class UserRepositoryImpl : UserRepository {

    private val _users = arrayListOf<User>()

    override fun findUser(name: String): User? {
        return _users.firstOrNull { it.name == name }
    }

    override fun addUsers(users : List<User>) {
        _users.addAll(users)
    }
}

Koin 模块​

使用 module 函数来声明 Koin 模块。 Koin 模块是我们定义所有要注入组件的地方。

val appModule = module {
    
}

让我们声明我们的第一个组件。 我们想要一个 UserRepository 的单例，通过创建一个 UserRepositoryImpl 的实例

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
}

使用 Presenter 显示用户​

让我们编写一个 presenter 组件来显示用户：

class UserPresenter(private val repository: UserRepository) {

    fun sayHello(name : String) : String{
        val foundUser = repository.findUser(name)
        return foundUser?.let { "Hello '$it' from $this" } ?: "User '$name' not found!"
    }
}

UserRepository 在 UserPresenter 的构造函数中被引用

我们在 Koin 模块中声明 UserPresenter。 我们将其声明为 factoryOf 定义，以不在内存中保留任何实例（避免 Android 生命周期中的任何泄漏）：

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    factoryOf(::UserStateHolder)
}

get() 函数允许要求 Koin 解析所需的依赖项。

在 Android 中注入依赖项​

UserPresenter 组件将被创建，同时解析 UserRepository 实例。 为了在我们的 Activity 中获取它，让我们使用 by inject() 委托函数来注入它：

class MainActivity : AppCompatActivity() {

    private val presenter: UserPresenter by inject()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        
        //...
    }
}

就是这样，你的应用程序已准备就绪。

信息

by inject() 函数允许我们在 Android 组件运行时（Activity、fragment、Service...）检索 Koin 实例

启动 Koin​

我们需要使用我们的 Android 应用程序启动 Koin。 只需在应用程序的主入口点，即我们的 MainApplication 类中调用 startKoin() 函数：

class MainApplication : Application(){
    override fun onCreate() {
        super.onCreate()
        
        startKoin{
            androidLogger()
            androidContext(this@MainApplication)
            modules(appModule)
        }
    }
}
信息

startKoin 中的 modules() 函数加载给定的模块列表

Koin 模块：经典或构造函数 DSL？​

这是我们应用程序的 Koin 模块声明：

val appModule = module {
    single<HelloRepository> { HelloRepositoryImpl() }
    factory { MyPresenter(get()) }
}

我们可以使用构造函数以更紧凑的方式编写它：

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    factoryOf(::UserPresenter)
}

验证你的应用！​

我们可以通过使用简单的 JUnit 测试验证我们的 Koin 配置来确保我们的 Koin 配置良好，然后再启动我们的应用程序。

Gradle 设置​

添加 Koin Android 依赖，如下所示：

// Add Maven Central to your repositories if needed
repositories {
	mavenCentral()    
}

dependencies {
    
    // Koin for Tests
    testImplementation "io.insert-koin:koin-test-junit4:$koin_version"
}

检查你的模块​

verify() 函数允许验证给定的 Koin 模块：

class CheckModulesTest : KoinTest {

    @Test
    fun checkAllModules() {
        appModule.verify()
    }
}

只需一个 JUnit 测试，你就可以确保你的定义配置没有任何遗漏！