Factory项目构建XCFramework时遇到的模块命名冲突问题解析

问题背景

在iOS开发中，使用xcodebuild工具构建XCFramework时，开发者可能会遇到一个特殊问题：当模块名称与模块内部定义的类型名称相同时，会导致编译失败。这个问题在使用Factory依赖注入框架时尤为明显。

问题现象

开发者在使用xcodebuild构建XCFramework时，会遇到如下编译错误：

Injections.swift:357:95: error: 'ObservableObject' aliases 'Combine.ObservableObject' and cannot be used here because 'Combine' was not imported by this file
@MainActor @frozen @propertyWrapper public struct InjectedObject<T>: DynamicProperty where T: ObservableObject {

当设置BUILD_LIBRARY_FOR_DISTRIBUTION=NO时，编译能够通过，但这并不是一个理想的解决方案，因为它会禁用库的分发优化功能。

根本原因分析

这个问题的根源在于Swift模块系统的一个限制：当模块名称与模块内部定义的类型名称相同时，会导致命名空间冲突。具体到Factory项目中：

1. 项目模块名为"Factory"
2. 模块内部定义了一个主要类型也叫"Factory"
3. 当启用BUILD_LIBRARY_FOR_DISTRIBUTION=YES时，编译器会生成.swiftinterface接口文件
4. 在接口文件中，这种命名冲突会导致编译器无法正确解析类型引用

解决方案演进

临时解决方案

1. 禁用分发构建：设置BUILD_LIBRARY_FOR_DISTRIBUTION=NO可以绕过问题，但这会牺牲框架的分发优化能力，不是长期解决方案。

2. 手动修改接口文件：构建完成后，可以手动修改生成的.swiftinterface文件，移除所有"Factory."前缀。这种方法虽然有效，但不够优雅且容易出错。

根本解决方案

Factory项目在2.5.0版本中采用了更彻底的解决方案：

1. 重命名模块：将模块名称从"Factory"改为"FactoryKit"
2. 保持核心类型名称不变：内部的主要类型仍然保持"Factory"名称
3. 更新导入语句：所有使用该库的项目需要将import Factory改为import FactoryKit

这种方案彻底解决了模块名与类型名的冲突问题，同时保持了API的稳定性。

技术深度解析

Swift模块系统的工作原理

Swift的模块系统负责管理代码的组织和可见性。当模块名称与内部类型名称相同时，编译器在解析类型引用时会产生歧义：

• 是引用模块本身？
• 还是引用模块内部的类型？

这种歧义在生成.swiftinterface接口文件时尤为明显，因为接口文件需要明确记录所有公开类型的完整路径。

XCFramework构建过程

构建XCFramework时，BUILD_LIBRARY_FOR_DISTRIBUTION=YES会：

1. 生成.swiftmodule和.swiftinterface文件
2. 启用ABI稳定性检查
3. 确保框架可以在不同Swift版本间兼容

当命名冲突存在时，这一过程会失败，因为编译器无法生成正确的接口定义。

最佳实践建议

1. 避免模块名与主要类型名相同：这是预防此类问题的根本方法
2. 考虑命名空间设计：为公开类型添加适当的前缀或命名空间
3. 及时更新依赖：使用FactoryKit等已经解决此问题的版本
4. 理解构建选项影响：明确BUILD_LIBRARY_FOR_DISTRIBUTION等标志的作用

总结

模块命名冲突是Swift项目开发中一个容易被忽视但影响重大的问题。Factory项目通过模块重命名提供了优雅的解决方案，这一经验值得所有Swift开发者借鉴。理解这类问题的本质有助于我们在项目初期就做出更好的架构设计决策，避免后期出现类似的兼容性问题。