Moya

모야가 대체 모야?

(아마 한국인이 작성한 모야 게시물 80%는 이걸로 시작할듯…)

그래서 모야는 뭘까요?

Moya는 enum 타입을 적극적으로 활용하여 네트워크 요청 레이어를 type-safe하게 래핑한 네트워킹 라이브러리입니다.

컴파일 타임에 엔드포인트 접근 관련 에러를 띄워주기 때문에 더욱 안전하고 간편하게 앱을 빌드할 수 있다는 장점이 있다고 해요!

Alamofire와의 관계?

Swift 언어를 처음 학습할 때 URLSession을 공부한 뒤에 네트워크 관련된 유용한 라이브러리가 많다는 사실을 알고 어떤 것이 있나 살펴보던 때가 있었습니다.

모두가 알고 있는 Alamofire, Kingfisher, Moya 등이 있었죠..

그 중에서 Kingfisher는 이미지 관련 라이브러리니 남는 건 Alamofire와 Moya였습니다.

아무것도 모르던 저는 Moya의 귀여운 이름에 끌려 무작정 공부를 시작했더랩죠..

무슨 말인지 하나도 이해하지 못하고 Alamofire로 후퇴했었는데요.. 당연한거였습니다.

Moya의 네트워킹은 사실 Alamofire를 사용하기 때문이죠…!

Dependency에 떡하니 박혀있는게 보이시죠..

개념

모야를 이해하려면 세 가지 핵심 요소를 먼저 알아야합니다.

Provider

MoyaProvider 객체로 접근할 수 있는 메인 객체입니다.

네트워크 관련 기능을 사용하기 위해서는 무조건 이 MoyaProvider 객체를 생성하거나 주입받아야 합니다.

Target

API를 제공하는 서비스를 부르는 명칭입니다.

공개된 오픈 API일 수도 있고, 프로젝트 내부에서 사용되는 서버의 API일 수도 있겠죠.

이 Target은 TargetType protocol을 사용해서 정의해줄 수 있습니다.

Endpoint

Endpoint는 네트워킹 요청을 위해 필요한 정보들을 담는 객체입니다.

HTTP 메서드, request body / header 등의 정보들을 담고 있고, Target 또한 MoyaProvider에 의해 이 Endpoint로 변환되어 사용됩니다.

이 Endpoint를 커스텀하면 모든 종류의 네트워킹에 필요한 데이터 맵핑을 수행할 수 있다고 하네요.

기초

공식 문서보다는 코데코의 예제가 쉬워보이니까 코데코의 예제로 진행해보겠습니다.

public enum Marvel {
  static private let publicKey = "PUBLIC_KEY"
  static private let privateKey = "PRIVATE_KEY"

  case comics
}

이렇게 enum 타입으로 API 서비스에 대한 정보를 넣어줄 수 있습니다.

case에는 필요한 API 엔드포인트마다 정의해주면 됩니다.

enum MyService {
    case zen
    case showUser(id: Int)
    case createUser(firstName: String, lastName: String)
    case updateUser(id: Int, firstName: String, lastName: String)
    case showAccounts
}

이렇게요..!

연관값으로 넣어준 파라미터들은 리퀘스트시에 파라미터가 필요할 경우 넣어주는 것으로 편하게 사용할 수 있습니다.

Target으로 사용될 enum은 반드시 TargetType 프로토콜을 채택해야 한다고 했었죠?

extension Marvel: TargetType {
  public var baseURL: URL {
	//
  }

  public var path: String {
	//
  }

  public var method: Moya.Method {
	//
  }

  public var sampleData: Data {
	//
  }

  public var task: Moya.Task {
	//
  }

  public var headers: [String : String]? {
	//
  }
}

프로토콜을 채택하고 필요한 프로퍼티들을 자동으로 넣어주면 위와 같은 형태가 됩니다.

extension Marvel: TargetType {
  public var baseURL: URL {
    return URL(string: "https://gateway.marvel.com/v1/public")!
  }

  public var path: String {
    switch self {
    case .comics: return "/comics"
    }
  }

  public var method: Moya.Method {
    switch self {
    case .comics: return .get
    }
  }

  public var sampleData: Data {
    return Data()
  }

