堅牢で再開可能なファイル転送の構築

堅牢で再開可能なファイル転送の構築

URLSession がどのようにアプリの大容量ファイル転送とネットワーク中断からの回復を支援するかを学びましょう。HTTP ファイル転送の一時停止と再開のサポート、および再開可能なアップロードのサポート方法を確認し、アプリがバックグラウンドで中断されている場合でも URLSession を使用してファイルを転送するためのベストプラクティスを紹介します。

関連する章
- 0:00 - Welcome
- 2:42 - Explore the resumable downloads protocol in HTTP
- 4:23 - Pause and resume downloads with URLSession
- 7:50 - Pause and resume uploads with URLSession
- 9:45 - Explore the resumable uploads protocol in HTTP
- 12:46 - Add resumable uploads to SwiftNIO
- 16:11 - Use background URLSession
リソース
関連ビデオ

WWDC19
- ネットワーキングの最新情報（パート1）
ダウンロード

♪ ♪
こんにちは Jonathanです Internet Technologiesチームのエンジニアです URLSessionを使用して堅牢で再開可能なファイル転送を構築する方法を検討します小さな中断からすべての状況が台無しになる可能性があり大規模なファイルの転送が大きな課題となって最初からやり直しになる可能性がありますそして転送が大きければ大きいほど所要時間も長くなり問題が発生する可能性が高まります
その間ユーザーがアプリや Wi-Fiの範囲を離れることで制御不能な非常に多くのネットワークの問題が発生する可能性がありますこれらの課題を解決しユーザーに堅牢なネットワーキングの体験を提供する方法を検討しましょう最初の方法は接続が中断されたときにユーザーが進行状況を維持できるようにする再開可能な HTTPプロトコルですこれにより時間と帯域幅の無駄がなくなり大量のデータを転送する場合の強力なツールになります再開可能なアップロードタスク用の新しいAPIを含めダウンロードとアップロードの両方を URLSessionで再開する方法を説明しますこれらのAPIの背後にあるメカニズムを理解することはアプリのデバッグや独自のサーバサポートの構築にも非常に役立ちますそのため再開可能なプロトコル自体についても説明しアプリとサーバがHTTP経由でどのように実現するかを正確に理解できるようにします
次にサーバについて説明します SwiftNIOを使用するサーバに再開可能なアップロードのサポート提供方法を学びます
最後にバックグラウンドの URLSessionsがユーザーとシステムリソースを効率的に利用しながらネットワークの中断をどのように処理できるかを確認します
URLSessionでのダウンロードとアップロードの再開について見てみましょう最新のXcodeをダウンロードしており 7ギガバイトのダウンロードがほぼ完了するところですが最後の最後で Wi-Fiが切れてしまいますただしダウンロードは一時停止されています Wi-Fiがオンラインに戻ったら中断したところからダウンロードを再開できます
多くの時間と数ギガの帯域幅を節約できました再開可能なダウンロードは素晴らしいですそれらはどのように機能するのでしょうか？クライアントはGETリクエストを送信してサーバからダウンロードを取得します
応答でサーバは Accept-Rangesヘッダーを使用した再開可能なダウンロードのサポートを通知します Accept-Ranges:バイトはサーバがこのリソースの特定のバイトの範囲リクエストをサポートしていることを意味しますサーバ応答にはある時点でのリソースを一意に識別する ETagと呼ばれるものも含まれていますサーバ上のコンテンツが変更されるとETagも変更されます
ではこのダウンロードが中断されるとどうなるのでしょうか？
クライアントは部分的なダウンロードデータを保存しているため必要なのは最後の部分だけですこれを達成するために範囲リクエストを送信してまだダウンロードできていないバイトを把握できますリクエストはRangeフィールドを使ってどのバイトかを示していますクライアントはリソースが変更されていないか確認しますがそうでなければ新しいリソースから保存されている古いリソースにデータを追加することになりますこれを防ぐために If-Rangeフィールドには前の応答から受信した ETagが含まれますが ETagが同じ場合は部分データのみを送信するようにサーバに指示します
ETagが同じ場合サーバは 206 Partial Content で応答しますここのContent-Rangeフィールドはこの応答に含まれるバイトの範囲を示しダウンロードを完了します
URLSessionは当初からRange リクエストを使用してダウンロードタスクを一時停止および再開するAPIを提供してきました今後はアップロードも一時停止と再開ができるようになりましたこれで進行中のタスクを手動で一時停止するほかエラー処理を実行して予期しない接続の問題から回復して中断したところから転送を再開しますこれがどう機能するかまずダウンロードから確認してみましょうユーザーがダウンロードを手動で一時停止し再開できる UIの作成を想定してみましょう Safariの例と同様にアプリはこのUIを所有していますが内部でURLSessionを使用することで部分的なダウンロードデータの追跡や ETag リクエストヘッダーなどすべての詳細を処理できますダウンロードを開始するには通常どおりダウンロードタスクを作成し resumeを呼び出して開始しますユーザーが一時停止ボタンをタップしてダウンロードを一時停止するには cancelByProducingResumeData を呼び出します後でこのダウンロードを再開するには URLSessionはETagや現時点のサイズディスク上の場所など部分ダウンロードに関する情報が必要ですこれと他のメタデータはこの関数から返される再開データオブジェクトに保存すると便利です繰り返しますが再開データは部分ダウンロードデータではないことに注意してください再開データがnilの場合再開可能なダウンロードの 1つ以上の要件が満たされていないことを意味しますそれについては後ほど説明します再開データがnilでない場合は後で使用できるよう保存する必要がありますユーザーが再開ボタンをタップしたときなどダウンロードを再開するにはこの保存されたデータを downloadTask withResumeDataメソッドに渡しますそれはとても簡単です！このパターンはダウンロードを手動で一時停止する場合に最適ですが URLSessionには予期しない接続の中断から回復する方法も用意されています
ネットワークの問題によりダウンロードタスクが失敗した場合はエラー自体で再開データを確認できますダウンロードを再開できる場合はエラーのuserInfoディクショナリにその再開データが含まれます URLError の downloadTaskResumeData プロパティを使用するとこのデータに簡単にアクセスできます URLSessionで再開可能なダウンロードにはいくつかの要件がありますダウンロードは本質的にデータを取得し繰り返しても安全である必要があり URLSessionではダウンロードタスクに HTTP GETリクエストが必要です他のスキームまたはメソッドはサポートされていませんサーバはバイト範囲リクエストをサポートする必要があり Accept-Rangesヘッダーを使用してこれをアドバタイズしますサーバはETag (Last-Modified) フィールドを提供する必要があります応答内のリソースに使用されますが ETagの方が優先されます最後に一時ダウンロードファイルはディスク領域の不足に応じてシステムによって削除されてはなりません
これらの要件を満たしていればダウンロードを手動で一時停止および再開するか接続中断から回復できます再開プロトコルなしではわずかな中断であっても初めから転送を再開しなければなりませんこれはアップロードにとってさらに大きな問題ですアップロード速度はダウンロード速度よりもはるかに遅く再起動するとさらに多くの時間とリソースが失われます iOS 17では再開可能なアップロードタスクの新しいサポートが導入されていますとてもエキサイティングな進展ですサーバが最新のプロトコルドラフトをサポートしている場合アップロードタスクが自動的に再開できるようになりましたまずは新しいAPIを見てみましょう次に再開可能なアップロードプロトコルの詳細を見ていきますダウンロードタスクと同様にアップロードタスクを作成し resumeを呼び出して開始します一時停止にはアップロードタスクがダウンロードタスクと同じ cancelByProducingResumeData メソッドをサポートしますこのタスクはサーバが最新の再開可能なアップロードプロトコルをサポートしているか自動的に検出しますサーバがサポートしている場合後で使用できるように再開データを保存できます
一時停止したアップロードを再開するには新しいUploadTask withResumeData メソッドを使用しますここに示されているパターンはダウンロードタスクと同じであることがわかりますつまりアプリでダウンロードを一時停止および再開する優れたエクスペリエンスをすでに作成している場合はユーザー向けに再開可能なアップロードを簡単に実装することもできますネットワークが一時的に中断されただけでサーバにまだアクセス可能な場合は URLSessionは自動的にアップロードを再開しようとします追加のコードは必要ありませんただしネットワークやサーバが完全にダウンした場合などその他の広範な接続の問題が発生した場合はダウンロードタスクと同様に再開データのエラーを確認します URLSessionで再開可能なアップロードを確認できることを非常に嬉しく思います気に入っていただければ幸いですこの機能を利用するにはサーバが最新の再開可能なアップロードプロトコルもサポートしている必要があります
このプロトコルは現在開発中で業界全体でIETFで標準化する取り組みが行われていますこのプロトコルではクライアントはサーバのサポートを自動的に検出できますつまり URLSessionは一番最初のリクエストですべてのアップロードを再開可能にできるよう試みられますサーバが再開可能なアップロードをサポートしていない場合リクエストは通常のアップロードとして継続されます通信回線でどう動くか見てみましょう
クライアントはまずアップロードエンドポイントにリクエストを送信します Upload-Incompleteフィールドはこのクライアントが再開可能なアップロードをサポートすると示しています疑問符ゼロは構造化フィールドのブール値として知られ値falseを表しますすべてのアップロードデータがリクエストの本文に含まれています
サーバが再開可能なアップロードをサポートしている場合サーバはクライアントのヘッダーを検出し 104情報応答を使用してサポート状況を周知します 104応答には再開URLを含む場所フィールドが含まれていますこの再開URLはアップロードを一意に識別するために使用され接続が中断された場合クライアントはアップロードを再開する場所を認識しますサーバは受信したアップロードデータをこの一意の再開URLに関連付けます
アップロードが中断されずに終了すれば問題はありませんサーバが201を送信すると完了ですただしアップロードが中断された場合クライアントとサーバは再開可能なアップロード手順を実行します
サーバは再開URLの部分アップロードを保存しましたがクライアントはサーバが実際に取得したデータ量を判断する方法を必要としますこれにはクライアントは HEADリクエストを再開URLに送信しサーバにアップロードオフセットを要求しますこのオフセットはサーバが受信した実際のバイト数です
サーバはクライアントの特定アップロードのアップロードオフセットで応答します
そして最後にクライアントはサーバのオフセットを承認して残りのデータを送信する必要がありますこのためにはクライアントは PATCHリクエストを一致するアップロードオフセットを持つ再開URLに送信しますこのリクエストの本文には指定されたオフセットから始まるアップロードデータが含まれています
これでクライアントは最終的にすべてのデータをサーバに送信しアップロードを完了します URLSessionのアップロードタスクでこれらを無料で取得できますここでサーバ側に簡単にアクセスし SwiftNIOを使って独自の再開可能なアップロードサーバを構築しましょう
すでにサーバ上で SwiftNIOを使用している方にはこのセクションが役立ちます再開可能なアップロードはどのサーバでも実装できますがサーバがすでにSwiftNIO を使用している場合はサポートを非常に簡単に追加できる新しいパッケージがあります簡単な例を見てみましょう詳しくない方のために説明すると SwiftNIOはアプリとサーバで動作する非同期ネットワークアプリケーションフレームワークですこのサンプルコードではHTTP/2 サーバをセットアップしていますサーバに2つのハンドラを追加しましたコーデックはHTTP/2 フレームをサンプルハンドラが理解できるリクエストに変換します逆の方向ではサンプルハンドラから応答を受け取りそれをHTTP/2フレームにコーディングします ExampleChannelHandler はサーバの基本的なルーティングとロジックを実行します最初は通常のアップロードのみをサポートします再開可能なアップロードをサポートするためサーバを変換することは簡単です
まずNIOResumableUpload プロジェクトをダウンロードし依存関係として追加しコードにインポートします次に再開可能なアップロードコンテキストを定義しますこれで再開URLを生成する際どのアップロードエンドポイントを使用するかをハンドラに指示します
最後に現在のハンドラを HTTP ResumableUploadHandlerでラップしますこれにより現在のロジックに基づいて再開可能なアップロード手順が実行されますアップロードごとにランダムで安全な再開URLが生成されこれがアップロードデータに関連付けられます接続が中断された場合ハンドラは部分的なデータを保持し再開可能なすべてのアップロード手順に応答しますワオ！わずか数行のコードで再開可能なアップロードをサポートするためサーバを強化できましたすでにサーバでSwiftを利用している場合はぜひこれを試してみてくださいそしてどなたでもセッションの説明にあるリンクからオープンソースのサンプルコードをチェックしてみてくださいサンプルコードでは新しいHTTPタイプも使用しておりアプリとSwift on Server プロジェクト全体で同じタイプを使用できますこれらのデータ型は SwiftNIOと連携したオープンソースパッケージとしてリリースされました Swiftブログで詳細をチェックしてフィードバックをお寄せください
すでにお気づきかもしれませんが再開可能なアップロードプロトコルは 104ステータスコードを使用した情報応答を利用しています新しいHTTPタイプを使ってサーバ側でこれらの応答を簡単にサポートできますアプリではURLSessionが再開可能なアップロードの 104レスポンスを自動的に処理しますさらにこのたび URLSessionはデリゲートメソッド― didReceiveInformationalResponse を提供するようになりましたこれによりアプリは 102 Processingや 103 Early Hintsなど他の中間応答を処理できるようになります
再開可能なプロトコルはネットワークの中断を軽減し帯域幅を節約する優れた方法ですバックグラウンドURLSessionは大規模なファイル転送処理にも役立ちますユーザーが旅先から巨大な 4K動画をアップロードするとします接続が中断されても可能ならアップロードを再開しますすべてのエラー処理を自分で行うこともできますまたはバックグラウンドで実行させることもできます
サーバがサポートしている場合バックグラウンドではダウンロードタスクとアップロードタスクの両方の再開を自動的に処理します
タスクが中断されるとシステムは間隔をあけてタスクを再開しようとします
タスクを再開できない場合システムは自動的にタスクを最初から再試行します
もしもユーザーが山で携帯の通信範囲を失ったり吹雪でWi-Fiが使えなくなったらバックグラウンドセッションは常に接続を待機するためデバイスが再びインターネットに接続した後タスクがある時点でスケジュールされます
ユーザーはビデオをアップロードしている間アプリやデバイスから離れる可能性がありますユーザーはおそらく他の作業をしている間まだアップロードが続くと期待するかもしれません
これには特にバックグラウンドセッションが必要ですバックグラウンドタスクはシステムによってスケジュールされるためアプリのプロセス外で実行されますつまりアプリがシステムによって一時停止または終了されてもネットワークタスクは確実に継続されます長い時間がかかりアプリを離れても保持する必要がある大規模なファイルの転送にはバックグラウンドセッションを使用します
ユーザーがアプリで最高の体験を得ることができるよう緊急性の低いタスクが後で実行されるようスケジュールすることもできますバックグラウンドセッションを使用するとネットワークアクティビティを効率的にする方法がいくつかありユーザーはリソースを節約できます
すぐに実行する必要がないタスクについてはバックグラウンド設定で isDiscretionaryプロパティを trueに設定することを検討してくださいこれによりシステムがタスクをインテリジェントにスケジュールし「ユーザーがWi-Fiに接続しているか」「デバイスは電源に接続されているか」「ネットワークは制限されているか」などの要素を考慮できるようになりますこれは後の使用のためにアセットをダウンロードしたり夜間のバックアップや分析をアップロードしたりする際に最適なオプションです
低データモードで帯域幅が過剰に使用されるのを防ぐには allowsConstrainedNetworkAccess プロパティを falseに設定します「Advances in Networking」セッションもチェックしてアプリで低データモードをサポートするヒントをご覧ください
バックグラウンドタスクをシステムリソースを使用しない時間に開始するようスケジュールすることもできます深夜は大規模なバックアップなどのタスクを行うのに最適です
システムのスケジューリングをさらに支援するために countOfBytesClientExpectsToSend および受信プロパティを設定できますこれらのプロパティを利用することでシステムがリソースを最適に割り当てられるようになりそのメリットをユーザーに還元できますバックグラウンドセッションはすぐに実行する必要のない大規模なファイル転送やアプリが一時停止されたときに継続の必要がある転送に最適なツールです小規模なタスクやできるだけ早く実行すべきタスクは標準のURLSessionを使用しますアプリに再開機能を導入することでユーザーのネットワークへの信頼性を高めます SwiftNIOとHTTPタイプを確認して Swiftで最高のHTTPエクスペリエンスを作成しましょう大規模なファイル転送にはバックグラウンドセッションを使って下さいユーザーが最も必要とするときに備えてリソースを保存する方法はたくさんありますご視聴ありがとうございます以下の素晴らしいネットワークに関する下記のセッションもぜひチェックしてくださいそれではお疲れ様でした！ ♪ ♪

