[SwiftUI] アプリの状態を表す ScenePhase

環境＆対象

ScenePhase

SwiftUI で Scene の状態を表す型として使用されます。

参考
ScenePhaseApple Developer Documentation

enum として定義されていて 値としては以下を取り得ます。
・active
・inactive
・background

それぞれ以下のような意味です（意訳)。

active

フォアグラウンドで動作していて操作可能状態

inactive

フォアグラウンドで動作しているが、停止中

background

UI には表出していない状態

SwiftUI で ScenePhase を参照する

Scene は、SwiftUI の View からは、以下のように Environment の１つとして参照できるようになっています。

@Environment(\.scenePhase) private var scenePhase

たとえば、scenePhase が変わるごとに 何か処理をするのであれば 以下のようになります。

import SwiftUI

@main
struct MyApp: App {
    @Environment(\.scenePhase) var scenePhase

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .onChange(of: scenePhase, {
           // process something
        })
    }
}

ScenePhase を使うケース１例

ScenePhase は アプリの状態を表現しているので、さまざまなケースで使用されそうです。

以下では、１つの例として AppTransparancyTracking の 許諾ダイアログを出すときを考えます。

許諾ダイアログは、ATTrackingManager.requestTrackingAuthorization という API を使用して表示します。

参考
requestTrackingAuthorization(completionHandler:)Apple Developer Documentation

ドキュメントにも記載されていますが、この API は、アプリケーションの状態が、Active のときに呼び出すことが必要です。

ドキュメントでは、UIApplicationStateActive で説明されていますが、用意されている状態から考えても、scenePhase も UIApplicationStateActive と同じ様に更新されるように思えます。（ドキュメントでの説明はありません）

以下のようにすることで、許諾ダイアログを表示することができるようになります。

@main
struct MyApp: App {
    @Environment(\.scenePhase) var scenePhase

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .onChange(of: scenePhase, initial: true, {
            if scenePhase == .active {
                Task { @MainActor in
                    let state = await ATTrackingManager.requestTrackingAuthorization()
                    // process along state
                }
            }
        })
    }
}

以前は、UIApplicationDelegate を指定して applicationDidBecomeActive を使わないと実装できなかったことも、scenePhase を使うことで、
UIApplicationDelegate なしで できるようになりました。

まとめ

SwiftUI で アプリの状態を表す ScenePhase

説明は以上です。
不明な点やおかしな点ありましたら、こちらまで。

SwiftUI おすすめ本

SwiftUI を理解するには、以下の本がおすすめです。

SwiftUI 徹底入門

＃ SwiftUI は、毎年大きく改善されていますので、少し古くなってしまいましたが、いまでも 定番本です。

Swift学習におすすめの本

詳解Swift

Swift の学習には、詳解 Swift という書籍が、おすすめです。

著者は、Swift の初期から書籍を出していますし、Swift の前に主力言語だった Objective-C という言語についても同様の書籍を出しています。

最新版を購入するのがおすすめです。

現時点では、上記の Swift 5 に対応した第５版が最新版です。

関連記事:

[SwiftUI] Scene まとめ(WWDC22) [SwiftUI] commands Modifier @SwiftUI(2024) [SwiftUI] appDelegate を使ってイベント対応する方法 [SwiftUI] @Entry の使い方