Codable 프로토콜은 무엇이며, 어떻게 사용하나요?

[JooYoungNoh]

• Encodable과 Decodable 프로토콜의 역할은 무엇인가요?
• JSON 데이터를 커스텀 객체로 디코딩하는 방법을 설명해주세요.
• Codable 프로토콜을 채택한 타입에서 인코딩/디코딩 키를 커스터마이징하는 방법은 무엇인가요?

[JooYoungNoh]

Codable

---

• Swift에서 JSON 데이터를 쉽게 다루기 위한 프로토콜
• JSON 데이터와 Swift의 데이터 모델 간의 변환을 쉽게 할 수 있도록 도와줌
• JSON을 사용하기 위해 필요한 많은 코드를 작성하지 않아도 되기 때문에 JSON 데이터를 처리하는 과정을 훨씬 간단하고 간결하게 만들어줌
• JSON 데이터를 객체로 변환하는 Decoding, 객체를 JSON 데이터로 변환하는 Encoding이 있음

public typealias Codable = Decodable & Encodable
//Codable은 Decodable과 Encodable로 이루어져 있다

Decodable

• JSON 데이터를 객체로 변환

동작 원리

매핑 규칙

• Decodable을 준수하는 구조체 또는 클래스는 CodingKeys라는 내부 열거형을 가질 수 있는데 이 열거형을 사용하여 JSON 키와 Swift의 프로퍼티를 매핑할 수 있음
• 구조체에 CodingKeys가 구현되어 있지 않으면, JSON 키와 동일한 이름을 가진 Swift의 프로퍼티에 자동으로 매핑

Optional 프로퍼티

• JSON 데이터에 특정 키가 없는 경우, 해당 프로퍼티는 옵셔널로 선언할 수 있음
• JSON 데이터의 일부가 없을 때 디코딩을 계속 진행할 수 있도록 함

디코딩 오류 처리

• do try catch 문을 사용하여 디코딩 과정에서 발생할 수 있는 오류를 처리할 수 있어서 예외적인 상황에 대한 대비가 가능

기본 타입 변환

• Swift의 기본 타입(Int, String, Bool 등)뿐만 아니라 배열과 딕셔너리 등의 복합적인 타입도 지원

Encodable

• 객체를 JSON 데이터로 변환

동작 원리

매핑 규칙

• Encodable을 준수하는 구조체 또는 클래스는 JSON 데이터로 변환하려는 프로퍼티들을 가지고 있어야 하고 이 프로퍼티들은 기본적으로 JSON 데이터의 키로 사용

JSON 인코딩 옵션

• JSONEncoder의 outputFormatting 속성을 통해 인코딩된 JSON의 형식을 지정할 수 있음
• .prettyPrinted 옵션을 사용하면 읽기 쉬운 형태의 JSON이 생성

디코딩과 반대 방향

• Encodable을 준수하는 타입은 Decodable을 준수하는 타입과 함께 사용하면 JSON 데이터를 객체로 디코딩하고 다시 그 객체를 JSON 데이터로 인코딩할 수 있음

예외 처리

• do try catch 문을 사용하여 인코딩 과정에서 발생할 수 있는 오류를 처리할 수 있어서 예외적인 상황에 대한 대비가 가능

Codable Example

Sample JSON Data

[
  {
    "id": 1,
    "title": "Grocery shopping",
    "description": "Buy milk, eggs, bread, and cheese.",
    "completed": false
  },
  {
    "id": 2,
    "title": "iOS Project",
    "description": "Work on the SwiftUI to-do list app.",
    "completed": false
  },
  {
    "id": 3,
    "title": "Read SwiftUI Documentation",
    "description": "Read the latest SwiftUI tutorials on Apple's developer website.",
    "completed": false
  },
  {
    "id": 4,
    "title": "Fitness",
    "description": "Go for a 30-minute run in the park.",
    "completed": true
  },
  {
    "id": 5,
    "title": "Book Club",
    "description": "Finish reading 'The Midnight Library' for the book club meeting.",
    "completed": true
  },
  {
    "id": 6,
    "title": "Laundry",
    "description": "Wash and fold clothes for the upcoming week.",
    "completed": false
  },
  {
    "id": 7,
    "title": "Weekly Planning",
    "description": "Plan out the work schedule for the next week, set goals and priorities.",
    "completed": false
  },
  {
    "id": 8,
    "title": "Gardening",
    "description": "Plant new flower seeds in the garden and water the plants.",
    "completed": false
  },
  {
    "id": 9,
    "title": "Learn Guitar",
    "description": "Practice guitar chords for at least 20 minutes.",
    "completed": true
  },
  {
    "id": 10,
    "title": "Call Parents",
    "description": "Have a catch-up call with mom and dad.",
    "completed": true
  }
]

