2023/12/30

【Swift Concurrency】withCheckedContinuationとwithCheckedThrowingContinuationの使い方

この記事からわかること

Swift Concurrencyとは？
withCheckedContinuationとwithCheckedThrowingContinuationの使い方
非同期処理の実装方法
asyncとの違い

index

[open]

Swift Concurrencyとは？
withCheckedContinuationとwithCheckedThrowingContinuationの使い所
実装例
引数：CheckedContinuation
おまけ：async/awaitに置き換える
カスタムエラークラスを指定できない

＼アプリをリリースしました／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

環境

Xcode：15.0.1
iOS：17.1
Swift：5.9
macOS：Sonoma 14.1

公式リファレンス：Concurrency
公式ドキュメント：Concurrency

Swift Concurrencyとは？

Swift Concurrency(同時実効性)とはiOS15(Swift 5.5)から導入された仕組みの1つで非同期プログラミング(並列処理)をより利用しやすくするための機能を提供しています。asyncやawaitキーワード、Task構造体などはSwift Concurrencyから提供されており、非同期処理を実装する際に利用されるcompletionHandler(コールバック関数)の弱みである可読性の低下を解消することができるようになりました。

今回はその中のwithCheckedContinuationとwithCheckedThrowingContinuationについてまとめていきます。

withCheckedContinuationとwithCheckedThrowingContinuationの使い所

先にwithCheckedContinuationとwithCheckedThrowingContinuationの使い所と役割を整理しておきます。この2つのメソッドはSwift Concurrencyから提供されている非同期処理を実装するためのメソッドです。といっても非同期処理の実装はasync/awaitを使用すれば実装できます。

両者のメソッドの引数と見てみるとそのまま別の関数(クロージャー)を渡せるようになっています。

公式リファレンス：withCheckedContinuationメソッド

func withCheckedContinuation<T>(
    function: String = #function,
    _ body: (CheckedContinuation<T, Never>) -> Void
) async -> T

なので使い所としては既存のコードを非同期関数に簡単に改修したい場合に活用できます。Swift Concurrencyを導入せずにcompletionHandler(コールバック関数)などで非同期的な処理を実装していた場合に、コード量が多かったり、複雑だとasync/awaitに対応するコストが大きくなってしまいます。これを時短できるのがwithCheckedContinuationとwithCheckedThrowingContinuationになるようです。

それぞれの違いは引数に渡す関数がエラーをthrowsするかしないかなので実装方法はほとんど同じです。

実装例

例えばまず既存のコードでにサーバーからデータを取得するfetchDataメソッドがあるとします。これはcompletionHandler(コールバック関数)で今までは実装されていました。

func fetchData(completion: @escaping (Result<Data, Error>) -> Void) {
    // 実際はAPIリクエストを送信
    sleep(2)
    if Bool.random() {
        completion(.success(Data()))
    } else {
        completion(.failure(NSError(domain: "ErrorDomain", code: 42, userInfo: nil)))
    }
}

これを非同期関数として改修したい場合に上記の場合は簡素なのでasync/awaitでも簡単ですが、もっと複雑なコードになっていると大変なのでwithCheckedThrowingContinuationを使用します。

func asyncFetchData() async throws -> Data {
    return try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Data, Error>) in
        fetchData { dataResult in
            switch dataResult {
            case .success(let data):
                // 非同期処理が成功した場合
                continuation.resume(returning: data)
            case .failure(let error):
                // 非同期処理が失敗した場合
                continuation.resume(throwing: error)
            }
        }
    }
}

Task {
    let result = try await asyncFetchData()
    print(result) // 0 bytes
}

このように元の関数をいじることなくラップするだけで非同期関数として実装することが可能になります。エラーを投げない場合はwithCheckedContinuationを使用するだけです。

引数：CheckedContinuation<T, Never>

公式リファレンス：CheckedContinuation構造体

引数bodyでは(CheckedContinuation<T, Never>) -> Void形式(クロージャー)になっています。クロージャーの引数として取得できるCheckedContinuation型は同期的な元の関数を非同期関数として繋ぎ込むためのインターフェース的な役割を持っています。

resumeメソッドを使用して非同期関数としての結果を操作します。

// 非同期処理が成功した場合
continuation.resume(returning: data)

// 非同期処理が失敗した場合
continuation.resume(throwing: error)

おまけ：async/awaitに置き換える

ちなみに先ほどのfetchDataをasync/awaitに置き換えると以下のような感じでしょうか？

func fetchData() async throws -> Data {
    // 実際はAPIリクエストを送信
    try await Task.sleep(nanoseconds: 2 * 1_000_000_000) // 2秒待機 (1秒 = 1_000_000_000ナノ秒)

    if Bool.random() {
        return Data()
    } else {
        throw NSError(domain: "ErrorDomain", code: 42, userInfo: nil)
    }
}

カスタムエラークラスを指定できない

公式リファレンス：withCheckedThrowingContinuationメソッド

func withCheckedThrowingContinuation<T>(
    isolation: isolated (any Actor)? = #isolation,
    function: String = #function,
    _ body: (CheckedContinuation<T, any Error>) -> Void
) async throws -> sending T

withCheckedThrowingContinuationにカスタムエラーを渡そうとしたところコンパイルエラーになりました。

 private func executeRequest(
    _ endPoint: APIEndpoint,
    parameters: [String: Any]? = nil
) async throws -> Data {
    return try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Data, APIError>) in
        // いろいろな処理
        continuation.resume(throwing: APIError.unidentified)
    }
}

発生していたエラーは以下です。定義を確認してみるとany Errorになっているのでカスタムエラーを渡すと型の不一致になってしまうようです。

Cannot convert value of type '(CheckedContinuation<Data, APIError>) -> Void' to expected argument type '(CheckedContinuation<Data, any Error>) -> Void'

Arguments to generic parameter 'E' ('any Error' and 'APIError') are expected to be equal