@ObservedObject: 概要、動作方法と例

SwiftUIの@ObservedObjectとは？

@ObservedObjectは、ビューをObservableObjectの変更に購読させるProperty Wrapperです。ObservableObjectはCombineフレームワークのプロトコルで、objectWillChangeパブリッシャーの実装を必要とします。@PublishedでマークされたプロパティがObservedObject内で変更されると、パブリッシャーがシグナルを送信し、SwiftUIは@ObservedObjectを通じて購読しているすべてのビューを再レンダリングします。

@ObservedObjectの主な特徴は所有権がないことです。ビューはオブジェクトの作成や破棄に責任を持ちません。オブジェクトは親ビューで（@StateObjectを介して）作成されるか、@EnvironmentObjectを介して注入されます。子ビューは変更を監視して更新を受け取るだけです。親でオブジェクトが置き換えられると、@ObservedObjectは新しいインスタンスに切り替わります。

@ObservedObjectはデータ共有シナリオに適しています：ユーザーモデル、共通設定、サーバー接続状態など。階層の異なるレベルにある複数のビューが同じデータを表示する必要がある場合、各ビューの@ObservedObjectは単一のソースに対して独立した一貫性のある購読を作成します。

@ObservedObject vs @StateObject: 主な違い

@ObservedObjectと@StateObjectの違いは、SwiftUIの面接で最もよく聞かれる質問の1つです。主なルール：@StateObjectはオブジェクトを作成して所有し、@ObservedObjectは既存のオブジェクトを監視します。このルールに違反すると、予期しないデータ損失や二重初期化が発生します。

@StateObjectはオブジェクトが一度作成され、ビュー構造の繰り返しの初期化を生き残ることを保証します。@ObservedObjectは外部からオブジェクトを受け取り、親構造の初期化ごとに再作成されます。親がオブジェクトに@StateObjectを使用している場合、子ビューは安全に@ObservedObjectを適用できます — オブジェクトは階層全体で一意になります。

@ObservedObjectが変更を追跡する仕組み

@ObservedObjectの追跡メカニズムはCombineとObservableObjectプロトコルに基づいています。初期化中、SwiftUIはobjectWillChangeパブリッシャーを呼び出します — オブジェクトは@Publishedプロパティを変更する前にシグナルを発行する必要があります。CombineはシグナルをSwiftUIの依存関係グラフに渡し、依存するすべてのビューを更新が必要としてマークします。これは値が変更される前に同期的に発生します。

class WeatherService: ObservableObject {
    @Published var temperature: Double = 22.0
    @Published var city: String = "Moscow"
}

struct WeatherView: View {
    @ObservedObject var weather: WeatherService

    var body: some View {
        VStack {
            Text("\(weather.city)")
            Text("\(weather.temperature)°C")
        }
    }
}

リストでは、WeatherServiceは2つの@Publishedプロパティを持つObservableObjectです。WeatherViewは@ObservedObject var weather: WeatherServiceを宣言し、親からインスタンスを受け取ります。temperatureが変更されると、新しい値を設定する前にobjectWillChangeが発動し、SwiftUIがWeatherViewを再レンダリングして実際の気温が表示されます。購読はSwiftUIによって自動的に管理されるため、開発者がsinkやdisposeを呼び出す必要はありません。

@ObservedObjectの使用パターン

最初のパターンはイニシャライザを介したモデルの受け渡しです。親は@StateObjectを介してObservableObjectを作成し、子ビューに@ObservedObjectとして渡します。これは標準的な階層的データ転送であり、ルートビューがモデルのライフサイクルを管理し、すべてのネストされたコンポーネントが変更を購読します。

2番目のパターンはEnvironmentObjectで、SwiftUI環境を介した@ObservedObjectのグローバルバージョンです。オブジェクトはシーンまたはルートビューレベルで注入され、イニシャライザを介した明示的な受け渡しなしですべての子コンポーネントが自動的に利用できます。子ビュー内では、@EnvironmentObjectは@ObservedObjectと同様に動作しますが、環境からオブジェクトを受け取ります。

3番目のパターンは複数のObservableObjectの構成です。複雑なアプリケーションでは、ビューは複数のオブジェクトを監視できます：@ObservedObject var user: UserService、@ObservedObject var network: NetworkMonitor。これにより、サービス間で責任が分離され、各コンポーネントのテスタビリティが維持されます。

struct DashboardView: View {
    @ObservedObject var user: UserViewModel
    @ObservedObject var network: NetworkMonitor

    var body: some View {
        VStack {
            Text("Welcome, \(user.name)")
            HStack {
                Circle()
                    .fill(network.isConnected ? Color.green : Color.red)
                    .frame(width: 10, height: 10)
            }
        }
    }
}

DashboardViewはUserViewModelとNetworkMonitorを監視します。各オブジェクトは自身のデータドメインを処理し、独立してビューに変更を通知します。ネットワークが切断されると、NetworkMonitorはisConnectedを変更し、SwiftUIはDashboardViewを再レンダリングしてインジケーターの色を更新します。ObservableObjectの構成は、SwiftUIアプリケーションでデータを整理するための推奨方法です。

@Published: ObservableObjectとSwiftUIの橋渡し

@PublishedはCombineのProperty Wrapperで、ObservableObject内のプロパティに自動的にパブリッシャーを追加します。@Publishedプロパティが変更されると、CombineはobjectWillChangeパブリッシャーを介してイベントを生成します。@ObservedObjectまたは@StateObjectを使用する際、SwiftUIはこのパブリッシャーを購読し、新しい値ごとにビューを再レンダリングします。

@Publishedは、オプショナル、コレクション、カスタム構造体を含むすべての型をサポートします。ただし、コレクション（配列、辞書）の場合、SwiftUIは参照の置き換えのみを追跡し、内容の変更は追跡しません。要素の追加や削除を検出するには、コレクション全体を再代入するか、手動のobjectWillChange.send（）とともにObservableObjectを使用する必要があります。

重要な詳細：@PublishedはObservableObjectを実装するクラス内でのみ使用する必要があります。ObservableObjectの外部で@Publishedを使用すると、コンパイルエラーが発生します。また、@Publishedを遅延初期化プロパティ（lazy var）や計算プロパティに適用することはできません。

@ObservedObjectのよくある間違い

最も深刻な間違いは、オブジェクトを作成するために@ObservedObjectを使用することです。親ビューで@ObservedObject var model = UserViewModel（）と記述すると、レンダリングのたびに新しいUserViewModelインスタンスが作成されます。データは失われ、@Publishedの購読は再作成されます。作成には常に@StateObjectを使用し、@ObservedObjectは既存のオブジェクトを受け取るためだけに使用してください。

2番目の間違いはメインスレッド外での@Publishedプロパティの変更です。ObservableObjectはCombineを使用しており、メインスレッド（main actor）での変更送信が必要です。バックグラウンドキューで@Publishedを変更すると、SwiftUIが不適切なタイミングでビューを再レンダリングし、競合状態を引き起こす可能性があります。更新にはDispatchQueue.main.asyncまたは@MainActorを使用してください。

3番目の問題は循環更新です。@Publishedの変更が再び@Publishedを変更する副作用を引き起こすと、無限の再レンダリングループが発生します。解決策：ガードフラグ（isUpdating）を使用するか、明確な責任範囲を持つ異なるObservableObjectにロジックを分離します。