Capacitor Android 插件开发指南

开发 Capacitor Android 插件需要使用 Java 或 Kotlin 与 Android SDK 进行交互。

入门指南

首先按照插件指南中的入门章节生成一个插件项目。

接着在 Android Studio 中打开 echo/android/ 目录。然后导航到插件的 .java 文件，其路径取决于创建插件时使用的插件 ID 和类名。

例如，对于 ID 为 com.domain.echo 且类名为 Echo 的插件，.java 文件路径为 android/src/main/java/com/domain/echo/EchoPlugin.java。

使用 Kotlin

Capacitor 默认使用 Java，但你也可以选择使用 Kotlin。

生成插件后，在 Android Studio 中右键点击 Java 插件类，选择"Convert Java file to Kotlin file"选项。Android Studio 会引导你配置项目的 Kotlin 支持。完成后，再次右键点击 Java 类并选择转换选项将其转为 Kotlin 类。

插件基础

Android 平台的 Capacitor 插件是一个继承 com.getcapacitor.Plugin 并带有 @CapacitorPlugin() 注解的简单 Java 类。其中带有 @PluginMethod() 注解的方法可以从 JavaScript 调用。

生成插件后，你可以通过打开生成器中选择的插件类文件开始编辑。

简单示例

生成的示例中包含一个简单的 echo 插件，其中的 echo 方法会原样返回接收到的值。

这个示例展示了 Capacitor 插件的两个核心功能：从插件调用接收数据，以及将数据返回给调用者。

EchoPlugin.java

package android.plugin.test;

import com.getcapacitor.JSObject;
import com.getcapacitor.Plugin;
import com.getcapacitor.PluginCall;
import com.getcapacitor.PluginMethod;
import com.getcapacitor.annotation.CapacitorPlugin;

@CapacitorPlugin(name = "Echo")
public class EchoPlugin extends Plugin {

    @PluginMethod()
    public void echo(PluginCall call) {
        String value = call.getString("value");

        JSObject ret = new JSObject();
        ret.put("value", value);
        call.resolve(ret);
    }
}

访问调用数据

每个插件方法都会接收一个 com.getcapacitor.PluginCall 实例，包含客户端调用插件方法的所有信息。

客户端可以发送任何可 JSON 序列化的数据，如数字、文本、布尔值、对象和数组。这些数据可通过 getData 字段或便利方法如 getString 或 getObject 访问。

例如，以下是获取方法参数的方式：

@PluginMethod()
public void storeContact(PluginCall call) {
  String name = call.getString("yourName", "default name");
  JSObject address = call.getObject("address", new JSObject());
  boolean isAwesome = call.getBoolean("isAwesome", false);

  if (!call.getData().has("id")) {
    call.reject("必须提供 id");
    return;
  }
  // ...

  call.resolve();
}

注意 PluginCall 实例上各种访问数据的方式，包括使用 getData 的 has 方法检查键是否存在。

返回数据

插件调用可以成功或失败。插件调用借鉴了 JavaScript Promise 的方法命名：调用 resolve() 表示成功（可选返回数据），使用 reject() 表示失败并附带错误信息。

PluginCall 的 resolve() 方法接收 JSObject 并支持 JSON 可序列化数据类型。以下是返回数据给客户端的示例：

JSObject ret = new JSObject();
ret.put("added", true);
JSObject info = new JSObject();
info.put("id", "unique-id-1234");
ret.put("info", info);
call.resolve(ret);

要表示失败或拒绝调用，使用 call.reject，传入错误信息，可选加上错误码和 Exception 实例

call.reject(exception.getLocalizedMessage(), null, exception);

持久化插件调用

多数情况下，插件方法被调用执行任务后可立即完成。但有时需要保持插件调用可用以便后续访问。比如定期返回实时地理位置数据或执行异步任务时。

有关持久化插件调用的更多细节，请参阅保存插件调用指南。

插件加载时运行代码

有时插件需要在首次加载时运行某些代码。

为此，实现 load() 方法：

@Override
public void load() {
}

权限管理

如果你的插件功能需要用户授权，则需要实现权限管理机制。

在继续之前，请确保已设置权限别名和状态接口。如未设置，请参阅网页指南中的权限章节。

注解变更