Model

struct SampleModel: Codable, Equatable, Identifiable {
    var id: Int
    var title: String
    var description: String
    var completed: Bool
}

Reducer

import ComposableArchitecture

import Foundation

@Reducer
struct SampleFeature {
    @ObservableState
    struct State: Equatable {
        var toDoList: [SampleModel] = []
    }

    enum Action {
        case clickTodo(Int)
        case decodingData
        case encodingData
    }

    var body: some ReducerOf<Self> {
        Reduce { state, action in
            switch action {
            case let .clickTodo(id):
                state.toDoList[id-1].completed.toggle()
                return .none

            case .decodingData:
                guard let file = Bundle.main.url(forResource: "sample.json", withExtension: nil) else { return .none }

                do {
                    let data = try Data(contentsOf: file)

                    state.toDoList = try JSONDecoder().decode([SampleModel].self, from: data)
                } catch {
                    print("디코딩 에러")
                }
                return .none

            case .encodingData:
                do {
                    let data = try JSONEncoder().encode(state.toDoList[0])

                    let changeString = String(data: data, encoding: .utf8)

                    print(changeString ?? "")
                } catch {
                    print("인코딩 에러")
                }
                return .none
            }
        }
    }
}

View

import ComposableArchitecture

import SwiftUI

struct SampleView: View {
    let store: StoreOf<SampleFeature>

    var body: some View {
        VStack {
            HStack {
                Spacer()

                Button {
                    store.send(.encodingData)
                } label: {
                    Text("Encoding Test")
                }
            }
            .padding(.trailing)

            List(store.toDoList) { todo in
                Button {
                    store.send(.clickTodo(todo.id))
                } label: {
                    HStack {
                        VStack(alignment: .leading, spacing: 10) {
                            Text(todo.title)
                                .font(.system(size: 20, weight: .semibold))

                            Text(todo.description)
                                .font(.system(size: 15))
                        }

                        Spacer()

                        if todo.completed {
                            Image(systemName: "checkmark")
                                .resizable()
                                .frame(width: 20, height: 20)
                                .foregroundStyle(Color(uiColor: .systemBlue))
                        } else {
                            Spacer()
                                .frame(width: 20)
                        }
                    }
                }
                .foregroundStyle(.black)
            }
        }
        .onAppear {
            store.send(.decodingData)
        }
    }
}

Codable 프로토콜을 채택한 타입에서 인코딩/디코딩 키를 커스터마이징하는 방법

CodingKeys

• 내부 열거형
• JSON 키와 Swift의 프로퍼티 간의 매핑을 원하는 대로 지정할 수 있음

struct SampleModel: Codable, Equatable, Identifiable {
    var id: Int
    var title1: String
    var description1: String
    var completed1: Bool

    //JSON 데이터의 키를 새로운 변수에 매핑
    enum CodingKeys: String, CodingKey {
        case id = "id"
        case title1 = "title"
        case description1 = "description"
        case completed1 = "completed"
    }
}

옵셔널

• 옵셔널 변수를 사용하여 쓰지 않는 정보나 일정한 형식이 아닌 JSON 데이터를 매핑할 수 있음
• 일정한 형식이 아니거나 nil 값이 들어오는 경우 오류가 생기지 않음

struct SampleModel: Codable, Equatable, Identifiable {
    var id: Int?
    var title: String?
    var description: String?
    var completed: Bool?
}