初期化のために一度だけ実行する処理はlazy varで行う。

[YusukeHosonuma]

Overview

ViewModel などに @MainActor を適用し、かつ Initializer を nonisolated でマークしている場合、task（onAppear）での初期化が必要になる場合がある（Publisherの接続など）。

その際に lazy var を利用すれば、一度だけしか実行されないことを保証できる。

struct ContentView: View {
    @StateObject var viewModel = ViewModel()
    
    var body: some View {
        Text(viewModel.text)
            .task {
                // 💡 `task` is executed on appear everytime.
                await viewModel.onAppear()
            }
    }
}

@MainActor
class ViewModel: ObservableObject {
    @Published var text: String = ""
    
    let listener = Listener()
    
    nonisolated init() {
        // 🚫 Compile error:
        // Can't access to `text` property. (Protected by MainActor)
        self.listener.listen().assign(to: &$text)
    }
    
    // ✅ Guaranteed to be executed only once.
    private lazy var initialize: () = {
        self.listener.publisher().assign(to: &$text)
    }()
    
    func onAppear() async {
        _ = initialize
    }
}

class Listener {
    func publisher() -> AnyPublisher<String, Never> {
        Just("Hello").eraseToAnyPublisher()
    }
}

Discussion

lazy var はマルチスレッド下において、複数回実行される可能性があるが、このコード例の場合 @MainActor によって保護されているので問題ない。

なお、lazy var ブロック内で async なメソッドを呼び出すことはできない。その際は、以下のようなdeferとguardを使ったコードパターンを活用すると良い。

private var initialized = false

// ✅ This method is execute on single-thread. Therefore not occur race-condition.
func onAppear() async {
    defer { initialized = true }
    guard initialized == false else { return }

    text = await self.listener.fetch()
}

Why not?

async なメソッドを呼ぶか呼ばないかによって、コードの書き方が変わるというのもややこしいので、前述したようなシンプルなコードに統一した方がベターな可能性も高い。（まだ頻度が読めていない）