SwiftUIでの@Environment — 定義、主な概念とメカニズム

SwiftUIでの@Environmentとは?

@Environmentは、システム環境から値を読み取るために設計されたSwiftUIのproperty wrapperです。環境は、SwiftUIが親Viewから子Viewへ自動的に伝播する値の階層的コンテナです。それぞれの環境値は、EnvironmentKeyプロトコルに従うタイプであるキーによって識別されます。

環境の仕組みは、フレームワークレベルでの依存性インジェクションに類似しています。システムは事前定義された値のセットを提供します — カラースキーム（ライト/ダーク）、ロケール、フォントサイズ、Core Data用のmanagedObjectContext、画面を閉じるためのdismiss、その他多数。特定のキーで@Environmentを宣言したViewは、現在の値を自動的に取得し、それが変わったときに再描画されます。

SwiftUI環境アーキテクチャは、EnvironmentValuesプロトコルに基づいています — すべてのシステム値を含む構造体です。それぞれの値は、getterとsetterを持つこの構造体のプロパティとして格納されます。@Environmentは、特定のプロパティにアクセスするためにkey pathを使用します: @Environment(\.colorScheme) — カラースキームへのアクセス、@Environment(\.locale) — ロケールへのアクセス。

Property Wrapperとしての@Environment

Property wrapper @Environmentは、2つの主な仕組みを実装しています: 環境から値を読み取り、その変化にサブスクライブすること。Viewが作成されると、SwiftUIはすべての@Environmentプロパティを経由し、現在のコンテキストから対応する値にリンクします。親Viewが.environment()修飾子を通じて値を変更すると、その値を読むすべての子Viewが自動的に再描画されます。

重要な機能: @Environmentはオプショナル値をサポートしています。階層で値が設定されていない場合、EnvironmentKeyで定義されたデフォルト値が返されます。システムキーの場合、デフォルト値はいつも合理的です — 例えば、デフォルトのカラースキームは.lightです。カスタムキーの場合、開発者がEnvironmentKeyプロトコルのdefaultValueメソッドでデフォルト値を定義します。

struct EnvironmentReaderView: View {
    @Environment(\.colorScheme) var colorScheme
    @Environment(\.locale) var locale
    @Environment(\.sizeCategory) var sizeCategory

    var body: some View {
        VStack {
            Text("Current scheme: \(colorScheme == .dark ? "Dark" : "Light")")
            Text("Locale: \(locale.identifier)")
            Text("Font size: \(sizeCategory)")
        }
    }
}

例では、Viewが3つのシステム環境値を読み取っています。colorSchemeが変わったとき — 例えば、ユーザーが設定でダークモードを有効にしたとき — Viewは新しい値で自動的に再描画されます。同様に、地域やフォントサイズ（Dynamic Type）が変わった場合も同じです。Viewは通知にサブスクライブしたり、refreshをコールする必要がありません — SwiftUIがこれを自動的に管理します。

システム環境値

SwiftUIは、インタフェースと動作のさまざまな要素をカバーする数十のシステム環境値を提供しています。カラースキーム (\.colorScheme)は、ライトモードとダークモードにインタフェースを適応させることができる、もっともよく使われる値の1つです。ロケール (\.locale)には、日付、数値、通貨のフォーマットのためのユーザーのローカル設定が含まれます。

Core Dataでは、managedObjectContext (\.managedObjectContext)が使用されます — パーシステンスコンテナから環境を通じて渡されるコンテキストです。ナビゲーションには、現在の画面を閉じるためのdismiss (\.dismiss)と、モーダル表示のためのisPresented (\.isPresented)が利用可能です。カレンダーとタイムゾーンには — それぞれcalendarとtimeZoneがあります。

システム値にアクセスするには、ドットでkey pathを使用します: @Environment(\.dismiss) var dismiss。コンパイラはEnvironmentValuesでのkey pathの存在を確認するため、間違ったキーはコンパイルタイムエラーを引き起こします。Appleは、iOSのバージョンごとに新しいシステム値を追加しています — 完全なリストはEnvironmentValuesドキュメンテーションで確認できます。

