Combine - Publishers

Created

2024/01/31 10:44

Publishers

Publishers의 역할과 중요성

Publishers는 Combine 프레임워크의 핵심 개념 중 하나로, 데이터 스트림을 생성하고 이벤트를 방출하는 역할을 한다. 구독자(Subscriber)는 이러한 Publishers에 구독하여 데이터 스트림을 받아 처리할 수 있다.

특징

•

타입 안전

◦

Publishers는 방출하는 값의 타입과 오류 타입을 명시한다. 이를 통해 컴파일 타임에 타입 체크를 할 수 있어, 런타임 오류의 가능성을 줄인다.

•

조합 가능

◦

여러 Publishers를 조합하고 변환하는 Operator를 통해 복잡한 데이터 처리 로직을 구현할 수 있다.

Publishers

•

protocol Publisher

◦

Publisher 프로토콜은 값이나 이벤트를 생성하고, 구독자에게 방출하는 객체가 준수해야 하는 규약이다

protocol Publisher<Output, Failure>

// Output : Publisher가 방출할 값의 타입
// Failure : Publisher가 방출할 수 있는 오류의 타입. 오류가 없을 경우 'Never' 타입을 사용한다.
Swift
복사

◦

목적 : 모든 Publisher 타입의 기본이 되는 프로토콜, 이 프로토콜을 준수하는 타입은 값을 발행하고, Combine의 다른 타입들이 구독할 수 있다.

◦

주요 메서드 : subscribe(_:) : 구독자를 받아들인다.

•

enum Publishers

enum Publishers
Swift
복사

◦

목적 : 다양한 종류의 Publisher를 생성하는 factory 메서드를 포함하고 있는 네임스페이스 역할을 한다. 예를들어 Publishers.Sequence 는 시퀀스의 요소를 발행하는 Publisher를 생성한다.

•

struct AnyPublisher

@frozen
struct AnyPublisher<Output, Failure> where Failure: Error
Swift
복사

◦

목적 : 타입 소거를 사용하여 Publisher의 타입 정보를 숨기면서. 어떤 Publisher와도 호환될 수 있는 일반적인 Publisher를 만든다. 이를 통해 구체적인 Publisher 타입을 노출하지 않고도 인터페이스를 제공할 수 있다.

•

struct Published

@propertyWrapper
struct Published<Value>
Swift
복사

◦

목적 : 프로퍼티를 Observable 객체로 변환하여, 프로퍼티의 값이 변경될 때마다 알림을 받을 수 있게 한다.

◦

사용법 : @Published 프로퍼티 래퍼를 사용하여, 값의 변경을 구독할 수 있다.

예제)

class Weather {
		@Published var temperature: Double
		init(temperature: Double) {
				self.temperature = temperature
		}
}

let weather = Weather(temperature: 20)
cancellable = weather.$temperature
		.sink() {
				print("Temperature now: \($0)")
}
weather.temperature = 25

// Prints:
// Temperature now: 20.0
// Temperature now: 25.0
Swift
복사

프로퍼티가 변경되면 프로퍼티의 willSet 블록에서 Publisheing이 발생하므로 Subsciber는 프로퍼티에 실제로 설정되기 전에 새 값을 받게 된다.

•

protocol Cancellable

protocoll Cancellable
Swift
복사

◦

목적 : 작업을 취소할 수 있는 객체를 위한 프로토콜이다. 구독을 취소할 때 사용!

◦

주요 메서드 : cancel() : 현재 수행 중인 작업을 취소한다.

•

class AnyCancellable

final class AnyCancellable
Swift
복사

◦

목적 : Cancellable 프로토콜을 준수하는 타입 소거 클래스로, 구독을 취소할 때 사용된다.

◦

AnyCancellable 인스턴스가 해제될 때 자동으로 cancel() 메서드를 호출한다.

예제)

import Combine

// Observable 클래스 정의
class MyModel {
		@Published var score = 0
}

// Observable 객체 생성
let model = MyModel()

// 구독 생성 및 값 변화에 따른 처리
var cancellables = Set<AnyCancellable>()

model.$score
		.sink { newScore in
				print("Score updated: \(newScore)")
		}
		.store(in: &cancellables)

// 갑 변경
model.score = 10
Swift
복사

‘MyModel’ 클래스에 @Published 로 선언된 score 프로퍼티가 있다.

