如何在 App Target 中访问 MockedHTTPClient？

2024-08-03 11:28:39

你是否也曾为 App 编写单元测试时，在测试目标中使用 MockedHTTPClient 提供模拟数据，却发现无法在 App Target 中访问它而苦恼？将 MockedHTTPClient 文件同时添加到 App 和测试目标，似乎又违背了测试隔离的原则。本文将为你揭晓如何优雅地解决这个问题。

问题根源：单元测试与代码隔离

在深入解决方案之前，我们需要了解问题的根源。单元测试的目标是在隔离的环境中验证代码逻辑，不受外部因素干扰。我们使用 MockedHTTPClient 模拟网络请求，正是为了避免测试依赖于真实的网络环境。

将 MockedHTTPClient 放在测试目标中合情合理，因为它只在测试时发挥作用。然而，直接在 App Target 中引用测试目标的代码会导致代码耦合，增加维护成本，甚至引发循环依赖问题，这是我们极力避免的。

解决方案：依赖注入，化解代码耦合

为了解决这个问题，我们可以采用依赖注入的方式，将 MockedHTTPClient 作为依赖项传递给需要使用它的对象，就像拼图一样，在需要的时候将它们组合在一起。

1. 定义协议：抽象 HttpClient 行为

首先，我们需要定义一个协议，规定 HTTPClient 的行为，就像制定一份合同，明确各方的责任和义务：

protocol HTTPClient {
    func sendRequest(request: URLRequest, completion: @escaping (Result<Data, Error>) -> Void)
}

2. 实现协议：MockedHTTPClient 与 RealHTTPClient

接下来，我们分别实现 MockedHTTPClient 和真实的 HTTPClient，就像根据合同，分别制定两套执行方案：

// MockedHTTPClient.swift (位于测试目标)
class MockedHTTPClient: HTTPClient {
    func sendRequest(request: URLRequest, completion: @escaping (Result<Data, Error>) -> Void) {
        // 返回模拟数据
        let data = Data() // 替换为你的模拟数据
        completion(.success(data))
    }
}

// RealHTTPClient.swift (位于 App Target)
class RealHTTPClient: HTTPClient {
    func sendRequest(request: URLRequest, completion: @escaping (Result<Data, Error>) -> Void) {
        // 执行真实的网络请求
        URLSession.shared.dataTask(with: request) { data, response, error in
            // 处理网络请求结果
            completion(.success(data ?? Data()))
        }.resume()
    }
}

3. 使用依赖注入：灵活传递 HttpClient

最后，我们将 HTTPClient 作为依赖项注入到需要使用它的类中，就像将拼图块安装到相应的位置：

class APRService {
    let httpClient: HTTPClient

    init(httpClient: HTTPClient) {
        self.httpClient = httpClient
    }

    // ... 其他方法 ...
}

4. 分别注入：App 与测试目标各不干扰

现在，我们可以在 App Target 和测试目标中分别注入不同的 HTTPClient 实现，就像根据不同的场景选择不同的拼图块：

// App Target
#Preview {
    NavigationStack {
        ContentView(aprService: APRService(httpClient: RealHTTPClient()))
    }
}

// 测试目标
class MyTests: XCTestCase {
    func testSomething() {
        let mockedHTTPClient = MockedHTTPClient()
        let aprService = APRService(httpClient: mockedHTTPClient)
        // ... 执行测试 ...
    }
}

代码解析：拨开迷雾，洞悉原理

通过上述步骤，我们成功地将 MockedHTTPClient 注入到 APRService 中，而无需在 App Target 中直接引用 MockedHTTPClient 类。

在 App Target 中，我们使用 RealHTTPClient 执行真实的网络请求；而在测试目标中，我们使用 MockedHTTPClient 提供模拟数据，从而实现测试隔离，就像在不同的环境下，使用不同的工具完成任务。

总结：依赖注入，提升代码质量

依赖注入是软件工程中常用的设计模式，它可以降低代码耦合度，提高代码可测试性和可维护性，就像将复杂的机器拆解成一个个独立的模块，方便我们组装和维护。

通过本文介绍的方法，我们轻松解决了在 App Target 中访问 MockedHTTPClient 的问题，同时保持代码的整洁和易于维护，就像一位 skilled 工匠，用精湛的技艺打造出精美的艺术品。

常见问题解答

问：除了模拟网络请求，依赖注入还可以应用于哪些场景？

答：依赖注入可以应用于各种场景，例如数据库访问、日志记录、第三方库集成等，只要你想降低代码耦合，提高代码可测试性，都可以考虑使用依赖注入。
问：依赖注入会增加代码的复杂度吗？

答：在简单的项目中，依赖注入可能会增加一些代码量，但在复杂的项目中，依赖注入可以降低代码的耦合度，提高代码的可读性和可维护性，最终降低项目的复杂度。
问：如何选择合适的依赖注入框架？

答： Swift 中有很多优秀的依赖注入框架，例如 Swinject、 Resolver 等，你可以根据项目规模和需求选择合适的框架，也可以选择不使用框架，手动实现依赖注入。
问：依赖注入和控制反转有什么区别？

答：控制反转 (Inversion of Control, IoC) 是一种设计原则，它提倡将对象的创建和管理交给容器来完成，而依赖注入是实现控制反转的一种具体方式。
问：如何学习和掌握依赖注入？

答：你可以阅读相关的书籍和文章，学习依赖注入的概念和原则，并尝试在实际项目中应用依赖注入，逐步掌握这项技能。