跳到主要内容
版本：v4

插件开发工作流

创建新插件后，您可以开始在各种平台上实现功能。

实现新方法​

要在插件中添加新功能，首先需要在 src/definitions.ts 中为插件导出的 TypeScript 接口定义方法签名。

下面的示例添加了接收 latitude 和 longitude 参数的 openMap() 方法。最佳实践是为方法参数定义接口，以便在应用中导入使用。

 export interface EchoPlugin {
   echo(options: { value: string }): Promise<{ value: string }>;
+  openMap(options: OpenMapOptions): Promise<void>;
 }

+export interface OpenMapOptions {
+  latitude: number;
+  longitude: number;
+}

在 src/web.ts 中实现 Web 端功能：

 import type {
   EchoPlugin,
+  OpenMapOptions,
 } from './definitions';

 export class EchoWeb extends WebPlugin implements EchoPlugin {
   // other methods

+  async openMap(location: OpenMapOptions): Promise<void> {
+    // 此处添加逻辑
+  }
 }

编译插件时，进入插件目录并运行：

npm run build

在 android/src/main/[嵌套目录]/EchoPlugin.java 中实现 Android 功能：

@PluginMethod()
public void openMap(PluginCall call) {
  Double latitude = call.getDouble("latitude");
  Double longitude = call.getDouble("longitude");

  // 更多逻辑

  call.resolve();
}

在 ios/Plugin/EchoPlugin.swift 中实现 iOS 功能：

@objc func openMap(_ call: CAPPluginCall) {
  let latitude = call.getString("latitude")
  let longitude = call.getNumber("longitude")

  // 更多逻辑

  call.resolve()
}

记得在 .m 文件中 注册插件方法

该示例展示了插件中最常见的方法类型，所有支持类型的详细信息 可在此处查看

本地测试​

开发过程中如需本地测试插件，可使用 npm install 将插件文件夹链接到应用中：

npm install ../path/to/echo

项目的 package.json 文件将在依赖项列表中显示插件包的链接：

"echo": "file:../path/to/echo",

最后运行 npx cap sync 使原生项目识别您的插件。如果检测成功，将输出类似信息：

[info] Found 1 Capacitor plugin for android:
    - echo (0.0.1)

解除插件链接​

要从应用中解除本地插件链接，使用 npm uninstall 加上插件包名：

npm uninstall echo

包脚本​

插件模板在 package.json 中提供了多种脚本：

  • verify: 构建并测试 Web 和原生代码
  • lint: 检查 Web 和原生代码规范
  • fmt: 自动格式化 Web 和原生代码
  • docgen: 从插件接口生成文档（参见 文档）
  • build: 将 Web 代码构建为 ESM 和打包版本

文档​

要为插件功能添加文档，请在方法和属性前添加 JSDoc 注释块。

在 TypeScript 文件中，通常不需要使用 @param 和 @returns JSDoc 标签包含类型信息。

以 openMap() 方法为例，打开 src/definitions.ts 开始编写文档：

 export interface EchoPlugin {
   echo(options: { value: string }): Promise<{ value: string }>;

+  /**
+   * 在指定位置打开地图
+   *
+   * @since 1.1.0
+   */
   openMap(options: OpenMapOptions): Promise<void>;
 }

 export interface OpenMapOptions {
+  /**
+   * 打开地图的纬度坐标
+   */
   latitude: number;

+  /**
+   * 打开地图的经度坐标
+   */
   longitude: number;
 }

插件模板内置了 @capacitor/docgen，可将生成的文档写入 README.md。文档在 npm run build 时生成，也可手动运行：

npm run docgen

发布​

准备就绪后，直接使用以下命令发布插件：

npm publish

这将构建插件的 JS 部分，并将其余文件发布到 npm。

现在任何 Capacitor 应用都可以通过 npm install echo 安装您的插件包。

Contents

编辑此页