URLSessionにおけるasync/awaitの使用

async/awaitとAsyncSequenceを使用して、URLSessionでSwift並列処理を採用する方法と、Swift並列処理の概念を適用してネットワーキングのコードを改良する方法を紹介します。

リソース

関連ビデオ

WWDC22

Swiftの並行処理でデータ競合を排除する

WWDC21

ダウンロード

♪ (URLSessionにおける async/awaitの使用) こんにちは Guoyeです Zhenchaoと私はHTTP フレームワークに取り組んでいます Swiftの同時実行性については今迄に沢山耳にしたことでしょうまだなら「Swiftのasync/awaitについて」をチェックしてみてくださいここでは async/awaitが URLSessionでどのように機能するかを説明します Swiftの並列処理で最も気に入っているのはコードを線形で簡潔にして Swiftのネイティブなエラー処理をサポートしていることですネットワークは本質的に非同期であり iOS 15と macOS Montereyでは Swiftの同時実行機能を利用するための新しいAPIセットを URLSessionに導入した新しいAPIを紹介するために async/awaitを採用するために開発中のAppを紹介します犬好きのための写真共有Appでこれらの写真をお気に入りに入れることができますこれは犬の写真を取得する既存のコードですこれは completionHandler ベースの便利なメソッドを URLSessionで使用コードは単純なようで私の限られたテストではうまくいきましたしかし少なくとも3つの間違いがありますちょっと探ってみましょうまずコントロールフローを見ていきましょうデータタスクを作成して再開しますタスクが完了したら完了ハンドラーにジャンプしてレスポンスをチェックしイメージを作成してそこでコントロールフローが終了しますうん前後にジャンプしていますスレッディングについてはどうですかこの小さなコードでは驚くほど複雑です実行コンテキストは全部で 3つあります最上位層は呼び出し元のスレッドまたはキューで実行され URLSessionTask completionHandlerはセッションの委任キューで実行され最終的な完了ハンドラはメインキューで実行されますコンパイラはここでは役に立たないのでデータ競合などのスレッド化の問題を避けるために細心の注意を払う必要があります今何かおかしいことに気づきました completionHandlerへの呼び出しは常にメインキューにディスパッチされるわけではありませんこれはバグである可能性がありますまたこちらに早く戻ることができません問題が起こった場合2回呼出し可能 completionHandlerをこれは呼び出し元が行った仮定に違反する可能性があります最後にこれはあまり明白ではないかもしれませんが UIImageの作成は失敗する可能性がありますデータの形式が正しくない場合 UIImageイニシャライザーは nilと返すため completionHandlerを nil imageと nil errorの両方で呼び出しますこれは想定外ですこれはasync/awaitを使った新しいバージョンですわあもっとシンプルだコントロールフローは上から下まで直線的でありこの関数のすべてが同じ並行性コンテキストで実行されることがわかっているためスレッド化の問題を心配する必要はありませんここではURLSessionで新規非同期データ方法を使用した現在の実行コンテキストを中断しブロックせずに正常終了時にデータとレスポンスを返すかエラーをスローしますまた応答が予期しない場合にエラーをスローするためにスローキーワードも使用しましたこれで呼び出し側はSwiftのネイティブなエラー処理を使用してエラーをキャッチし処理することができます最後にこの関数からオプションの UIImageを返そうとするとコンパイラが吠えるので基本的には nilを正しく処理する必要がある nilを正しく扱うことを強制しますここではネットワークからデータを取得するために使用したメソッドのシグネチャを示します URLSession.data方法は URLまたはURLRequestのどれかを受入これらは既存のデータタスクの簡易メソッドと同等ですまたデータをアップロードしたりファイルをアップロードしたりできるアップロードメソッドも用意されていますこれらは既存のアップロードタスクの簡易メソッドと同等ですデフォルトのメソッドGETはアップロードをサポートしていないためリクエストを送信する前に正しいHTTPメソッドを設定してくださいダウンロードメソッドはレスポンス本文をメモリーではなくファイルとして格納しますダウンロードタスクの便利な方法とは異なりこれらの新しい方法ではファイルが自動的に削除されないため自分で削除することを忘れないでくださいこの例ではさらに処理するためにファイルを別の場所に移動します Swiftの同時実行性キャンセルは URLSessionで動作する asyncメソッド取消する一つの方法は同時並行タスクの Task.Handleを使用することここではasyncを呼び出して 2つのリソースを1つずつロードする同時実行タスクを作成しますその後 Task.Handleを使って現在実行中の操作をキャンセルすることができます並行性タスクに注意してください「タスク」という名前を共有していますが URLSessionTaskとは無関係です先ほど説明したメソッドデータアップロードダウンロードはレスポンス本文全体が到着するのを待ってから戻りますレスポンス本文を段階的に受信する場合はどうすればよいですか URLSession.bytes メソッドを紹介しますレスポンスヘッダが受信された時に戻りレスポンスボディをバイト AsyncSequenceとして配送します同僚のZhenchaoが Dogs Appにどうやってそれを適用しているかをデモしますありがとうGuoye こんにちは Zhenchaoです犬の写真をどれだけの人が気に入ったかを表示する Dogs Appの新機能に取り組んでいます