4:53 - Pausing and resuming a URLSessionDownloadTask

let downloadTask = session.downloadTask(with: request)
downloadTask.resume()

5:21 - Pausing and resuming a URLSessionDownloadTask

let downloadTask = session.downloadTask(with: request)
downloadTask.resume()

guard let resumeData = await downloadTask.cancelByProducingResumeData() else {
    // Download cannot be resumed
    return
}

6:11 - Pausing and resuming a URLSessionDownloadTask

let downloadTask = session.downloadTask(with: request)
downloadTask.resume()

guard let resumeData = await downloadTask.cancelByProducingResumeData() else {
    // Download cannot be resumed
    return
}

let newDownloadTask = session.downloadTask(withResumeData: resumeData)
newDownloadTask.resume()

6:34 - Retrieving resume data on error

do {
    let (url, response) = try await session.download(for: request)
} catch let error as URLError {
    guard let resumeData = error.downloadTaskResumeData else {
        // Download cannot be resumed
        return
    }
}

8:29 - Pausing and resuming a URLSessionUploadTask

let uploadTask = session.uploadTask(with: request, fromFile: fileURL)
uploadTask.resume()

8:37 - Pausing and resuming a URLSessionUploadTask

let uploadTask = session.uploadTask(with: request, fromFile: fileURL)
uploadTask.resume()

