[swift] Moya와 ObjectMapper를 사용하여 API 호출 후 데이터 매핑하는 프로세스 이해하기 설명

15 Nov 2023

swift

Moya와 ObjectMapper는 Swift를 위한 두 가지 훌륭한 라이브러리입니다. Moya는 네트워크 작업을 추상화하고 API 호출을 쉽게 관리할 수 있는 기능을 제공하며, ObjectMapper는 JSON 데이터를 모델 객체로 변환하는 역할을 합니다. 이 두 라이브러리를 함께 사용하면 API 호출 후 데이터를 매핑하는 프로세스를 더욱 간단하게 구현할 수 있습니다.

Moya

Moya를 사용하면 API 호출을 위한 네트워크 작업을 추상화할 수 있습니다. Moya는 URLSession과 Alamofire를 기반으로 동작하며, Endpoint와 Target을 통해 서버의 API 엔드포인트와 작업을 정의합니다. Moya의 장점 중 하나는 코드의 가독성이 우수하다는 것입니다.

아래는 간단한 Moya 타겟(Target)의 예제입니다.

import Moya

enum MyAPI {
    case getUser(id: Int)
    case createUser(name: String, email: String)
}

extension MyAPI: TargetType {
    var baseURL: URL {
        return URL(string: "https://api.example.com")!
    }
    
    var path: String {
        switch self {
        case .getUser(let id):
            return "/users/\(id)"
        case .createUser:
            return "/users"
        }
    }
    
    var method: Moya.Method {
        switch self {
        case .getUser:
            return .get
        case .createUser:
            return .post
        }
    }
    
    var task: Task {
        switch self {
        case .getUser, .createUser:
            return .requestPlain
        }
    }
    
    var headers: [String: String]? {
        return nil
    }
}

위의 코드에서는 getUser와 createUser 두 가지 API 호출을 정의합니다. 각 호출에 대해 엔드포인트, HTTP 메소드, 파라미터 등을 설정하고 있습니다.

ObjectMapper

ObjectMapper는 JSON 데이터를 모델 객체로 변환하는 역할을 합니다. ObjectMapper는 Swift의 Codable 프로토콜 대신 사용할 수도 있으며, 기존의 모델 객체에 타입 안전성을 제공하고 유지보수를 용이하게 해줍니다.

아래는 ObjectMapper를 사용하여 JSON 데이터를 매핑하는 예제입니다.

import ObjectMapper

struct User: Mappable {
    var id: Int?
    var name: String?
    var email: String?
    
    init?(map: Map) {}
    
    mutating func mapping(map: Map) {
        id <- map["id"]
        name <- map["name"]
        email <- map["email"]
    }
}

let userJSON = """
{
    "id": 1,
    "name": "John Doe",
    "email": "john.doe@example.com"
}
"""

if let user = Mapper<User>().map(JSONString: userJSON) {
    print(user.name ?? "")
}

위의 예제에서는 User라는 모델 객체를 정의하고, ObjectMapper를 사용하여 JSON 데이터를 User 객체로 매핑하고 있습니다.

Moya와 ObjectMapper를 함께 사용하기

Moya와 ObjectMapper를 함께 사용하면, Moya의 API 호출 결과를 ObjectMapper를 통해 모델 객체로 변환할 수 있습니다.

import Moya
import ObjectMapper

// Moya로 API 호출
let provider = MoyaProvider<MyAPI>()
provider.request(.getUser(id: 1)) { result in
    switch result {
    case let .success(response):
        do {
            // ObjectMapper로 JSON 데이터를 모델 객체로 변환
            let user = try response.mapObject(User.self)
            print(user.name ?? "")
        } catch {
            print("Mapping error: \(error)")
        }
    case let .failure(error):
        print("Network error: \(error)")
    }
}

위의 코드에서는 Moya로 API 호출을 수행하고, 성공적인 응답이 있을 경우 ObjectMapper를 사용하여 JSON 데이터를 User 객체로 변환하는 과정을 보여주고 있습니다.

Moya와 ObjectMapper를 함께 사용하면, API 호출 후 데이터 매핑 과정이 간단해지고, 코드의 가독성과 유지보수성이 향상됩니다.

결론

Moya와 ObjectMapper를 함께 사용하면 Swift에서 API 호출 후 데이터 매핑하는 프로세스를 더욱 효율적이고 간단하게 구현할 수 있습니다. 이 두 라이브러리는 개발 생산성을 향상시키고, 코드의 가독성과 재사용성을 높여줍니다.