model.$score.sink 를 통해 score 프로퍼티의 변화를 구독하고, 값이 변경될 때마다 콘솔에 출력한다.

AnyCancellable 인스턴스는 cancellables 세트에 저장되어, 구독이 필요 없어지면 자동으로 취소된다.

Convenience Publishers

•

class Future

◦

단일 값을 생성한 다음 finishes 또는 fails를 보내주는 Publisher

◦

비동기 작업의 결과를 방출하는 Single-shot Publisher

final class Future<Output, Failure> where Failure: Error
Swift
복사

◦

목적 : 하나의 작업 결과를 나타내는 Publisher이다. 비동기 작업을 수행하고, 그 결과를 나중에 발행한다.

◦

특징 : 작업이 완료될 때 단 한번만 결과를 발행한다.

예제) Future 를 사용하여 어떤 작업을 수행한 후 단일 요소를 비동기적으로 게시하는 방법

◦

Future 는 성공 또는 실패를 나타내는 Result 로 프라미스를 호출하는 클로저와 함께 초기화된다. 성공한 경우, Future 의 하류 구독자는 게시 스트림이 정상적으로 완료되기 전에 요소를 받는다. 결과가 오류인 경우, 게시는 해당 오류로 종료된다.

// 짧은 지연 후에 랜덤 숫자를 비동기적으로 게시하는 'future'를 사용하는 방법
func generateAsyncRandomNumberFromFuture() -> Future<Int, Never> {
    return Future() { promise in
        DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
            let number = Int.random(in: 1...10)
            promise(.success(number))
        }
    }
}


// async-await 버전
func generateAsyncRandomNumberFromContinuation() async -> Int {
		return await withCheckedContinuation { continuation in
				DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
						let number = Int.random(in 1...10)
						continuation.resume(returning: number)
				}
		}
}
Swift
복사

게시된 값을 받기 위해, Subscriber.Sink Combine 구독자를 사용!

cancellable = generateAsyncRandomNumberFromFuture()
		.sink { number in print("Got random number \(number).") }
Swift
복사

async-await 구문과 통합하기 위해, Future 는 대기하는 호출자에게 값을 제공할 수 있다. 이는 Future 가 다른 Publisher 와 달리 단일 요소만을 게시한다는 점에서 특히 유용하다. value 속성을 사용하면 위의 호출 포인트는 다음과 같이 보인다.

// future 사용 버전
let number = await generateAsyncRandomNumberFromFuture().value
print("Got random number \(number).")

// async-await 버전
let asyncRandom = await generateAsyncRandomNumberFromContinuation()
Swift
복사

예제 2)

import Combine

var cancellables = Set<AnyCancellable>()

let futurePublisher = Future<String, Error> { promise in
		DispatchQueue.global().asyncAfter(deadline: .now() + 2) {
				promise(.success("Future 결과"))
		}
}

futurePublisher
		.sink(receiveCompletion: { completion in
				switch completion {
				case .finished:
						print("완료")
				case .failure(let error):
						print("에러 발생: \(error)")
				}
		}, receiveValue: { value in
				print("받은 값: \(value)")
		})
		.store(in: &cancellables)
Swift
복사

•

struct Just

◦

구독자마다 단 한 번씩 출력을 방출한 후 종료되는 발행자

struct Just<Output>
Swift
복사

◦

목적 : 단일 값을 발행하고 완료되는 Publisher. 초기화할 때 제공된 값을 구독자에게 즉시 발행한다.

◦

특징 : 테스트나 단순한 값 변환에 유용하다.

•

struct Defferred

struct Defferred<DeferredPublisher> where DeferredPublisher: Publisher
Swift
복사

◦

목적 : 구독이 발생할 때까지 Publisher 생성을 지연시키는 Publisher 이다. 이를 통해 구독자마다 새로운 Publisher 인스턴스를 생성할 수 있다.

◦

특징 : 초기화 비용이 큰 Publisher를 사용할 때 유용하다.

•

struct Empty

struct Empty<Output, Failure> where Failure: Error
Swift
복사

◦

목적 : 아무 값도 발행하지 않고 즉시 완료되거나, 완료되지 않는 Publisher

◦

특징 : 테스트나 기본값 없이 빈 상태를 나타낼 때 사용된다.

•

struct Fail

struct Fail<Output, Failure> where Failure: Error
Swift
복사

◦

