Swift Protocol Di Testing

affaan-m/ECC/docs/ja-JP/skills/swift-protocol-di-testing

作者 affaan-mef648e01899ba3e8dc6371642deaaf64b4477775无许可证275K 个星标收录于 2026年10月9日更新于 2026年10月9日仓库4天前更新

テスト可能なSwiftコードのためのプロトコルベースの依存性注入——焦点を絞ったプロトコルとSwift Testingを使用してファイルシステム、ネットワーク、外部APIをモックする。

AI 生成的概览

指导在 Swift 中基于协议进行依赖注入,以便在测试中模拟文件系统、网络和 API 依赖。

功能
该技能记录了一套让 Swift 代码可测试的模式:把外部依赖抽象为小而专注的协议。它演示如何定义提供者协议、编写默认的生产实现、构建可配置错误的模拟实现,并通过默认参数注入依赖。它还介绍如何使用 Swift Testing 编写确定性测试,并列出最佳实践与反模式。
适用场景
适用于编写会访问文件系统、网络、iCloud 或外部 API 的 Swift 代码时。也适合需要在不引发真实故障的情况下测试错误处理路径,或需要模块在应用、测试和 SwiftUI 预览环境中运行的场景。
运行要求
不附带任何脚本或工具,仅为说明性内容。应用这些模式需要 Swift 项目,并使用 Swift Testing 以及 Actor、Sendable 等 Swift 并发特性。

プロトコルベースのSwift依存性注入テスト

外部の依存関係(ファイルシステム、ネットワーク、iCloud)を小さく焦点を絞ったプロトコルとして抽象化することで、SwiftコードをテストしやすくするパターンI/Oなしの決定論的テストをサポートする。

起動条件

  • ファイルシステム、ネットワーク、または外部APIにアクセスするSwiftコードを書く場合
  • 実際の障害を起こさずにエラー処理パスをテストする必要がある場合
  • 異なる環境(アプリ、テスト、SwiftUIプレビュー)で動作するモジュールを構築する場合
  • Swift並行処理(Actor、Sendable)をサポートするテスト可能なアーキテクチャを設計する場合

コアパターン

1. 小さく焦点を絞ったプロトコルを定義する

各プロトコルは1つの外部関心事のみを処理する。

swift
// File system accesspublic protocol FileSystemProviding: Sendable {    func containerURL(for purpose: Purpose) -> URL?}
// File read/write operationspublic 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. デフォルト(本番用)実装を作成する

swift
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. テスト用のモック実装を作成する

swift
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. デフォルトパラメーターで依存関係を注入する

本番コードはデフォルト値を使用し、テストはモックを注入する。

swift
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を使用してテストを書く

swift
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()    }}

ベストプラクティス

  • 単一責任:各プロトコルは1つの関心事を処理する——多くのメソッドを持つ「ゴッドプロトコル」を作らない
  • Sendable 一貫性:プロトコルがActor境界をまたいで使用される場合に必要
  • デフォルトパラメーター:本番コードは実際の実装をデフォルトで使用する。テストだけがモックを指定する必要がある
  • エラーのモック:障害パスをテストするために設定可能なエラープロパティを持つモックを設計する
  • 境界のみをモック:外部の依存関係(ファイルシステム、ネットワーク、API)をモックし、内部型はモックしない

避けるべきアンチパターン

  • すべての外部アクセスをカバーする単一の大きなプロトコルを作成する
  • 外部の依存関係を持たない内部型をモックする
  • 適切な依存性注入の代わりに #if DEBUG 条件文を使用する
  • Actorと組み合わせて使用する際に Sendable 一貫性を忘れる
  • 過度な設計:型が外部の依存関係を持たない場合、プロトコルは必要ない

使用場面

  • ファイルシステム、ネットワーク、または外部APIに触れるあらゆるSwiftコード
  • 実際の環境では引き起こすことが難しいエラー処理パスをテストする場合
  • アプリ、テスト、SwiftUIプレビューのコンテキストで動作するモジュールを構築する場合
  • Swift並行処理(Actor、構造化並行処理)を採用したテスト可能なアーキテクチャが必要なアプリ

来源与署名

来源:affaan-m/ECC位于docs/ja-JP/skills/swift-protocol-di-testing提交ef648e0

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架