Combine入門 | 独自のタイプをCombine対応にする

Combineはアップル純正の非同期処理を実装するためのフレームワークです。SwiftUIのバインディングなどでも使われています。少し分かりにくいのですが、重要なフレームワークです。

Combineが初めての方は、次の記事もご覧ください。

[clink url=”https://www.rk-k.com/archives/3937″]

Combineを使った他の例については以下の記事をご覧ください。

[clink url=”https://www.rk-k.com/archives/3943″]

この記事では、独自のデータモデルクラスをCombine対応のクラスにする方法を解説します。

ObservableObjectで独自のタイプを定義する

Combine対応のクラスを作るには、ObservableObjectプロトコルに適合させます。

値が変更されたときに、Combineを使って通知したいプロパティに@Publishedアトリビューを付けて定義します。

class PlayerStatus : ObservableObject {
    @Published var name: String = ""
    @Published var hitPoint: Int = 100
}

@Published

@Publishedアトリビュートを付けたプロパティは、Publisherを作れるようになります。

Publisherを作るには、$演算子を使います。

let status = PlayerStatus()
let hitPointPublisher = status.$hitPoint

独自のタイプの変更を受け取る

Publisherを取得した後は、sinkを使って変更されたときに処理を実行できます。

let cancellable = status.$hitPoint.sink { (value) in 
    // 変更時の処理
}

但し、上のコードの変更時の処理が実行されている間は、まだ、プロパティの値は変わっていません。変更時の処理の中で直接プロパティを参照すると、変更前の値が取れてしまいます。

サンプルアプリ

サンプルアプリを作りました。「Hit」ボタンでHPを減らして、「Heal」ボタンで回復します。HPが0でもHealで復活できるというめちゃくちゃな設定ですが、ObservableObjectの動きは分かると思います。

import UIKit
import Combine

class PlayerStatus: ObservableObject {
    @Published var name:String = ""
    @Published var hitPoint: Int = 100
}

class ViewController: UIViewController {
    @IBOutlet var hitPointLabel: UILabel!
    
    var playerStatus: PlayerStatus = PlayerStatus()
    var hitPointCancellable: AnyCancellable? = nil

    private func refresh(hitPoint: Int) {
        self.hitPointLabel.text = "\(hitPoint)"
    }
    
    @IBAction func hit(_ sender: Any?) {
        if self.playerStatus.hitPoint > 0 {
            self.playerStatus.hitPoint -= 10
        }
    }
    
    @IBAction func heal(_ sender: Any?) {
        self.playerStatus.hitPoint = 100
    }
    
    override func viewDidLoad() {
        super.viewDidLoad()
        refresh(hitPoint: self.playerStatus.hitPoint)
        
        hitPointCancellable = self.playerStatus.$hitPoint.sink { (value) in
            self.refresh(hitPoint: value)
        }
    }
}