[iOS] CodingKey 란?

선수 지식 : Codable

 

안녕하세요🐶

오늘은 Codable 프로토콜에서 커스텀 키 매핑 등의 용도로 사용하는 CodingKey 프로토콜에 대하여 다루어 보려고 합니다.

 

공식 문서를 살펴보던 중 이 프로토콜에 대한 설명이 나와있어 이것을 정리해보겠습니다.

막상 CodingKey 문서에는 설명이 전혀 없었던...

struct Coordinate: Codable {
    var latitude: Double
    var longitude: Double
    var elevation: Double

    enum CodingKeys: String, CodingKey {
        case latitude
        case longitude
        case elevation
    }
}

 

위 코드와 같이, Codable 타입은 CodingKeys 라는 이름을 가진 특별한 nested 열거형 을 정의할 수 있습니다.

그리고 이 열거형은 CodingKey 프로토콜을 채용해야 합니다. 

 

❗️CodingKeys 열거형은 CodingKey 프로토콜을 채택해야 한다. 철자 's' 하나 차이이니 잘 구분해주세요!

 

Codable 을 채용한 타입에 이 열거형(CodingKeys) 이 존재한다면, 이 열겨형은 타입의 인스턴스가 인코딩 혹은 디코딩 될 때 이 열거형의 case 리스트에 해당하는 속성들이 전부 있어야 한다고 선언하는 역할을 합니다.

 

열거형 case 들의 이름은 인코딩 혹은 디코딩 되는 타입의 속성의 이름과 각각 모두 매칭되어야 합니다.

 

만약 디코딩하는 인스턴스에 등장하지 않거나,

예를 들어 디코딩하는 데이터에는 'abc'라는 이름의 속성이 없는데, CodingKeys 열거형에 추가하여 디코딩을 시도할 이유가 없습니다.

 

인코딩해야하는 표현에 포함되지 않아야할 속성이라면 CodingKeys 열거형에서 제외하면 됩니다.

인코딩할 데이터에 추가하고 싶지 않는 속성이라면 또한 CodignKeys  에서 제외하면 됩니다.

 

💡 인코딩에서는 필요 없는 속성 인데, 디코딩에서는 필요하다면? Codable 을  Encodable 과 Decodable 로 나누어 구현한다.

 

CodingKeys 에서 제외된 속성은 기본 값을 설정해 놓아야합니다. 그래야 Codable 프로토콜의 기본 구현을 제공받습니다.

struct Coordinate: Codable {
    var latitude: Double
    var longitude: Double
    
    // CodingKeys 에서 제외되었으므로, 기본 값을 nil 로 설정하였습니다.
    var elevation: Double?

    enum CodingKeys: String, CodingKey {
        case latitude
        case longitude
    }
}

 

만약 CodingKeys 열거형의 case 이름과 속성의 이름이 일치하지 않는다면, String 을 RawValue 로 사용하여 제공하면 됩니다.

:: 커스텀 키 매핑

 

 RawValue 로 제공한 값은 인코딩 과 디코딩 시 key 의 이름와 속성 이름을 매핑하는 데 사용됩니다.

 

이런 커스텀 키 매핑을 통해 Swift API Design Guidelines 를 따른 속성명을 사용할 수 있게 됩니다.

 

만약 키 매핑이 지원이 되지 않는다면, 외부에서 받아온 swift naming convention 에 맞지 않는 이름들을 속성 명으로 그대로 사용해야 하기 때문입니다.

snake_case 를 사용해야 한다던지, UpperCamelCase 를 사용해야 한다던지...

 

 

 

끝!

---

🤖🟢[우짱의 iOS 블로그]🔵💻

iOS를 공부하면서 배운 내용을 기록하고 있습니다.

 

 

 

참고 문서: https://developer.apple.com/documentation/foundation/archives_and_serialization/encoding_and_decoding_custom_types