Codable에 대하여 설명하시오.

[Do-hyun-Kim]

Codable에 대하여 설명하시오.

• Codable 프로토콜은 자신을 외부 표현으로 변환(Encode) 하거나 외부 표현으로 부터 변환(Decode) 할 수 있는 타입이다.
• Codable 프로토콜은 Encodable & Decodable로 구성된 유니온 타입(union type) 이다.
• Codable은 프로토콜이기 때문에 class, struct, enum 에 채택이 가능하다.

🧐Encoding 이란?

• 인코딩(Encoding)이란 정해진 규칙에 따라 코드화, 암화화, 부호화하는 것을 말한다.
• 인코딩(Encoding)을 하는 이유는 정보의 형태 표준화, 보안, 저장 공간 절약 등을 위해서이다.
• 인코등의 대표적인 종류는 문자 인코딩(character Encoding), 사진 & 오디오 & 비디오 인코딩이 있다.

🤔 Encoding 방식

• HTML Encoding 방식은 HTML 페이지를 올바르게 나타내기위해 사용되는 인코딩의 종류이다.
• URL Encoding방식은 URL(Uniform Resource Locator) 인코딩은 인터넷을 통해 전송될 수 있는 포멧으로 문자를 변환 시키는 인코딩 방식이다.
  • ASCII - character - set을 사용하여 인터넷으로 URL을 보내는데 사용된다.
  • URL에 한글이 들어가 있으면 Encoding 에러가 나는 경우가 있는데 addingPercentEncoding 을 사용해서 해당 글자를 인코딩 해주면 해결 된다.
  • Encoding 방식에서 영어와 달리 한글은 ASCII 문자가 아니기에 한글과 같이 NON - ASCII 문자를 %~기호를 + 16진수 숫자로 인코딩 하여 보내주어야 한다.
  • NON - ASCII 문자를 %~으로 나타내어 URL 인코딩을 percent encoding 이라고 부른다.

• UNICODE Encoding 은 많은 인코딩 방법들 중 기준이 되는 인코딩이다. (**Universal Character Set)

  • 전 세계 대부분의 언어 또는 writing Systems을 인코딩 할 수 있고 표현하고 다룰 수 있다.
  • Unicode는 글자를 나타내기 위해 8, 16, 32 비트를 사용한다. 여기서 8비트를 사용하는 UTF-8은 가장 많이 보고 들어온 인코딩 방식이다.

  UNICODE Encoding 방식

  • UTF - 8 Encoding

    • Unicode Encoding 중 가장 기준이 되는 방식이며, 8 비트를 기본으로 사용한다.
    • ASCII - CODE 와 직접적으로 호환이 가능하며 Legacy apps 업데이트를 할 경우 거의 UTF-8을 선택한다.
    • 대부분의 경우 UTF-8은 가장 적은 메모리를 사용한다. 하지만 각 글자의 넓이를 보장 할 수 없어 1,2,3 또는 4의 넓이를 가지게 되어 String 조작에 어려움이 있다.

  • UTF - 16 Encoding

    • UTF - 16 Encoding 방식은 UTF - 8, UTF - 32 방식을 반반 섞은 인코딩 방식 이다.

    • UTF - 16은 대부분의 글자를 고정된 넓이 (a fixed - width) 16bit 값으로 한다. 중국어 기호나 음악 음표나 다른 특수한 케이스가 아닌 이상 우리는 UTF - 16으로 된 인코딩 된 글자가 모두 16bits wide를 가진다고 생각 할 수 있다.

    • UTF - 32 보다 적은 메모리를 사용하지만 UTF - 8 보단 큰 메모리를 사용한다.

  • UTF - 32 Encoding

    • UTF - 32 Encoding 방식은 가장 많은 메모리를 사용한다.
    • 각 글자는 4bytes wide 넓이를 가지고 있으며, String 조작이 훨씬 수월하고 간편하다.

🥹 Decoding 이란?

• Decoding 이란 Encoding의 반대되는 개념으로 복호화, 역코드화 의 의미를 가지고 있다.
• Decoding 은 이진 형식의 데이터를 사람이 해석할 수 있는 데이터로 변환 하는 작업이다.

😊 JSONEncoder Method

• Swift 4 버전 이전에는 JSONSerialization 를 사용하여 JSON 데이터 타입을 생성하였습니다.
• Swift 4 버전 이후부터 JSONEncoder Class를 사용하여 인코딩 할 수 있습니다.
• JSONEncoder에 제공되는 instance Method인 encode 를 사용하여 인코딩 작업을 실행 할 수 있습니다.
• JSONEncoder 객체에서 OutputFormatting 타입 프로퍼티를 사용하여 출력 설정을 지정할 수 있습니다.

🥳 JSONEncoder 제공 Method, properties

// where절을 통해 Encodable 채택한 파라메터만 받을 수 있도록 제약을 걸어두고 있다.
open func encode<T>(_ value: T) throws -> Data where T : Encodable

