[Combine] 개발 새싹 어린이 시점에서 작성한 Combine 개념 정리

[italsehf]

누추한 저의 Combine 정리 노션

Combine

• Customize handling of asynchronous events by combining event-processing operators

💡 시간 경과에 따라 변경되는 값을 내보내는 Publisher와 이를 수신하는 Subscriber로 시간 경과에 따른 값 처리를 위한 선언적 Swift API

import Combine

Publisher

protocol Publisher {
    associatedtype Output
    associatedtype Failure : Error
    func receive<S>(subscriber: S) where S : Subscriber, Self.Failure == S.Failure, Self.Output == S.Input
}

• 하나 혹은 여러 개의 Subscriber 객체에 시간이 흐름에 따라 값을 내보낼 수 있는 타입을 선언하기 위한 프로토콜 형태
• 이벤트를 보내는 역할을 담당함
• Output, Failure 타입이 제네릭으로 구현되어 있음
• Declares that a type can transmit a sequence of values over time
  • Subscriber에게 시간이 지남에 따라 값 (이벤트) 을 보낼 수 있는 타입
  • 관심있는 값에 Subscribe를 걸고 → 그 값에 새 이벤트가 발생하면 (값이 변경되면) → 비동기식으로 이벤트 (값) 을 전달 받음

Publisher와 Subscriber 사이에서 발생하는 이벤트 순서

1. Publisher가 Subscriber를 구독
   1. Publisher의 인스턴스함수 subscribe()를 호출
2. Subscriber는 Subscribe를 생성해서 Subscriber에게 제공
   1. Publisher은 내부적으로 receive()함수를 호출
   2. 게시자가 받은 구독자에게 Subscriber의 인스턴스 함수 receive(subscription: )을 통해 구독을 전달
3. Subscriber가 값을 요청
   1. Subscription(구독)의 인스턴스함수인 request()를 호출
4. Publisher가 값을 보냄
   1. Subscriber의 인스턴스 메소드 receive(_ input)를 이용해서 전달하며 구독자는 값을 받음
5. Publisher가 완료를 보냄
   1. 게시자가 모든 값을 보냈다면 혹은 완료 이벤트를 receive(completion: )함수를 통해서 구독자에게 완료이벤트를 전달함

예시 코드

class IntSubscriber: Subscriber {
    typealias Input = Int
    typealias Failure = Never
    
    // Publisher가 Subscription주면 호출됨
    func receive(subscription: Subscription) {
        subscription.request(.max(1))
    }
    
    // Publisher가 주는 값을 처리
    func receive(_ input: Int) -> Subscribers.Demand {
        print("Received value: \(input)")
        // Publisher에게 한 번 더 달라고 요청
        return .max(1)
    }
    
    func receive(completion: Subscribers.Completion<Never>) {
        print("Received completion: \(completion)")
    }
}

// IntArray를 하나 만듭니다.
let intArray: [Int] = [1,2,3,4,5]

// IntSubscriber를 만듭니다.
let intSubscriber = IntSubscriber()

// IntArray Publisher를 subscribe 합니다.
// intSubscriber가 intArray.publisher에게 값을 요청하면 달라고 말합니다.
intArray.publisher
    .subscribe(intSubscriber)

Received value: 1
Received value: 2
Received value: 3
Received value: 4
Received value: 5
Received completion: finished

Publisher 종류

• Just
  • 가장 단순한 형태의 Publsiher로 에러타입으로 Never를 갖습니다.
• Promise
  • Just와 비슷하지만 Filter Type을 정의할 수 있습니다.
• Fail
  • 정의된 실패타입을 내보냅니다.
• Empty
  • 어떤 데이터도 발행하지 않는 퍼블리셔로 주로 에러처리나 옵셔널값을 처리할때 사용됩니다.
• Sequence
  • 데이터를 순차적으로 발행하는 Publisher로 (1…10).Publisher로 이에 해당합니다.

@published 프로퍼티 래퍼

• 프로퍼티에 Published 어노테이션을 붙여서 사용
• 일반 프로퍼티로 접근 가능
• 값에 대한 Publisher 생성
• $로 접근하여 publisher에 접근 가능
• 프로퍼티가 해제될때 내부적으로 라이프사이클을 관리하고 구독을 취소
• .assign(to: ) 함수와 함께 사용하기 좋음

@Published var userName: String = “”

1. Just

• 단일 값 Publisher을 생성할 수 있는 타입
• 구독자에게 출력을 한번 내보낸 다음 완료하는 게시자
• 인자로 받는 값의 타입을 Output 타입으로 실패 타입은 항상 Never로 리턴

public struct Just<Output> : Publisher {

