跳到主要内容
版本：v7

Capacitor 数据类型

Capacitor 中在 Web 运行时和原生环境之间传输的数据需要进行序列化和反序列化，以便能以各种语言原生存储。支持的数据类型包括 JSON 可表示的类型，如数字、字符串、布尔值、数组和对象（或称字典/键值存储）。

iOS 平台​

虽然 Swift 是 iOS 的首选语言，但它需要与 Objective-C（系统框架的构建基础）互操作，因此平台需要支持三种语言的交集。大多数数据类型会按预期转换，但有些情况需要特别注意。

空值处理​

Objective-C 不支持在数组、字典或集合等容器中存储空值，而是使用特殊占位对象 NSNull 来表示空值。而 Swift 则使用可选值来描述可能为空的数值。Swift 可以处理 NSNull 值，但 Objective-C 无法处理可选值（不过在部分上下文中，运行时会自动将可选值映射为基础值或 NSNull）。无论使用哪种语言，都可能遇到这些 NSNull 对象。

例如，考虑以下传递给 Capacitor 插件调用的对象：

{ 'foo': null, 'bar': [1, 2, null, 4]}

字典处理​

CAPPluginCall 将这些数据存储为 options 属性，并提供多种便捷访问方法。这些访问方法会将值转为预期类型，因此 NSNull 值会被过滤掉。

if let value = call.getString("foo") {
    // 正确做法：`value` 为 nil，此代码块不会执行
}

但如果直接访问存储属性，可能会返回 NSNull 对象。

if call.options["foo"] != nil {
    // 错误做法：键返回了真值 `NSNull` 对象，此代码块会执行
}

不建议依赖键是否存在来判断逻辑。始终对值进行类型检查后再使用。

数组处理​

由于访问数组通常需要整体类型转换，必须考虑数组是单一类型还是混合类型。

if let values = call.getArray("bar") {
    // 中性做法：数组包含全部有效对象，代码块会执行，但每个值仍需单独类型检查
}
if let values = call.getArray("bar", Int?) {
    // 错误做法：数组混合了 `Int` 和 `NSNull`，无法转为 `Int?`，代码块不会执行
}

为解决此问题，Capacitor 提供了便捷扩展方法，可将包含 NSNull 的数组映射为可选值数组。该方法基于 JSValue 协议（表示所有可跨环境桥接的有效类型），但可转为特定子类型。

if let values = call.getArray("bar").capacitor.replacingNullValues() as? [Int?] {
    // 最佳实践：`values` 现在转为 `Int?` 类型，索引2位置为 `nil`
}

日期处理​

大多数情况下日期类型能按预期工作。从 JavaScript 发送的 Date 对象，或插件返回的 Date/NSDate 对象都会序列化为 ISO 8601 字符串。

但如需改变此行为也可调整。数据从 Web 运行时到原生 iOS 的传输机制与反向传输不同。WKWebView 会自动将 JavaScript Date 对象转为原生 Date 对象。为保持多平台一致性并符合开发者预期，Capacitor 3.0 开始会在传递给插件前序列化这些对象。如需禁用此行为，可在插件中设置 shouldStringifyDatesInCalls 属性。

override func load() {
    shouldStringifyDatesInCalls = false
}

CAPPluginCall 的便捷方法 getDate 能处理两种数据类型并返回 Date 对象。

从原生代码到 Web 视图的数据会序列化为 JSON。由于 JSON 未正式定义日期类型，3.0 之前插件结果中包含 Date 对象会抛出异常。现在 Capacitor 会自动按约定将 Date 对象序列化为字符串。如需特殊处理日期类型，请先将其转为其他支持的 JSON 类型。

Contents

编辑此页