現時点ではスクロールビューをプルダウンしてお気に入りの数を更新できますこれらのお気に入りの数をリアルタイムで更新したいですそうすることでAppはずっとインタラクティブに感じられるそのためにバックエンドのエンジニアたちはリアルタイムのイベントエンドポイントを作って写真をリアルタイムでアップデートできるようにしたエンドポイントを調べてレスポンスを調べますレスポンス本文の各行は写真の更新更新されたお気に入り数など記述するJSONデータです新規非同期シーケンスAPIを使用してエンドポイントのレスポンスを消費しリアルタイムイベントの解析時にお気に入りのカウントを更新しましょう onAppearHandler 関数でライブ更新を開始できますこの関数は写真コレクションビューが表示されたときに呼び出されますこの関数の中で新しい URLSession.bytes APIを呼び出して新しいエンドポイントからデータを取得します

ここで返されるバイトのタイプは URLSession.AsyncBytes であることに注意してくださいこれによりレスポンスボディをインクリメンタルに消費することができますサーバーから正常なレスポンスを得ていることを確認するためにエラーチェックを追加しました

レスポンスの各行を JSONデータの一部として解析したいその為にAsyncBytesの AsyncBytesのlines方法を使用

これによりデータを受信するたびに一行ずつレスポンスを消費することができます

ループ内では JSONデータを解析して UIを更新するために updateFavoriteCount UI の更新はメインのアクターで行われる必要があることに注意してくださいそのため非同期関数である updateFavoriteCount を await 構文で呼び出しているナイスお気に入りのカウントはリアルタイムで更新されます Guoye戻します

Zhenchaoは AsyncSequence 組み込み変換 linesを使用して応答本文を 1行ずつ解析する方法を示しました AsyncSequenceは多くの便利な変換をサポートしており FileHandleなどの他のシステムフレームワークAPIでも AsyncSequenceを使用できます AsyncSequenceの詳細については動画「AsyncSequenceについて」をご覧ください URLSessionは認証チャレンジやメトリックなどイベントのコールバックを提供する委任モデルを中心に設計されています新しい非同期方式では基礎となるタスクが公開されなくなったためタスク固有の認証の課題をどのように処理するのでしょうかはいこれらのメソッドはすべて追加の引数タスク固有のデリゲートを取ることができますこのデータアップロードに特化したデリゲートメッセージを処理するオブジェクトを提供できますダウンロードやバイトの操作を行うことができますまたObjective-Cでは NSURLSessionTask プロパティを導入し同じ機能を利用できますデリゲートはタスクが完了するか失敗するまでタスクによって強く拘束されますなおタスク固有のデリゲートはバックグラウンドの URLSessionではサポートされていませんある方式がセッションデリゲートとタスクデリゲートの両方に実装している場合はタスクデリゲートの方法が呼出されます Zhenchaoはタスク固有のデリゲートを使って認証のチャレンジを処理する方法を紹介しますありがとうGuoye Dogs Appには新しい非同期APIで書かれたシンプルなデータフェッチレイヤーがあります写真をお気に入りに登録したりお気に入りに登録された写真をすべて取得するなどデータを取得するためにはユーザーの認証が必要です現在写真をお気に入りに登録しようとタップすると「Unauthorized」というエラーが表示されますタスク固有のデリゲートを使用してユーザー認証を追加する方法について説明します URLSessionTaskDelegateをまず作成します AuthenticationDelegate と呼びましょう

AuthenticationDelegate は URLSessionTaskDelegate プロトコルに準拠しそのイニシャライザーで signInControllerのインスタンスを受け入れます実装したsignInController クラスにはユーザーにクレデンシャルを要求するのに利用できる便利なヘルパー関数がすでに含まれています URLSession idReceive challenge delegateメソッドを次に実装します

