2022/7/12

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

この記事からわかること

Swiftの@ObservedObjectとは？
意味や使い方、メリット
ObservableObjectプロトコルとクラスでの定義方法
@Publishedの使い方
ビュー間でクラスのデータを共有する方法

index

[open]

＼アプリをリリースしました／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

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 Article1:ObservableObject{
    var title:String = ""
    var body:String = ""
}

監視したいプロパティに@Publishedを付与

変更を監視したいプロパティに@Publishedを付与しておきます。

class Article1:ObservableObject{
    @Published  var title:String = ""
    var body:String = ""
}

プロパティはlet(定数)では当たり前ですがProperty wrapper can only be applied to a 'var'のようなエラーになるのでvarで宣言しておきます。

インスタンス化した変数に@ObservedObjectを付与

ObservedObjectプロトコルに準拠させたクラスをインスタンス化し変数に格納します。その際に@ObservedObjectを付与します。これでクラスのプロパティの値が変化した時にビューも連動して更新されるようになります。

struct ContentView: View {
    @ObservedObject  var article = Article1()
    
    var body: some View {
        VStack {
            TextField("タイトル", text: $article.title)
            Text("\(article.title)")
        }
    }
}

上記の例ではTextFieldから入力された値がクラスのプロパティに格納されます。@ObservedObjectを未使用の場合は下のTextは表示されません。

まだまだ勉強中ですので間違っている点や至らぬ点がありましたら教えていただけると助かります。

ご覧いただきありがとうございました。

Swift