ViewModel

Koin 通过 koin-core-viewmodel 模块提供跨平台 ViewModel 支持。这允许您在所有 Kotlin 跨平台目标中声明并注入 AndroidX ViewModel 实例。

安装

添加核心 ViewModel 依赖项：

// build.gradle.kts (commonMain)
implementation("io.insert-koin:koin-core-viewmodel:$koin_version")

对于平台特定的注入 API，请添加：

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

// Compose Multiplatform
implementation("io.insert-koin:koin-compose-viewmodel:$koin_version")

声明 ViewModel

编译器插件 DSL

class UserViewModel(
    private val repository: UserRepository
) : ViewModel()

val appModule = module {
    viewModel<UserViewModel>()
}

注解

@KoinViewModel
class UserViewModel(
    private val repository: UserRepository
) : ViewModel()

经典 DSL

val appModule = module {
    // 使用构造函数引用
    viewModelOf(::UserViewModel)

    // 使用 lambda
    viewModel { UserViewModel(get()) }
}

带有参数的 ViewModel

使用 @InjectedParam 在注入时传递参数：

编译器插件 DSL

class DetailViewModel(
    @InjectedParam val itemId: String,
    private val repository: DetailRepository
) : ViewModel()

val appModule = module {
    viewModel<DetailViewModel>()
}

注解

@KoinViewModel
class DetailViewModel(
    @InjectedParam val itemId: String,
    private val repository: DetailRepository
) : ViewModel()

经典 DSL

val appModule = module {
    viewModel { params ->
        DetailViewModel(
            itemId = params.get(),
            repository = get()
        )
    }
}

ViewModel 作用域

需要其自身作用域依赖项的 ViewModel 使用 viewModelScope 模式。在 viewModelScope 内部声明的依赖项与 ViewModel 的生命周期绑定。

编译器插件 DSL

val appModule = module {
    viewModelScope {
        scoped<UserCache>()
        scoped<UserRepository>()
        viewModel<UserViewModel>()
    }
}

注解

@ViewModelScope
class UserCache

@ViewModelScope
class UserRepository(private val cache: UserCache)

@KoinViewModel
@ViewModelScope
class UserViewModel(
    private val repository: UserRepository
) : ViewModel()

经典 DSL

val appModule = module {
    viewModelScope {
        scoped { UserCache() }
        scoped { UserRepository(get()) }
        viewModel { UserViewModel(get()) }
    }
}

INFO

在第一次访问 ViewModel 时会创建 viewModelScope 内部的依赖项，并在清除 ViewModel 时销毁。

注入 ViewModel

在 Compose (跨平台) 中

在 Composable 函数中使用 koinViewModel()：

@Composable
fun UserScreen() {
    val viewModel = koinViewModel<UserViewModel>()
    // 或带有参数
    val detailVM = koinViewModel<DetailViewModel> { parametersOf("item_123") }
}

在 Android 中

在 Activity 或 Fragment 中使用 by viewModel() 委托：

class UserActivity : AppCompatActivity() {
    private val viewModel: UserViewModel by viewModel()

    // 带有参数
    private val detailVM: DetailViewModel by viewModel { parametersOf("item_123") }
}

SavedStateHandle

将 SavedStateHandle 添加到您的 ViewModel 构造函数中 - Koin 会自动注入它：

@KoinViewModel
class MyViewModel(
    private val handle: SavedStateHandle,
    private val repository: UserRepository
) : ViewModel() {

    val userId: String? = handle["userId"]
}

val appModule = module {
    viewModel<MyViewModel>()  // 编译器插件 DSL
    // 或
    viewModelOf(::MyViewModel)  // 经典 DSL
}

快速参考

方式	模块声明	作用域声明
编译器插件 DSL	viewModel<MyVM>()	viewModelScope { viewModel<MyVM>() }
注解	@KoinViewModel	@KoinViewModel @ViewModelScope
经典 DSL	viewModelOf(::MyVM)	viewModelScope { viewModelOf(::MyVM) }

平台	注入 API
Compose	koinViewModel<MyVM>()
Android	by viewModel()

平台特定功能

• Android：有关 Activity/Fragment 共享、导航图作用域的信息，请参阅 Android ViewModel
• Compose：有关 Compose 特定 API 的信息，请参阅 Compose ViewModel

后续步骤

• 作用域 - 核心作用域概念
• Android ViewModel - Android 特定功能
• Compose - Compose 跨平台集成