跳到主要内容
版本:v7

创建 Capacitor 插件

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

本指南将帮助您开始创建可共享的 Capacitor 插件,这些插件将发布到 npm。您也可以在应用中创建本地 Capacitor 插件。请参阅 iOSAndroid 的自定义原生代码指南。

设计理念

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

协作精神

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

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