自定义原生 Android 代码

使用 Capacitor，我们鼓励你编写 Java 或 Kotlin 代码来实现应用所需的原生功能。

可能并非所有功能都有对应的 Capacitor 插件——但这没关系！你完全可以在应用中编写可被 WebView 访问的原生代码。

可被 WebView 访问的原生代码

在 JavaScript 和原生代码之间进行通信的最简单方法是构建一个仅限应用内部使用的自定义 Capacitor 插件。

EchoPlugin.java

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

将以下 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('来自原端的响应：', value);

下一步

阅读 Android 插件指南 ›