自定义 Native iOS 代码

使用 Capacitor，我们鼓励您编写 Swift 或 Objective-C 代码来实现您的应用所需的原生功能。

可能并非所有功能都有 Capacitor 插件 —— 这没关系！您可以直接在应用中编写 WebView 可访问的原生代码。

WebView 可访问的原生代码

在 JavaScript 和原生代码之间通信的最简单方法是构建一个本地于您的应用的自定义 Capacitor 插件。

EchoPlugin.swift

首先，通过 打开 Xcode 创建 EchoPlugin.swift 文件，右键单击 App 组（在 App target 下），从上下文菜单中选择 New File...，在窗口中选择 Swift File，然后创建文件。

将以下 Swift 代码复制到 EchoPlugin.swift 中：

import Capacitor

@objc(EchoPlugin)
public class EchoPlugin: CAPPlugin, CAPBridgedPlugin {
    public let identifier = "EchoPlugin"
    public let jsName = "Echo"
    public let pluginMethods: [CAPPluginMethod] = [
        CAPPluginMethod(name: "echo", returnType: CAPPluginReturnPromise)
    ]

    @objc func echo(_ call: CAPPluginCall) {
        let value = call.getString("value") ?? ""
        call.resolve(["value": value])
    }
}

@objc 装饰器是必需的，以确保 Capacitor 的运行时（必须使用 Objective-C 进行动态插件支持）可以看到它。

注册插件

我们必须在 iOS 和 web 上都注册自定义插件，以便 Capacitor 可以在 Swift 和 JavaScript 之间建立桥接。

MyViewController.swift

创建自定义的 MyViewController.swift。

然后添加 capacitorDidLoad() 方法覆盖并注册插件：

override open func capacitorDidLoad() {
    bridge?.registerPluginInstance(EchoPlugin())
}

JavaScript

在 JS 中，我们使用 @capacitor/core 中的 registerPlugin() 来创建一个链接到我们的 Swift 插件的对象。

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

const Echo = registerPlugin('Echo');

export default Echo;

registerPlugin() 的第一个参数是插件名称，必须与 EchoPlugin.swift 中的 jsName 匹配。

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 对象调用您的插件方法。以下代码段将在 iOS 上调用 Swift 并打印结果：

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

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

下一步

阅读 iOS 插件指南 ›