목적 : 구독 직후에 실패를 발행하는 Publisher이다. 에러 처리를 테스트하거나 구현할 때 사용된다.

◦

특징 : 특정한 에러 타입을 발행한다.

•

struct Record

struct Record<Output, Failure> where Failure: Error
Swift
복사

◦

목적 : 미리 정의된 값을 순서대로 발행하고, 완료 이벤트를 보내는 Publisher이다. 테스트 목적으로 사용된다.

◦

특징 : 고정된 데이터 스트림을 재생산한다.

•

protocol ConnectablePublisher

protocol ConnectablePublisher<Output, Failure>: Publisher
Swift
복사

◦

목적 : 구독자가 구독하기 전까지 데이터 발행을 시작하지 않는 Publisher를 위한 프로토콜이다. connect()  메서드를 호출해야 데이터 발행을 시작한다.

◦

특징 : 여러 구독자가 동시에 동일한 데이터 시퀀스를 수신할 수 있게 해준다.

→ 주로 멀티캐스팅(multicasting) 상황에서 유용하게 사용된다.

예제) Just, Empty, Fail

import Combine

// Just 예제
let justPublisher = Just("Just 발행 값")
justPublisher
		.sink(receiveValue: { print($0) })
// Just는 단일 값 발행에 사용!


// Empty 예제
let emptyPublisher = Empty<String, Never>()
emptyPublisher
		.sink(receiveCompletion: { print($0) }, receiveValue: { print($0) })

let failPublisher = Fail<String, Error>(error: NSError(domain: "TestError", code: -1, userInfo: nil))
failPublisher
		.sink(receiveCompletion: { completion in
				switch completion {
				case .finished:
						print("완료")
				case .failure(let error):
						print("에러 발생: \(error.localizedDescription)")
				}
		}, receiveValue: { value in
				print(value)
		})
// Empty와 Fail은 특정 상황(값이 없거나 에러 발생)을 시뮬레이션할 때 사용된다.
Swift
복사

•

Publishers.Sequence

◦

이 퍼블리셔는 시퀀스(배열, 범위 등)을 입력으로 받아, 시퀀스의 각 요소를 순차적으로 방출한다. 이를 사용하면 주어진 시퀀스에 대해 반응형 프로그래밍을 적용할 수 있다.

import Combine

// 배열 사용 예
let numbers = [1, 2, 3, 4, 5]
let numbersPublisher = Publisher.Sequence(sequence: numbers)

// 구독 생성 및 값 처리
let subscription = numbersPublisher
		.sink(
				receiveCompletion: { completion in
						switch completion {
						case .finished:
								print("Completed")
						case .failure(let error):
								print("Error: \(error)")
						}
				},
				receiveValue: { value in
						print("Received value: \(value)")
				}
		)

// 범위 사용 예
let rangePublisher = Publishers.Sequence(sequence: 1...5)

// 구독 생성 및 값 처리
let rangeSubscription = rangePublisher
		.sink(
				receiveCompletion: { completion in
						print("Range Completed")
				},
				receiveValue: { value in
						print("Range Received Value: \(value)")
				}
		)
Swift
복사

데이터 스트림 작업

마찬가지로 Combine을 사용하면 이벤트나 데이터 스트림을 선언적으로 조작하고 변환하는 다양한 연산자(Operator)를 사용할 수 있다.

변환 연산자

•

map

◦

map은 스트림에 포함된 각 값에 대해 함수를 적용하고 그 결과를 새로운 값으로 방출한다. 이를 통해 입력 데이터를 원하는 형태로 변환할 수 있다.

let publisher = [1, 2, 3, 4 ,5].publisher
publisher
		.map { $0 * 2 }
		.sink { print("\($0)", terminator: " ") }
// 2 4 6 8 10
Swift
복사

•

flatMap

◦

flatMap은 각 입력 값에 대해 새로운 퍼블리셔를 생성하고, 생성된 모든 퍼블리셔의 출력을 단일 퍼블리셔로 병합한다. 이것은 비동기 작업을 체인으로 연결할 때 특히 유용하다.

필터링 연산자

•

filter

◦

filter는 주어진 조건에 맞는 값만을 방출한다. 조건에 맞지 않는 값은 무시

publisher
		.filter { $0 % 2 == 0 }
		.sink { print("\($0)", terminator: " ") }
// 2 4
Swift
복사