跳至主要内容

Android

本教學課程將引導您編寫一個 Android 應用程式，並使用 Koin 依賴注入（dependency injection）來檢索您的元件。 完成本教學課程大約需要 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" 資料​

我們將管理一個 Users 集合。以下是資料類別：

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 的 singleton，通過建立一個 UserRepositoryImpl 的實例

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

使用 Presenter 顯示 User​

讓我們編寫一個 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 生命周期（lifecycle）的任何洩漏）：

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 測試，您就可以確保您的定義配置沒有遺漏任何內容！