[Swift] CodingKey

다들 Codable은 많이 사용하시죠~~~??  Codable에 대한 설명은 👉 여기에

간단히 요약하면 네트웍 통신 등을 통해 외부와 데이터를 주고 받는 가장 보편적인 데이터 포맷이 json이죠!!

이 json파일을 앱에서 사용가능하도록 Object로 만드는 과정을 Decoding, 앱의 Object를 json파일로 만드는 과정을 Encoding 이라고 했었죠! 그리고 Encoding, Decoding 프로토콜을 둘 다 포함하는게 Codable 프로토콜이었습니다 🤟

 

Codable 프로토콜을 통해 Encoding, Decoding은 알고 있다고 생각하고 훌 훌 지나갑니다!! 여기 꼭 보고오세요👍

Codable은 Swift에서 굉장히 강력한! 기능을 제공해주는 것은 맞습니다만,,,, 

그냥 사용하게 되면 외부의 데이터 key값과 우리 앱에서 사용하는 Object의 property 이름이 같아야 했죠!

 

예를 들어 우리 앱에서는 카멜케이스를 사용해서, 이렇게 프로퍼티명을 정해줬다고 칩시다.

struct Car {
    var model: String
    var maxSpeed: Int
    var createAt: Date
}

근데.. 서버에서 내려오는 json의 키값이 max_speed 처럼 스네이크 케이스를 사용하거나, highSpeed 처럼 다른 Key명을 가진다면 아마 Codable만 사용해서는 Parsing이 안될거에요 😭

 

이렇게 json데이터의 Key값과, Object의 프로퍼티명이 다를때! 필요한게 CodingKey 타입이에요.

 

CodingKey 역시 프로토콜이고, 인코딩 및 디코딩을 위한 키로 사용할 수 있는 타입이라고 하네요 😎

 

*약간* 복잡한 예시를 가지고 설명해볼게요! 집중해주세요 🙏

우리는 서버에서 이런 json데이터를 내려받았고, 우리에게 필요한 데이터는 위에서 초록색 박스에 있는 녀석들이에요!

근데 우리는 Video Object의 프로퍼티명을 이렇게 정의해줬어요.

struct Video: Decodable { 
    var videoId: String
    var title: String
    var description: String
    var thumbnail: String
    var published: Date
}

음.. 그러면 키값이 달라서 정상적으로 Codable을 바로 사용할 수 없는 상황이 됐죠~~?

 

지금부터 CodingKey를 통해 해결해볼게요!!

enum CodingKeys: String, CodingKey {       
        case published = "publishedAt"
        case title
        case description
        case thumbnail = "url"
        case videoId
}

짠~~ 이렇게 CodingKey 프로토콜을 채택하는 CodingKeys라는 enum타입을 통해 실제로 json데이터에 있는 key이름을 명시적으로 지정해줬어요! 여기서 String을 채택하는 이유는, json의 모든 key명이 String이기 때문이에요~!!

이제는 "이 키값을 이 프로퍼티에 사용해라!"라고 해준거죠 ㅎㅎ

 

그런데.... 이렇게 CodingKey로 바로바로 지정해주는데는 한계점이 있어요,

바로.. 저렇게 단순하게 사용하기 위해선 json에서 { } 로 감싸져 있는 depth가 같아야 한다는거에요!

위 json데이터를 예로들면, items (1depth), snippet (2depth), title (3depth), url (5depth) 이렇게 모두 depth가 다르죠~?

이런 경우에는 CodingKey만 딱! 지정해줬다고 바로 찾을 수가 없어요.😭

(만약 이 경우에도 depth가 모두 같았다면 아래 과정은 필요없이 바로 사용이 가능해요 😎)

 

그래서 지금부터 초기화코드에서 내가 원하는 저 키값이 json에서 어느 위치(depth)에 있는지를 같이 명시적으로 알려줄거에요!

우선, 우리가 찾는 키값이 있는 곳까지 가기 위해 거쳐야하는 상위 depth의 키값들을 같이 정의해주세요.

 enum CodingKeys: String, CodingKey {
 
        case snippet
        case thumbnails
        case high
        case resourceId
        
        case published = "publishedAt"
        case title
        case description
        case thumbnail = "url"
        case videoId
}

 

 

본격 초기화 설명에 앞서, json에서 "container" 라는 개념은 json에서 { }로 묶인 하나의 단위 라고 생각해주세요!

 init(from decoder: Decoder) throws {
 
        let container = try decoder.container(keyedBy: CodingKeys.self)
    } 

decoder를 파라미터로 갖는 init 메소드를 사용해줄거에요.

먼저 container를 정의해줬죠!? 이건 최상위 { } 에 포함된 container를 정의해준거에요 -> 여기선 items { }

 

다음은 snippet에 대한 container를 정의해줘볼게요.

init(from decoder: Decoder) throws {

        let container = try decoder.container(keyedBy: CodingKeys.self)
        let snippetContainer = try container.nestedContainer(keyedBy: CodingKeys.self, forKey: .snippet)
        
}

