Encoding and Decoding Custom Types 📙

1️⃣ 설명

외부 표현 형식(JSON, 등)에 호환되도록 데이터 유형을 인코딩 및 디코딩할 수 있도록 만들기

• 데이터를 네트워크 연결을 통해 전송하거나 데이터를 디스크에 저장하거나 API 및 서비스에 데이터를 제출하는 것은 많은 프로그래밍 작업에 포함 돼있음
• 이러한 작업은 데이터가 전송되는 동안 중간 형식으로 데이터를 인코딩하고 디코딩해야 하는 경우가 많음
• Swift 표준 라이브러리는 데이터 인코딩과 디코딩에 대한 표준화된 접근 방식을 정의함
• 사용자 정의 타입에 Encodable 및 Decodable프로토콜을 구현함으로써 이 접근 방식을 채택할 수 있음
• 이 프로토콜들을 채택함으로써 데이터를 인코딩하거나 디코딩하는 작업을 수행할 수 있는 Encoder와 Decoder구현체들이 데이터를 가져와서 JSON 또는 프로퍼티 리스트와 같은 외부 표현 형식으로 인코딩하거나 디코딩할 수 있음

  프로퍼티 리스트

  • 다양한 데이터 유형을 지원하는 계층적인 구조
  • 다은은 앱의 구성 설정을 저장하기 위한 프로퍼티 리스트

  <dict>
     <key>Theme</key>
     <string>Dark</string>
     <key>Language</key>
     <string>English</string>
     <key>Notifications</key>
     <true/>
  </dict>

• 인코딩과 디코딩을 모두 지원하려면 Encodable과 Decodable프로토콜을 결합한 Codable을 채택하도록 선언
• 이 과정은 타입을 Codable하게 만듬

📌 Encode and Decode Automatically

• 타입을 Codable로 만드는 가장 간단한 방법은 해당 타입의 속성들을 이미 Codable인 타입으로 선언하는 것
• 이러한 타입들은 String, Int, Double과 같은 표준 라이브러리 타입, 그리고 Date, Data, URL과 같은 Foundation 타입을 포함
• 속성들이 Codable인 어떤 타입이든 간에, 해당 타입이 Codable을 준수한다는 선언만 하면 자동으로 Codable에 준수하게 됨
• 아래 예제는 랜드마크(Landmark) 구조체의 예시이고 구조체는 랜드마크의 이름과 창립 연도를 저장함

struct Landmark {
    var name: String
    var foundingYear: Int
}

• Landmark구조체에 Codable을 상속 목록에 추가하면, Encodable과 Decodable의 모든 프로토콜 요구사항을 충족하게 됨

struct Landmark: Codable {
    var name: String
    var foundingYear: Int
    
    // Landmark now supports the Codable methods init(from:) and encode(to:), 
    // even though they aren't written as part of its declaration.
}

• 자체 타입에 Codable을 채택하면 내장된 데이터 형식 및 사용자 정의 인코더 및 디코더가 제공하는 형식과의 직렬화 및 역직렬화가 가능해짐
• Landmark구조체는 PropertyListEncoder 및 JSONEncoder클래스를 사용하여 인코딩이 가능해짐
• Landmark자체에는 명시적으로 프로퍼티 리스트나 JSON을 처리하는 코드가 없더라도 가능
• 이 원칙은 Codable로 구성된 다른 사용자 정의 타입에도 적용됨
• 모든 프로퍼티가 Codable을 준수한다면, 사용자 정의 타입도 Codable이 될 수 있음
• 아래 예제 에서는 Landmark구조체에 location프로퍼티를 추가했을 때 자동 Codable준수가 적용된 것을 보여줌

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


struct Landmark: Codable {
    // Double, String, and Int all conform to Codable.
    var name: String
    var foundingYear: Int
    
    // Adding a property of a custom Codable type maintains overall Codable conformance.
    var location: Coordinate
}

