URLSession + Combine 조합으로 네트워크 레이어 만들기

 

우리가 Firebase Firestore RestAPI 를 사용하면서,

기존에 사용했던 SDK 를 사용한 메서드를 다시 새로 구현해야했다.

 

먼저 우리는 Firestore로부터 데이터를 가지고오고, Firestore 로 데이터를 전송하기 위해

URLSession 을 사용해서 네트워크 작업을 처리했다.

 

네트워크 작업을 처리하기 위해 다양한 비동기 처리방식중 Combine을 채택하여

Combine 과 URLSession 이 둘 조합을 사용해보기로 했다.

 

먼저 큰 구조로 한번 생각해보면, 🤔

1. URL 에 대한 데이터 작업을 위한 Publisher 와
2. Publisher 를 구독해서 Publisher에서 발생하는 값을 처리할 Subscriber 가 필요합니다.

 

그래서 어떻게 네트워크 레이어를 구현할 것이냐 ! 🤔

1. 저는 먼저 생성된 URL 요청을 사용하여 Publisher를 생성해주는 메서드와
2. 생성된 Publisher를 구독하고, 발생하는 값을 처리할 메서드를 나눠서 구현할 겁니다!

 

 

이번 프로젝트는 MVVM 패턴으로 구성을 했고, 전체적인 네트워크 작업 레이어는 이렇게 구성되어있습니다. 👆🏻

 

 

먼저 Publisher 를 생성해주는 메서드는 이렇습니다.

static func getUser(nextPageToken: String) -> AnyPublisher<UserResponse, Error> {
        do {
            let request = try UserRouter.get(nextPageToken: nextPageToken).asURLRequest()
            return URLSession
                .shared
                .dataTaskPublisher(for: request)
                .map{ $0.data }
                .decode(type: UserResponse.self, decoder: JSONDecoder())
                .eraseToAnyPublisher()
        } catch {
            return Fail(error: HTTPError.requestError).eraseToAnyPublisher()
        }
    }

 

 

dataTaskPublisher ?

먼저 URLSession 의 메서드인 dataTaskPublisher(for:) 를 사용했는데요!

 

이 dataTaskPublisher(for:) 는 무엇을 하는 칭구냐면 ?

 

URLSession의 메서드이고, Combine 프레임워크에서 사용할 수 있는 Combine Publisher를 반환합니다.

이 Publisher를 사용해 우리는 비동기적인 네트워크 데이터 작업을 수행하고, 결과를 처리할 수 있는것이죠!

 

dataTaskPublisher(for:) 가 방출한 Publisher는 데이터 작업이 시작되면 데이터를 발생시키고,

작업이 완료되면 완료 이벤트를 방출합니다. 작업 도중에 발생하는 오류는 에러 이벤트로 처리합니다.

 

 

 

(위의 메서드,,, 너무 ,,, 뭐가 많죠 ? 하나씩 살펴볼게요 !!! 🤓)

1. UserRouter.get(nextPageToken: nextPageToken).asURLRequest(): UserRouter는 URL 요청을 생성하는 열거형 라우터에서 get(nextPageToken:) 메서드를 사용하여 URL 요청을 생성.
2. URLSession.shared.dataTaskPublisher(for: request): 생성된 URL 요청을 사용해서 dataTaskPublisher(for:) 메서드를 호출.
3. .map{ $0.data}: Publisher로부터 받은 (data: Data, response: URLResponse) 튜플을 받아 데이터 부분만 추출.  .data 프로퍼티를 사용하여 데이터에 접근.
4. .decode(type: UserResponse.self, decoder: JSONDecoder()): 추출한 데이터를 JSONDecoder() 를 사용하여 JSON 데이터를 UserResponse 타입으로 디코딩.
5. .eraseToAnyPublisher(): decode 메서드의 반환 타입은 Publishers.Decode 타입이지만, 반환 타입을 AnyPublisher<UserResponse, Error>로 변환하기 위해 eraseToAnyPublisher()를 호출.
6. return Fail(error: HTTPError.requestError).eraseToAnyPublisher(): 요청 생성 또는 네트워크 작업 중에 오류가 발생한 경우, HTTPError.requestError를 가진 Fail Publisher를 반환. 이 경우에도 eraseToAnyPublisher()를 호출하여 반환 타입을 AnyPublisher<UserResponse, Error>로 변환.

 

