Apollo iOS 项目中 SPM 测试目标链接错误的解决方案

问题背景

在使用 Apollo iOS 1.18.0 版本时，开发者在 Swift Package Manager (SPM) 项目中遇到了一个典型的链接错误。当将 Apollo 生成的文件添加到主目标时能够正常构建，但在将这些文件同时添加到测试目标时，出现了 "Undefined symbols for architecture arm64" 的错误。

错误现象分析

该错误具体表现为测试目标无法找到主目标中定义的符号，特别是与 ApolloNetwork 相关的类型描述符和初始化方法。这种错误通常发生在以下几种情况：

1. 目标依赖关系配置不正确
2. 符号可见性问题
3. 架构兼容性问题

问题根源

经过深入分析，发现问题的核心在于 SPM 包配置上存在两个关键问题：

1. 目标重复引用：在 Package.swift 中，同一个目标被同时包含在两个不同的库产品中，这违反了 SPM 的设计原则。具体表现为 ModuleTarget 和 ApolloSchema 被同时包含在 ModuleTarget 和 ModuleTarget_UnitTests 两个库产品中。

2. 依赖关系混乱：测试目标直接依赖了 Apollo 生成的代码目标，而不是通过主目标间接引用。这种设计会导致符号解析路径不清晰。

解决方案

方案一：重构 SPM 包结构

正确的 SPM 包配置应遵循以下原则：

1. 单一职责原则：每个目标应该有明确的单一职责，避免交叉引用。

2. 清晰的依赖链：测试目标应该只依赖主目标，而主目标则负责依赖 Apollo 相关组件和生成的代码。

3. 合理的库产品划分：测试目标通常不应作为库产品导出。

修正后的 Package.swift 关键部分应类似如下结构：

.target(
    name: "MainTarget",
    dependencies: [
        .product(name: "Apollo", package: "apollo-ios"),
        .product(name: "ApolloAPI", package: "apollo-ios"),
        "GeneratedCode"
    ]
),
.testTarget(
    name: "MainTargetTests",
    dependencies: ["MainTarget"]
)

方案二：使用独立的生成代码包

Apollo iOS 支持将生成的代码配置为独立的 SPM 包，这是更推荐的实践方式：

1. 配置 codegen 输出为 SPM 包格式
2. 将该包作为独立依赖引入主项目
3. 主目标和测试目标通过包依赖关系共享生成的代码

这种方式更符合模块化设计原则，也更容易维护。

最佳实践建议

1. 避免目标交叉引用：在 SPM 中，一个目标不应该被多个库产品直接包含。

2. 合理组织测试依赖：测试目标应该通过主目标间接访问所有必要符号，而不是直接依赖底层组件。

3. 考虑生成代码的可见性：确保生成的代码有适当的访问级别，既能够被测试目标访问，又不会过度暴露实现细节。

4. 架构一致性检查：验证所有目标和依赖项都支持相同的架构（如 arm64）。

总结

在 Apollo iOS 项目中使用 SPM 时，合理的包结构设计是避免链接错误的关键。通过遵循清晰的依赖关系原则和模块化设计思想，可以有效地解决这类符号找不到的问题。对于 Apollo 生成的代码，最佳实践是将其配置为独立的 SPM 包或作为主目标的私有依赖，而不是在多个目标间共享。