• Array, Dictionary, Optional과 같은 Built-in types은 Codable을 준수함
• Built-in types이 Codable타입을 포함하고 있을 때 자동으로 Codable을 준수하게 됨
• Landmark에 Coordinate인스턴스의 배열을 추가해도 전체 구조체는 여전히 Codable을 준수함
• 아래 예제는 Landmark내에 내장된 Codable타입을 사용하여 여러 프로퍼티를 추가했을 때 자동 Codable준수가 적용되는 예시

struct Landmark: Codable {
    var name: String
    var foundingYear: Int
    var location: Coordinate
    
    // Landmark is still codable after adding these properties.
    var vantagePoints: [Coordinate]
    var metadata: [String: String]
    var website: URL?
}

📌 Encode or Decode Exclusively

• 일부 경우에는 Codable의 양방향 인코딩 및 디코딩 지원이 필요하지 않을 수 있음
• 일부 앱은 원격 네트워크 API에 호출만 필요로 하며 동일한 유형을 포함하는 응답을 디코딩할 필요가 없는 경우도 있음
• 데이터의 인코딩만 지원해야하는 경우 Encodable을 준수로 선언하면 됨
• 마찬가지로, 특정 유형의 데이터를 읽기만해야하는 경우 Decodable을 준수로 선언하면 됨
• 아래 예제 에서는 데이터를 인코딩하거나 디코딩하는데만 필요한 Landmark구조체의 대체 선언을 보여줌

struct Landmark: Encodable {
    var name: String
    var foundingYear: Int
}

struct Landmark: Decodable {
    var name: String
    var foundingYear: Int
}

📌 Choose Properties to Encode and Decode Using Coding Keys

• Codable유형은 CodingKey프로토콜을 준수하는 특수한 중첩 열거형인 CodingKeys를 선언할 수 있음
• 이 열거형이 존재할 경우, 해당 사례들은 인코딩 또는 디코딩할 때 포함되어야 하는 속성들의 정식 목록으로 작동
• 열거형 case의 이름은 유형의 해당 property에 지정한 이름과 일치해야 함
• Decoding인스턴스에 없을 경우 또는 인코딩된 표현에 특정 속성을 포함시키지 않아야하는 경우 CodingKeys열거형에서 속성을 제외시켜야 함
• CodingKeys에서 제외된 속성은 Decodable 또는 Codable에 대한 자동 준수를 받기 위해 기본값이 필요함
• 직렬화된 데이터 형식(JSON, 등)에서 사용하는 키가 데이터 유형의 속성 이름과 일치하지 않는 경우 CodingKeys열거형의 rawValue로 String을 지정하여 대체 키를 제공할 수 있음
• 각 열거형 case의 rawValue로 사용하는 문자열은 인코딩 및 디코딩 중에 사용되는 키 이름
• case이름과 rawValue 간의 연관 관계를 통해 데이터 구조를 Swift API Design Guidelines에 따라 명명할 수 있으며 직렬화된 데이터(JSON, 등)의 이름, 구두점 및 대문자와 일치시킬 필요가 없어짐
• 아래 예제에서는 Landmark구조체의 name 및 foundingYear속성에 대해 인코딩 및 디코딩할 때 대체 키를 사용하는 방법을 보여줌

struct Landmark: Codable {
    var name: String
    var foundingYear: Int
    var location: Coordinate
    var vantagePoints: [Coordinate]
    
    enum CodingKeys: String, CodingKey {
        case name = "title"
        case foundingYear = "founding_date"
        
        case location
        case vantagePoints
    }
}

📌 Encode and Decode Manually

• Swift 타입의 구조가 인코딩된 형식의 구조와 다른 경우, 직접 Encodable과 Decodable을 구현하여 사용자 정의 인코딩 및 디코딩 로직을 정의할 수 있음
• 아래 예시에서는 Coordinate구조체가 추가 정보인 additionalInfo컨테이너 내에 포함된 elevation속성을 지원하도록 확장됨

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


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

