Capacitor iOS 插件开发指南

为 iOS 构建 Capacitor 插件需要编写 Swift（或 Objective-C）代码来与苹果的 iOS SDK 进行交互。

开始之前

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

接下来，在 Xcode 中打开 echo/ios/Plugin.xcworkspace。然后，导航到你的插件对应的 .swift 文件。

例如，对于一个插件类名为 Echo 的插件，你应该打开 EchoPlugin.swift。

插件基础

一个 iOS 平台的 Capacitor 插件是一个简单的 Swift 类，它继承自 CAPPlugin，并包含一些可以从 JavaScript 调用的已导出方法。

简单示例

在生成的示例中，有一个简单的 echo 插件，它包含一个 echo 函数，该函数仅返回接收到的值。

这个示例演示了 Capacitor 插件的几个核心组件：从插件调用接收数据，以及将数据返回给调用者：

EchoPlugin.swift

import Capacitor

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

访问调用数据

每个插件方法都会接收到一个 CAPPluginCall 实例，其中包含了客户端调用该插件方法的所有信息。

客户端可以发送任何能够被 JSON 序列化的数据，例如数字、文本、布尔值、对象和数组。这些数据可以通过调用实例的 options 字段访问，或者使用便捷方法如 getString 或 getObject。传递和访问这些值中的某些内容需要注意一些特殊之处，具体在单独章节中讨论。

例如，以下是如何获取传递给方法的数据：

@objc func storeContact(_ call: CAPPluginCall) {
  let name = call.getString("yourName") ?? "default name"
  let address = call.getObject("address") ?? [:]
  let isAwesome = call.getBool("isAwesome") ?? false

  guard let id = call.options["id"] as? String else {
    call.reject("Must provide an id")
    return
  }

  // ...

  call.resolve()
}

请注意在 CAPPluginCall 实例上访问数据的多种方式，包括如何使用 guard 来要求必需的选项。

返回数据

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

CAPPluginCall 的 resolve() 方法接收一个字典，并支持 JSON 可序列化的数据类型。以下是一个将数据返回给客户端的示例：

call.resolve([
  "added": true,
  "info": [
    "id": id
  ]
])

要表示失败或拒绝调用，请调用 reject()，并传递一个错误字符串，以及可选的错误代码和 Error 实例：

call.reject(error.localizedDescription, nil, error)

在插件加载时运行代码

有时，插件可能需要在首次加载时运行一些代码。例如，这是设置任何通知中心事件处理程序的好地方。

为此，请为 load() 方法提供一个实现：

override public func load() {
}

导出到 Capacitor

为了确保 Capacitor 能够识别你的插件，插件生成器会做两件事：将你的 Swift 类导出到 Objective-C，并使用提供的 Capacitor Objective-C 宏进行注册。

要将 Swift 类导出到 Objective-C，插件生成器会在你的 Swift 类上方添加 @objc(EchoPlugin)，并在 echo 方法前添加 @objc。

要注册插件，插件生成器会创建一个与你的插件对应的 .m 扩展名文件（例如 EchoPlugin.m），并使用 CAP_PLUGIN 宏注册插件，使用 CAP_PLUGIN_METHOD 宏注册 echo 方法。

#import <Capacitor/Capacitor.h>

CAP_PLUGIN(EchoPlugin, "Echo",
  CAP_PLUGIN_METHOD(echo, CAPPluginReturnPromise);
)

这使 Echo 插件和 echo 方法对 Capacitor Web 运行时可用，并向 Capacitor 表明 echo 方法将返回一个 Promise。

要向插件添加更多方法，请在 .swift 插件类中创建它们，并在 func 关键字前添加 @objc，然后在 .m 文件中添加新的 CAP_PLUGIN_METHOD 条目。

权限

如果你的插件在 iOS 上具有需要最终用户授权的功能，那么你需要实现权限模式。

在遵循本节之前，请确保你已经设置了权限别名和状态接口。如果没有，请参阅 Web 指南中的权限章节。

实现权限

将 checkPermissions() 和 requestPermissions() 方法添加到你的 Swift 插件类中。

 import Capacitor

 @objc(EchoPlugin)
 public class EchoPlugin: CAPPlugin {
     ...

+    @objc override public func checkPermissions(_ call: CAPPluginCall) {
+        // TODO
+    }

+    @objc override public func requestPermissions(_ call: CAPPluginCall) {
+        // TODO
+    }
 }

checkPermissions()

此方法应返回插件中权限的当前状态，这应该是一个与你定义的权限状态定义结构匹配的字典。通常，这些信息可以直接从你正在使用的框架中获取。

