[Swift] Codable ( Decodable & Encodable ) 에 대해서

안녕하세요 ~

 

오늘은 Codable에 대해서 정리하려고 합니다 : )

 

 

애플 개발자 문서를 참고하시면 좋을 것 같아 링크를 첨부해 두겠습니다.

 

Codable | Apple Developer Documentation

 

---

Swift에서 Codable 프로토콜은

JSON, Property List 및 기타 데이터 표현 형식을 쉽게 인코딩하고 디코딩 할 수 있게 해주는 프로토콜입니다.

 

Codable 프로토콜은 Encodable과 Decodable 프로토콜의 합성입니다.

Encodable 프로토콜은 인코딩 가능한 데이터를 나타내는 데 사용되고

Decodable 프로토콜은 디코딩 가능한 데이터를 나타내는 데 사용됩니다.

 

Codable 프로토콜을 사용하면 데이터 모델을 만들고 JSON 데이터와 빠르게 상호 작용할 수 있습니다.

 

Encodable

Encodable 프로토콜은 인코딩 가능한 데이터를 나타내는 데 사용됩니다.

즉, 객체를 JSON이나 다른 형식으로 변환할 수 있습니다.

Encodable을 준수하는 객체는 encode(to:) 메소드를 구현해야 합니다.

 

struct Person: Encodable {
    let name: String
    let age: Int
}

let person = Person(name: "경푸", age: 20)
let encoder = JSONEncoder()
let encodedData = try encoder.encode(person)
print(String(data: encodedData, encoding: .utf8)!) // 출력: {"name":"경푸","age":20}

 

Decodable

Decodable 프로토콜은 디코딩 가능한 데이터를 나타내는 데 사용됩니다.

즉, JSON이나 다른 형식의 데이터를 객체로 변환할 수 있습니다.

Decodable을 준수하는 객체는 init(from:) 이니셜라이저를 구현해야 합니다.

 

struct Person: Decodable {
    let name: String
    let age: Int
}

let jsonString = """
{
    "name": "경푸",
    "age": 20
}
"""

let jsonData = jsonString.data(using: .utf8)!
let decoder = JSONDecoder()
let person = try decoder.decode(Person.self, from: jsonData)
print(person) // 출력: Person(name: "경푸", age: 20)

 

위의 코드는 Person 객체를 JSON 데이터로 인코딩하고

다시 디코딩하여 Person 객체를 가져오는 방법을 보여주는 예시입니다.

 

주의사항

주의사항으로는 Codable은 기본 자료형(Int, Double, String 등)과 Optional을 지원하지만, Date, URL 및 Enum의 경우 일부 작업을 해줘야 합니다.

 

struct Person: Codable {
    let name: String
    let age: Int
    let email: String
}

let jsonString = """
{
    "first_name": "경푸",
    "age": 20,
    "email_address": "fu@example.com"
}
"""

let jsonData = jsonString.data(using: .utf8)!
let decoder = JSONDecoder()
let decodedPerson = try decoder.decode(Person.self, from: jsonData)

 

위의 코드는 제대로 동작할 수 없습니다.

JSON 데이터의 "first_name" 데이터와 Person 객체의 "name" 프로퍼티와 매핑되지 않고 "email_address" 데이터와 "email" 프로퍼티와 매핑되지 않기 때문입니다. 

 

이럴 때 사용하는 것이 바로 CodingKey입니다.

 

CodingKey

Codable 프로토콜을 사용할 때, 일부 경우에는 프로퍼티 이름이 JSON 키와 일치하지 않을 수 있습니다.

이러한 경우, CodingKey 프로토콜을 사용하여 매핑을 정의할 수 있습니다.

CodingKey 프로토콜은 다음과 같이 정의됩니다.

 

public protocol CodingKey {
    var stringValue: String { get }
    init?(stringValue: String)
    var intValue: Int? { get }
    init?(intValue: Int)
}

 

CodingKey는 stringValue와 intValue라는 두 개의 프로퍼티를 가집니다.

stringValue는 JSON 데이터와 일치하는 프로퍼티 이름을 나타내며

intValue는 프로퍼티가 숫자로 인덱싱 되는 경우 사용됩니다.

 

CodingKey 프로토콜을 채택하여 매핑을 정의하는 것은 간단합니다.

주의사항에서 사용했던 예제를 통해 설명하겠습니다.

 

struct Person: Codable {
    let name: String
    let age: Int
    let email: String

    private enum CodingKeys: String, CodingKey {
        case name = "first_name"
        case age
        case email = "email_address"
    }
}

 

Person 객체의 프로퍼티 이름과 JSON 데이터의 키 이름이 달랐지만

CodingKeys 열거형을 사용하여 매핑을 정의했습니다.

 

매핑이 가능하게 되어

JSONEncoder 및 JSONDecoder 인스턴스를 사용하여 객체를 인코딩하고 디코딩할 수 있습니다.

 

let jsonString = """
{
    "first_name": "경푸",
    "age": 20,
    "emailAddress": "fu@example.com"
}
"""

let jsonData = jsonString.data(using: .utf8)!
let decoder = JSONDecoder()
let decodedPerson = try decoder.decode(Person.self, from: jsonData)

 

정리

encode(to:)와 init(from:) 메서드는 Codable 프로토콜의 일부분으로

Encodable 프로토콜과 Decodable 프로토콜이 각각 가지고 있는 메서드입니다.

 

Encodable 프로토콜을 준수하는 타입의 객체를 JSON 데이터로 인코딩하려면, encode(to:) 메서드를 구현해야 합니다.

반면, Decodable 프로토콜을 준수하는 타입의 객체를 JSON 데이터에서 디코딩하려면, init(from:) 메서드를 구현해야 합니다.

 

CodingKey 프로토콜을 채택한 타입의 객체를 사용하여 프로퍼티 이름과 JSON 데이터의 키 이름 간의 매핑을 정의할 수 있습니다. 이를 통해 프로퍼티 이름이 JSON 데이터의 키 이름과 일치하지 않는 경우에도 쉽게 인코딩 및 디코딩 작업을 수행할 수 있게 됩니다.

 

struct Person: Codable {
    let name: String
    let age: Int
    let email: String

    private enum CodingKeys: String, CodingKey {
        case name = "first_name"
        case age
        case email = "email_address"
    }
}

let person = Person(name: "경푸", age: 20, email: "fu@example.com")

// Encode
let encoder = JSONEncoder()
let jsonData = try encoder.encode(person)
let jsonString = String(data: jsonData, encoding: .utf8)!
print(jsonString)
// 출력: {"name":"경푸","age":20,"email_address":"fu@example.com"}

// Decode
let decoder = JSONDecoder()
let decodedPerson = try decoder.decode(Person.self, from: jsonData)
print(decodedPerson.name, decodedPerson.age, decodedPerson.email)
// 출력: 경푸 20 fu@example.com