
关于
基于协议的依赖注入,用于可测试的 Swift 代码 — 使用聚焦协议和 Swift Testing 模拟文件系统、网络和外部 API。
name: swift-protocol-di-testing description: 基于协议的依赖注入用于可测试的 Swift 代码——使用聚焦协议和 Swift Testing 模拟文件系统、网络和外部 API。 origin: ECC
Swift 基于协议的依赖注入测试
通过将外部依赖(文件系统、网络、iCloud)抽象到小型聚焦协议后面,使 Swift 代码可测试的模式。实现无需 I/O 的确定性测试。
何时激活
- 编写访问文件系统、网络或外部 API 的 Swift 代码时
- 需要在不触发真实故障的情况下测试错误处理路径时
- 构建跨环境工作的模块(应用、测试、SwiftUI 预览)时
- 使用 Swift 并发(actors、Sendable)设计可测试架构时
核心模式
1. 定义小型聚焦协议
每个协议处理恰好一个外部关注点。
// File system access
public protocol FileSystemProviding: Sendable {
func containerURL(for purpose: Purpose) -> URL?
}
// File read/write operations
public protocol FileAccessorProviding: Sendable {
func read(from url: URL) throws -> Data
func write(_ data: Data, to url: URL) throws
func fileExists(at url: URL) -> Bool
}
// Bookmark storage (e.g., for sandboxed apps)
public protocol BookmarkStorageProviding: Sendable {
func saveBookmark(_ data: Data, for key: String) throws
func loadBookmark(for key: String) throws -> Data?
}
2. 创建默认(生产)实现
public struct DefaultFileSystemProvider: FileSystemProviding {
public init() {}
public func containerURL(for purpose: Purpose) -> URL? {
FileManager.default.url(forUbiquityContainerIdentifier: nil)
}
}
public struct DefaultFileAccessor: FileAccessorProviding {
public init() {}
public func read(from url: URL) throws -> Data {
try Data(contentsOf: url)
}
public func write(_ data: Data, to url: URL) throws {
try data.write(to: url, options: .atomic)
}
public func fileExists(at url: URL) -> Bool {
FileManager.default.fileExists(atPath: url.path)
}
}
3. 创建用于测试的 Mock 实现
public final class MockFileAccessor: FileAccessorProviding, @unchecked Sendable {
public var files: [URL: Data] = [:]
public var readError: Error?
public var writeError: Error?
public init() {}
public func read(from url: URL) throws -> Data {
if let error = readError { throw error }
guard let data = files[url] else {
throw CocoaError(.fileReadNoSuchFile)
}
return data
}
public func write(_ data: Data, to url: URL) throws {
if let error = writeError { throw error }
files[url] = data
}
public func fileExists(at url: URL) -> Bool {
files[url] != nil
}
}
4. 使用默认参数注入依赖
生产代码使用默认值;测试注入 mock。
public actor SyncManager {
private let fileSystem: FileSystemProviding
private let fileAccessor: FileAccessorProviding
public init(
fileSystem: FileSystemProviding = DefaultFileSystemProvider(),
fileAccessor: FileAccessorProviding = DefaultFileAccessor()
) {
self.fileSystem = fileSystem
self.fileAccessor = fileAccessor
}
public func sync() async throws {
guard let containerURL = fileSystem.containerURL(for: .sync) else {
throw SyncError.containerNotAvailable
}
let data = try fileAccessor.read(
from: containerURL.appendingPathComponent("data.json")
)
// Process data...
}
}
5. 使用 Swift Testing 编写测试
import Testing
@Test("Sync manager handles missing container")
func testMissingContainer() async {
let mockFileSystem = MockFileSystemProvider(containerURL: nil)
let manager = SyncManager(fileSystem: mockFileSystem)
await #expect(throws: SyncError.containerNotAvailable) {
try await manager.sync()
}
}
@Test("Sync manager reads data correctly")
func testReadData() async throws {
let mockFileAccessor = MockFileAccessor()
mockFileAccessor.files[testURL] = testData
let manager = SyncManager(fileAccessor: mockFileAccessor)
let result = try await manager.loadData()
#expect(result == expectedData)
}
@Test("Sync manager handles read errors gracefully")
func testReadError() async {
let mockFileAccessor = MockFileAccessor()
mockFileAccessor.readError = CocoaError(.fileReadCorruptFile)
let manager = SyncManager(fileAccessor: mockFileAccessor)
await #expect(throws: SyncError.self) {
try await manager.sync()
}
}
最佳实践
- 单一职责:每个协议应处理一个关注点——不要创建包含多个方法的"上帝协议"
- Sendable 一致性:当协议跨 actor 边界使用时必需
- 默认参数:使用默认参数使生产代码简洁,同时保持测试灵活性
- Mock 可配置性:Mock 应允许配置成功和失败路径
- 协议粒度:宁可多个小协议也不要一个大协议
- 值类型优先:生产实现优先使用 struct,Mock 使用 class(需要可变状态)
兼容工具
Claude CodeCursor
标签
移动端