@Environment vs @EnvironmentObject

同じような名前にもかかわらず、@Environmentと@EnvironmentObjectは異なる目的を持ちます。@Environmentは、EnvironmentKeyを通じて登録されたシステムまたはカスタム値を読み取ります。@EnvironmentObjectは、明示的なキーなしで、タイプによって環境を通じて渡されるObservableObjectのproperty wrapperです。

@EnvironmentObjectは依存性インジェクションに使用されます: 親Viewがオブジェクト（例: ViewModel）を作成し、.environmentObject()修飾子を通じて子Viewに渡します。子Viewは@EnvironmentObjectを通じて受け取り、そのプロパティを読み取ったり変更したりできます。一方、@Environmentはシステム値のための読み取り専用であり、フィードバックをサポートしていません。

実務上: システムパラメータ（モード、ロケール、フォントサイズ）およびランタイムで変わらないカスタム設定にアクセスするには@Environmentを使用します。子コンポーネントから状態を変更する必要がある場合、View階層を通じてViewModelまたはサービスを渡すには@EnvironmentObjectを使用します。

@Environmentコード例

カスタム環境値の作成を見てみましょう。これには、EnvironmentKeyプロトコルに従う構造体を定義し、EnvironmentValuesを新しいプロパティで拡張する必要があります。これにより、プロパティを使わずに、アプリケーション設定やテーマ設定をViewツリー全体に渡すことができます。

struct AppThemeKey: EnvironmentKey {
    static let defaultValue: AppTheme = .system
}

extension EnvironmentValues {
    var appTheme: AppTheme {
        get { self[AppThemeKey.self] }
        set { self[AppThemeKey.self] = newValue }
    }
}

enum AppTheme { case system, light, dark }

EnvironmentKeyプロトコルは、静的プロパティdefaultValueの実装を必要とします — これは、親Viewがカスタム環境を設定していない場合に使用される値です。EnvironmentValuesを拡張すると、キーでsubscriptを使用して、計算プロパティappThemeが追加されます。これにより、どのViewでも@Environment(\.appTheme)を通じて値を読み取ることができます。

カスタムキーでの@Environmentの使用

struct ThemedView: View {
    @Environment(\.appTheme) var appTheme
    @Environment(\.colorScheme) var colorScheme

    var body: some View {
        VStack {
            if appTheme == .dark || (appTheme == .system && colorScheme == .dark) {
                Text("Dark mode active")
                    .foregroundStyle(.white)
                    .background(Color.black)
            } else {
                Text("Light mode active")
                    .foregroundStyle(.black)
                    .background(Color.white)
            }
        }
    }
}

struct ContentView: View {
    @State private var selectedTheme = AppTheme.system

    var body: some View {
        ThemedView()
            .environment(\.appTheme, selectedTheme)
    }
}

ThemedViewは2つの環境を読み取ります: カスタムのappThemeとシステムのcolorScheme。この組み合わせにより、軽柔なテーマ設定が可能になります: ユーザーは、ライト、ダーク、システムのテーマを選択できます。システムが選択された場合、値はcolorSchemeから取得され、iOS設定でテーマが切り替えられると自動的に変更されます。親View (ContentView)は.environment()修飾子を通じてappTheme値を設定します。

画面を閉じるためのdismissの使用

struct ModalView: View {
    @Environment(\.dismiss) var dismiss
    @State private var name = ""

    var body: some View {
        NavigationStack {
            Form {
                TextField("Your name", text: $name)
                Button("Save") { dismiss() }
            }
            .navigationTitle("Edit Profile")
        }
    }
}

この例は、dismissの実用的な使い方を示しています — 環境からのDismissActionのインスタンスです。関数としてdismiss()を呼び出すと、モーダル画面が閉じるか、NavigationLinkが戻ります。唯一の条件は、Viewがモーダルで表示されているか、NavigationStack内にあることです。dismissはコンテキストから自動的に決定されます: Viewがsheetとして開かれていればsheetが閉じられ、popoverとして開かれていればpopoverが閉じられます。