版本：v4

创建 Capacitor 插件

Capacitor 中的插件使 JavaScript 能够直接与原生 API 交互。

本指南将帮助您开始创建可共享的 Capacitor 插件，并将其发布到 npm。您也可以创建应用本地的 Capacitor 插件。请参阅 iOS 和 Android 的自定义原生代码指南。

设计理念

如果您的插件打算公开发布，我们在开始之前有一些关于 Capacitor 插件的设计理念与您分享。

我们相信合作比竞争能产生更高质量的插件。这也是我们创建 Capacitor Community GitHub 组织的原因之一，该组织比个人仓库中的插件更容易促进社区间的合作。

如果 Capacitor Community 中已存在某个主题的插件，请考虑为其做出贡献！如果某个插件缺少主要维护者，Capacitor 团队很乐意考虑将您加入 GitHub 组织。

我们认为 Capacitor 插件的范围应该合理精简。Capacitor 插件会向应用中添加可能用也可能不用的原生代码。通过保持插件的范围小巧，我们可以确保应用中只包含最必要的原生代码。这可以避免不必要的应用臃肿，以及因使用未附使用说明的 API 而导致的 App Store 警告或拒绝。

当然，范围精简还能带来其他好处，如更快的部署、更便捷的合作、更好的可维护性等。

Capacitor 插件应力求在跨平台间提供统一的、JavaScript 开发者熟悉的使用体验。这意味着来自原生平台的值可能需要进行类型转换。

以下是一些指导原则和示例，展示如何创建统一且符合习惯的体验：

优先使用 undefined 而非 null 和其他非值。 例如：如果 Android API 返回 0.0 表示"无值"，则应在 JavaScript 层将该值转换为 undefined。
优先使用相同的单位。 例如：如果 iOS API 使用摄氏度而 Android API 使用华氏度，则应在值传递给 JavaScript 使用者之前统一转换为其中一种单位。
优先使用带时区的 ISO 8601 日期时间格式。 例如：从形如 "2020-12-13T20:21:58.415Z" 的字符串可以轻松获取准确的 JavaScript Date 对象，但如果给定 Unix 时间戳（JavaScript 时间戳以毫秒为单位）则会造成混淆。始终包含时区信息，否则来自不同地区的日期时间可能会被错误解析。

准备好开始了吗？Capacitor 提供了插件生成器，您可以用它来开始开发插件。

在继续之前，建议确保您使用的是最新的 Node LTS 版本和 npm 6+。

在新的终端中，运行以下命令：

npm init @capacitor/plugin@latest

生成器会提示您输入信息。您也可以提供命令行选项（请参阅 GitHub 仓库）。