• Coordinate 타입의 인코딩된 형식은 두 번째 수준의 중첩 정보를 포함하고 있기 때문에 해당 타입은 Encodable 및 Decodable프로토콜을 채택하는 데 두 개의 열거형을 사용

  두 번째 수준의 중첩 정보(second level of nested information)

  • Coordinate타입의 인코딩된 형식에서 추가로 포함되는 데이터의 구조를 의미
  • 예를 들어 JSON에서 additionalInfo객체 안에 elevation이 포함 된 구조

• 각각의 열거형은 인코딩 또는 디코딩 작업을 수행하는 특정 수준에서 사용되는 모든 코딩 키(속성 이름)의 목록을 포함
• 아래 예제 에서는 Coordinate구조체를 확장하여 Decodable프로토콜을 준수하기 위해 필요한 이니셜라이저인 init(from:)을 구현합니다.

extension Coordinate: Decodable {
    init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        latitude = try values.decode(Double.self, forKey: .latitude)
        longitude = try values.decode(Double.self, forKey: .longitude)
        
        let additionalInfo = try values.nestedContainer(keyedBy: AdditionalInfoKeys.self, forKey: .additionalInfo)
        elevation = try additionalInfo.decode(Double.self, forKey: .elevation)
    }
}

• init(from:)메서드는 Decoder를 매개변수로 받고, 디코딩 작업을 수행
• 메서드 내부에서는 decoder.container(keyedBy:)메서드를 사용하여 디코더의 컨테이너를 얻음
• 이 컨테이너는 디코딩할 데이터에 대한 키-값 쌍을 포함
• container(keyedBy:)메서드를 사용하여 values변수에 대한 컨테이너를 생성
• values컨테이너는 CodingKeys열거형을 키 타입으로 사용하며, 해당 열거형은 latitude와 longitude속성에 대응하는 코딩 키를 나타냄
• decode(_:forKey:)메서드를 사용하여 컨테이너에서 각 속성의 값을 디코딩하고, 이를 latitude와 longitude속성에 할당
• nestedContainer(keyedBy:forKey:)메서드를 사용하여 additionalInfo변수에 대한 중첩된 컨테이너를 생성
• 이 컨테이너는 AdditionalInfoKeys열거형을 키 타입으로 사용하며, 해당 열거형은 elevation속성에 대응하는 코딩 키를 나타냄
• decode(_:forKey:)메서드를 사용하여 중첩된 컨테이너에서 elevation속성의 값을 디코딩하고, 이를 elevation속성에 할당
• 이렇게 해서 init(from:)메서드는 디코딩 작업을 완료하고, Coordinate구조체의 모든 속성이 올바르게 초기화된 상태로 인스턴스를 생성함

  컨테이너

  • 컨테이너는 디코딩 작업에서 사용되는 구조체로, 디코딩할 데이터에 대한 키-값 쌍이나 순차적인 값들을 담고 있음
  • KeyedDecodingContainer 또는 UnkeyedDecodingContainer프로토콜을 준수하는 인스턴스

• Coordinate인스턴스의 두 속성인 latitude 와 longitude은 Swift 표준 라이브러리에서 제공하는 KeyedContainer API를 사용하여 초기화됨
• 이 API는 디코딩 작업 중에 사용되며, 디코더로부터 전달받은 Decoder인스턴스를 통해 접근할 수 있음
• 아래 예제는 Coordinate구조체가 Encodable프로토콜을 준수하기 위해 필요한 메서드인 encode(to:)를 구현하는 방법

extension Coordinate: Encodable {
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(latitude, forKey: .latitude)
        try container.encode(longitude, forKey: .longitude)
        
        var additionalInfo = container.nestedContainer(keyedBy: AdditionalInfoKeys.self, forKey: .additionalInfo)
        try additionalInfo.encode(elevation, forKey: .elevation)
    }
}

• 이 encode(to:)메서드의 구현은 이전 예제의 디코딩 작업을 역으로 수행

---

출처📚

🍎Apple Docs: Encoding and Decoding Custom Types