guard let resumeData = await uploadTask.cancelByProducingResumeData() else {
    // Upload cannot be resumed
    return
}

8:57 - Pausing and resuming a URLSessionUploadTask

let uploadTask = session.uploadTask(with: request, fromFile: fileURL)
uploadTask.resume()

guard let resumeData = await uploadTask.cancelByProducingResumeData() else {
    // Upload cannot be resumed
    return
}

let newUploadTask = session.uploadTask(withResumeData: resumeData)
newUploadTask.resume()

9:22 - Retrieving resume data on error

do {
    let (data, response) = try await session.upload(for: request, fromFile: fileURL)
} catch let error as URLError {
    guard let resumeData = error.uploadTaskResumeData else {
        // Upload cannot be resumed
        return
    }
}

13:15 - Before resumable uploads in Swift NIO

NIOTSListenerBootstrap(group: NIOTSEventLoopGroup())
    .childChannelInitializer { channel in
        channel.configureHTTP2Pipeline(mode: .server) { channel in
            channel.pipeline.addHandlers([
                HTTP2FramePayloadToHTTPServerCodec(),
                ExampleChannelHandler()
            ])
        }.map { _ in () }
    }
    .tlsOptions(tlsOptions)

14:06 - Add resumable uploads in Swift NIO

import NIOResumableUpload

