Factory项目中的SPM模块化与容器共享问题解析

问题背景

在使用Factory依赖注入框架进行模块化开发时，当项目从CocoaPods迁移到Swift Package Manager(SPM)后，开发团队遇到了一个棘手的问题：在单元测试中设置的模拟依赖项被主项目代码忽略。这个问题特别出现在多模块项目中，当测试计划包含多个SPM模块的单元测试时尤为明显。

问题现象

开发团队发现，尽管单元测试中正确设置了所有模拟依赖项，但在测试执行过程中，主项目代码解析这些依赖项时却创建了一个新的容器实例，而不是使用测试夹具通过setUpMocks()设置的静态分配容器。这导致测试无法按预期工作。

根本原因分析

经过深入调查，发现问题的核心在于Swift的模块系统和SPM的编译方式：

1. 静态变量作用域：Swift中静态变量默认具有模块级作用域。当使用SPM时，每个包都是独立编译的，这可能导致不同模块中存在相同静态变量的不同实例。

2. 测试目标链接问题：当将模拟库目标链接到主应用程序测试目标时，可能会意外地导致模块代码被重复包含。特别是当ModuleBMocks包含ModuleB，而ModuleB又包含ModuleA时，容易形成依赖链导致容器实例重复。

3. 对象标识不一致：通过打印ObjectIdentifier可以观察到，在测试环境和主应用环境中，容器实例的标识符不同，证实了存在多个容器实例的问题。

解决方案

方案一：重构模拟代码结构

1. 移除独立的模拟库目标：不再为每个模块创建单独的模拟库目标(如ModuleAMocks)，而是将模拟代码直接包含在主模块中。

2. 使用条件编译：通过定义编译标志来区分模拟环境和生产环境。

.target(
    name: "ModuleA",
    dependencies: [
        .product(name: "Factory", package: "Factory")
    ],
    path: "Sources",
    swiftSettings: [
        .define("MOCKING", .when(configuration: .debug))
    ]
)

3. 集中管理模拟代码：在模块内部通过条件编译包含模拟代码：

#if MOCKING
public protocol ModuleAMocksProviding {
    var demoRepositoryMock: DemoRepositoryMock! { get }
}

public extension ModuleAMocksProviding {
    var demoRepositoryMock: DemoRepositoryMock! {
        ModuleAContainer.shared.demoRepository() as? DemoRepositoryMock
    }
}
#endif

方案二：统一容器访问

1. 确保单例一致性：在测试代码中，直接操作主模块的容器实例，而不是通过模拟库中的副本。

2. 简化测试设置：

@testable import ModuleA

final class DemoBuilderTests: XCTestCase, ModuleAMocksProviding {
    override func setUpWithError() throws {
        ModuleAContainer.setUpMocks()
        demoRepositoryMock.getClassNameReturnValue = "DemoRepositoryMock"
    }
}

最佳实践建议

1. 避免将应用代码链接到测试目标：特别是核心框架代码(如Factory本身)不应链接到测试目标，以防止出现多个实例。

2. 谨慎设计模块依赖：确保模块间的依赖关系清晰，避免循环依赖或过度嵌套。

3. 统一容器管理：考虑使用应用程序级别的容器管理策略，确保在整个应用中容器实例的唯一性。

4. 充分利用条件编译：合理使用编译标志来区分不同环境下的行为，保持代码整洁。

总结

在SPM模块化项目中使用Factory框架时，容器共享问题主要源于Swift的模块系统和SPM的编译特性。通过重构模拟代码结构、合理使用条件编译以及确保容器单例的一致性，可以有效解决这一问题。关键在于理解SPM模块隔离机制对静态变量的影响，并据此设计合理的代码组织结构。

对于大型模块化项目，建议采用集中式的依赖管理策略，并在早期就考虑测试环境的需求，以避免后期出现类似的集成问题。同时，定期检查模块间的依赖关系，确保不会因为过度嵌套而导致容器实例的意外复制。