デリゲート方式では認証情報の入力をユーザーに求めることで HTTP基本認証の要求に応答することを選択できますもちろんエラー処理を忘れてはいけません AuthenticationDelegate クラスを次にタスク固有のデリゲートとして使用しますそのためにはそのインスタンスをインスタンス化しそれを方式 URLSession.dataで delegate引数として構文解析するだけですなおデリゲートオブジェクトはインスタンス変数ではなくタスクが完了するか失敗するまでタスクに強く保持されていますここでの新機能はデリゲートを使って URLSessionタスクのインスタンスに固有のイベントを処理できることです URLSessionタスクのインスタンスに固有のイベントを扱うことができます素晴らしいここをタップして写真をお気に入りに登録できます

...ログインフォームが表示されます

ログインするとその写真がお気に入りと表示されお気に入りの写真コレクションに追加されました Guoyeに戻しますデモをありがとうZhenchao URLSessionで async/awaitを皆さんが試すのを待つことはできませんし関数の変更完了ハンドラのasync関数への変更繰り返しイベントハンドラの AsyncSequencesへの変更など同じasyncの概念を適用したコードの改善をお勧めします URLSessionの進歩についてさらに学ぶために AppのHTTP トラフィックを調べるクールな新しいツールについての動画そしてURLSessionで HTTP/3サポートについての動画がありますありがとうございましたそして素晴らしいWWDCを ♪

2:52 - Fetch photo with async/await

// Fetch photo with async/await

func fetchPhoto(url: URL) async throws -> UIImage
{
    let (data, response) = try await URLSession.shared.data(from: url)

    guard let httpResponse = response as? HTTPURLResponse,
          httpResponse.statusCode == 200 else {
        throw WoofError.invalidServerResponse
    }

    guard let image = UIImage(data: data) else {
        throw WoofError.unsupportedImage
    }

    return image
}

3:45 - URLSession.data

let (data, response) = try await URLSession.shared.data(from: url)
guard let httpResponse = response as? HTTPURLResponse,
      httpResponse.statusCode == 200 /* OK */ else {
    throw MyNetworkingError.invalidServerResponse
}

4:03 - URLSession.upload

var request = URLRequest(url: url)
request.httpMethod = "POST"

let (data, response) = try await URLSession.shared.upload(for: request, fromFile: fileURL)
guard let httpResponse = response as? HTTPURLResponse,
      httpResponse.statusCode == 201 /* Created */ else {
    throw MyNetworkingError.invalidServerResponse
}

4:21 - URLSession.download

let (location, response) = try await URLSession.shared.download(from: url)
guard let httpResponse = response as? HTTPURLResponse,
      httpResponse.statusCode == 200 /* OK */ else {
    throw MyNetworkingError.invalidServerResponse
}

try FileManager.default.moveItem(at: location, to: newLocation)

4:44 - Cancellation

let task = Task {
    let (data1, response1) = try await URLSession.shared.data(from: url1)

    let (data2, response2) = try await URLSession.shared.data(from: url2)

}

task.cancel()

7:53 - asyncSequence demo

let (bytes, response) = try await URLSession.shared.bytes(from: Self.eventStreamURL)
guard let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 200 else {
    throw WoofError.invalidServerResponse
}
for try await line in bytes.lines {
    let photoMetadata = try JSONDecoder().decode(PhotoMetadata.self, from: Data(line.utf8))
    await updateFavoriteCount(with: photoMetadata)
}

11:20 - task specific delegate demo

class AuthenticationDelegate: NSObject, URLSessionTaskDelegate {
    private let signInController: SignInController
    
    init(signInController: SignInController) {
        self.signInController = signInController
    }
    
    func urlSession(_ session: URLSession,
                    task: URLSessionTask,
                    didReceive challenge: URLAuthenticationChallenge) async
    -> (URLSession.AuthChallengeDisposition, URLCredential?) {
        if challenge.protectionSpace.authenticationMethod == NSURLAuthenticationMethodHTTPBasic {
            do {
                let (username, password) = try await signInController.promptForCredential()
                return (.useCredential,
                        URLCredential(user: username, password: password, persistence: .forSession))
            } catch {
                return (.cancelAuthenticationChallenge, nil)
            }
        } else {
            return (.performDefaultHandling, nil)
        }
    }
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。