在移动应用开发中,用户首选项(Preferences)是一种常见的数据存储方式,用于保存用户的个性化设置或应用的配置信息。类似于Android中的SharedPreferences
,Preferences以键值对(Key-Value)的形式将数据存储在应用的内存和本地文件中。本文将详细介绍Preferences的概念、运作机制、API使用以及相关的限制。
一、用户首选项(Preferences)的概念
Preferences是一种轻量级的数据存储方式,适用于存储少量的、非敏感的用户数据。它通过键值对的形式将数据存储在应用的内存中,读取速度快。当需要持久化数据时,可以通过调用flush()
方法将数据写入本地文件。Preferences的文件存储在应用沙箱内部,路径为context.getApplicationContext().preferencesDir
。
由于Preferences的数据缓存在内存中,随着存储数据量的增加,应用占用的内存也会增大。因此,Preferences不适合存储大量数据,且不支持数据加密。通常,Preferences用于存储用户的个性化设置、应用的配置信息等轻量级数据。
二、Preferences的运作机制
Preferences的实例可以通过应用的上下文(Context)和文件名来获取。每个文件对应一个唯一的Preferences实例,系统会通过静态容器将这些实例存储在内存中,以确保实例的唯一性。通过put()
方法可以将数据存储在Preferences实例中,调用flush()
方法后,数据会被持久化到本地文件中。如果只调用了put()
而未调用flush()
,数据将仅存储在内存中,应用关闭后数据会丢失。
通过get()
方法可以从Preferences实例中获取指定的数据。Preferences的文件存储在应用沙箱内部,文件名不可重复,以便进行分文件管理。
三、Preferences的API说明
获取Preferences实例
preferences.getPreferencesSync(context: Context, options: Options): Preferences
通过上下文和文件名获取Preferences实例。
options
参数包括name
(Preferences实例的名称)和dataGroupId
(应用组ID,暂不支持)。删除Preferences实例
preferences.deletePreferences(context: Context, options: Options): Promise<void>
从缓存中移除指定的Preferences实例,并删除对应的持久化文件。调用后,该实例不可再使用。
从缓存中移除Preferences实例
preferences.removePreferencesFromCacheSync(context: Context, name: string): void
从缓存中移除指定的Preferences实例,但不删除持久化文件。调用后,需重新获取实例。
获取指定键的值
getSync(key: string, defValue: ValueType): ValueType
从缓存的Preferences实例中获取指定键的值。如果值为
null
或不支持的数据类型,返回默认值defValue
。获取所有键
getAllSync(): Object
从缓存的Preferences实例中获取所有的键,返回一个对象。
写入数据
putSync(key: string, value: ValueType): void
将数据写入缓存的Preferences实例中。如果键已存在,会覆盖原来的值。数据仅存储在内存中,需调用
flush()
持久化。检查键是否存在
hasSync(key: string): boolean
检查缓存的Preferences实例中是否包含指定的键。
删除键值对
deleteSync(key: string): void
从缓存的Preferences实例中删除指定的键值对。需调用
flush()
以删除本地文件中的数据。持久化数据
flush(): Promise<void>
将缓存的Preferences实例中的数据异步存储到本地文件中。
清除所有数据
clearSync(): void
清除缓存的Preferences实例中的所有数据。需调用
flush()
以清除本地文件中的数据。订阅数据变更
on(type: 'change', callback: Callback<string>): void
订阅数据变更事件,当数据发生变更并调用
flush()
时触发回调。订阅多进程数据变更
on(type: 'multiProcessChange', callback: Callback<string>): void
订阅多进程间的数据变更事件,当任意进程中的数据发生变更并调用
flush()
时触发回调。订阅指定键的数据变更
on(type: 'dataChange', keys: Array<string>, callback: Callback<Record<string, ValueType>>): void
订阅指定键的数据变更事件,当指定键的值发生变更并调用
flush()
时触发回调。取消订阅
off('type')
取消订阅指定类型的事件。
四、Preferences的使用限制
数据大小限制
Key的最大长度为1024个字节,Value的最大长度为16MB。
数据类型限制
Key的数据类型为
string
,Value支持的数据类型包括number
、string
、boolean
、Array<string>
、Array<number>
、Array<boolean>
、Uint8Array
、object
、bigint
。并发安全限制
Preferences无法保证进程并发安全,存在文件损坏和数据丢失的风险,因此不支持在多进程场景下使用。
内存限制
随着存储数据量的增加,内存占用也会增加。建议存储的数据量不超过一万条,以避免内存开销过大。
五、总结
Preferences是一种轻量级的数据存储方式,适用于存储少量的用户设置或应用配置信息。它通过键值对的形式将数据存储在内存中,读取速度快,且可以通过flush()
方法将数据持久化到本地文件中。然而,Preferences不适合存储大量数据,且不支持多进程并发操作。在使用时,开发者应注意数据大小、数据类型以及内存占用的限制,以确保应用的性能和稳定性。