Apollo iOS 中处理 GraphQL 类型同时包含 _id 和 id 字段的解决方案

在 Apollo iOS 项目中，当 GraphQL 类型同时包含 _id 和 id 字段时，代码生成器会产生一个特殊的编译错误。这个问题源于 Swift 语言对属性包装器的处理机制。

问题现象

当 GraphQL 类型定义中同时包含 _id 和 id 字段时，生成的 MockObject 类型会出现编译错误："Invalid redeclaration of synthesized property '_id'"。这是因为 Swift 编译器在处理属性包装器时会自动合成带下划线前缀的存储属性。

技术背景

在 Swift 中，当使用 @propertyWrapper 时，编译器会自动生成一个以下划线开头的存储属性。例如，对于 @Field var id，编译器会生成 _id 存储属性。当 GraphQL 类型中同时存在 _id 和 id 字段时，就会导致命名冲突。

解决方案

Apollo iOS 提供了优雅的解决方案：使用 GraphQL 的 alias 特性。通过为其中一个字段设置别名，可以避免生成的 Swift 代码中出现命名冲突。

例如，可以将 _id 字段重命名为 aliasedId：

query MyQuery {
  myType {
    aliasedId: _id
    id
  }
}

这样生成的 Swift 代码将使用别名而不是原始字段名，从而避免了命名冲突。

实现细节

使用别名后，生成的 MockObject 代码将变为：

public class MyGeneratedType: MockObject {
  public struct MockFields {
    @Field<MyGeneratedSchema.ID>("aliasedId") public var aliasedId
    @Field<MyGeneratedSchema.ID>("id") public var id
  }
}

这种方式既保持了 GraphQL 查询的语义完整性，又避免了 Swift 编译器的命名冲突问题。

最佳实践

1. 在 GraphQL 类型设计阶段，尽量避免同时使用 _id 和 id 字段
2. 如果必须同时使用这两个字段，优先考虑使用别名方案
3. 在团队中建立统一的命名规范，减少此类冲突的发生

通过理解这个问题的根源和解决方案，开发者可以更有效地使用 Apollo iOS 的代码生成功能，避免类似的编译错误。