[swift] Moya와 ObjectMapper를 사용하여 JSON 데이터를 모델로 변환하는 방법 및 예제 구현 설명

15 Nov 2023

swift

Moya와 ObjectMapper 소개

Moya는 네트워킹 라이브러리로, Alamofire를 기반으로 하여 Swift 언어를 위해 제작된 강력한 도구입니다. ObjectMapper는 JSON 데이터를 Swift 객체로 매핑하기 위한 라이브러리입니다. 이 둘을 결합하여 사용하면, 네트워킹을 통해 받은 JSON 데이터를 쉽게 모델 객체로 변환할 수 있습니다.

설치 및 설정

Moya와 ObjectMapper를 설치하기 위해서는 각각의 라이브러리를 프로젝트에 추가해야 합니다. CocoaPods를 사용한다면, Podfile에 아래의 코드를 추가합니다:

pod 'Moya'
pod 'ObjectMapper'

설치가 완료되면, 프로젝트의 코드에서 라이브러리를 import 해줍니다:

import Moya
import ObjectMapper

Moya와 ObjectMapper를 사용하여 JSON 데이터를 모델로 변환하는 방법

먼저, MoyaProvider 객체를 생성하여 Moya에 사용할 타깃(Target)을 설정합니다. 타깃은 네트워킹에 필요한 endpoint, HTTP method 등을 정의합니다.
MoyaProvider를 사용해 API 요청을 보내면, Moya는 네트워킹을 처리하고 JSON 데이터를 받아옵니다.
ObjectMapper를 사용하여 받아온 JSON 데이터를 모델 객체로 변환합니다. ObjectMapper는 JSON 데이터와 모델 클래스를 매핑하기 위해 필요한 메소드를 제공합니다.

아래는 간단한 예제입니다:

// 모델 클래스
class Person: Mappable {
    var name: String?
    var age: Int?
    
    required init?(map: Map) { }
    
    func mapping(map: Map) {
        name <- map["name"]
        age <- map["age"]
    }
}

// Moya 타깃 설정
enum API {
    case getUser
}

extension API: TargetType {
    var baseURL: URL {
        return URL(string: "https://api.example.com")!
    }
    
    var path: String {
        switch self {
        case .getUser:
            return "/user"
        }
    }
    
    var method: Moya.Method {
        switch self {
        case .getUser:
            return .get
        }
    }
    
    var task: Task {
        switch self {
        case .getUser:
            return .requestPlain
        }
    }
    
    var headers: [String : String]? {
        return nil
    }
}

// API 요청 및 JSON 데이터를 모델로 변환
let provider = MoyaProvider<API>()
provider.request(.getUser) { (result) in
    switch result {
    case .success(let response):
        do {
            let json = try response.mapJSON()
            let person = Mapper<Person>().map(JSONObject: json)
            
            // 변환된 모델 객체 사용
            if let person = person {
                print("Name: \(person.name), Age: \(person.age)")
            }
        } catch {
            print("Error mapping JSON")
        }
    case .failure(let error):
        print("Error: \(error.localizedDescription)")
    }
}

예제 구현 설명

위의 예제에서는 “https://api.example.com/user” 주소로 GET 요청을 보내어 사용자 정보를 받아옵니다. 받아온 JSON 데이터를 ObjectMapper를 사용하여 Person 모델 객체로 변환합니다. 변환된 모델 객체의 name과 age 속성에 접근하여 값을 확인합니다.

결론

Moya와 ObjectMapper를 사용하여 JSON 데이터를 모델로 변환하는 방법을 알아보았습니다. Moya를 사용하면 네트워킹을 편리하게 처리할 수 있으며, ObjectMapper는 JSON 데이터를 Swift 객체로 변환하는데 유용한 기능을 제공합니다. 이 두 라이브러리를 조합하여 사용하면 모델 객체를 쉽고 효율적으로 생성할 수 있습니다.

목차

Moya와 ObjectMapper 소개

설치 및 설정

Moya와 ObjectMapper를 사용하여 JSON 데이터를 모델로 변환하는 방법

예제 구현 설명

결론