Kotlin

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

NOTE

更新 - 2024-10-21

获取代码

INFO

源代码可在 Github 上获取

设置

首先，请确保已按如下方式添加 koin-core 依赖项：

dependencies {
    
    // Kotlin 应用程序的 Koin
    implementation "io.insert-koin:koin-core:$koin_version"
}

应用程序概述

该应用程序的目的是管理用户列表，并在我们的 UserApplication 类中显示它：

用户 -> UserRepository -> UserService -> UserApplication

“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 {
    single<UserRepository> { UserRepositoryImpl() }
}

UserService 组件

让我们编写 UserService 组件来请求默认用户：

class UserService(private val userRepository: UserRepository) {

    fun getDefaultUser() : User = userRepository.findUser(DefaultData.DEFAULT_USER.name) ?: error("Can't find default user")
}

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

我们在 Koin 模块中声明 UserService。我们将其声明为 single 定义：

val appModule = module {
     single<UserRepository> { UserRepositoryImpl() }
     single { UserService(get()) }
}

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

在 UserApplication 中注入依赖项

UserApplication 类将帮助从 Koin 中引导实例。它将解析 UserService，这得益于 KoinComponent 接口。这使得可以使用 by inject() 委托函数来注入它：

class UserApplication : KoinComponent {

    private val userService : UserService by inject()

    // display our data
    fun sayHello(){
        val user = userService.getDefaultUser()
        val message = "Hello '$user'!"
        println(message)
    }
}

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

INFO

by inject() 函数允许我们在任何扩展 KoinComponent 的类中检索 Koin 实例。

启动 Koin

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

fun main() {
    startKoin {
        modules(appModule)
    }

    UserApplication().sayHello()
}

INFO

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

Koin 模块：经典模式还是构造函数 DSL？

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

val appModule = module {
    single<UserRepository> { UserRepositoryImpl() }
    single { UserService(get()) }
}

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

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