이 말은 먼저 정의해줬던 container { } 의 바로 "하위에 nesting 되어있는 { } 컨테이너를 가져와서 우리가 CodingKeys에 정의한 snippet에 이 컨테이너를 할당해줘라!" 라는 의미가 되는거에요.

아직은 조~금 느낌은 오지만 헷갈리죠~~?

 

init(from decoder: Decoder) throws {

        let container = try decoder.container(keyedBy: CodingKeys.self)
        let snippetContainer = try container.nestedContainer(keyedBy: CodingKeys.self, forKey: .snippet)
        self.title = try snippetContainer.decode(String.self, forKey: .title)
        
}

title 이라는 키값은 snippet이라는 컨테이너에 바로 포함되어 있죠!? 우리가 원하는 title을 찾았네요!!

그래서 CodingKeys에 정의한 title에, 지금 찾은 json에서의 title 을 할당해줘라! 라고 해줍니다!

 

published, description 2가지는 title과 같은 depth에 있으니 똑같이 적용 해줍니다.

init(from decoder: Decoder) throws {

        let container = try decoder.container(keyedBy: CodingKeys.self)
        let snippetContainer = try container.nestedContainer(keyedBy: CodingKeys.self, forKey: .snippet)
        self.title = try snippetContainer.decode(String.self, forKey: .title)
        self.description = try snippetContainer.decode(String.self, forKey: .description)
        self.published = try snippetContainer.decode(Date.self, forKey: .published)
}

 

약~간 느낌이 조금 더 오시나요!?

이번에는 snippet 컨테이너로부터 2depth 하위에 있는 url 키를 찾아서, thumbnail에 할당해줄거에요!

init(from decoder: Decoder) throws {

        let container = try decoder.container(keyedBy: CodingKeys.self)
        let snippetContainer = try container.nestedContainer(keyedBy: CodingKeys.self, forKey: .snippet)
        self.title = try snippetContainer.decode(String.self, forKey: .title)
        self.description = try snippetContainer.decode(String.self, forKey: .description)
        self.published = try snippetContainer.decode(Date.self, forKey: .published)
        
        let thumbnailContainer = try snippetContainer.nestedContainer(keyedBy: CodingKeys.self, forKey: .thumbnails)
        let highContainer = try thumbnailContainer.nestedContainer(keyedBy: CodingKeys.self, forKey: .high)
}

이렇게요! snippet 컨테이너 하위에 nesting 되어있는 thumbnails 컨테이너를 할당해주고,

thumbnails 하위에 nesting 되어있는 high 컨테이너까지 할당해줬어요!

self.thumbnail = try highContainer.decode(String.self, forKey: .thumbnail)

그리고선 실제로 사용하려고 했던 thumbnail에 url 키값에 있는 녀석을 할당해주는거죠!

여기서 .thumbnail 이라고만 써줬는데, CodingKeys를 정의할때 url을 사용하라고 명시해줬기 때문에 이렇게 써줍니다👍

 

마찬가지로 videoId까지 가져온 전체 초기화 코드는 아래와 같아요.

init(from decoder: Decoder) throws {

        let container = try decoder.container(keyedBy: CodingKeys.self)
        let snippetContainer = try container.nestedContainer(keyedBy: CodingKeys.self, forKey: .snippet)
        self.title = try snippetContainer.decode(String.self, forKey: .title)
        self.description = try snippetContainer.decode(String.self, forKey: .description)
        self.published = try snippetContainer.decode(Date.self, forKey: .published)

        let thumbnailContainer = try snippetContainer.nestedContainer(keyedBy: CodingKeys.self, forKey: .thumbnails)
        let highContainer = try thumbnailContainer.nestedContainer(keyedBy: CodingKeys.self, forKey: .high)
        
        self.thumbnail = try highContainer.decode(String.self, forKey: .thumbnail)
        
        let resourceIdContainer = try snippetContainer.nestedContainer(keyedBy: CodingKeys.self, forKey: .resourceId)
        self.videoId = try resourceIdContainer.decode(String.self, forKey: .videoId)
        
    }

이제 좀 느낌이 오시죠~~? ㅎㅎ 🤟

 

 

음.. 근데 왜 items에 대한 CodingKey는 안써줬는지 궁금하죠~~? items는 따로 빼주었어요!

이 소스는 위에서 해온 과정과 완전 동일해서 쉽게 이해 가능하실거에요 🤙

struct Response: Decodable {
    
    var items: [Video]?
    
    enum CodingKeys: String, CodingKey {
        case items
    }
    
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.items = try container.decode([Video].self, forKey: .items)
    }
}

이렇게 따로 Response Object를 정의해서 빼줬답니다! 실제로 디코딩 과정에서 아래처럼 식별하기 위함이에요 😁

let response = try decoder.decode(Response.self, from: data!)

 

 

오늘은 CodingKey에 대해 다소 복잡한 예제를 가지고 설명해봤는데요!

쉬운 예제만 보다가 어려운 실전을 만나는 것보다는.. 어렵게 공부하고 실전에서 쉽게 만나자는 취지에서.. 👍

오늘도 누군가에게 도움이 되었길 바래요!! 🙏