仍在使用 @NativePlugin？请参阅升级指南切换至 @CapacitorPlugin。

 @CapacitorPlugin(
     name = "FooBar",
+    permissions = {
+        @Permission(
+            alias = "camera",
+            strings = { Manifest.permission.CAMERA }
+        ),
+        @Permission(
+            alias = "storage",
+            strings = {
+                Manifest.permission.READ_EXTERNAL_STORAGE,
+                Manifest.permission.WRITE_EXTERNAL_STORAGE
+            }
+        )
+    }
 )
 public class FooBarPlugin extends Plugin {
     ...

在 @CapacitorPlugin 注解中添加 permissions 属性，它是一个或多个 @Permission 注解的数组。每个 @Permission 注解包含零个或多个 Android 权限 strings 和简短的用途描述 alias。

按插件功能将权限字符串分组到各个 @Permission 中。如果插件在其他平台需要权限但在 Android 上不需要，则定义具有相同别名但 strings 为空的权限。这会导致该权限别名的请求结果自动返回为"已授予"。

@Permission(
    alias = "notifications",
    strings = {}
)

实现权限请求

通过在 @CapacitorPlugin 注解中定义权限，checkPermissions() 和 requestPermissions() 方法应能完全正常工作。应用开发者可以按需手动请求权限。但最佳实践是在插件功能中封装自动权限请求。

权限回调

创建一个带有单个 PluginCall 参数的 void 方法，并用 @PermissionCallback 注解，然后将方法名作为字符串传入权限请求调用。权限请求完成后会运行此回调。

@PluginMethod()
public void takePhoto(PluginCall call) {
  if (getPermissionState("camera") != PermissionState.GRANTED) {
    requestPermissionForAlias("camera", call, "cameraPermsCallback");
  } else {
    loadCamera(call);
  }
}

@PermissionCallback
private void cameraPermsCallback(PluginCall call) {
  if (getPermissionState("camera") == PermissionState.GRANTED) {
    loadCamera(call);
  } else {
    call.reject("需要相机权限才能拍照");
  }
}

发起权限请求

通过调用请求辅助方法之一来发起权限请求。

对于单个别名可使用 requestPermissionForAlias。多个别名可提供给 requestPermissionForAliases。使用 requestAllPermissions 请求插件注解中定义的所有权限。

 @PluginMethod()
 public void takePhoto(PluginCall call) {
   if (!hasRequiredPermissions()) {
+    requestAllPermissions(call, "cameraPermsCallback");
   } else {
     loadCamera(call);
   }
 }

 @PermissionCallback
 private void cameraPermsCallback(PluginCall call) {
   ...
 }

清单文件

将所有必需的安装时权限放入插件的 AndroidManifest.xml 中。不要添加运行时权限（需要用户同意的权限），这些应该由应用开发者添加到 Capacitor 应用的清单中。确保你的插件文档中列出了需要添加到应用的所有运行时权限。

  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="com.mycompany.plugins.network">
+     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  </manifest>

错误处理

不可用状态

当功能当前无法使用时（通常因为需要更高的 Android API 版本）可抛出此错误。

@PluginMethod
public void methodThatUsesNewAndroidAPI(PluginCall call) {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
        // TODO 实现
    } else {
        call.unavailable("Android API 25 或更早版本不可用");
    }
}

建议尽可能优雅降级处理旧 API 的体验。谨慎使用 unavailable。

未实现状态

使用此错误表示方法无法在 Android 上实现。

@PluginMethod
public void methodThatRequiresIOS(PluginCall call) {
    call.unimplemented("Android 上未实现此功能");
}

展示原生界面

要在 Capacitor 界面上展示原生界面，我们将使用 Android 的 Intent。Intent 允许你从自己的应用或其他应用启动 Activity。参见常见 Intent

无返回结果的 Intent

大多数情况下，你只是想展示原生 Activity，这时可以触发相关操作。

Intent intent = new Intent(Intent.ACTION_VIEW);
getActivity().startActivity(intent);

有返回结果的 Intent

有时启动 Intent 后需要获取结果。这时应使用 startActivityForResult。

创建一个带有 PluginCall 和 ActivityResult 参数的回调方法处理启动 Activity 的结果，并用 @ActivityCallback 注解。将此方法名传给 startActivityForResult，当启动的 Activity 完成时会执行该方法。

@CapacitorPlugin()
class ImagePicker extends Plugin {

  @PluginMethod()
  public void pickImage(PluginCall call) {
    Intent intent = new Intent(Intent.ACTION_PICK);
    intent.setType("image/*");

    // 使用回调方法名启动 Activity 获取结果
    startActivityForResult(call, intent, "pickImageResult");
  }

  @ActivityCallback
  private void pickImageResult(PluginCall call, ActivityResult result) {
    if (call == null) {
      return;
    }

    // 处理结果数据
  }
}

插件事件

插件可以触发自定义事件，你可以通过监听插件对象来接收：

import { MyPlugin } from 'my-plugin';

MyPlugin.addListener('myPluginEvent', (info: any) => {
  console.log('myPluginEvent 已触发');
});

在 Java 插件类中触发事件：

JSObject ret = new JSObject();
ret.put("value", "某个值");
notifyListeners("myPluginEvent", ret);

移除监听器：

import { MyPlugin } from 'my-plugin';

const myPluginEventListener = await MyPlugin.addListener(
  'myPluginEvent',
  (info: any) => {
    console.log('myPluginEvent 已触发');
  },
);

myPluginEventListener.remove();

也可以在 window 上触发全局事件。参见 triggerJSEvent 文档。

覆盖导航

Capacitor 插件可以覆盖 WebView 导航。为此插件可以重写 public Boolean shouldOverrideLoad(Uri url) 方法。 返回 true 会使 WebView 中止加载 URL。 返回 false 会使 WebView 继续加载 URL。 返回 null 将采用默认的 Capacitor 策略。