let uploadContext = HTTPResumableUploadContext(origin: "https://example.com")

NIOTSListenerBootstrap(group: NIOTSEventLoopGroup())
    .childChannelInitializer { channel in
        channel.configureHTTP2Pipeline(mode: .server) { channel in
            channel.pipeline.addHandlers([
                HTTP2FramePayloadToHTTPServerCodec(),
                HTTPResumableUploadHandler(context: uploadContext, handlers: [
                    ExampleChannelHandler()
                ])
            ])
        }.map { _ in () }
    }
    .tlsOptions(tlsOptions)

15:48 - Informational responses in URLSession

protocol URLSessionTaskDelegate : URLSessionDelegate {
    optional func urlSession(_ session: URLSession, task: URLSessionTask,
                             didReceiveInformationalResponse response: HTTPURLResponse)
}

18:19 - Using background URLSession

// Configuring your background session
let configuration = URLSessionConfiguration.background(withIdentifier: "com.example.app")
configuration.isDiscretionary = true
configuration.allowsConstrainedNetworkAccess = false
let session = URLSession(configuration: configuration, delegate: self, delegateQueue: nil)

// Configuring your background task
let backgroundTask = session.uploadTask(with: url, fromFile: fileURL)
backgroundTask.earliestBeginDate = .now.addingTimeInterval(60 * 60)
backgroundTask.countOfBytesClientExpectsToSend = 500 * 1024
backgroundTask.countOfBytesClientExpectsToReceive = 200

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

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

関連する章

リソース

関連ビデオ

WWDC19