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

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

版本：4\.0\.4
npm 元数据更新时间：2026-05-04T07:09:13.835Z
中文译文更新时间：2026-11-14T06:21:32.296Z
软件包许可：MIT

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：63.9 kB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core ^7\.0\.1
- 首次发布：2024-10-28T07:58:00.937Z
- 最新版本发布：2025-08-12T13:29:07.175Z
- 近 30 天下载量：2270（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

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

## 安装

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

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

## README

# 电容安全存储插件

[![NPM Version](https://img.shields.io/npm/v/%40evva%2Fcapacitor-secure-storage-plugin)](https://www.npmjs.com/package/@evva/capacitor-secure-storage-plugin) [![NPM Downloads](https://img.shields.io/npm/dy/%40evva%2Fcapacitor-secure-storage-plugin)](https://www.npmjs.com/package/@evva/capacitor-secure-storage-plugin) ![NPM Unpacked Size (with version)](https://img.shields.io/npm/unpacked-size/%40evva%2Fcapacitor-secure-storage-plugin/latest) ![GitHub last commit](https://img.shields.io/github/last-commit/evva-sfw/capacitor-secure-storage-plugin) [![GitHub branch check runs](https://img.shields.io/github/check-runs/evva-sfw/capacitor-secure-storage-plugin/main)](https://npmcn.com/package/%40evva/capacitor-secure-storage-plugin/%5BURL%5D\(https://github.com/evva-sfw/capacitor-secure-storage-plugin/actions\)) [![EVVA License](https://img.shields.io/badge/license-EVVA_License-yellow.svg?color=fce500&logo=data:image/svg+xml;base64,PCEtLSBHZW5lcmF0ZWQgYnkgSWNvTW9vbi5pbyAtLT4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjY0MCIgaGVpZ2h0PSIxMDI0IiB2aWV3Qm94PSIwIDAgNjQwIDEwMjQiPgo8ZyBpZD0iaWNvbW9vbi1pZ25vcmUiPgo8L2c+CjxwYXRoIGZpbGw9IiNmY2U1MDAiIGQ9Ik02MjIuNDIzIDUxMS40NDhsLTMzMS43NDYtNDY0LjU1MmgtMjg4LjE1N2wzMjkuODI1IDQ2NC41NTItMzI5LjgyNSA0NjYuNjY0aDI3NS42MTJ6Ij48L3BhdGg+Cjwvc3ZnPgo=)](https://npmcn.com/package/%40evva/capacitor-secure-storage-plugin/LICENSE)

> \[大 这个包被重新命名了,请使用新的包名! **@evva/ 电容器- 安全存储- 插件**

IOS和Android上安全存储字符串值的电容插件.

## 如何安装

### 电容 7

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

### 电容 6

```
npm install @evva/capacitor-secure-storage-plugin@3.1.0
npx cap sync
```

### 旧版本

关于低于6的版本,请参考 [https://github.com/martinkasa/concessor-secure-storage-plugin 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/martinkasa/capacitor-secure-storage-plugin)

## 兼容性

### iOS 15.0+ (英语)

### Android API 第29级+

## 使用量

```typescript
import { SecureStoragePlugin } from '@evva/capacitor-secure-storage-plugin';
```

## 示例

```ts
const key = 'username';
const value = 'hellokitty2';

SecureStoragePlugin.set({ key, value })
  .then(success => console.log(success))
```

```ts
const key = 'username';
SecureStoragePlugin.get({ key })
  .then(value => {
    console.log(value);
  })
  .catch(error => {
    console.log('Item with specified key does not exist.');
  });
```

```ts
async getUsername(key: string) {
  return await SecureStoragePlugin.get({ key });
}
```

## API 密码

-   [接口](https://npmcn.com/package/%40evva/capacitor-secure-storage-plugin/#readme-interfaces)

### 接口

#### 安全套接字接口

| Prop | 类型 |
| --- | --- |
| **`get`** | `(options: { key: string; accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: string; }>` |
| **`set`** | `(options: { key: string; value: string; accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: boolean; }>` |
| **`remove`** | `(options: { key: string; accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: boolean; }>` |
| **`clear`** | `(options?: { accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: boolean; }>` |
| **`keys`** | `(options?: { accessibility?: string; group?: string; }) => Promise<{ value: string[]; }>` |
| **`getPlatform`** | `() => Promise<{ value: string; }>` |

## 平台特定信息

### iOS系统

此插件使用 SimpleKeychain Swift 库用于 iOS .

### 机器人

在Android上,它使用AndroidKeyStore,"共享优先"和"加密共享优先"来实施,以加强安全. 这种方法使用现代加密标准,以确保与Android Marshmallow及以上设备的数据安全.

### 网页

浏览器中没有安全的存储(不是因为它没有被这个插件执行,而是根本不存在). 值被存储在"localStorage"中,但它们至少被碱基64编码. 插件添加"顶部"_秒_' 键的前缀,以避免与存储在localStorage中的其他数据相冲突.

## 常见问题

### @evva/capacitor-secure-storage-plugin 是什么？

安全存储iOS & Android上的用户名、密码、信使、证书或其他敏感信息\(字符串\)等机密注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @evva/capacitor-secure-storage-plugin？

在项目目录运行 npm install @evva/capacitor-secure-storage-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（^7\.0\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @evva/capacitor-secure-storage-plugin 支持 TypeScript 吗？

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

### @evva/capacitor-secure-storage-plugin 支持 ESM 还是 CommonJS？

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

### @evva/capacitor-secure-storage-plugin 可以商用吗？

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

### @evva/capacitor-secure-storage-plugin 的下载量有多少？

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

### @evva/capacitor-secure-storage-plugin 还在维护吗？

最新版本 4\.0\.4 发布于 2025/08/12（1\.3 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/10/28。作者已将其标记为弃用，新项目建议寻找替代方案。