iOS Codable 사용법

Codable 

   - JSON과 같은 외부 표현과의 호환성을 위해 데이터 유형을 인코딩 및 디코딩할 수 있는 프로토콜입니다.

   - Codable = Decodable & Encodable

 

Codable은 Decodable과 Encodable을 준수하는 프로토콜인데 그러면 Decodable과 Encodable을 알아 보겠습니다.

 

Decodable

  - 원하는 모델로 데이터를 디코딩 할 수 있는 프로토콜입니다.

  - Key의 일부를 디코딩 하지 않는 것은 문제가 없습니다.

  - 보통 Struct에 채택하여 사용하며, Enum과 Class 또한 채택할 수 있습니다.

 

아래와 같은 형태의 JSON 데이터가 있다면

  {
    "blogName": "천원의 개발",
    "userID": "1000원",
    "number" : 111
  }

 

아래와 같은 형태로 BlogInfo 구조체에 Decodable을 채택하고 JSONDecoder를 사용하여 BlogInfo 타입으로 값을 반환합니다.

여기서 JSON 데이터의 Key값과 동일하게 구조체를 만들어 줘야합니다.

struct BlogInfo: Decodable {
    let blogName, userID: String
    let number: Int
}

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        
        do {
            let value = try JSONDecoder().decode(BlogInfo.self, from: data)
            print(value) // BlogInfo(blogName: "천원의 개발", userID: "1000원", number: 111)
        } catch {
            print(error)
        }
        
    }
}

 

 

DecodingStrategy: SnakeCase

아래와 같이 JSON 데이터가 SnakeCase 형태로 Key값이 온다면

  {
    "blog_name": "천원의 개발",
    "user_id": "1000원",
    "number" : 111
  }

JSONDecoder의 keyDecodingStrategy 프로퍼티를 convertFromSnakeCase 로 변경 해주면 해결할 수 있습니다.

struct BlogInfo: Decodable {
    let blogName, userId: String
    let number: Int
}

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        let decoder = JSONDecoder()
        decoder.keyDecodingStrategy = .convertFromSnakeCase // calmelcase로 key값 설정
        
        do {
            let value = try decoder.decode(BlogInfo.self, from: data)
            print(value)
        } catch {
            print(error)
        }   
    }
}

 

 

DecodingStrategy:  CodingKey

  - JSON 데이터의 키값과 모델의 키값을 다르게 하고 싶을 때 CodingKey 프로토콜을 사용합니다.

  - 열거형 CodingKeys 는 내부적으로 항상 생성 되어 있습니다.

  - CodingKey를 작성하면 커스텀 키로 사용하지 않을 키도 모두 열거형으로 포함해야 합니다.

 

  {
    "blogName": "천원의 개발",
    "userID": "1000원",
    "number" : 111
  }

 

name에는 "blogName"의 값이 들어가도록 하고 user에는 "UserID"의 값이 들어 갑니다.

struct BlogInfo: Decodable {
    let name, user: String
    let number: Int
    
    enum CodingKeys: String, CodingKey {
        case name = "blogName"
        case user = "userID"
        case number
    }
}

 

 

DecodingStrategy: init(from decoder: Decoder)

  - 서버에서 받은 값을 그대로 사용하지 않고 제약 조건이나 특정 값을 추가 하고 싶을 때 사용합니다.

struct BlogInfo: Decodable {
    let name, user: String
    let number: Int
    
    enum CodingKeys: String, CodingKey {
        case name = "blogName"
        case user = "userID"
        case number
    }
    
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.name = "이름: " + (try container.decode(String.self, forKey: .name))
        self.user = "유저ID: " + (try container.decode(String.self, forKey: .user))
        self.number = try container.decode(Int.self, forKey: .number)
    }
}

 

Quicktype.io

   - JSON 데이터를 입력하면 모델 구조를 만들어 주는 사이트

 

Encodable 

  - 데이터를 외부로 전달하기 위해 JSON 데이터 등으로 변환 할 때 사용하는 프로토콜

  - Struct, Enum, Class 에서 모두 채택할 수 있습니다.

 

User 구조체에 Encodable을 채택 해줍니다.

struct User: Encodable {
    let name: String
    let nickName: String
    let age: Int
}

 

JSONEncoder의 encode 메서드를 통해 Data 타입으로 반환합니다.

class ViewController: UIViewController {
    
    let users: [User] = [
        User(name: "철수", nickName: "김철수", age: 7),
        User(name: "짱구", nickName: "신짱구", age: 7),
        User(name: "짱아", nickName: "신짱아", age: 3)
    ]

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
        
        do {
        	// JSONEncoder의 encode 메서드로 Data 타입으로 반환
            let jsonData = try JSONEncoder().encode(users)
            
            // 변환된 Data 타입을 String 타입으로 변환하여 출력
            guard let jsonString = String(data: jsonData, encoding: .utf8) else { return }
            print(jsonString)
        } catch {
            print(error)
        }
        
    }
}

 

반환된 Data 타입을 String 타입으로 출력

 

 

 

여기까지 Codable 정리였습니다.

 

 

 

출처:

https://developer.apple.com/documentation/foundation/archives_and_serialization/encoding_and_decoding_custom_types,

🌱SeSAC iOS 2기 40회차 강의자료