[Swift] Codable

우리가 네트웍통신 등을 통한 방법으로 데이터를 주고 받죠!

어떤 웹서비스를 호출해서 받을수도 있고, 어떤 웹서비스를 통해서 서버에 전송하기도 하죠,

가장 보편적으로 데이터를 주고 받을때 사용하는 포맷이 바로 json 포맷이에요!

 

{
	"name": "Nury",
	"age": 10,
	"birthDate": "2021-02-26T12:15:17+0000"
}

이렇게 생긴 녀석들 많이 보셨죠~~?

json포맷은 이렇게 [key : value] 로 묶인 마치 Dictionary 형태의 포맷이에요 ㅎㅎ

 

Swift에서는 Codable이라는 녀석을 통해 json을 앱의 Object로, 앱의 Object를 json으로 쉽게 만들 수 있어요!

그럼~~ Codable이라는게 뭐냐면~~~

 

자신을 변환하거나 외부표현(json같은)으로 변환할 수 있는 타입이라고 합니다!

근데 Decodable & Encodable 이라는 타입을 Codable 타입으로 정의해놨네요! 

그럼 Decodable, Encodable에 뭔가요~?

 

정의를 보니 이건 둘다 어떤 프로토콜이네요!

그러면, "Codable은 Decodable과 Encodeble 프로토콜을 준수하는 타입(프로토콜)이다." 라고 할 수 있겠네요!

음~~ 좋아. 근데 Decodable과 Encodeble은 뭐하는 애들이야? 😂

 

Decodable : 자신을 외부표현(json등)에서 디코딩 할 수 있는 타입

Eecodable : 자신을 외부표현(json등)으로 인코딩 할 수 있는 타입

 

그럼.. 디코딩, 인코딩은 뭐냐,

디코딩 : json같은 외부 포맷을 앱에서 사용할 수 있도록 Object로 변환하는 것!

인코딩 : 앱의 Object 타입을 json같은 외부 포맷으로 변환하는 것!

 

둘은 완전 반대의 개념이죠~~? 사용하는것도 완전히 반대에요! 그럼 어떻게 사용하는지 살펴볼게요.

 

Decodable

let jsonString = """
{
    "name": "Nury",
    "age": 10,
    "birthDate": "2021-02-26T12:15:17+0000"
}
"""

위에서 봤던 이런 녀석을 앱에서 사용하도록 디코딩 해볼거에요!

 

struct Person: Codable {
    var name: String
    var age: Int
    var birthDate: Date
}

먼저 변환할 타입을 정의해줍니다! 여기서 중요한 것은 Codable 프로토콜을 채택했다는 거에요!

그리고, 눈치채셨겠지만 json파일의 key값과, Object의 프로퍼티명을 이렇게 맞춰줘야 아~ 얘가 얘구나~~ 하고 변환이 되요.

만약 키값이 달라야 하는 상황이면, CodingKey라는 녀석을 사용해주면 됩니다!!

 

그럼 먼저 변환 단계를 살펴보고, 하나씩 자세하게 알아볼게요!

 

1. JSONDecoder 선언
2. String 타입의 json을 Data타입으로 만들기.
   (예시에서는 진짜 .json 파일이 아니라 String으로 임의로 만들었기 때문에 변환하는거에요! 진짜 json은 data타입입니다.)
3. Data타입을 JSONDecoder를 통해 Object로 만들기

 

1. JSONDecoder 선언

let decoder = JSONDecoder()

 

2. String 타입의 json을 Data타입으로 만들기.

let jsonData = jsonString.data(using: .utf8)

string.data() 메소드의 리턴은 Data? 타입이에요! 옵셔널 바인딩을 해줍시다.

 

3. Data타입을 JSONDecoder를 통해 Object로 만들기

if let jsonData = jsonString.data(using: .utf8) {
    let person = try decoder.decode(Person.self, from: jsonData)
}

우리는 JSONDecoder가 가진 decode() 메소드를 통해서 디코딩을 할 수 있어요! 

그럼 decode() 메소드의 정의를 살펴볼까요~?

먼저 type은 우리가 디코딩 후에 이 type으로 만들거야. 즉 "Decode 할 값의 타입"이라는 거에요,

이게 T.Type이라고 되어있죠? 그리고 오른쪽에 보시면 T where T : Decodable 이런게 있네요!

즉 이말은, type은 어떤 타입(T.Type)인데, Decodable을 준수해야만 돼! 라고 정의가 되어있네요!

 

여기서 우리는 Person 타입으로 디코딩을 해줄거고, Person은 Codable(Decodable을 포함하는) 프로토콜을 준수했죠!?

그러니까 우리는 Person타입을 저 type자리에 넣어줄 수 있겠네요! 👍

 

