SwiftUIアプリでバックグラウンドタスクの実行(ネットワーク、プッシュ通知) (BackgroundTasks, URLSession) #QiitaEngineerFesta2022

本記事で使用している画像の一部は、WWDCのセッションビデオより引用しています。

iOS 16の新しいビューモディファイアで、SwiftUIで簡単にバックグラウンドタスクを実行することができるようになりました。

バックグラウンドタスク (BackgroundTasks) とは

バックグラウンドタスクは、アプリケーションがアクティブに実行されていないときに実行されます。
この記事では、アプリ内のデータを再読み込みする（次の通知やウィジェットの再読み込みなどのスケジュールも設定する）ために使用される、リフレッシュバックグラウンドタスク (.refresh) について説明します。

通常のフロー

上のグラフで、青い長方形はフォアグラウンドのアプリ、灰色の長方形はバックグラウンドのアプリ、緑はシステムを表しています。

フォアグラウンド (Foreground runtime) のアプリが一時停止すると、正午 (noon) にアプリの更新を要求することができます。正午になると、システム (System) はバックグラウンド (Background runtime) でアプリを起動し、タスクを実行します。このグラフでは、アプリがURLのリモートデータリクエスト (URL Session request) を送信しています。そして、更新タスクのバックグラウンド時間が終了したため、バックグラウンドタスクが終了 (Suspend) します。その後、しばらくして、URLリモートデータリクエストが応答を返すと、システムは再びバックグラウンドのアプリを起動させます (URLSession response)。このとき、アプリはローカル通知を送信する (Send notification) ようにスケジューリングすることができます。

通常のユースケース

例えば、このデモプロジェクトはQiita.comのホームページをチェックして、Swiftキーワードがあるかどうかを確認します。もしあれば、ローカルにプッシュ通知を送ります。

アプリのインターフェイスを更新するためにリモートからデータを取得したり、ユーザーにプッシュ通知を送信するためにリフレッシュタスクを使用することができます。

制限事項

リフレッシュバックグラウンドタスクは最大1つまで利用可能です。各バックグラウンドタスクには、実行時間（1分以内）が設定されています。この時間を超えると、システムはそのプロセスを終了させます。

システムのバッテリーが低下したとき、またはユーザーがアプリ・スイッチャーでアプリを閉じたときは、バックグラウンド・タスクは実行されません。

ユーザーがアプリを最初にインストールしたとき、通常は最初のバックグラウンド・タスクをスケジュールします。そして、最初のバックグラウンドタスクが実行され始めると、次のタスクがスケジュールされます。

エンタイトルメントを追加する

まず、Background Modes (Background fetch, Background Processing)エンタイトルメントを追加します。

次に、タスクの識別子を定義します。
Info.plistで、BGTaskSchedulerPermittedIdentifiersという名前の新しい配列エントリを作成し、識別子の値を設定します。

ユーザーがバックグラウンド再読み込みを許可しているかどうかを確認する

ユーザーは、アプリごとにバックグラウンド再読み込み機能のオン／オフを切り替えることができます。
許可しているかどうかを確認することができます。

NSProcessInfo.processInfo.backgroundRefreshStatus

バックグラウンドタスクの予約 (スケジュール)

バックグラウンドタスクをスケジュールするには、バックグラウンドタスクが実行される時刻を定義する必要があります。
この時刻はタスクが実行される最も早い時刻 (earliest begin date) を意味することに注意してください。
タスクが実行される正確な時間ではありません。
定義された時間の後、システムがタスクを実行する時間を決定します。

通常、iOS 16 beta 2のテストでは、タスクはスケジュールされた時間の30分後と1時間後に実行されます。
シミュレータでバックグラウンドのアクティビティをテストすることはできませんので、ご注意ください。

// import BackgroundTasks
if let scheduledTime = Calendar.current.date(byAdding: .second, value: 10, to: Date()) {
    let request = BGAppRefreshTaskRequest(identifier: "com.test.test.appRefreshTest")
    request.earliestBeginDate = scheduledTime
    do {
        try BGTaskScheduler.shared.submit(request)
    } catch {
        // Handle errors here...
    }
}

上記のように、まず BGAppRefreshTaskRequest オブジェクトを識別子で初期化します。次に、earliestBeginDate変数を用いて、最も早い開始日を指定します。
次に、 BGTaskScheduler.shared.submit(request) を使ってタスクをスケジュールします。

バックグラウンドタスクのリストアップ

BGTaskScheduler.shared.getPendingTaskRequests` 関数を使うと、スケジュールされているすべてのバックグラウンドタスクをリストアップすることができます。

BGTaskScheduler.shared.getPendingTaskRequests { requests in
    DispatchQueue.main.async {
        self.allUpdateRequests = requests
    }
}

また、Swiftの新しいasyncを使って、上記のコードを書くことができます。

Task {
    let allRequests = await BGTaskScheduler.shared.pendingTaskRequests()
    print(allRequests)
}

バックグラウンドタスクが実行されると、そのタスクは保留中のリクエストリストから削除されます。
リクエストがまだリストに残っている場合は、システムがまだそのタスクの実行を決定していないことを意味します。

スケジュールされたタスクの削除

スケジュールされたタスクはすべて削除することができます。

BGTaskScheduler.shared.cancelAllTaskRequests()

また、特定の識別子を持つスケジュールタスクの削除も可能です。

BGTaskScheduler.shared.cancel(taskRequestWithIdentifier: "com.test.test.appRefreshTest")

(>iOS 16 のみ) バックグラウンドタスクのために実行するコードを追加する

SwiftUI アプリの @main コードで、WindowGroup ビューのための .backgroundTask ビューモディファイアを追加します。

@main
struct BackgroundTaskSwiftUIDemoApp: App {
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .backgroundTask(.appRefresh("com.test.test.appRefreshTest")) {
            await scheduleTestNotification()
            await DataFetchHelper.shared.startRequestingRemoteData()
        }
    }
    
}

ビュー修飾子 .backgroundTask を初期化するために、バックグラウンドタスクの種類を定義します。アプリのリフレッシュタスクには .appRefresh を、バックグラウンドのURLセッションには .urlSession を定義できます。内カッコの中には、識別子を記述します。

.backgroundTaskビューモディファイアを選択的に適用

.backgroundTask` ビュー修飾子は iOS 16 以降のシステムでのみ利用可能です。
このビュー修飾子をオプションで適用することで、アプリがiOS 16の新機能を試しつつ、iOS 15や他のシステムとの互換性も維持することができます。