getUser 메서드의 반환값은 결국 AnyPublisher<UserResponse, Error> 가 되는데,

 

이는 비동기 작업의 결과가 

• 성공적인 경우 UserResponse 형식으로
• 실패한 경우 Error형식 으로 전달하기 위함입니다.

 

이를 통해 작업의 성공 또는 실패에 따라 적절하게 처리를 할 수 있게 되는거죠!

 

이렇습니다 … 정말 ,,, 쉽죠잉 ?

 

 

그럼 Publisher를 생성하면 구독(Subscription) 은 어떻게 할까요 ?

그렇다면 위의 메서드에서 Publisher를 반환하면 이제 어떤 작업을 수행해야할까요 ?

이 발행된 Publisher를 구독하여 작업이 수행되면, 발생된 데이터를 처리해야겠죠!

 

바로 이 작업은 ViewModel 안에서 수행됩니다. !

1. 먼저 ViewModel 안에 유저 데이터를 저장하고, 데이터 상태를 관리할 “users” (@Published) 변수를 선언해줍니다.
2. fetchUsersSuccess 라는 PassthroughSubject 를 선언해줍니다.

PassthroughSubject 도 publisher이고, 작업이 끝나면 send 메서드를 호출해서 새 값을 발행시켜 줄겁니다.

 

@Published var users = [UserDocument]()
var fetchUsersSuccess = PassthroughSubject<[UserDocument], Never>()

func fetchUser() {
        UserService.getUser()
            .receive(on: DispatchQueue.main)
            .sink { (completion: Subscribers.Completion<Error>) in
             // 에러를 처리하는 코드 작성
              switch completion {
              case .finished:
                  print("작업이 성공적으로 완료되었습니다.")
              case .failure(let error):
                  print("에러 발생: \(error)")
            } receiveValue: { (data: UserResponse) in
              // 받은 값 처리 
              users = data.document   
              self.fetchUsersSuccess.send(data.documents)
            }.store(in: &subscription)
    }

 

먼저 fetchUser 메서드에서 UserSerivce.getUser() 를 호출해서 Publisher를 return 하면

sink 를 통해 구독을 하게 되는데요,

 

sink ?

여기서 주목해야할 메서드는 sink 입니다 ! 한번 알아볼게요 

바로 이 sink 메서드를 사용하면, puslisher 와 subscriber 를 연결하는 subscription을 아주 쉽게 만들 수 있습니다.

 

또 이 sink 메서드를 사용해서 Publisher 에서 발생하는 값 또는 완료 및 에러 이벤트를 처리할 수 있습니다.

 

sink 메서드의 receiveCompletion 클로져에서 completion 매개변수타입은

Subscribers.Completion<Error> 입니다 . Subscribers.Completion은 Combine 프레임워크에서 완료 및 에러 이벤트를 나타내기 위해 사용되는 열거형입니다.

 

이 열거형은 아래 두가지 케이스를 가지고 있고 각각의 이벤트를 처리할 수 있습니다!

1. .finished : 작업이 성공적으로 완료된 경우
2. .failure : 작업이 성공적으로 완료되지 못한 채 에러가 발생한 경우

 

 

receivedValue ?

sink 메서드 바로 다음에 보이는 receivedValue 클로져는

sink 를 통해 pulisher 를 구독하고, Publisher가 데이터를 발생했을때 호출되고,

이 데이터를 처리하기 위해 사용됩니다.

그래서 서버에서 데이터를 받아오면 그 데이터를 VM 에 프로퍼티인 users 배열에 저장해주게 되는거죠!

 

 

 

 

여기까지 URLSession 과 Combine을 사용해서 데이터를 요청하고, 데이터를 받아와 처리 하는 과정을 알아봤습니다.

 

다음은 URLSession 의 URL 을 만드는 과정에 대해서 알아볼게용

(위에 네트워크 레이어에 있는 Router 는 뭐하는 칭구일까 ? )

To be Continue ~

 

 

 

오늘도 해결완 ~ 😃