Capacitor iOS 插件指南

为 iOS 构建 Capacitor 插件涉及编写 Swift（或 Objective-C）代码，以便与苹果的 iOS SDK 进行交互。

开始之前

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

接下来，在 Xcode 中打开 Package.swift 文件。然后，你需要导航到插件的 .swift 文件。

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

插件基础

一个用于 iOS 的 Capacitor 插件包含两个简单的 Swift 类：一个是继承自 NSObject 的实现类，你应该在此放置插件逻辑；另一个继承自 CAPPlugin 和 CAPBridgedPlugin，包含一些可以从 JavaScript 调用的导出方法，并包装了实现类的方法。

简单示例

在生成的示例中，有一个简单的 echo 插件，其 echo 函数只是返回接收到的值。

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

Echo.swift

import Foundation

@objc public class Echo: NSObject {
    @objc public func echo(_ value: String) -> String {
        print(value)
        return value
    }
}

EchoPlugin.swift

import Foundation
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)
    ]
    private let implementation = Echo()

    @objc func echo(_ call: CAPPluginCall) {
        let value = call.getString("value") ?? ""
        call.resolve([
            "value": implementation.echo(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("必须提供 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，并注册插件方法。

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

为了注册插件方法，插件生成器会创建一个 CAPPluginMethod 数组 pluginMethods，并注册 echo 方法。

public let pluginMethods: [CAPPluginMethod] = [
    CAPPluginMethod(name: "echo", returnType: CAPPluginReturnPromise)
]

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

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

权限

如果你的插件在 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 方法检查当前权限状态，最后完成调用。

@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("Location services are disabled")
    }
}

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 将继续加载该 URL
• 返回 nil 将采用 Capacitor 的默认策略

高级配置

Capacitor iOS 插件同时支持 CocoaPods 和 Swift Package Manager 库，因此添加依赖、必需框架或进行其他高级配置时，需要编辑 CocoaPods 的 .podspec 文件和 SPM 的 Package.swift 文件。这些文件由插件生成器创建。

查看 podspec 参考文档 了解 CocoaPods 的所有可用选项。 查看 Package 描述文档 了解 SPM 的所有可用选项。

添加 FirebaseFirestore 依赖的示例（要求版本不低于 11.8.0 且低于 12.0.0）：

  s.dependency 'Capacitor'
  s.dependency 'FirebaseFirestore', '~> 11.8'

添加 FirebaseFirestore 依赖的 Package.swift 示例（要求版本不低于 11.8.0 且低于 12.0.0）：

...
let package = Package(
...
    dependencies: [
        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
        .package(url: "https://github.com/firebase/firebase-ios-sdk.git",  from: "11.8.0")
    ],
    targets: [
        .target(
            name: "FirebaseFirestorePlugin",
            dependencies: [
                .product(name: "Capacitor", package: "capacitor-swift-pm"),
                .product(name: "Cordova", package: "capacitor-swift-pm"),
                .product(name: "FirebaseCore", package: "firebase-ios-sdk"),
                .product(name: "FirebaseFirestore", package: "firebase-ios-sdk")
            ],
            path: "ios/Plugin")
    ]
...
)