自定义原生 Android 代码

Capacitor 鼓励开发者使用 Java 或 Kotlin 来实现应用所需的自定义原生功能。

并非所有功能都能找到现成的 Capacitor 插件——这完全正常！你可以直接在应用中编写能被 WebView 访问的原生代码。

WebView 可访问的原生代码

在 JavaScript 和原生代码之间通信的最简单方式，是构建一个专属于你应用的本地 Capacitor 插件。

EchoPlugin.java

首先创建 EchoPlugin.java 文件：打开 Android Studio，展开 app 模块和 java 文件夹，右键点击应用的 Java 包，从上下文菜单中选择 New -> Java Class 创建文件。

将以下 Java 代码复制到 EchoPlugin.java：

package com.example.myapp;

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);
    }
}

注册插件

我们需要在 Android 和 Web 两端都注册自定义插件，Capacitor 才能桥接 Java 和 JavaScript。

MainActivity.java

在应用的 MainActivity.java 中，使用 registerPlugin() 或 registerPlugins() 方法注册你的自定义插件。

 public class MainActivity extends BridgeActivity {
     @Override
     public void onCreate(Bundle savedInstanceState) {
+        registerPlugin(EchoPlugin.class);
         super.onCreate(savedInstanceState);
     }
 }

JavaScript 端

在 JS 中，我们使用 @capacitor/core 的 registerPlugin() 创建一个与 Java 插件关联的对象。

import { registerPlugin } from '@capacitor/core';

const Echo =registerPlugin('Echo');

export default Echo;

registerPlugin() 的第一个参数是插件名称，必须与 EchoPlugin.java 中 @CapacitorPlugin 注解的 name 属性一致。

TypeScript 支持

我们可以通过定义接口并将其用于 registerPlugin() 调用来为关联对象添加类型约束。

 import { registerPlugin } from '@capacitor/core';

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

-const Echo = registerPlugin('Echo');
+const Echo = registerPlugin<EchoPlugin>('Echo');

 export default Echo;

registerPlugin() 的泛型参数定义了关联对象的结构。如有需要，也可以使用 registerPlugin<any>('Echo') 忽略类型检查。我们不会因此评判你。❤️

使用插件

通过导出的 Echo 对象调用插件方法。以下代码片段将在 Android 上调用 Java 方法并打印结果：

import Echo from '../path/to/echo-plugin';

const { value } = await Echo.echo({ value: 'Hello World!' });
console.log('Response from native:', value);

下一步

阅读 Android 插件开发指南 ›