그리고 data는 디코딩할 소스데이터를 말하는거에요! 이 data를 저 type으로 변경해줘! 하는거죠.

let person = try decoder.decode(Person.self, from: jsonData)

자, 그러면 이제 이 코드가 이해가 되시나요?ㅎㅎ 😎

디코딩도 했으니 새로만든 person녀석을 좀 출력해볼까요?

if let jsonData = jsonString.data(using: .utf8) {
    let person = try decoder.decode(Person.self, from: jsonData)
    
    print("name : \(person.name)")
    print("age : \(person.age)")
    print("birth : \(person.birthDate)")
}

헉.. 뭔가 에러가 발생합니다!!

"Double타입의 디코딩을 예상했지만, String, Data타입을 찾았습니다" 라고 하네요!

이건 바로 birthDate가 Date 타입으로 정의되었기 때문인데요!

아무리 Codable이 매우매우 강력하다고는 하지만,,, 이렇게 날짜포맷의 String을 Date로 변환하기 위해서는,

decoder.dateDecodingStrategy = .iso8601

이렇게 디코더에게 날짜 포맷은 어떻게 할거야? 하고 전략을 지정해줘야 할 필요가 있어요!

 

그리고 다시 실행을 해보면....

짠~~~ 잘 출력 되었네요!!

json을 가져와서 앱에서 사용하는 Object로 JSONDecoder를 통해서 디코딩하는 과정을 살펴 보았습니다 👍👍

 

Encodable

이제는 Encodable에 대해 알아볼건데요! Encoding은 Decoding과 완전 정반대 개념이였고, 구현도 정반대라고 했죠!?

 

1. JSONEncoder 선언
2. Object 타입을 JSONEncoder를 통해 Data타입(json)으로 만들기
3. Data타입을 String타입으로 만들기
   (예시에서는 String타입으로 출력해보려고 하는거에요! 실제로 API의 Body에 호출할때는 Data타입 그대로 호출합니다)

 

1. JSONEncoder 선언

let encoder = JSONEncoder()

 

2. Object 타입을 JSONEncoder를 통해 Data타입(json)으로 만들기

let data = try encoder.encode(person)

이번에는 JSONEncoder의 encode() 메소드로 Data타입으로 만들어 줬네요!

그럼 encode() 메소드의 정의를 살펴볼까요~?

 

Encodable 프로토콜을 준수하는 T라는 어떤 데이터타입을 Data타입으로 리턴해주는 메소드네요~!

 

우리는 위에서 person Object를 만들었고, 이 person은 Person타입이였죠!? 그리고 Person은 Codable프로토콜을 준수하니까 당연히 Encodable도 준수하고 있겠죠! 그럼 우리는 이 person을 value로 넣어줄 수 있겠네요!

 

실제로 웹서비스를 통해 json 데이터를 전달해야 할때는 일반적으로 Post방식을 통한 API호출로 이루어져요.

그때 body에 이 Data타입의 json을 그대로 넣어주면 됩니다!

 

우리는 실습이니까, 이 Data타입을 String타입으로 변환해서 한번 출력해볼게요!

 

3. Data타입을 String타입으로 만들어서 출력해보기

if let jsonString = String(data: data, encoding: .utf8) {
        print(jsonString)
    }

오~~ 우리가 원하던 json 포맷으로 변형이 됐네요!! 근데.. 저 birthDate의 6360어쩌구 저쩌구는 뭐죠..!? 

이건 decoder에 date 포맷 전략을 줬던 것과 똑같아요!

encoder.dateEncodingStrategy = .iso8601

오호~~ 잘 나오네요!! 👍

한가지, decoder나 encoder에 date포맷 전략을 줄때 iso8601이라는 표준 규격만 주고 있죠~?

이거 외에도 Custom DataFormatter를 사용해서 원하는 포맷으로도 변환이 가능하답니다 😎

 

음.... 근데.. 아직도 약~간 아쉽죠!? 우리는 익숙히 보던 이쁜 포맷으로 만들어주고 싶은데요 😂

encoder.outputFormatting = .prettyPrinted

encoder에 날짜포맷에 대한 전략을 줬던 것처럼, 출력 포맷팅을 정해줄 수 있어요!

이렇게 출력 포맷을 .prettyPrinted로 정해주고 다시 출력을 해보면! 

와~~ 우리가 원하는 json 데이터로 다시 변형이 되었네요!!! 🤙🤙

 

 

오늘은 간단한 예제를 통해서 Codable에 대해서 알아보고, 실제로 Decoding, Encoding하는 방법을 실습해보았어요!!

오늘도 누군가에게 도움이 되었길 바래요 🙏