如何在Jetpack Compose中通过koinViewModel()注入Activity作用域依赖

核心思路 #

要让koinViewModel()能识别Activity专属作用域，关键是正确绑定Activity的Scope并传递给Compose层级，同时确保ViewModel和依赖项在对应Scope内声明。

步骤1：在MainActivity中创建并管理Scope #

首先在Activity中创建与自身生命周期绑定的Koin Scope，再通过CompositionLocal将其传递给所有子Compose组件：

class MainActivity : ComponentActivity() {
    // 创建与当前Activity实例绑定的专属Scope
    private val activityScope by lazy { getKoin().createScope<MainActivity>(this) }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            // 通过CompositionLocal向下暴露Activity Scope
            CompositionLocalProvider(LocalMainActivityScope provides activityScope) {
                MyApp()
            }
        }
    }

    override fun onDestroy() {
        // 销毁Activity时关闭Scope，释放关联资源
        activityScope.close()
        super.onDestroy()
    }
}

// 定义全局CompositionLocal用于传递Activity Scope
val LocalMainActivityScope = staticCompositionLocalOf<Scope> {
    error("MainActivity Scope未在父级Compose中提供")
}

步骤2：在模块中声明Scope内的依赖 #

确保需要Activity作用域的ViewModel和依赖项都放在scope<MainActivity>块内，这样Koin才能在该Scope下解析它们：

val module = module {
    scope<MainActivity> {
        // 声明Activity作用域内的MainViewModel
        viewModel {
            MainViewModel(
                state = State(),
                authRepository = get(),
                emailLoginFlow = get(),
                appleLoginFlow = get(),
                networkWatcher = get(),
                mapper = get(),
                settings = get(),
            )
        }
        // 声明依赖Activity作用域的LoggedInViewModel
        viewModel { LoggedInViewModel(get(), get()) } // get()优先从当前Scope获取依赖
        // 其他Activity作用域的依赖
        scoped<Activity> { get<MainActivity>() }
        // ... 更多scoped依赖
    }

    // 全局作用域的公共依赖（如全局Repository等）
    single { AuthRepository() }
    // ... 其他全局依赖
}

步骤3：在Compose页面中使用Scope注入ViewModel #

在Compose函数中，通过CompositionLocal获取Activity Scope，并传递给koinViewModel()：

@Composable
fun LoggedInScreen(
    viewModel: LoggedInViewModel = koinViewModel(
        scope = LocalMainActivityScope.current
    )
) {
    val state = viewModel.model.collectAsState()
    WebViewWrapper(state.value, viewModel)
}

关键注意点 #

• scope<MainActivity>内的get()会优先从当前Activity Scope查找依赖，找不到才会向上搜索全局Scope。
• 必须在Activity销毁时关闭Scope，避免内存泄漏。
• 用CompositionLocal传递Scope而非直接传递Activity实例，更符合Compose的状态管理最佳实践。

内容的提问来源于stack exchange，提问作者siliconeagle