跳到主要内容
版本：v5

@capacitor/preferences

Preferences API 为轻量级数据提供简单的键/值持久化存储。

移动操作系统可能会定期清除 window.localStorage 中设置的数据，因此 应改用此 API。当作为渐进式 Web 应用运行时，此 API 将回退到使用 localStorage。

此插件将在 iOS 上使用 UserDefaults， 在 Android 上使用 SharedPreferences。 如果应用被卸载，存储的数据将被清除。

注意：此 API 不 旨在用作本地数据库。如果你的应用 存储大量数据、具有高读写负载或需要复杂查询， 我们建议考虑使用基于 SQLite 的解决方案。一个这样的解决方案是 Ionic Secure Storage，一个具有完整加密支持的基于 SQLite 的引擎。Capacitor Community 还构建了许多其他存储引擎。

安装​

npm install @capacitor/preferences@latest-5
npx cap sync

示例​

import { Preferences } from '@capacitor/preferences';

const setName = async () => {
  await Preferences.set({
    key: 'name',
    value: 'Max',
  });
};

const checkName = async () => {
  const { value } = await Preferences.get({ key: 'name' });

  console.log(`你好 ${value}!`);
};

const removeName = async () => {
  await Preferences.remove({ key: 'name' });
};

使用 JSON​

Preferences API 只支持字符串值。但是，你可以使用 JSON，方法是在调用 set() 之前对对象进行 JSON.stringify，然后对 get() 返回的值进行 JSON.parse。

此方法也可用于存储非字符串值，例如数字和布尔值。

API​

configure(...)​

configure(options: ConfigureOptions) => Promise<void>

在运行时配置偏好设置插件。

值为 undefined 的选项将不会被使用。

参数类型
options
ConfigureOptions

自从: 1.0.0

get(...)​

get(options: GetOptions) => Promise<GetResult>

从偏好设置中获取指定键的值。

参数类型
options
GetOptions

返回: 

Promise<GetResult>

自从: 1.0.0

set(...)​

set(options: SetOptions) => Promise<void>

在偏好设置中为指定键设置值。

参数类型
options
SetOptions

自从: 1.0.0

remove(...)​

remove(options: RemoveOptions) => Promise<void>

从偏好设置中移除指定键的值（如果有）。

参数类型
options
RemoveOptions

自从: 1.0.0

clear()​

clear() => Promise<void>

清除偏好设置中的键和值。

自从: 1.0.0

keys()​

keys() => Promise<KeysResult>

返回偏好设置中已知键的列表。

返回: 

Promise<KeysResult>

自从: 1.0.0

migrate()​

migrate() => Promise<MigrateResult>

从 Capacitor 2 Storage 插件迁移数据。

此操作是非破坏性的。它不会删除旧数据，并且只会在键尚未设置时 写入新数据。 要在迁移后删除旧数据，请调用 removeOld()。

返回: 

Promise<MigrateResult>

自从: 1.0.0

removeOld()​

removeOld() => Promise<void>

从 Capacitor 2 Storage 插件中删除带有 _cap_ 前缀的旧数据。

自从: 1.1.0

接口​

ConfigureOptions​

属性类型描述默认值自从
groupstring设置偏好设置组。偏好设置组用于组织键/值对。使用值 'NativeStorage' 提供与 cordova-plugin-nativestorage 的向后兼容性。警告：使用 'NativeStorage' 组时，clear() 方法可能会删除意外值。CapacitorStorage1.0.0

GetResult​

属性类型描述自从
valuestring | null与给定键关联的偏好设置值。如果以前未设置值或已移除，则 value 将为 null。1.0.0

GetOptions​

属性类型描述自从
keystring要从偏好设置中检索其值的键。1.0.0

SetOptions​

属性类型描述自从
keystring要与在偏好设置中设置的值关联的键。1.0.0
valuestring要在偏好设置中与关联键一起设置的值。1.0.0

RemoveOptions​

属性类型描述自从
keystring要从偏好设置中移除其值的键。1.0.0

KeysResult​

属性类型描述自从
keysstring[]偏好设置中的已知键。1.0.0

MigrateResult​

属性类型描述自从
migratedstring[]已迁移的键数组。1.0.0
existingstring[]已在 Capacitor 2 Preferences 插件中拥有值，且已经迁移或已存在于偏好设置中的键数组。1.0.0

Contents

编辑此页