Apollo iOS 中废弃输入字段访问导致崩溃问题解析

问题背景

在 Apollo iOS 客户端 1.15.3 版本中，当开发者废弃(Deprecate) GraphQL 输入对象(Input Object)中的某个字段后，如果尝试访问该废弃字段，应用程序会发生崩溃。这是一个典型的向后兼容性问题，涉及到代码生成器的行为模式和运行时数据访问机制。

技术细节分析

代码生成器行为

当 GraphQL 输入对象中的字段被标记为废弃时，Apollo iOS 的代码生成器会生成两套初始化方法：

1. 新的初始化方法只包含当前有效的字段
2. 废弃的初始化方法会添加 @available(*, deprecated) 注解

// 新字段的初始化方法
public init(newField: GraphQLNullable<MyType>) {
  __data = InputDict(["newField": newField])
}

// 废弃字段的初始化方法
@available(*, deprecated, message: "Argument 'oldField' is deprecated")
public init(oldField: GraphQLNullable<MyType>) {
  __data = InputDict(["oldField": oldField])
}

属性访问机制

对于废弃字段，代码生成器仍然会生成对应的计算属性，但标记为废弃：

@available(*, deprecated, message: "Use newField instead")
public var oldField: GraphQLNullable<MyType> {
  get { __data["oldField"] }
  set { __data["oldField"] = newValue }
}

崩溃原因

当开发者使用新的初始化方法创建输入对象实例时，底层的数据字典 InputDict 中不会包含废弃字段。然而，如果代码中仍然访问了废弃字段属性，会尝试从字典中强制解包该字段值，导致类型转换失败而崩溃。

// 使用新初始化方法
let input = MyInput(newField: .some(value))

// 访问废弃字段 - 导致崩溃
let oldValue = input.oldField

崩溃的具体错误是类型转换失败，因为字典中不存在该键，返回的是 Optional<GraphQLOperationVariableValue> 类型，而属性期望的是 GraphQLNullable<MyType> 类型。

解决方案

Apollo iOS 开发团队已经修复了这个问题。修复方案主要涉及：

1. 确保废弃字段的访问不会导致强制解包失败
2. 当字段不存在时返回合理的默认值
3. 保持与 GraphQL 规范一致的废弃字段处理逻辑

修复后的行为应该是在访问废弃字段时：

• 如果字段不存在（使用新初始化方法创建），返回 .none 或合理的默认值
• 如果字段存在（使用旧初始化方法创建），返回实际存储的值
• 仍然保持废弃警告，提示开发者迁移到新字段

最佳实践建议

1. 及时更新依赖：升级到包含此修复的 Apollo iOS 版本
2. 全面替换废弃字段：即使不崩溃，也应尽快替换所有废弃字段的使用
3. 代码审查：在团队中建立机制，确保新代码不使用废弃字段
4. 自动化测试：添加测试用例验证废弃字段的访问行为

总结

这个问题展示了在 GraphQL 模式演进过程中保持客户端兼容性的重要性。Apollo iOS 通过改进代码生成器和运行时行为，确保了废弃字段的安全访问，为开发者提供了更平滑的迁移路径。理解这类问题的本质有助于开发者更好地设计可演进的 GraphQL API 和客户端实现。