🐛 [SwiftUI] @Published 변수 값을 비동기를 통해 변경 시 'Publishing changes from background threads is not allowed’ 경고 메시지 해결 방법

삡삡 안녕하세요 이서에요🥸. SwiftUI의 @Published를 사용하여 네트워크 통신을 통해 받아온 값으로 변경하는 도중 아래와 같은 경고 메시지를 확인하여 이를 해결하는 방법에 대해 포스팅하고자 해요.

경고 메시지

Publishing changes from background threads is not allowed; make sure to publish values from the main thread (via operators like receive(on:)) on model updates.

백그라운드 스레드에서 변경 사항을 발행하는 것은 허용되지 않아요. 모델 업데이트에 대한 값을 발행할 때는 (receive(on:)과 같은 연산자를 통해) 메인 스레드에서 실행을 보장하세요.

왜 Xcode는 위와 같은 경고 메시지를 보여준 걸까요? 아래에서 경고 메시지가 발생한 코드를 한 번 보도록 해요.

경고 메시지 발생 코드

import Foundation

class CoinViewModel: ObservableObject {
    @Published var coin: String = ""
    @Published var price: String = ""
    
    init(coin: String) {
        self.coin = coin
        self.fetchPrice()
    }
    
    func fetchPrice() {
        let urlString: String = "https://api.coingecko.com/api/v3/simple/price?ids=\(self.coin)&vs_currencies=krw"
        guard let url: URL = URL(string: urlString) else { return }
        
        URLSession.shared.dataTask(with: url) { data, response, error in
            guard let data = data else { return }
            guard let jsonObject: [String : Any] = try? JSONSerialization.jsonObject(with: data) as? [String : Any] else { return }
            guard let values = jsonObject[self.coin] as? [String : Int] else { return }
            guard let price = values["krw"] else { return }
            
            // Publishing changes from background threads is not allowed;
            // make sure to publish values from the main thread (via operators like receive(on:)) on model updates.
	          self.price = "₩\(price)"
        }.resume()
    }
}

위의 코드를 보면 price를 URLSession을 통해 가져온 data로 값을 변경해주고 있어요. 이 때 Xcode에서는 위와 같이 경고 메시지를 알려주고 있어요.

URLSession은 Apple의 Foundation 프레임워크에서 제공하는 클래스로, 네트워크 요청을 생성하고 관리하는 데 사용해요. 비동기 네트워크 작업을 수행하는 데 널리 사용되며, 웹 서버와 데이터를 주고받기 위해 주로 HTTP 요청을 사용해요. 이를 통해 앱은 인터넷을 통해 데이터를 가져오거나 서버와 통신할 수 있어요.

URLSession의 경우 비동기 처리를 하여 메인 스레드를 차단하지 않아요. 따라서 위의 코드의 self.price의 값을 변경해주는 부분은 앱의 메인 스레드에서 처리하지 않고 별도의 스레드에서 값을 변경하고 있어요.

해당 경고 메시지는 SwiftUI와 비동기 처리에서 흔히 발생하는 문제로, 백그라운드 스레드에서 UI를 업데이트하려고 하거나 비동기로 발행된 값에서 UI를 변경하려고 할 때 발생하는 오류에요. SwiftUI는 주로 메인 스레드에서 사용하도록 설계되었으며, 백그라운드 스레드에서 UI를 업데이트하면 예상치 못한 동작 또는 충돌이 발생할 수 있어요.

따라서 이 이슈를 해결하려면 SwiftUI 뷰의 업데이트, 특히 @Published 속성 또는 Combine 퍼블리셔와 관련된 업데이트를 메인 스레드에서 수행하도록 보장해야 해요.

DispatchQueue.main.async

DispatchQueue.main.async는 GCD(Grand Central Dispatch)의 일부로, iOS 및 macOS 앱에서 비동기적으로 작업을 메인 스레드에서 실행하도록 하는 중요한 패턴 중 하나에요.

메인 스레드는 대부분의 UI 관련 작업 및 사용자 인터페이스 업데이트를 처리하는 스레드에요. 따라서 메인 스레드에서 실행되어야 하는 작업에는 UI 업데이트, 뷰 컨트롤러의 메서드 호출 및 사용자 이벤트 처리가 포함돼요. 그러나 백그라운드 스레드에서 비동기 작업을 수행하고 나중에 결과를 메인 스레드로 보내야 할 때 DispatchQueue.main.async를 사용해요.

DispatchQueue.global().async {
    // 백그라운드 스레드에서 비동기 작업을 수행
    // ...

    DispatchQueue.main.async {
        // 메인 스레드에서 실행되어야 하는 작업
        // 예: UI 업데이트
    }
}

위 코드에서는 DispatchQueue.global().async를 사용하여 백그라운드 스레드에서 비동기 작업을 수행한 후, DispatchQueue.main.async 내부에서 메인 스레드로 전환하여 메인 스레드에서 실행되어야 하는 작업을 수행해요.

DispatchQueue.main.async를 사용하면 메인 스레드에서 실행해야 하는 코드 블록을 정의하고, 메인 스레드에서 비동기적으로 실행되도록 예약할 수 있어요. 이렇게 하면 UI 업데이트 및 다른 메인 스레드에서 수행해야 하는 작업을 안전하게 처리할 수 있으며, 앱의 응답성을 유지할 수 있어요.

해결 방법

따라서 우리는 URLSession이 비동기 처리를 완료하고 UI를 변경할 수 있도록 DispatchQueue.main.async를 통해 해당 값의 변경을 메인 스레드에서 처리할 수 있어요.

func fetchPrice() {
    let urlString: String = "https://api.coingecko.com/api/v3/simple/price?ids=\(self.coin)&vs_currencies=krw"
    guard let url: URL = URL(string: urlString) else { return }
    
    URLSession.shared.dataTask(with: url) { data, response, error in
        guard let data = data else { return }
        guard let jsonObject: [String : Any] = try? JSONSerialization.jsonObject(with: data) as? [String : Any] else { return }
        guard let values = jsonObject[self.coin] as? [String : Int] else { return }
        guard let price = values["krw"] else { return }
        
	      // 메인 스레드에서 값을 변경하도록 했어요.
        DispatchQueue.main.async {
            self.price = "₩\(price)"
        }
    }.resume()
}

SwiftUI의 UI 업데이트와 관련한 인사이트가 부족해서 생긴 이슈였어요. 이번 트러블 슈팅을 통해 또 한번 성장했다고 생각해요😎