一般的な通信でも使える バックグラウンドURLSessionの活用方法 / How to use background URLSession for general network data transfer tasks.

iOSDC Japan 2023
https://fortee.jp/iosdc-japan-2023/proposal/4021be4d-5fd6-4217-b852-c8c91fad7cd6

Transcript

1. Ұൠతͳ௨৴Ͱ΋࢖͑Δ όοΫάϥ΢ϯυURLSessionͷ׆༻ํ๏ iOSDC Japan 2023
2. ࣗݾ঺հ Li Jierong Ϧ έπΤΠ ▸ גࣜձࣾΏΊΈ ▸ iOSϦʔυΤϯδχΞ݉ςοΫϦʔυ ▸ ӬԕʹϦϦʔεͰ͖ͣݸਓ։ൃ ▸ @jierongli@mastodon.social DuckDuckGoGo
3. Ұൠతͳ௨৴Ͱ΋࢖͑ΔόοΫάϥ΢ϯυURLSessionͷ׆༻ํ๏ τϐοΫ ▸ όοΫάϥϯυURLSessionͱ͸ ▸ ϝϦοτͱ׆༻ํ๏ ▸ ࣮૷ͷ۩ମྫ ▸ ࢖༻্ͷ஫ҙࣄ߲
4. όοΫάϥ΢ϯυ URLSessionͱ͸
5. όοΫάϥ΢ϯυURLSessionͱ͸ URLSessionͱ͸ ▸ An object that coordinates a group of related, network data transfer tasks. ▸ ωοτϫʔΫ௨৴ʹ͓͍ͯෆՄܽͳ΋ͷɻ ▸ AlamofireͳͲͷωοτϫʔΫ௨৴ϥΠϒϥϦʔ͸͋͘·ͰURLSessionͷϥο ύʔɻ
6. όοΫάϥ΢ϯυURLSessionͱ͸ όοΫάϥ΢ϯυͱ͸ URLSessionConfigurationʹ͸ࡾͭͷछྨ͕͋Δɻ ▸ defaultɺephemeral ▸ ΞϓϦͱಉ͡ϓϩηεͰ࣮ߦ͞ΕΔɻ ▸ background ▸ ผϓϩηεͰ࣮ߦ͞ΕΔɻ
7. όοΫάϥ΢ϯυURLSessionͱ͸ όοΫάϥ΢ϯυͱ͸ Suspend Foreground runtime Suspend Background runtime System Background URLSession request URLSession response
8. όοΫάϥ΢ϯυURLSessionͱ͸ ओཁͳ༻్ σʔλྔ͕େ͖͍௨৴ʹ࢖༻͞ΕΔɻ ▸ ͕͔͔࣌ؒΔ௨৴ͩͱϢʔβʔʹϑΥΞάϥ΢ϯυͰ଴ͨͤΔΘ͚ʹ͸͍͔ͳ ͍ɻ ▸ URLSessionConfiguration.background(withIdentifier:)ͷυΩϡϝϯτʹݴٴ͞ Εͨ།Ұͷྫɿ ▸ Downloading Files in the Background
9. ϝϦοτͱ ׆༻ํ๏
10. ϝϦοτͱ׆༻ํ๏ ϝϦοτ ผϓϩηεͰ࣮ߦ͞ΕΔ͜ͱʹΑΓɺԼهͷ໰୊͕ճආͰ͖Δɻ ▸ iOSΞϓϦ͕όοΫάϥ΢ϯυʹ͋Δ࣌ʹɺURLSession͕ΞϓϦϓϩηεͱͱ΋ ʹҰ࣌ఀࢭ͞ΕΔɻ ▸ ϑΥΞάϥ΢ϯυʹ໭ͬͯ΋ɺλΠϜΞ΢τʹΑΔΤϥʔ͕ൃੜɻ ▸ ϝϞϦෆ଍ͳͲͷݪҼͰɺόοΫάϥ΢ϯυʹ͋ΔΞϓϦ͕iOSʹऴྃ͞Εͨ৔ ߹ɺதࢭ͞ΕΔɻ
11. ϝϦοτͱ׆༻ํ๏ ϝϦοτ γεςϜঢ়ଶΛ؂ࢹ͠ɺ࠷దͳߦಈΛͯ͘͠ΕΔɻ ▸ σϑΥϧτ ▸ ઀ଓঢ়گ ▸ ࣗಈϦτϥΠ ▸ isDiscretionary == true ▸ όοςϦʔ࢒ྔ ▸ ଳҬ෯ʢ௨৴࿏༰ྔʁʣ
12. ϝϦοτͱ׆༻ํ๏ ϝϦοτ Background TasksϑϨʔϜϫʔΫͱҧ͍ɺԼهͷ੍ݶ͕ͳ͍ɻ ▸ Capabilitiesͷొ࿥͕ඞਢɻ ▸ Ϣʔβʔͷઃఆ΍௿ిྗϞʔυʹΑΓɺڧ੍తʹແޮԽ͞ΕΔ͜ͱ͕͋Δɻ ▸ όοΫάϥ΢ϯυͰ࣮ߦՄೳͷ͕࣌ؒෆఆɻ
13. ϝϦοτͱ׆༻ํ๏ ׆༻ํ๏ ϑΥΞάϥ΢ϯυͰ଴ͭ࣌ؒͷ࡟ݮʹ໾ཱͭɻ ▸ ৘ใͷࣄલऔಘ ▸ iOSDC Japan 2021ɿWidgetKitͰྑ͍ମݧΛ࡞Δʹ͸ ▸ BGAppRefreshTaskͷ୅ସ
14. ׆༻ํ๏ BGAppRefreshTaskͷ୅ସ Suspend Foreground runtime Background runtime System Request App refresh for soon URLSession response Suspend App refresh task URLSession request
15. ׆༻ํ๏ BGAppRefreshTaskͷ୅ସ Suspend Foreground runtime Background runtime System Background URL Session request for soon URLSession response Suspend
16. ϝϦοτͱ׆༻ํ๏ ׆༻ํ๏ ϑΥΞάϥ΢ϯυͰ଴ͭ࣌ؒͷ࡟ݮʹ໾ཱͭɻ ▸ ৘ใͷࣄલऔಘ ▸ iOSDC Japan 2021ɿWidgetKitͰྑ͍ମݧΛ࡞Δʹ͸ ▸ BGAppRefreshTaskͷ୅ସ ▸ λΠϜΞ΢τ΍தࢭͷճආ ▸ beginBackgroundTask(withName:expirationHandler:)ͷԆ௕ ▸ BGAppRefreshTaskͷԆ௕
17. ׆༻ํ๏ BGAppRefreshTaskͷԆ௕ Background runtime System Suspend App refresh task URLSession request URLSession response
18. ׆༻ํ๏ BGAppRefreshTaskͷԆ௕ Background runtime System Suspend Suspend App refresh task URLSession request Background URLSession request Low runtime signal URLSession response
19. ࣮૷ͷ۩ମྫ
20. ࣮૷ͷ۩ମྫ όοΫάϥ΢ϯυURLSessionΛ׆༻ͨ͠ ͍͚Ͳɺcompletion handler෇͖ͷAPI͕࢖͑ ͣɺ࢖͍উख͕ѱ͍ɻ
21. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ public final class BackgroundSessionTaskManager: NSObject { public typealias CompletionHandler = (Result<(Data, HTTPURLResponse), Error>) -> Void private var session: URLSession! private var tasks: [Int: TaskWrapper] = [:] public init(sessionIdentifier: String) { super.init() self.session = .init( configuration: .background(withIdentifier: sessionIdentifier), delegate: self, delegateQueue: nil ) } func makeTask(with request: URLRequest, completionHandler: CompletionHandler?) -> URLSessionDownloadTask { precondition(request.url?.scheme == "https") let task = session.downloadTask(with: request) tasks[task.taskIdentifier] = TaskWrapper(task: task, completionHandler: completionHandler) return task } }
22. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ private struct TaskWrapper { let wrappedValue: URLSessionDownloadTask let completionHandler: CompletionHandler? var fileReadResult: Result<Data, Error>? init( task: URLSessionDownloadTask, completionHandler: CompletionHandler? ) { self.wrappedValue = task self.completionHandler = completionHandler } }
23. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ extension BackgroundSessionTaskManager: URLSessionDownloadDelegate { public func urlSession( _ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL ) { let key = downloadTask.taskIdentifier guard var task = tasks[key] else { return } task.fileReadResult = .init { try Data(contentsOf: location) } tasks[key] = task } }
24. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ extension BackgroundSessionTaskManager: URLSessionTaskDelegate { public func urlSession( _ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error? ) { guard let task = tasks.removeValue(forKey: task.taskIdentifier), let completionHandler = task.completionHandler else { return } do { if let error = error { throw error } else if let response = task.wrappedValue.response as? HTTPURLResponse { let data = try task.fileReadResult?.get() ?? .init() completionHandler(.success((data, response))) } else { throw BackgroundSessionTaskError.invalidResponse } } catch { completionHandler(.failure(error)) } } }
25. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ let task = manager.makeTask(with: request) { result in // ... } task.earliestBeginDate = Date(timeIntervalSinceNow: 60 * 60) task.resume()
26. ࣮૷ͷ۩ମྫ ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ ▸ UIKitͷ৔߹ ▸ SwiftUIͷ৔߹ ▸ Widget extensionͷ৔߹
27. ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ UIKitͷ৔߹ public let manager = BackgroundSessionTaskManager(sessionIdentifier: "MySession") class AppDelegate: NSObject, UIApplicationDelegate { func application( _ application: UIApplication, handleEventsForBackgroundURLSession identifier: String ) async { await manager.waitUntilEventDeliveryFinished() } }
28. ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ SwiftUIͷ৔߹ public let manager = BackgroundSessionTaskManager(sessionIdentifier: "MySession") @main struct PlaygroundApp: App { var body: some Scene { WindowGroup { ContentView() } .backgroundTask(.urlSession) { _ in await manager.waitUntilEventDeliveryFinished() } } }
29. ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ Widget extensionͷ৔߹ struct MyWidget: Widget { let kind: String = "MyWidget" var body: some WidgetConfiguration { StaticConfiguration(kind: kind, provider: Provider()) { entry in WidgetEntryView(entry: entry) .containerBackground(.fill.tertiary, for: .widget) } .configurationDisplayName("My Widget") .description("This is an example widget.") .backgroundTask(.urlSession) { identifier in let manager = BackgroundSessionTaskManager(sessionIdentifier: identifier) await manager.waitUntilEventDeliveryFinished() } } }
30. ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ Widget extensionͷ৔߹ struct MyWidget: Widget { let kind: String = "MyWidget" var body: some WidgetConfiguration { StaticConfiguration(kind: kind, provider: Provider()) { entry in WidgetEntryView(entry: entry) .containerBackground(.fill.tertiary, for: .widget) } .configurationDisplayName("My Widget") .description("This is an example widget.") .onBackgroundURLSessionEvents { identifier, completion in Task { let manager = BackgroundSessionTaskManager(sessionIdentifier: identifier) await manager.waitUntilEventDeliveryFinished() completion() } } } }
31. ࣮૷ͷ۩ମྫ ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ extension BackgroundSessionTaskManager: URLSessionDelegate { public func urlSessionDidFinishEvents( forBackgroundURLSession session: URLSession ) { eventDeliveryCompletionHandler?() eventDeliveryCompletionHandler = nil } public func waitUntilEventDeliveryFinished() async { await withCheckedContinuation { eventDeliveryCompletionHandler = $0.resume } } }
32. ࣮૷ͷ۩ମྫ ϝϞϦ্ʹอ͍࣋ͯ͠Δtasks͸Ξϓ Ϧ͕ऴྃ͞ΕͨΒফ͑ͳ͘ͳ͍ʁ
33. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ extension BackgroundSessionTaskManager: URLSessionDownloadDelegate { public func urlSession( _ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL ) { let key = downloadTask.taskIdentifier guard var task = tasks[key] else { return } task.fileReadResult = .init { try Data(contentsOf: location) } tasks[key] = task } }
34. ࣮૷ͷ۩ମྫ DelegateͰ݁ՌΛड͚औΔ extension BackgroundSessionTaskManager: URLSessionDownloadDelegate { public func urlSession( _ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL ) { let key = downloadTask.taskIdentifier var task = tasks[key, default: .init(task: downloadTask, completionHandler: nil)] task.fileReadResult = .init { try Data(contentsOf: location) } tasks[key] = task } }
35. ࣮૷ͷ۩ମྫ ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ extension BackgroundSessionTaskManager: URLSessionTaskDelegate { public func urlSession( _ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error? ) { guard let task = tasks.removeValue(forKey: task.taskIdentifier), let completionHandler = task.completionHandler else { return } do { if let error = error { throw error } else if let response = task.wrappedValue.response as? HTTPURLResponse { let data = try task.fileReadResult?.get() ?? .init() completionHandler(.success((data, response))) } else { throw BackgroundSessionTaskError.invalidResponse } } catch { completionHandler(.failure(error)) } } }
36. ࣮૷ͷ۩ମྫ ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ guard let task = tasks.removeValue(forKey: task.taskIdentifier), let completionHandler = task.completionHandler else { return }
37. ࣮૷ͷ۩ମྫ ΞϓϦ͕Ұ࣌ఀࢭɾऴྃ͞Εͨ৔߹ let task = tasks.removeValue(forKey: task.taskIdentifier) ?? .init(task: task, completionHandler: nil) let completionHandler = task.completionHandler ?? { result in var userInfo = [TaskDidCompleteNotification.UserInfoKey: Any]() userInfo[.description] = task.wrappedValue.taskDescription userInfo[.result] = result NotificationCenter.default.post( name: TaskDidCompleteNotification.name, object: self, userInfo: userInfo ) }
38. ࣮૷ͷ۩ମྫ BGAppRefreshTaskͷ֦ு .backgroundTask(.appRefresh("WEATHER_DATA")) { let (data, response) = try? await URLSession.shared.data(for: request) // ... }
39. ࣮૷ͷ۩ମྫ BGAppRefreshTaskͷ֦ு .backgroundTask(.appRefresh("WEATHER_DATA")) { let request = URLRequest(url: WEATHER_URL) await withTaskCancellationHandler { let (data, response) = try? await URLSession.shared.data(for: request) // ... } onCancel: { manager.makeTask(with: request, completionHandler: nil) .resume() } }
40. ࢖༻্ͷ஫ҙࣄ߲
41. ࢖༻্ͷ஫ҙࣄ߲ ݶఆతʹ࢖༻ ผϓϩηεʹ࣮ߦ͞ΕΔͨΊɺΦʔόϔου͕ଘࡏɻ ▸ ओཁͳ༻్ ▸ σʔλྔ͕େ͖͍௨৴ ▸ ׆༻ํ๏ ▸ ৘ใͷࣄલऔಘ ▸ λΠϜΞ΢τ΍தࢭͷճආ
42. ࢖༻্ͷ஫ҙࣄ߲ ಈ࡞֬ೝ ▸ exit(0)Ͱऴྃɻ ▸ task.resume()௚ޙͰ΋໰୊ͳ͍ɻ ▸ Proxyman΍CharlesͳͲͷπʔϧͰ௨৴Λ؍࡯ɻ ▸ Wait for the executable to be launchedɻ
43. ࢖༻্ͷ஫ҙࣄ߲ ੍ݶ ▸ Delegate͕ඞਢɻ ▸ HTTP௨৴͔͠αϙʔτ͞Εͳ͍ɻ ▸ ϦμΠϨΫτ͸ৗʹڐՄ͞ΕΔɻ ▸ Upload taskΛ࢖͏৔߹ɺϑΝΠϧ͔ΒͷΞοϓϩʔυ͢Δඞཁ͕͋Δɻ
44. ·ͱΊ ▸ ϑΝΠϧμ΢ϯϩʔυҎ֎ʹ΋όοΫάϥ΢ϯυURLSessionΛ׆༻Ͱ͖Δɻ ▸ ޻෉͢Ε͹ϑΥΞάϥ΢ϯυURLSessionͱಉ͡࢖͍উखʹͳΕΔɻ ▸ ผϓϩηεͰ࣮ߦ͞ΕΔͨΊɺบ͕͋Γɺ੍ݶ΋ଟ͍ɺཁ஫ҙɻ
45. ࢀߟ ▸ WWDC14: What’s New in Foundation Networking ▸ WWDC19: Advances in App Background Execution ▸ WWDC22: Efficiency awaits: Background tasks in SwiftUI ▸ Swift Package Manager: URLSessionHTTPClient ▸ URLSession: Common pitfalls with background download & upload tasks ▸ iOSDC Japan 2021ɿWidgetKitͰྑ͍ମݧΛ࡞Δʹ͸