extension Scene {
    func backgroundTaskIfAvailable(_ taskIdentifier: String, action: @Sendable @escaping () async -> Void) -> some Scene {
        if #available(iOS 16.0, *) {
            return self
                .backgroundTask(.appRefresh(taskIdentifier), action: action)
        } else {
            return self
        }
    }
}

上記のコードは、iOS 16がインストールされている場合にのみ .backgroundTask を適用します。

注意: このビュー修飾子をオプションで適用した場合、古いiOSシステムでもバックグラウンドタスクを実行したいのであれば、バックグラウンドタスクのコードブロックを定義する必要があります (次のセクションを参照)。

(互換性) 背景タスクを実行するためのコードブロックを定義する

バックグラウンドタスクのコードを古いiOSシステムと互換性のあるものにしたい場合、アプリが起動する前にAppDelegateにブロックを定義します。

BGTaskScheduler.shared.register(forTaskWithIdentifier: <#T##String#>, using: <#T##DispatchQueue?#>, launchHandler: <#T##(BGTask) -> Void#>)

バックグラウンド・ネットワーク (URLSession)

URLSessionConfiguration.background 設定を使用すると、バックグラウンドでのネットワーク呼び出しを行うことができます。ここでは、バックグラウンドでのネットワークリクエストを行うためのヘルパーを作成します。

import Foundation

class DataFetchHelper: NSObject, URLSessionDownloadDelegate {
    
    static let shared = DataFetchHelper(backgroundTaskIdentifier: "com.test.test.fetchRemoteData")
    
    private var urlSession: URLSession?
    
    init(backgroundTaskIdentifier: String) {
        super.init()
        let config = URLSessionConfiguration.background(withIdentifier: backgroundTaskIdentifier)
        config.sessionSendsLaunchEvents = true
        self.urlSession = URLSession(configuration: config, delegate: self, delegateQueue: nil)
    }
    
    func startRequestingQiitaWebsite() {
        let request = URLRequest(url: URL(string: "https://qiita.com")!)
        let task = urlSession?.downloadTask(with: request)
        task?.resume()
    }
    
    func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
        if let textData = try? String(contentsOf: location, encoding: .utf8) {
            print(textData)
        }
    }
    
}

ネットワーク要求が短時間で完了した場合は、すぐに結果を取得して処理する必要があります。

そうでない場合は、バックグラウンドで作業を続けるためにネットワーク呼び出しを拒否し、sessionSendsLaunchEventsを定義したので（ダウンロードが完了したらバックグラウンドアプリが起動するという意味）、ダウンロードイベントが完了したらイベントを受信することができます。

@main
struct BackgroundTaskSwiftUIDemoApp: App {
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .backgroundTask(.appRefresh("com.test.test.appRefreshTest")) {
            scheduleTestNotification()
            DataFetchHelper.shared.startRequestingQiitaWebsite()
        }
+        .backgroundTask(.urlSession("com.test.test.fetchRemoteData")) { item in
+            _ = DataFetchHelper.shared
+        }
    }
    
}

デモプロジェクトを実行すると、以下のようになります。30分ほど待つと、バックグラウンドタスクが実行されます。

ここで、バックグラウンドダウンロードが完了したことがアプリに通知されたら、タスクをダウンロードしたときと同じパラメータでURLSessionを初期化する必要があります。(上記のサンプルコードでは、DataFetchHelperを初期化していますが、これも同じように行います)

システムは、それが同じURLセッションであることを認識します。したがって、デリゲート関数 func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) は自動的にダウンロード済みのデータで呼び出されるはずです。

古いバージョンのシステムでは、アプリはAppDelegateを通じてバックグラウンドタスクが完了したことを通知されます。

func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void)

SwiftUIアプリを使用している場合、AppDelegateアダプタを追加することができます。

デモコード

Xcode 13を使って、このアプリをデバイス上で実行してみてください。最初のボタンをクリックして、バックグラウンドタスクをスケジュールします。
そして、Xcodeを開き、iPhoneを接続し、debuggerを開いたままにしておきます。
アプリをバックグラウンドにスワイプして、それから待ってください。
約30分後、コンソールにログが表示され、バックグラウンドタスクが実行されたことを示すプッシュ通知が表示されるはずです）。

注意：ブレークポイントを見続ける必要があります。バックグラウンドタスクの実行時間は約1分に制限されているため、ブレークポイントを遅くまで続けると、バックグラウンドプロセスがすでに終了している可能性があります。

お読みいただきありがとうございました。