Apollo iOS 中自定义标量类型的使用注意事项

在 Apollo iOS 1.9.0 版本中，开发者在使用自定义标量类型时可能会遇到一个常见问题：自定义标量类型在解码过程中没有被正确识别和使用。本文将深入分析这个问题及其解决方案。

问题现象

当开发者定义一个名为 BasicScalar 的自定义标量类型，并将其用于 GraphQL 模式中的字段时，例如 result: BasicScalar!，期望在解码后得到的是 BasicScalar 类型的实例（如 .bool(true)）。然而实际解码结果却是原生 Swift 类型（如 true），自定义标量类型完全被忽略了。

问题根源

经过分析，问题出在自定义标量类型的实现上。开发者错误地实现了 _asAnyHashable 方法，该方法内部调用了 hashable 私有函数，而这个函数返回的是基础类型（如 Bool 或 Int）。正是这个返回值最终被存储在了 DataDict 中。

解决方案

正确的做法是不需要在自定义标量类型中定义 _asAnyHashable 方法。Apollo iOS 框架会自动处理标量类型的哈希和存储。开发者只需确保以下几点：

1. 正确定义 init(_jsonValue value: JSONValue) 初始化方法
2. 实现 _jsonValue 计算属性
3. 不要覆盖 _asAnyHashable 方法

最佳实践

在实现自定义标量类型时，建议遵循以下模式：

public enum BasicScalar: Hashable {
    case bool(Bool)
    case int(Int)
    case string(String)
    
    public init(_jsonValue value: JSONValue) throws {
        switch value {
        case let bool as Bool:
            self = .bool(bool)
        case let int as Int:
            self = .int(int)
        case let string as String:
            self = .string(string)
        default:
            throw // 适当的错误处理
        }
    }
    
    public var _jsonValue: JSONValue {
        switch self {
        case let .bool(value): return value
        case let .int(value): return value
        case let .string(value): return value
        }
    }
}

总结

在 Apollo iOS 中使用自定义标量类型时，开发者应当避免手动处理哈希相关的逻辑，让框架自动管理这些底层细节。通过遵循上述最佳实践，可以确保自定义标量类型在 GraphQL 查询和响应中被正确识别和使用。

记住，框架设计者已经考虑了大多数使用场景，过度定制化有时反而会带来问题。当遇到类似问题时，检查是否实现了不必要的覆盖方法往往是解决问题的第一步。