@atroo/capacitor-secure-storage-plugin

中文文档
8.0.0发布于 2026/03/19MITTypeScriptESM + CJS零依赖近 30 天下载 1.1万

安全存储iOS & Android上的用户名、密码、信使、证书或其他敏感信息(字符串)等机密

中文使用文档
文档目录20 节
  1. 兼容性
  2. 安装
  3. 特征
  4. 机器人
  5. iOS系统
  6. 页:1
  7. 机器人
  8. API 密码
  9. 设置StorageAdapter(...)
  10. 获取StorageAdapter ()
  11. 获取(...)
  12. 获取可访问性(...)
  13. 设置(...)
  14. 删除(...)
  15. 清除( c)
  16. 键( )
  17. 获取公式 ()
  18. 接口
  19. 类型异名
  20. 数字

@ atroo/ 电容器- 安全存储- 插件

安全存储iOS & Android上的用户名、密码、信使、证书或其他敏感信息(字符串)等机密

兼容性

由于v5我们遵循Capacitor的版本,这意味着这个插件的v5可以被Capacitor 5使用,而v6可以被Capacitor 6使用.

安装

npm install @atroo/capacitor-secure-storage-plugin
npx cap sync

特征

机器人

此插件使用加密共享首选项安全存储任何Android设备上的敏感信息. 它将在更新后对旧版本的数据进行自动化.

iOS系统

使用时 set() 当允许访问密钥时,您可以指定用于控制的密钥链的不同无障碍修饰符。 在接连呼叫中提供不同的无障碍修饰符 set() 用于同一密钥,将去掉旧密钥并创建在引擎盖下的新密钥来防止键链出错.

页:1

机器人

自动备份

为了保持安全,你需要处理Android的自动备份规则. 请参考 此文档。 。 。 .

爪哇语 21

插件需要Java 21运行. 您可以使用以下选项设置 :

  • 更改 IDE 设置.
  • 更改 JAVA HOME 环境变量 .
  • 变化 org.gradle.java.home 内 gradle.properties。 。 。 .
升级 gralde

转到机器人运行 ./gradlew --version 并检查 Android Gradle 插件版本。 格蕾尔.

编辑 gradle/ wrapper/ gradle- wrapper. 财产 : distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip

然后更新包装:

./gradlew wrapper --gradle-version 8.7

API 密码

安全套接字插件接口

设置StorageAdapter(...)

setStorageAdapter(options: { web: { adapter: WebStorageAdapter; }; }) => Promise<{ value: boolean; }>

获得给定密钥的值

参数类型说明
options{ web: { adapter: WebStorageAdapter; }; }键以获取值

回返情况: Promise<{ value: boolean; }>


获取StorageAdapter ()

getStorageAdapter() => Promise<{ adapter: WebStorageAdapter; }>

获得当前存储适配器或无效

回返情况: Promise<{ adapter: WebStorageAdapter; }>


获取(...)

get(options: { key: string; }) => Promise<{ value: string; }>

获得给定密钥的值

参数类型说明
options{ key: string; }键以获取值

回返情况: Promise<{ value: string; }>


获取可访问性(...)

getAccessibility(options: { key: string; }) => Promise<{ value: string | undefined; }>

获取给定密钥的可访问性

参数类型说明
options{ key: string; }关键字

回返情况: Promise<{ value: string; }>


设置(...)

set(options: SetDataOptions) => Promise<{ value: boolean; }>

设置给定密钥的值

参数类型说明
optionsSetDataOptions键和要设置的值

回返情况: Promise<{ value: boolean; }>


删除(...)

remove(options: { key: string; }) => Promise<{ value: boolean; }>

删除给定密钥的值

参数类型说明
options{ key: string; }要删除值的密钥

回返情况: Promise<{ value: boolean; }>


清除( c)

clear() => Promise<{ value: boolean; }>

清除所有值

回返情况: Promise<{ value: boolean; }>


键( )

keys() => Promise<{ value: string[]; }>

获得全部密钥

回返情况: Promise<{ value: string[]; }>


获取公式 ()

getPlatform() => Promise<{ value: string; }>

获得平台

回返情况: Promise<{ value: string; }>


接口

设置数据选项

允许定义如何在 iOS 上访问属性

Prop类型
keystring
valuestring
accessibilityAccessibility

类型异名

无障碍

允许定义如何在 iOS 上访问属性

'afterFirstUnlock' | 'afterFirstUnlockThisDeviceOnly' | 'whenUnlocked' | 'whenUnlockedThisDeviceOnly' | 'always' | 'alwaysThisDeviceOnly' | 'whenPasscodeSetThisDeviceOnly'

数字

WebStorage 自动调试器

成员数值
LocalStorage'LocalStorage'
SessionStorage'SessionStorage'
SessionCookie'SessionCookie'

版本与发布记录

@atroo/capacitor-secure-storage-plugin 共发布 6 个版本,首次发布于 2022/05/13;过去 12 个月发布了 1 个版本。

版本发布日期距今
8.0.0latest2026/03/197 个月前
7.0.02025/08/151.2 年前
6.1.02025/03/241.6 年前
6.0.02024/08/052 年前
5.0.02023/12/012 年前
0.7.02022/05/134 年前

关于 @atroo/capacitor-secure-storage-plugin 的常见问题

@atroo/capacitor-secure-storage-plugin 是什么?

安全存储iOS & Android上的用户名、密码、信使、证书或其他敏感信息(字符串)等机密

如何安装 @atroo/capacitor-secure-storage-plugin?

在项目目录运行 npm install @atroo/capacitor-secure-storage-plugin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@atroo/capacitor-secure-storage-plugin 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@atroo/capacitor-secure-storage-plugin 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@atroo/capacitor-secure-storage-plugin 可以商用吗?

@atroo/capacitor-secure-storage-plugin 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@atroo/capacitor-secure-storage-plugin 的下载量有多少?

根据 npm 官方下载统计,@atroo/capacitor-secure-storage-plugin 在 2026/10/07 – 2026/11/05 这 30 天内被下载 10,802 次,日均约 360 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@atroo/capacitor-secure-storage-plugin 还在维护吗?

最新版本 8.0.0 发布于 2026/03/19(7 个月前);至今共发布 6 个版本,其中过去 12 个月发布了 1 个;首次发布于 2022/05/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。