# @atroo/capacitor-secure-storage-plugin 中文文档

规范地址：https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/

版本：8\.0\.0
npm 元数据更新时间：2026-03-19T07:49:56.384Z
中文译文更新时间：2026-11-07T03:57:22.798Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40atroo/capacitor-secure-storage-plugin
原文对照：https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/?lang=original
项目主页：https://github.com/atroo/capacitor-secure-storage-plugin.git#readme
源码仓库：https://github.com/atroo/capacitor-secure-storage-plugin.git

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：150 kB，36 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2022-05-12T17:07:00.050Z
- 最新版本发布：2026-03-19T07:49:56.262Z
- 近 30 天下载量：10802（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 1 个）

## 中文简介

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

## 安装

```sh
npm install @atroo/capacitor-secure-storage-plugin
```

也可以使用：`pnpm add @atroo/capacitor-secure-storage-plugin`、`yarn add @atroo/capacitor-secure-storage-plugin`、`bun add @atroo/capacitor-secure-storage-plugin`

## README

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

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

## 兼容性

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

## 安装

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

## 特征

### 机器人

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

### iOS系统

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

## 页:1

### 机器人

#### 自动备份

为了保持安全,你需要处理Android的自动备份规则. 请参考 [此文档](https://developer.android.com/guide/topics/data/autobackup#IncludingFiles)。 。 。 .

#### 爪哇语 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 密码

-   [`setStorageAdapter(...)`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-setstorageadapter)
-   [`getStorageAdapter()`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-getstorageadapter)
-   [`get(...)`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-get)
-   [`getAccessibility(...)`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-getaccessibility)
-   [`set(...)`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-set)
-   [`remove(...)`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-remove)
-   [`clear()`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-clear)
-   [`keys()`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-keys)
-   [`getPlatform()`](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-getplatform)
-   [接口](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-type-aliases)
-   [数字](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-enums)

安全套接字插件接口

### 设置StorageAdapter(...)

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

获得给定密钥的值

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `{ web: { adapter: [WebStorageAdapter](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-webstorageadapter); }; }` | 键以获取值 |

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

* * *

### 获取StorageAdapter ()

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

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

**回返情况:** `Promise<{ adapter: [WebStorageAdapter](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-webstorageadapter); }>`

* * *

### 获取(...)

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

获得给定密钥的值

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

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

* * *

### 获取可访问性(...)

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

获取给定密钥的可访问性

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

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

* * *

### 设置(...)

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

设置给定密钥的值

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[SetDataOptions](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-setdataoptions)` | 键和要设置的值 |

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

* * *

### 删除(...)

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

删除给定密钥的值

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

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

* * *

### 清除( c)

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

清除所有值

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

* * *

### 键( )

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

获得全部密钥

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

* * *

### 获取公式 ()

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

获得平台

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

* * *

### 接口

#### 设置数据选项

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

| Prop | 类型 |
| --- | --- |
| **`key`** | `string` |
| **`value`** | `string` |
| **`accessibility`** | `[Accessibility](https://npmcn.com/package/%40atroo/capacitor-secure-storage-plugin/#readme-accessibility)` |

### 类型异名

#### 无障碍

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

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

### 数字

#### WebStorage 自动调试器

| 成员 | 数值 |
| --- | --- |
| **`LocalStorage`** | `'LocalStorage'` |
| **`SessionStorage`** | `'SessionStorage'` |
| **`SessionCookie`** | `'SessionCookie'` |

## 常见问题

### @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 和提交记录判断。