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

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

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

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

この記事では、独自のデータモデルクラスを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)
        }
    }
}

投稿者プロフィール

林 晃
林 晃macOS/iOSアプリ/SDK/ミドルウェア開発が専門の開発者
アールケー開発代表。macOS/iOSアプリ/SDK/ミドルウェア開発が専門の開発者。ObjC/Swift/C++使い。豊富な開発実務経験を基に、教育コンテンツ開発、技術書執筆、技術指導、技術セミナー講師、企業内研修講師、行政・自治体職員研修講師も行います。

基礎から学ぶMetal


「基礎から学ぶMetal」を執筆しました。本書はMetalを使ってGPUプログラミングを行うための最初のステップを解説するMetalの解説書です。

私が初めてGPUプログラミングを行ったとき、どこから手をつけて、学んでいけば良いのか分からず呆然としました。もし、あのとき、これを教えてくれればという部分を解説しました。本書で解説している部分はMetalの基礎となる部分で、Metalを使うときに必ず触れることになる部分です。

詳細

基礎から学ぶSwiftUI


「基礎から学ぶ SwiftUI」というタイトルの本を執筆しました。

SwiftUIの入門書です。

SwiftUIのコンセプトは「ユーザーインターフェイスを作るための最短パスを提供する」「一度学べば(Appleのプラットフォームの)どこにでも適用できる」です。

SwiftUIの概要から始まって、一つ一つのテクノロジートピックに注目しながらSwiftUIとは何か?どんなことができるのか?どのようなコードを書けば良いのかなどを丸々一冊使って解説しています。

詳細

関連記事

  1. 【2020/4/1更新】【Swift|ObjC 】 UIWebView…

  2. HTTPのステータスコードへの対応

  3. SwiftのUnsafeMutableBufferは[]演算子よりも速…

  4. 【2020/2/10更新】UIWebViewは廃止

  5. iOS アプリの開発に必要な Apple ID の作り方

  6. 【Python】loggingを使ってログを出力する

最近の著書

  1. 基礎から学ぶ SwiftUI

最近の記事