More than 3 years have passed since last update.

Background Task Completion

Last updated at 2020-03-18Posted at 2020-03-13

この記事は

iOSで利用可能なバックグラウンド処理の1つである「BackgroundTaskCompletion」についてのまとめと挙動の検証

機能概要

特徴
- フォアグラウンドでやり残した作業をバックグラウンド状態でも引き継いで実行させることが可能
  - バックグラウンドタスクを開始するのではなく、フォアグラウンドの処理を中断せずに実行させ続けるもの
  - 主にユーザー起動のリクエストが当てはまる
- アプリが停止する前にバックグラウンドで動く時間をAppに与えることができる
- ユーザーによりアプリがkillされた場合は実行はキャンセルされる
実行可能時間
- 最大実行時間については明記されていないが、環境によって変わるらしい
  - UIApplication.shared.backgroundTimeRemaining で取得できる
  - 検証環境（iPhone11Pro iOS13）では30secだった
- 長時間に及ぶタスクには向かない
所感
- メッセージ送信中にバックグラウンドにされた場合などで、送信処理が完了させるまで少しの実行時間を与えたい場合みたいなケースに有効

イメージ

サンプルコード

実装概要

BackgroundTaskCompletionは UIApplication.shared.beginBackgroundTask で起動することができる。
これにより現在フォアグラウンドで動いている処理を、バックグラウンドに移行しても一定の時間動作させ続けることが可能となる。

また、処理の完了後は、 endBackgroundTask を呼び出すことで処理を停止させることができる。
これが呼び出されないままバックグラウンドでの最大実行可能時間を過ぎてしまった場合、beginBackgroundTaskに渡してある expirationHandler が呼び出される。
（不要なリソースが使用され続けることを防ぐために、endBackgroundTaskを適切に呼ぶことが推奨されている。）
ここで各種キャンセル処理やユーザーへのフィードバックなどを行うことになる。

細かい内容はサンプルコード内にコメントとして記載しているが、以下に重要な部分のみ抜粋。

let taskIdentifier = UIApplication.shared.beginBackgroundTask(expirationHandler: {
    self.cancellables.forEach { $0.cancel() }
    NotificationHelper.postLocalNotification(with: Message(body: "処理が完了しませんでした"))
})

sampleRepository.post(processTime: 10)
    .sink(receiveCompletion: { (result) in
        switch result {
        case .finished:
            break
        case .failure:
            NotificationHelper.postLocalNotification(with: Message(body: "処理が失敗しました"))
            UIApplication.shared.endBackgroundTask(taskIdentifier)
        }
    }) { _ in
        NotificationHelper.postLocalNotification(with: Message(body: "処理が成功しました"))
        UIApplication.shared.endBackgroundTask(taskIdentifier)
    }.store(in: &cancellables)