Combine101: share(), multicast(), connect(), autoconnect()

[Taehyeon-Kim]

문제 의식

share()

1. 비용이 많이 드는 작업에서 중복 작업을 제거하고 싶다.
2. struct로 디자인된 Combine에서 리소스를 공유할 수 있도록 참조를 사용하고 싶다.

multicast()

1. share는 버퍼링 시스템이 별도로 존재하지 않는다.
2. 모든 구독이 완료되면 이벤트를 방출하고 싶다.

Combine

• Combine은 기본적으로 구조체(struct)로 디자인되어 있다.
• 프로퍼티에 저장되거나 함수에서 전달될 때 시스템이 복사를 한다.
• side-effects 없이 값을 전달할 수 있도록 한다.

import Foundation
import Combine

let numbers = [1,2,3,4,5,6,7,8,9,10]
  .publisher
  .print()

var cancellabes = Set<AnyCancellable>()

numbers.sink { _ in }.store(in: &cancellabes)
numbers.sink { _ in }.store(in: &cancellabes)

receive subscription: ([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
request unlimited
receive value: (1)
receive value: (2)
receive value: (3)
receive value: (4)
receive value: (5)
receive value: (6)
receive value: (7)
receive value: (8)
receive value: (9)
receive value: (10)
receive finished
receive subscription: ([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
request unlimited
receive value: (1)
receive value: (2)
receive value: (3)
receive value: (4)
receive value: (5)
receive value: (6)
receive value: (7)
receive value: (8)
receive value: (9)
receive value: (10)
receive finished

• 기본적으로 퍼블리셔의 복사가 일어나기 때문에 각 구독이 생겨날 때마다 독립적인 스트림(= 퍼블리셔 생성)이 시작된다.

share operator

• share 연산자를 통해서 값의 복사를 막고 하나의 참조로 값을 공유할 수 있다.
• 이는 네트워크 요청과 같은 리소스가 많이 드는 작업에서 유용하다. 중복 요청을 줄이고 동일한 값을 사용할 수 있다.

struct Post: Decodable {
  let userId: Int
  let id: Int
  let title: String
  // let body: String
}

let url = URL(string: "https://jsonplaceholder.typicode.com/posts")!
let posts = URLSession.shared.dataTaskPublisher(for: url)
  .map(\.data)
  .decode(type: [Post].self, decoder: JSONDecoder())
  .replaceError(with: [])
  .print()
  .share()

posts
  .sink(receiveValue: {
    print("subscription1 value: \($0)") })
  .store(in: &cancellables)
posts
  .sink(receiveValue: {
    print("subscription2 value: \($0)") })
  .store(in: &cancellables)

• 실제로 이벤트가 한 번만 발생한다. (share를 지워보면 이벤트가 여러 번 발생한다.)
• share operator를 사용하는 경우에도 문제는 있다. 요청이 완료된 이후에 구독이 새롭게 시작되면 완료 이벤트만 수신하게 된다.

multicast operator

• multicast operator는 모든 구독자가 설정되면 퍼블리셔를 트리거하기 위해 connect 메서드를 제공하는 ConnectablePublisher 타입을 사용한다.
• 여러 구독자에게 Element를 전달하기 위해 subject가 제공되어야 한다.

let postsSubject = PassthroughSubject<[Post], Never>()

let url = URL(string: "https://jsonplaceholder.typicode.com/posts")!
let posts = URLSession.shared.dataTaskPublisher(for: url)
  .map(\.data)
  .decode(type: [Post].self, decoder: JSONDecoder())
  .replaceError(with: [])
  .print()
  .multicast(subject: postsSubject)

• 위와 같이 작성하고 구독을 하면 아무일도 발생하지 않는다. 퍼블리셔가 트리거 되지 않았기 때문이다.

posts.connect().store(in: &cancellables)

• connect 연산자를 이용해야 한다.

Advantages

• multicast 연산자는 실제 네트워크 요청 구현을 비공개로 유지하면서 여러 구독자와 단일 리소스를 공유할 때 유용하다.

makeConnectable()

해당 메서드를 사용하면 연결 가능한 래퍼를 생성할 수 있다. Subject를 다룰 필요 없이 즉시 퍼블리셔를 ConnectablePublisher로 전환할 수 있다.

let url = URL(string: "https://jsonplaceholder.typicode.com/posts")!
let posts = URLSession.shared.dataTaskPublisher(for: url)
  .map(\.data)
  .decode(type: [Post].self, decoder: JSONDecoder())
  .replaceError(with: [])
  .print()
  .makeConnectable()

posts.connect().store(in: &cancellables)

autoconnect operator

• 명시적인 연결이 필요없을 경우에는 autoconnect operator를 사용하면 된다.
• 일부 퍼블리셔(e.g. Publishers.Multicast, Timer.TimerPublisher)는 ConnectablePublisher를 구현하고 있다.
• 여러 구독자를 연결할 필요가 없을 수 있기에 이 경우 명시적으로 connect()를 호출하는 것은 부담스러운 작업이고 휴먼 에러를 야기할 수 있다.
• 이 경우에는 autoconnect를 사용해서 즉시 이벤트를 수신할 수 있도록 하면 된다.

let cancellable = Timer.publish(every: 1, on: .main, in: .default)
    .autoconnect()
    .sink() { date in
        print ("Date now: \(date)")
     }

정리

1. 콤바인에서는 퍼블리셔가 기본적으로 Struct임
2. Value Type이라 구독이 발생하면 퍼블리셔의 복사가 발생함
3. 이러면 API 통신 같은 거에서 중복 요청이 발생할 수 있음
4. 여러 구독자가 생겨도 1회만 요청하게 바꾸고 싶음
5. share, multicast 연산자
6. → Struct를 Class로 래핑함 (Reference Type)
7. 여러 구독자가 1회의 요청에서 얻은 데이터를 받을 수 있게 해줌
8. share는 구독이 발생하면 곧바로 실행됨
   1. 구독자를 여러개 만들고 있는 과정에서 도중에 실행되면 나중에 구독한 친구는 값을 못받을 수 있음
   2. upstream을 여러 개의 publisher로 나누고 싶을 때.
9. multicast
   1. 구독자들을 미리 다 만들고 개발자가 필요한 시점에 connect()를 실행하면 그 때 퍼블리셔가 값을 생산하기 시작함
   2. ConnectablePublisher인데 애플에서 기본적으로 제공하는 Timer 퍼블리셔가 이 타입임
   3. 근데 우리가 모든 상황에서 여러 구독자를 만드는 것이 아니기 때문에 ConnectablePublisher 이지만 곧바로 실행되길 원하는 상황이 생길 수 있음 (Timer) 이 때를 위한 오퍼레이터가 autoconnect()이다.
10. 반드시 share를 사용해야 하는 것은 아님. Future를 사용해도 동일한 결과를 얻어낼 수 있음

Links:

• https://jllnmercier.medium.com/combine-share-and-multicast-dcd75fa7d9d6
• https://developer.apple.com/documentation/combine/controlling-publishing-with-connectable-publishers#Hold-Publishing-by-Using-a-Connectable-Publisher