版本：v4

创建 Capacitor 插件

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

本指南将帮助你开始创建一个可分享的 Capacitor 插件，该插件将发布到 npm。你也可以为你的应用程序创建本地 Capacitor 插件。请参阅针对 iOS 和 Android 的自定义原生代码指南。

核心理念

如果你的插件是面向公众的，在开始之前，我们想分享一些关于 Capacitor 插件的理念。

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

如果 Capacitor 社区中已经存在针对某个特定主题的插件，请考虑为其做出贡献！如果某个插件缺少主要维护者，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 仓库）。