[iOS] Codable - Encodable & Decodable 프로토콜

json을 파싱하는 방법 중 하나이다. 다른 하나는 다음 글에서 알아보겠다. (많관부)

 

 

Codable 이란?

-> 자신을 변환하거나 외부 표현(ex> json)으로 변환할수 있는 타입

보통은 json으로 가장 많이 사용된다! 그래서 아래 예시도 json 타입으로 변환하는 방법을 살펴볼 것이다. 

 

Encodable과 Decodable을 통틀은 것

 

typealias는 뭐지 ??

* typealias - 기존 선언된 데이터 타입에 별칭을 사용함으로서 코드를 더 읽기 쉽도록 만드는 문법

예를 들어서 typealias Name: String 이라 했을 때 

 

let name: Name = "홍길동"   ==   let name: String = "홍길동"

 

기존 타입 String의 별명을 Name으로 했을때 아하 String 중에서 특별해 Name만으로 범위를 좁힌 타입이구나 하고 알수 있는 것이다. 

 

 

Codable은 프로토콜이다! 따라서 Codable을 이루고 있는 Encodable과 Decodable 역시 프로토콜로 

enum, class, struct 에서 채택하여 사용할 수 있다.

 

codable을 채택하게 되면 외부 표현으로 만들 수 있다는 것으로 struct로 표현된 데이터를 json과 같은 외부 표현으로 만들수 있다는 말이다.

 

Encodable - 원하는 형태로 바꾸어줌 (f(x) 함수와 같다) 

 

->자기 자신을 외부 표현으로 encode 할 수 있는 타입

 

 

Decodable - 그 형태를 해석해줌(f-1(x) 역함수와 같다)

자기 자신을 외부 표현으로 decode 할 수 있는 타입

참고로 Decodable을 채택하는 데이터는 init함수를 필수적으로 가져야 한다

 

 

공식 문서에 그렇게 나와있음 ㅎㅎ

 

 

어떻게 해주어야 할까 Codable 이 녀석의 사용법이 궁금하다 ..! 

encodable부터 차근 차근 알아보도록 하자 

 

예를 들어 user struct가 아래와 같이 있다 

 

struct User {

var userName: String

var userEmail: String

}

 

1. 먼저 encoder 선언

let encoder = JSONEncoder()) //외부 표현 그 중 json으로 encode 해주는 객체

 

2. struct를 실체화한 인스턴스 생성

let uri = User(userName: "Uri", userEmail: "spqjf12345@gmail.com")

 

3. encode 하기

let jsonData = try? encoder.encode(uri) //encode 함수는 codable을 준수하는 uri를 encode

 

그러면 결과가 이렇게 json 형태로 잘 encoding 되었다 ㅎㅎ 

if let jsonData = jsonData, let jsonString = String(data: jsonData, encoding: .utf8) {
	print(jsonString)
} -> {"userName" : "uri", "userEmail" : "spqjf12345@gmail.com"} 

 

 

반대로 decode는 ?

 

what? {"userName" : "uri", "userEmail" : "spqjf12345@gmail.com"} 을 decode 해줄 것이다.

 

 

1. 우선 jsonDecoder 선언

let decoder = JSONDecoder()

 

 

2. json을 data로 만들기

var data = jsonString.data(using: .utf8)

 

3. data를 인스턴스화

 if let result = try? decoder.decode(User.self, from: data) {

            return result.userName //uri

 }

 

 

 

 

---

codingKey 란?

 

만약 우리의 User 데이터가

 

struct User: Codable {

var userName: String

var userEmail: String

}

 

jsonData 형태

 

{

"user_name" : "uri",

"user_email": "spqjf12345@gmail.com"

}

으로 되어있을때

이 jsonData를 User 데이터 타입으로 decode하게 될시

에러가 나게된다. 왜? key 값의 이름이 같지 않기 때문

 

이를 위해 codingKey라는 protocol이 존재한다.

 

인코딩 및 디코딩을 위한 키로 사용할 수 있는 타입

 

enum을 사용해 codingKey 프로토콜을 채택하게 하는것

따라서 우리가 기존에 세웠던 User struct는

 

struct User: Codable {
	var userName: String
	var userEmail: String
}

//codingKey 추가
struct User: Codable {
	var userName: String
	var userEmail: String

	enum CodingKeys: String, CodingKey {
	
	case userName = "user_name"
	case userEmail = "user_email"
	}
}

 

이렇게 될 것이다! 

 

하나 하나 뜯어 해석해보니 기존에 

result["userName"] as? String 이런 식으로 key값과 value값을 구분해 다시 userData에 append 해주는 것보다 훨 간단한 방식인거 같다 많이 애용해야지 ㅎㅎ 

 

참고 :

https://developer.apple.com/documentation/swift/codable/

https://zeddios.tistory.com/394