iOS [Swift] - Moya를 통한 네트워크 통신

📄

목차

개념

특징

Flow (정말 간단하게만 사용법 익히기)

마무리

References

iOS에서 네트워크 작업이라고 하면 가장 떠오르는 URLSession, Alamofire가 있을 것이다. URLSession은 프로젝트의 복잡도가 올라가고 가독성이 안좋은 반면, URLSession 기반의 Alamofire는 보다 간결하고 가독성이 좋다. 하지만, Alamofire는 유지보수 & 테스트에 적합하다고 확언할 수 없다. 그래서 오늘의 주제 Moya를 살펴볼 것이다.

---

개념

• URLSession을 추상화 시킨 Alamofire를 한 번 더 추상화시킨 Networking Library이다.

• Enum(열거형)을 사용해서 네트워크 요청을 type-safe한 방식으로 캡슐화한다. (안전 & 깔끔)
  • type-safe

    • 해당 Type에는 정해진 Type만 저장이 가능하다. 라는 의미 (다른 Type 안돼!! ❌)

    • 즉, 변수의 Type이 명확해진다.

---

특징

• Alamofire에서 네트워크 계층을 구조화하는 방법과는 다른 방법을 제공한다.

• Alamofire Library를 Enum 타입으로 만들어 더 사용성과 테스트성을 용이하게 만들었다.
  • Enum이기 때문에 Type 지정을 해주기 편하다.

• 기존 네트워킹 방식 VS Moya

  

  • 기존 네트워킹 사용법은 왼쪽 그림처럼 Network Layer를 통해 자유롭게 구현되고 있다.

  • 따라서, 기존 네트워킹 방식은 다음과 같은 문제점들을 가지고 있었다.

    • 새 App을 작성하기 어렵다.(어디서부터 시작해야하는가?)

    • 기존 App을 유지하기 어렵게 만든다.(아놔, 너무 엉망 진창이네..)

    • 단위 테스트를 작성하기 어렵게 만든다.(이 작업을 다시 하려면 어떻게 해야해?)

  • Moya는 오른쪽 그림처럼 보다 깔끔한 Layer를 통해 자체적으로 네트워킹을하지 않고 Alamofire를 통해 구현된다.

  • 뿐만 아니라, Network Layer를 Template화 시켜서 재사용이 가능하다.

• Moya의 장점

  • 올바른 API 엔드포인트 액세스를 위한 컴파일 시간 검사.

  • 연결된 열거형 값을 사용하여 다양한 엔드포인트의 명확한 사용법을 정의할 수 있습니다.

  • 테스트 스텁을 일급 시민으로 취급하므로 단위 테스트가 매우 쉽습니다.

---

Flow (정말 간단하게만 사용법 익히기)

1. Pod 설치
   1. pod init
   2. pod install

   pod 'Moya', '~> 15.0'

2. API 통신을 위한 Moya > TargetType을 정의

import Foundation
import Moya

enum APIClient {
  case users, todos, comments
}

extension APIClient: TargetType {
  var baseURL: URL {
    switch self {
    case .users, .todos, .comments:
      return URL(string: "https://jsonplaceholder.typicode.com/")!
    }
  }
  
  var path: String {
    switch self {
    case .users:
      return "users"
    case .todos:
      return "todos"
    case .comments:
      return "comments"
    }
  }
  
  var method: Moya.Method {
    switch self {
    case .users, .todos, .comments:
      return .get
    }
  }
  
  var task: Moya.Task {
    switch self {
    case .users:
      return .requestPlain
    case .todos:
      return .requestPlain
    case .comments:
      return .requestPlain
    }
  }
  
  var headers: [String : String]? {
    return ["Content-type": "application/json"]
  }
}

3. Json Model Struct 작성

struct Todos: Codable {
  var userId: Int
  var id: Int
  var title: String
  var completed: Bool
}

4. API 통신

func getDataFromJsonPlaceHolder() {
    let moyaProvider = MoyaProvider<APIClient>()
    
    moyaProvider.request(.todos) { result in
      switch result {
      case .success(let response):
//        guard let todoTitle = try? response.mapJSON() else { return }
        guard let todo = try? response.map([Todos].self) else { return }
        self.labelText.text = todo[Int.random(in: 1..<10)].title
      case .failure(let moyaError):
        print(moyaError.errorDescription ?? "Moya API Request Error")
      }
    }
  }

---

마무리

• URLSession & Alamofire VS Moya 차이점
  • 기존에 사용해봤던 URLSession과 Alamofire는 request/response를 하면서 동시에 여러가지(url, method 등)를 신경 써야했다. (사용할 때마다 반복 작성)
  • Moya를 공부하고 사용해보면서 하나의 타입을 다 정의 해줘야한다는 작업이 조금(?)은 귀찮을 수 있지만, 같은 API를 많이 사용하게 되는 프로젝트라면 사용하는게 좋다고 생각됐다.
  • 아무래도 같은 API에 대해서 반복적으로 같은 코드를 작성하는 것은 비효율적일 수 있다. 또한, 데이터 처리하는 과정에서 어쩌면 집중도를 떨어뜨리는 요인이 될 수 있다고 생각한다.
  • Moya의 TargetType에서 여러가지 항목들을 미리 작성해놓고, 반복적으로 사용되는 부분을 재사용한다면 데이터 처리하는 과정에서 보다 집중도 있고 가독성이 좋은 코드를 작성할 수 있다고 생각한다.

• 오히려 내가 지금 반복적으로 말하고 있긴하지만 ㅋㅋ 아무튼간!! Moya는 상황에 따라 맞춰 필요한 프로젝트에 적용하면 좋을 것 같다.

• 그리고 Moya를 좀 더 효율적으로 쓰기 위해선 CommonMoyaProvider를 만들어서 모든 API 코드에 적용하는 것이 좋다고 생각한다.
  • ex) 모든 api response에 중복 로그인 에러 처리를 하는 반복적인 코드를 작성하지 않기 위해 Custom 해주는 것.
  • CommonMoyaProvider에는 Moya TargetType을 가진 API들을 모두 담아 사용할 수 있도록 Generic 형태로 사용하는 것이 좋다. CommonMoyaProvider<T: TargetType>

• 막 네트워크 통신을 위해서 Moya는 쓰는게 진짜 좋아!! 이정도의 메리트는 아닌 느낌이 들었다. 그러나 분명히 쓰임새가 좋고 활용도가 높은건 확실!하다. 코드도 간결해지고..?

• 이번 포스팅 끝!

References

iOS Networking and Testing | 우아한형제들 기술블로그

Networking은 요즘 앱에서 거의 필수적인 요소입니다. 설치되어 있는 앱들 중에 네트워킹을 사용하지 않는 앱은 거의 없을 겁니다. API 추가가 쉽고 변경이 용이한 네트워킹 모듈을 개발하는것이 중요한 이유죠. 미드 보셨나요? 쉘든 쿠퍼 라는 주인공은 16살에 박사학위를 취득할 만큼 천재이면서 동시에 대단히 특이한 사람입니다. 주변에서 "Are you crazy?" 라는 말을 자주 듣습니다.

https://techblog.woowahan.com/2704/

Uploaded by N2T