  public var task: Moya.Task { // TODO: 알맞는 옵션으로 변경
    return .requestPlain
  }

  public var headers: [String : String]? {
    return ["Content-Type": "application/json"]
  }

  public var validationType: ValidationType {
    return .successCodes
  }
}

baseURL

API 서비스의 baseURL을 입력해줍니다.

path

baseURL 뒤에 붙는 요청 API의 path 주소를 입력해줍니다.

예시의 경우 전체 API 요청 주소는 https://gateway.marvel.com/v1/public/comics 가 되겠죠!

method

path에 맞는 HTTPS 통신 메서드를 반환해줍니다.

ex) .get, .delete, .patch 등

sampleData

유닛 테스트를 할 때나 실제로 서버가 없을 경우, 이 sampleData로 가상의 데이터를 담아주면 해당 데이터를 반환값으로 받아옵니다.

필요하지 않을 경우 Data()를 반환하여 비어있는 데이터를 전달해줍니다!

task

요청에 파라미터를 포함하거나, 데이터를 포함하여 요청을 하는 등의 옵션들을 추가적으로 제공하여 HTTP 요청을 전송합니다.

API가 요구하는 양식이나 서버의 상태등에 따라 너무나 다양한 경우가 있으므로 우선 아무런 옵션을 넣지 않는 .requestPlain을 선택해주었습니다.

headers

HTTP 헤더를 넣어줍니다.

예시에서는 가장 자주 쓰이는 Content-Type: application/json을 넣어주었습니다. (JSON 형식의 컨텐츠)

validationType

필수적으로 필요한 항목은 아니지만, 자주 쓰이는 항목입니다.

.successCodes는 200..<299 사이의 응답 코드를 받으면 통신을 성공했다고 처리하는 case입니다.

이 Target만 봐도 Moya가 대충 어떤 느낌으로 쓰이는 지 알 수 있을 것 같네요.

통신에 필요한 데이터들을 한 군데 모아두고 switch-case를 통해서 쉽게 요청 항목을 선택할 수 있을 것 같습니다.

https://developer.marvel.com/documentation/authorization

이번에 사용하는 마블 API의 문서를 살펴보고, task 부분을 채워줍시다.

Client-Side 앱은 사전에 인증이 되어 있어야 한다는군요.

Server-Side 방식으로 진행해줍니다.

public var task: Task {
  let ts = "\(Date().timeIntervalSince1970)"
  let hash = (ts + Marvel.privateKey + Marvel.publicKey).md5
  let authParams = ["apikey": Marvel.publicKey, "ts": ts, "hash": hash]
  
  switch self {
  case .comics:
	return .requestParameters(
	  parameters: [
		"format": "comic",
		"formatType": "comic",
		"orderBy": "-onsaleDate",
		"dateDescriptor": "lastWeek",
		"limit": 50] + authParams,
	  encoding: URLEncoding.default)
  }
}

이제 실제로 API request를 보내봅시다.

let provider = MoyaProvider<Marvel>()

provider.request(.comics) { result in
  switch result {
  case .success(let response):
	do {
	  print(try response.mapJSON())
	} catch {
	  // error handling
	}
  case .failure:
	// error handling
  }
}

위와 같이 짧고 간결하게 통신 요청을 보낼 수 있습니다.

엄청나게 많은 데이터들이 들어오는군요..

이 데이터들을 감싸고 View에 적용하는 내용은 다른 HTTP 통신들과 같습니다.

Moya는 RxSwift와도 아주 잘 어울립니다.

provider.rx.requestWithProgress(.zen).subscribe { event in
    switch event {
    case .next(let progressResponse):
        if let response = progressResponse.response {
            // do something with response
        } else {
            print("Progress: \(progressResponse.progress)")
        }
    case .error(let error):
        // handle the error
    default:
        break
    }
}

이런식으로 기본적으로 Rx화도 되어있거든요. (패키지를 설치할 때 Moya/RxSwift도 함께 설치해주어야 합니다.)

대략적인 사용 방법을 알았으니 실전에 적용해보기 위해 떠나보도록 하겠습니다.

References

Kodeco - # Moya Tutorial for iOS: Getting Started

Moya - Basic Usage