跳到主要内容
版本：v7

@capacitor/preferences

Preferences API 提供了一个简单的键/值持久化存储，适用于轻量级数据。

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

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

注意：此 API 不 适合用作本地数据库。如果您的应用需要存储大量数据、有高读写负载或需要复杂查询，建议考虑基于 SQLite 的解决方案。其中一个方案是 Ionic Secure Storage，这是一个基于 SQLite 且支持全加密的引擎。Capacitor 社区 也构建了多种其他存储引擎。

安装​

npm install @capacitor/preferences
npx cap sync

Apple 隐私清单要求​

Apple 要求应用开发者现在必须为 API 使用指定批准的原因，以增强用户隐私。到 2024 年 5 月 1 日，向 App Store Connect 提交应用时必须包含这些原因。

当在应用中使用此特定插件时，您必须在 /ios/App 中创建一个 PrivacyInfo.xcprivacy 文件，或使用 VS Code 扩展生成它，并指定使用原因。

有关如何执行此操作的详细步骤，请参阅 Capacitor 文档。

对于此插件，必需的字典键是 NSPrivacyAccessedAPICategoryUserDefaults，推荐的原因是 CA92.1。

示例 PrivacyInfo.xcprivacy​

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NSPrivacyAccessedAPITypes</key>
    <array>
      <!-- 如果 PrivacyInfo 文件已存在，请将此字典条目添加到数组中 -->
      <dict>
        <key>NSPrivacyAccessedAPIType</key>
        <string>NSPrivacyAccessedAPICategoryUserDefaults</string>
        <key>NSPrivacyAccessedAPITypeReasons</key>
        <array>
          <string>CA92.1</string>
        </array>
      </dict>
    </array>
  </dict>
</plist>

插件使用示例​

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(`Hello ${value}!`);
};

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

处理 JSON​

Preferences API 仅支持字符串值。但是，您可以在调用 set() 之前使用 JSON.stringify 处理对象，然后在 get() 返回的值上使用 JSON.parse，这样就可以使用 JSON。

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

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

Interfaces​

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

编辑此页