【Swift UI】@ObservedObjectの意味と使い方!クラスとプロトコルとの関係

この記事からわかること
- Swiftの@ObservedObjectとは?
- 意味や使い方、メリット
- ObservableObjectプロトコルとクラスでの定義方法
- @Publishedの使い方
- ビュー間でクラスのデータを共有する方法
index
[open]
\ アプリをリリースしました /
Swift UIでクラスのプロパティの更新を監視するために使用する「@ObservedObject
」や「@Published
」などの使い方やメリットをまとめていきたいと思います。
@ObservedObjectとは?
@ObservedObject
は@Binding
などと同じくSwift5.1から導入された機能「Property Wrapper(プロパティラッパ)」の1つです。プロパティラッパの特徴はプロパティ(変数)に対する操作や処理をカプセル化して定義することで特定のキーワードを追加するだけで任意の動作や挙動を行わせることができるデータ構造です。
@ObservedObject
は@Published
と組み合わせて使用することで、クラスのプロパティの変更を監視し、更新された時にビューに表示されている値も更新するためのプロパティラッパです。つまりクラスのプロパティの更新がリアルタイムにビューに反映されるようになります。
@Published
もプロパティラッパの1種でcombine
フレームワークから提供されている機能の1つです。@Published
が付与されたプロパティは監視状態になります。これで値が変更された時にその変化を感知することができるようになります。
@Published
が付与されているプロパティが更新され、ビューが再描画されるためにはそのクラスがObservedObject
プロトコルに準拠しインスタンス化した変数に@ObservedObject
または@EnvironmentObject
が指定されている必要があります。
ポイント
- @ObservedObjectはProperty Wrapper(プロパティラッパ)の1つ
- クラスのプロパティの更新がリアルタイムにビューに反映する役割
- 監視するプロパティには@Publishedを付与
- クラスはObservableObjectプロトコル準拠
- インスタンス化した変数に@ObservedObjectまたは@EnvironmentObjectを付与
使い方
クラスで定義しているプロパティの値が変化する際にビュー(表示)も同時に更新したい場合に@ObservedObject
を使います。使う流れは以下の通りです。
- クラスはObservableObjectプロトコルに準拠して定義
- 監視したいプロパティに@Publishedを付与
- インスタンス化した変数に@ObservedObjectを付与
クラスはObservableObjectプロトコルに準拠して定義
まずは適当なSwiftファイルにクラスを定義します。プロトコルはクラス名:ObservableObject
の形式で指定できます。
class MainViewModel: ObservableObject {
var title: String = ""
}
監視したいプロパティに@Publishedを付与
変更を監視したいプロパティに@Published
を付与しておきます。
class MainViewModel: ObservableObject {
@Published var title: String = ""
}
プロパティはlet
(定数)では当たり前ですがProperty wrapper can only be applied to a 'var'
のようなエラーになるのでvar
で宣言しておきます。
インスタンス化した変数に@ObservedObjectを付与
ObservedObject
プロトコルに準拠させたクラスをインスタンス化し変数に格納します。その際に@ObservedObject
を付与します。これでクラスのプロパティの値が変化した時にビューも連動して更新されるようになります。
struct ContentView: View {
@ObservedObject private var viewModel = MainViewModel()
var body: some View {
VStack {
TextField("タイトル", text: $viewModel.title)
Text("\(viewModel.title)")
}
}
}
上記の例ではTextField
から入力された値がクラスのプロパティに格納されます。@ObservedObject
を未使用の場合は下のText
は表示されません。
まだまだ勉強中ですので間違っている点や至らぬ点がありましたら教えていただけると助かります。
ご覧いただきありがとうございました。