    /// The kind of errors this publisher might publish.
    ///
    /// Use `Never` if this `Publisher` does not publish errors.
    public typealias Failure = Never
}

2. Future

• 단일 결과를 비동기적으로 생성한 다음 완료할 수 있는 타입
• Promise는 단일 값 또는 오류가 포함된 Result타입을 수신하는 클로져 타입
• promise를 다시 실행하지않고 결과를 공유하거나 재사용함

final public class Future<Output, Failure> : Publisher
  where Failure: Error {
  public typealias Promise = (Result<Output, Failure>) -> Void
  ...
}

AnyPublisher

• Publisher를 따르는 struct 형태

AnyPublisher<String, Error>

Subscriber

public protocol Subscriber : CustomCombineIdentifierConvertible {
    associatedtype Input
    associatedtype Failure : Error

    func receive(subscription: Subscription)
    func receive(_ input: Self.Input) -> Subscribers.Demand
    func receive(completion: Subscribers.Completion<Self.Failure>)
}

• Publisher에게 값을 받을 수 있는 타입을 선언하기 위한 프로토콜 형태
• Input, Failure 타입이 제네릭으로 구현
• 성공 타입과 실패 타입을 함께 명시해줘야함
• Pulbihser와 Subscriber의 타입이 똑같지 않다면 에러가 발생함
• 이벤트를 받는 역할을 담당함
• 구현 방법
  • Subscriber를 상속받아 직접 구현하기 sink를 이용하여 결괏값 받기 asggin을 이용하여 스트림 값을 전달하기
• sink
  • 클로저 형태로 데이터를 받는 Subscriber
  • 별도의 타입 선언 없이 클로저로 받아 receive와 completion때의 라이프사이클만 접근 가능
  • Input 타입으로는 클로저로 받게되는 데이터값을 에러타입으로는 Never를 받음

AnySubscriber

• Subscriber를 따르는 struct 형태

Operators

• Publisher를 반환하는 Publisher 프로토콜에 정의된 메서드
• 여러 종류의 Operator를 Combine 하여 사용하여 Publisher가 내보내는 값을 처리
• Upstream, DownStream이라고 하는 Input, Output을 가지고 있음
• Publisher와 Subscriber 중간에 위치하여 데이터 스트림을 가공해주는 역할
• 연산하는 publisher 갯수에 따라서 Operator가 여러개가 존재함
• 에러를 던질 수 있는 Operator 제공
• 종류
  • Mapping Element
    • 주로 데이터를 다른 데이터 타입으로 변형하는 역할
    • scan, setFailureType, map, flatMap
  • Filtering Element
    • 조건에 맞는 데이터만 허용
    • compactMap, replaceEmpty, filter, replaceError, removeDuplicates
  • Reduce Element
    • 데이터 스트림을 모아 출력
    • collect, reduce, tryReduce, ignoreOutput
  • Mathematic operations on elements
    • 숫자시퀀스값과 관련된 스트림을 제어
    • max, count, min
  • Sequence Elements
    • 데이터 시퀀스를 변형할때 사용
    • prepend, firstWhere, tryFirstWhere, first, lastWhere, tryLastWhere, last, dropWhile

Subject

• Publisher의 일종 + 외부에서 안으로 데이터를 주입시킬 수 있음
• Subscriber에게 value, error, finished를 제공
• PassthroughSubject
  • initial value 없음
  • 상태값을 가지지않는 Subject
  • 쉽게 리팩토링 가능
• CurrentValueSubject
  • initial value 있음
  • 상태값을 가지는 Subject
  • subscriber가 구독한 시점에 초기값을 제공
  • 주로 UI의 상태값에따라 데이터를 발행할때 사용하기 유용

Subscription

• Publisher와 Subscriber의 연결을 나타내는 프로토콜
• Publisher + Operator + Subscriber로 이뤄진 하나의 작업

Cancellable

• 데이터 발행 중 cancel() 메서드가 호출되었을 때 모든 데이터 전달 과정이 멈추고 끝나게 됩니다.
• 사용자가 데이터 로딩을 기다리던도중 뒤로 간다거나 취소를 누른는경우처럼 스트림을 중단해야할때 사용되기도 함
• 언제든 send 메서드를 이용해서 스트림으로 데이터를 전달 가능
• cancel이 호출된 이후에는 더 이상 데이터가 발행 X

Change Thread

• 연산이나 구독 같은 특정 작업의 쓰레드를 지정해줄 때 receiveOn(on:) 을 사용함
  • receiveOn(on: ) = It works only downstream
• Observer가 동작할 쓰레드를 지정해줄 때 Subscribe(on:) 을 사용함
  • Subscribe(on:) 은 위치와 상관있음
  • Subscribe(on:) = It works only upstream