在multiplatform-settings项目中实现JS平台的ObservableSettings

背景介绍

multiplatform-settings是一个跨平台的键值存储库，支持Android、iOS、JVM和JS等多个平台。在JS平台上，原生实现可能不直接支持设置变化的监听功能，这就需要开发者自行实现一个可观察的设置存储方案。

核心实现思路

实现JS平台的可观察设置存储主要包含两个核心部分：

1. ObservableSetting类：负责维护设置变更的监听器列表，并在设置值变化时通知所有监听器
2. StorageSettingHandler：作为上层封装，将监听器机制转换为Kotlin的Flow API，提供更友好的响应式编程接口

具体实现分析

1. ObservableSetting实现

ObservableSetting类是核心的监听器管理实现，它包装了原始的Settings实例，并添加了监听功能：

private class JsObservableSetting(val delegate: Settings) : IJsObservableSetting {
    private val listeners = mutableMapOf<String, MutableSet<SettingListener>>()

    // 保存字符串值并通知监听器
    override fun saveString(key: String, value: String) {
        delegate[key] = value
        notifyByKey(key, delegate.getStringOrNull(key))
    }

    // 添加字符串监听器
    override fun addStringListener(key: String, listener: SettingListener) {
        addListener<String?>(key, listener)
        listener.notify(delegate.getStringOrNull(key))
    }

    // 通知特定key的所有监听器
    private fun <T : Any?> notifyByKey(key: String, value: T) {
        listeners[key]?.forEach { listener ->
            listener.notify(value)
        }
    }
}

关键点：

• 使用mutableMap维护key与监听器集合的映射关系
• 在设置值变更后立即通知所有相关监听器
• 添加监听器时立即通知当前值

2. StorageSettingHandler实现

StorageSettingHandler将底层的监听器机制转换为Flow API，提供更现代的响应式接口：

class StorageSettingHandlerImpl(private val observableSettings: IJsObservableSetting) : IStorageSettingsHandler {
    // 加载字符串设置并返回Flow
    override suspend fun loadString(key: String, defaultValue: String?): Flow<String?> {
        return callbackFlow<String?> {
            val listener = object : SettingListener {
                override fun notify(newValue: Any?) {
                    trySend(newValue as? String ?: defaultValue)
                }
            }
            observableSettings.addStringListener(key, listener)
            awaitClose { observableSettings.removeStringListener(key, listener) }
        }.flowOn(Dispatchers.io())
    }
}

关键点：

• 使用callbackFlow将监听器回调转换为Flow
• 在Flow收集结束时自动移除监听器
• 使用flowOn确保操作在IO线程执行

设计优势

1. 线程安全：所有监听器通知都在IO线程执行，避免UI线程阻塞
2. 资源管理：利用Flow的awaitClose确保监听器正确移除，防止内存泄漏
3. 类型安全：通过泛型处理不同类型设置值的转换
4. 响应式接口：提供Flow API，与现代Kotlin协程生态无缝集成

使用示例

开发者可以这样使用该实现：

// 创建可观察设置实例
val settings = Settings().createObservableSettings()
val handler = StorageSettingHandlerImpl(settings)

// 观察设置变化
launch {
    handler.loadString("user_name", "default")
        .collect { name -> println("用户名变更为: $name") }
}

// 修改设置值
handler.saveString("user_name", "新用户")

总结

在multiplatform-settings项目中实现JS平台的ObservableSettings功能，核心在于构建一个监听器管理系统，并将其封装为响应式接口。这种实现方式既保持了原始库的简单性，又添加了现代响应式编程的支持，为JS平台的设置管理提供了更强大的功能。开发者可以根据实际需求进一步扩展，比如添加防抖、过滤重复值等高级功能。