跳到主要内容
版本:v6

创建 Capacitor 插件

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

本指南将帮助你开始创建一个可共享的 Capacitor 插件,该插件将发布到 npm。你也可以创建仅用于自己应用的本地 Capacitor 插件。请参阅 iOSAndroid 的自定义原生代码指南。

设计理念

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

协作共赢

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

如果 Capacitor Community 中已经存在某个特定主题的插件,请考虑为其做出贡献!如果一个插件缺少主要维护者,Capacitor 团队将很乐意考虑将你添加到 GitHub 组织中。

小而精

我们相信 Capacitor 插件应该保持合理的精简范围。Capacitor 插件会向应用中添加可能用不到的原生代码。通过保持插件的精简,我们可以确保应用只包含必需的最少量原生代码。这避免了不必要的应用臃肿,以及应用商店因未声明使用用途的 API 等产生的警告或拒绝。

当然,保持精简范围还有其他好处,例如更快的部署、更轻松的协作、更好的可维护性等。

统一且符合习惯

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 仓库)。

后续步骤

了解 Capacitor 插件开发工作流程 ›

了解为 Capacitor 构建 Android 插件 ›

了解为 Capacitor 构建 iOS 插件 ›

了解为 Capacitor 构建 Web/PWA 插件 ›