// Type properties
struct JSONEncoder.OutputFormatting

struct Track: Codable {
  let title: String
  let artistName: String
  let isStreamable: Bool
}

let smapleTrack = Track(title: "Love Lee", artistName: "AKMU", isStreamable: true)

do {
    let encoder = try JSONEncoder().encode(smapleTrack)
    // UTF - 8 Encoding
    if let jsonString = String(bytes: encoder, encoding: .utf8) {
        print(jsonString)
      //print: {"artistName":"AKMU","title":"Love Lee","isStreamable":true}
    }
    //print: 60bytes
    print(encoder)
} catch {
    print(error.localizedDescription)
}

🫣 JSONDecoder Method

• Swift 4 버전 이후부터 JSONDecoder Class를 사용하여 디코딩 할 수 있습니다.
• JSONDecoder Class에서 제공되는 decode Method를 사용하여 디코딩 작업을 실행 할 수 있습니다.
• JSONDecoder Class에서 제공되는 keyDecodingStrategy를 사용하여 Key 전략을 유연하게 변환 시킬 수 있습니다.
  • useDefaultKeys : 별도 keyDecodingStrategy 을 지정하지 않으면 default 값으로 사용되는 전략입니다.
  • convertFromSnakeCase : Snake-case를 Camel-case로 변환 하는 전략입니다. 즉 (_) 밑줄 뒤에 있는 오는 단어를 대문자로 변환 시키거나, 문자열 맨 처음이나 끝에 있지 않은 모든 밑줄을 제거하며, 단어를 하나의 문자열로 결합합니다.

struct Track: Codable {
  let title: String
  let artistName: String
  let isStreamable: Bool
}

let jsonData = """
{
  "artistName" : "Dua Lipa",
  "isStreamable" : true,
  "title" : "New Rules"
}
""".data(using: .utf8)!

do {
    let decoder = JSONDecoder()
    let data = try decoder.decode(Track.self, from: jsonData)
    print(data)
} catch {
    print(error)
}

📝 참고 사이트

• Key decoding strategy
• URL Encoding을 위한 CharacterSet 살펴보기
• Apple Documet Site

[vichye-1]

Codable이란?

• Swift 4부터 추가된 프로토콜
• JSON 데이터를 간편하고 쉽게 encoding, decoding 할 수 있게 해준다.
• enum, class, struct 모두 Codable을 채택할 수 있다.

Codable Protocol의 구성

typealias Codable = Decodable & Encodable

• Encodable : 내가 원하는 struct, class, enum 등의 인스턴스를 JSON 형태의 Data로 만들어주는 것
• Decodable : JSON 형태의 데이터를 Swift에서 다룰 수 있는 값(struct, class, enum 등)으로 변환하는 역할

codable을 이용한 encoding

• Foundation을 꼭 import해야한다.
• Codable을 이용해 JSON으로 Encoding하고 싶을 경우, Codable이라는 프로토콜을 준수하고 있어야함
• encoding 중 에러가 발생할 수 있기 때문에 try와 같이 써주어야 함

import Foundation

struct introduce: Codable {
    var name: String
    var age: Int
}

let firstTime: introduce = .init(name: "Alice", age: 12)

let data1 = try? JSONEncoder().encode(firstTime)
let result = String(data: data1!, encoding: .utf8)!
print(result)

codable을 이용한 decoding

• codable을 준수하고 있어야 함
• decoding 중에 실패할 수 있기 때문에, 반드시 try랑 함께 써주어야 함
• JSON Data의 Key 값은 Codable을 따르는 타입(introduce 구조체)의 멤버 이름과 1대 1 매칭 되어야만 문제 없이 사용할 수 있다.
  • 만약 1대1매칭을 하지 않고 key값을 변경하려면 ‘CodingKey’라는 프로토콜을 사용해서 Key의 이름이 바뀌었다는 것을 명시해줘야 한다.

import Foundation

struct introduce: Codable {
    var name: String
    var age: Int

let data = """
{
    "name" : "Alice",
    "age" : 12
}
""".data(using: .utf8)!

let human = try? JSONDecoder().decode(introduce.self, from: data)

human?.name // "Alice"
human?.age // 12

출처

• https://developer.apple.com/documentation/swift/codable
• https://babbab2.tistory.com/61

[ronick-grammer]

Codable 이란

• Swift 데이터를 외부 표현으로 변환하거나 외부 표현으로부터 변환할 수 있는 프로토콜이다.

• Encodable 과 Decodable 프로토콜의 type alias 이다

  public typealias Codable = Decodable & Encodable

• Swift 유형을 이 프로토콜에 맞추면 컴파일러가 JSON과 같은 직렬화된 형식에서 이 유형의 인스턴스를 인코딩/디코딩하는 데 필요한 코드를 합성한다.

📝 참고 사이트

• Swift Codable을 사용한 Cloud Firestore 데이터 매핑 -[iOS] Swift에서의 Codable