在下面的示例中，我们将位置服务中的当前授权状态映射到一个权限状态，并将 location 别名与该状态关联。

@objc override func checkPermissions(_ call: CAPPluginCall) {
    let locationState: String

    switch CLLocationManager.authorizationStatus() {
    case .notDetermined:
        locationState = "prompt"
    case .restricted, .denied:
        locationState = "denied"
    case .authorizedAlways, .authorizedWhenInUse:
        locationState = "granted"
    @unknown default:
        locationState = "prompt"
    }

    call.resolve(["location": locationState])
}
```#### `requestPermissions()`

**基于代码块的 API**

如果框架支持基于代码块的权限请求 API，那么可以在单个方法内完成整个操作。

在下面的示例中，我们向 `AVCaptureDevice` 请求视频访问权限，然后使用自定义的 `checkPermissions` 方法检查当前权限状态，最后完成调用。

```swift
@objc override func requestPermissions(_ call: CAPPluginCall) {
    AVCaptureDevice.requestAccess(for: .video) { [weak self] _ in
        self?.checkPermissions(call)
    }
}

基于委托的 API

如果框架使用委托（或回调）API，要完成操作需要先保存原始调用，然后在回调被触发时再取回调用。

var permissionCallID: String?
var locationManager: CLLocationManager?

@objc override func requestPermissions(_ call: CAPPluginCall) {
    if let manager = locationManager, CLLocationManager.locationServicesEnabled() {
        if CLLocationManager.authorizationStatus() == .notDetermined {
            bridge?.saveCall(call)
            permissionCallID = call.callbackId
            manager.requestWhenInUseAuthorization()
        } else {
            checkPermissions(call)
        }
    } else {
        call.reject("定位服务已禁用")
    }
}

public func locationManager(_ manager: CLLocationManager, didChangeAuthorization status: CLAuthorizationStatus) {
    if let callID = permissionCallID, let call = bridge?.getSavedCall(callID) {
        checkPermissions(call)
        bridge?.releaseCall(call)
    }
}

多权限请求

当需要请求多种权限时，使用 DispatchGroup 可以方便地同步多个调用。

let store = CNContactStore()

@objc override func requestPermissions(_ call: CAPPluginCall) {
    // 获取需要检查的权限类型，默认为所有类型
    var permissions = call.getArray("types", String.self) ?? []
    if permissions.isEmpty {
        permissions = ["contacts", "camera"]
    }

    let group = DispatchGroup()
    if permissions.contains("contacts") {
        group.enter()
        store.requestAccess(for: .contacts) { (_, _) in
            group.leave()
        }
    }
    if permissions.contains("camera") {
        group.enter()
        AVCaptureDevice.requestAccess(for: .video) { _ in
            group.leave()
        }
    }
    group.notify(queue: DispatchQueue.main) {
        self.checkPermissions(call)
    }
}

持久化插件调用

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

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

错误处理

不可用

当功能当前无法使用时可以抛出此错误，通常是因为需要更新的 iOS 版本。

@objc override func methodThatUsesNewIOSFramework(_ call: CAPPluginCall) {
    if #available(iOS 14, *) {
        // TODO 具体实现
    } else {
        call.unavailable("iOS 13 或更早版本不支持此功能。")
    }
}

建议尽可能使用旧版 API 优雅降级体验。请谨慎使用 unavailable。

未实现

使用此错误表示某个方法在 iOS 上无法实现。

@objc override func methodThatRequiresAndroid(_ call: CAPPluginCall) {
    call.unimplemented("iOS 平台未实现此功能。")
}

插件事件

插件可以发出自定义事件，你可以通过为插件对象添加监听器来接收这些事件：

import { MyPlugin } from 'my-plugin';

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

在 Swift 插件类中触发事件：

self.notifyListeners("myPluginEvent", data: [:])

从插件对象移除监听器：

import { MyPlugin } from 'my-plugin';

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

myPluginEventListener.remove();

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

展示原生界面

你可以使用 Capacitor 的 UIViewController 在应用上方展示原生界面。

重写导航

Capacitor 插件可以重写 WebView 导航。为此，插件可以重写 - (NSNumber *)shouldOverrideLoad:(WKNavigationAction *)navigationAction 方法。 返回 true 会使 WebView 中止加载 URL。 返回 false 会使 WebView 继续加载 URL。 返回 nil 将采用默认的 Capacitor 策略。

高级配置

Capacitor iOS 插件本质上是 CocoaPods 库，因此要添加依赖项、必需框架或进行任何其他高级配置，你需要编辑插件生成器创建的 .podspec 文件。查看 podspec 参考文档 了解所有可用选项。