[Swift] Wrapping existing asynchronous code in async/await in Swift

Swift의 async/await 기능은 iOS 13 및 이후 버전에서 비동기 코드의 가독성을 향상시키는 놀라운 방법입니다. 새 프로젝트에서는 이로 인해 더 표현력이 있고 가독성이 좋으며 디버깅하기 쉬운 비동기 코드를 작성할 수 있으며, 이는 동기 코드와 매우 유사하게 읽히게 됩니다. 그러나 async/await를 채택하는 것은 함수의 완료 핸들러를 기반으로 하는 비동기 API를 사용하는 경우, 코드베이스를 상당히 변경해야 할 수도 있습니다.

 

다행히도, 기존의 콜백 기반 비동기 코드를 새로운 async/await 세계로 가져오기 위해 Swift의 내장 기능을 활용할 수 있습니다. 이 글에서는 기존의 콜백 기반 비동기 코드를 async 및 async/await와 함께 작동하는 함수로 변환하는 방법 중 하나를 살펴보겠습니다.

콜백 기반 함수를 async/await로 변환하기

콜백 기반 함수는 다양한 형태로 나타날 수 있습니다. 그러나 대부분의 경우 다음 예와 비슷하게 보일 것입니다.

func validToken(_ completion: @escaping (Result<token, error="">) -> Void) {
    let url = URL(string: "<https://api.internet.com/token>")!
    URLSession.shared.dataTask(with: url) { data, response, error in
        guard let data = data else {
            completion(.failure(error!))
        }

        do {
            let decoder = JSONDecoder()
            let token = try decoder.decode(Token.self, from: data)
            completion(.success(token))
        } catch {
            completion(.failure(error))
        }
    }
}
</token,>

위의 예제는 validToken(_:) 메서드가 어떻게 보일 수 있는지 매우 단순화한 버전입니다. 이 함수는 completion 클로저를 취하며, 유효한 토큰을 얻는 시도의 결과로 completion 클로저가 호출하는 몇 군데 지점이 있다는 것입니다.

@escaping 참고

validToken 함수를 async 함수로 사용할 수 있도록 만드는 가장 쉬운 방법은 async throws로 표시하고, Token을 반환하는 2번째 버전을 작성하는 것입니다. 메서드 시그니처는 다음과 같습니다.

func validToken() async throws -> Token {
	// ...
}

이 메서드 시그니처는 이전보다 훨씬 깔끔해보이지만, 이제 기존의 콜백 기반 함수를 어떻게든 활용하고 클로저에 전달된 async validToken으로부터 반환된 Result<Token, Error>를 사용해야합니다.

 

이를 위해 continuation이라는 메커니즘을 활용할 수 있는데, 사용할 수 있는 continuation에는 여러 가지 종류가 있습니다:

• withCheckedThrowingContinuation
• withCheckedContinuation
• withUnsafeThrowingContinuation
• withUnsafeContinuation

보시다시피, checked와 unchecked continuation이 있습니다. 이 차이점에 대해서 알고 싶다면 이 글을 확인하세요. 또한 throw와 non-throwing 버전의 continuation이 있습니다. 이는 사용자가 예상 가능한 상황에 유용합니다. async/await 함수로 변환하는 실패할 수 있는 경우, throwing continuation을 사용하세요. 함수가 항상 성공 값으로 콜백을 호출하는 경우, 일반 continuation을 사용하세요.

 

우선 checked continuation을 사용할 때 완성된 validToken은 다음과 같습니다.

func validToken() async throws -> Token {
    return try await withCheckedThrowingContinuation { continuation in
        validToken { result in
            switch result {
            case .success(let token):
                continuation.resume(returning: token)
            case .failure(let error):
                continuation.resume(throwing: error)
            }
        }
    }
}

return try await withChecked…에 주목하세요.

continuation에 대한 반환 타입은 resume(returning:) 메서드 호출에서 전달한 객체 타입입니다.

콜백을 받는 validToken 버전의 함수는 Result<Token, Error>로 콜백을 호출하기 때문에 Swift는 result 인자의 성공 케이스가 Token이라는 것을 알고 있으므로 resume(returning:)에 전달한 객체의 타입이 Token이고, withCheckedThrowingContinuation의 반환 타입은 Token이 됩니다.

 

withCheckedThrowingContinuation과 그에 대응하는 함수들은 모두 continuation 객체의 resume 함수가 호출될 때까지 일시 중단되는 async 함수입니다. 이 continuation 객체는 with*Continuation 함수에 의해 생성되며, (결국) 이 함수를 사용하여 실행을 재개하는 것은 사용자의 몫입니다. 이 작업을 하지 않으면 continuation이 result를 생성하지 않으므로 메서드가 영원히 일시 중단됩니다.

 

with*Continuation 함수에 전달된 클로저는 즉시 실행되므로, 콜백 기반의 validToken 버전이 바로 호출됩니다. resume을 호출하면 비동기 validToken 함수의 호출자는 일시 중단된 상태에서 벗어나 즉시 이동하여 실행을 재개할 수 있습니다.

Result는 Error를 포함할 수 있으므로, async validToken이 오류를 던지도록 하려면 failure case를 확인하고 resume(throwing:)을 호출해야 합니다.

 

위의 코드는 상당히 장황하며, Swift 팀은 위의 패턴이 매우 일반적인 패턴일 수 있다는 것을 인식해서 Result 객체를 허용하는 3번째 버전의 resume을 제공했습니다. 이를 사용하는 방법은 다음과 같습니다.

func validToken() async throws -> Token {
    return try await withCheckedThrowingContinuation { continuation in
        validToken { result in
            continuation.resume(with: result)
        }
    }
}

훨씬 깔끔합니다.

continuation을 사용할 때 중요한 2가지 사항을 기억하세요.

• continuation은 한 번만 재개할 수 있습니다.
• continuation 클로저 내에서 resume을 호출하는 것은 여러분의 책임입니다. resume을 호출하지 않으면 함수 호출자가 result를 영원히 기다리게 됩니다.

또한 오류를 던질 수 있는 지의 여부를 제외하고는 with*Continuation 함수가 모두 동일한 규칙을 사용한다는 점을 알아두는 것이 좋습니다. 다른 규칙은 완전히 동일합니다.

Summary

이 글에서는 콜백을 받는 함수를 continuation으로 래핑하여 새로운 async/await 함수로 변환하는 방법에 대해 알아보았습니다. continuation에는 다양한 종류가 있으며 어떻게 사용하는지에 대해 알아보았습니다.

 

continuation은 모든 코드를 한 번에 다시 작성하지 않고도 기존의 코드를 async/await로 변환할 수 있는 훌륭한 방법입니다. 글의 작성자는 개인적으로 continuation을 활용하여 느리지만 확실하게 코드의 많은 부분을 점진적으로 async/await로 마이그레이션했습니다. 예를 들어 네트워킹 코드를 다시 작성하지 않고도 뷰 모델과 네트워킹 사이에 async/await를 지원하는 중간 레이어를 작성할 수 있다는 것은 매우 멋진 일입니다.

 

전반적으로 continuation은 기존의 콜백 기반 함수를 async/await로 변환하는 간단하고 우아한 API를 제공한다고 생각합니다.

 

원문

https://www.donnywals.com/wrapping-existing-asynchronous-code-in-async-await-in-swift/