CodableのためのEncoderとDecoderを自作してみた

Codableのための
EncoderとDecoderを
自作してみた
クラスメソッド株式会社
Nakayasu Yuichi

About me
中安佑一
Nakayasu Yuichi
クラスメソッド株式会社
モバイルアプリサービス部所属
Classmethod, Inc. Mobile Application Service dep
@nkysyuichi
主にiOSアプリエンジニア
iOS App Engineer

Codableって使ってますか?

Codable
Swift4からFoundationに標準搭載された
特定のフォーマットのデータと特定のクラスや構造体との
相互変換を簡単に行えるようにするための
非常に強力なプロトコル
/// A type that can convert itself into and out of an external
representation.
public typealias Codable = Decodable & Encodable
実際は Encodable と Decodable の合成プロトコル

Codable
struct SearchCondition {
let departure: String
let destination: String
let date: Date
let stay: Int
let persons: Int
let keyword: String
}
let condition = SearchCondition(
departure: "Osaka",
destination: "Sapporo",
date: Date(),
stay: 3,
persons: 1,
keyword: "朝食付き"
)
(例) とある旅行検索アプリの検索条件を入れるための構造体

Codable
struct SearchCondition: Codable {
let departure: String
let destination: String
let date: Date
let stay: Int
let persons: Int
let keyword: String
}
departure: "Osaka",
date: Date(),
stay: 3,
persons: 1,
)
(例) とある旅行検索アプリの検索条件を入れるための構造体

Codable
let encoder = JSONEncoder()
let encoded = try! encoder.encode(condition)
let json = String(data: encoded, encoding: .utf8)!
SearchCondition > JSON文字列にする
JSONEncoderにSearchConditionを渡してやるだけ
{
"stay" : 3,
"destination" : "Sapporo",
"keyword" : "朝食付き",
"departure" : "Osaka",
"persons" : 1,
"date" : "2018-05-10"
}

Codable
let decoder = JSONDecoder()
let decoded = json.data(using: .utf8)!
let condition = try!
decoder.decode(SearchCondition.self, from: decoded)
JSON文字列 > SearchConditionにする
JSONDecoderにJSON文字列を渡して
SearchConditionの型を指定してやるだけ

Codableって便利ですよね！

Standard Prepared
Swift4で用意されているEncoder / Decoder
- JSONEncoder / JSONDecoder
- PropertyListEncoder / PropertyListDecoder

だったら、自作してみよう！

作ってみたいもの
URLQueryItemEncoder
Codableなオブジェクトを渡すと、URLQueryItemの配列を返す
departure: "Osaka",
date: Date(),
stay: 3,
persons: 1,
)
var components = URLComponents(string: "https://
hogehoge.com")!
components.queryItems =
try! URLQueryItemEncoder().encode(condition)

作ってみたいもの
URLQueryItemDecoder
URLQueryItemの配列を渡すと、Codableなオブジェクトを返す
let urlString = "http://hogehoge.com?
departure=Osaka&destination=Sapporo&date=%5B%2254623157
5.650868%22%5D&stay=3&persons=1&keyword=%E6%9C%9D%E9%A3
%9F%E4%BB%98%E3%81%8D"
let components = URLComponents(string: urlString)
let condition =
try! URLQueryItemDecoder()
.decode(SearchCondition.self,
from: components?.queryItems)

登場人物
Encoderプロトコル
protocol Encoder {
var codingPath: [CodingKey] { get }
var userInfo: [CodingUserInfoKey : Any] { get }
func container<Key>(keyedBy type: Key.Type) ->
KeyedEncodingContainer<Key> where Key : CodingKey
func unkeyedContainer() -> UnkeyedEncodingContainer
func singleValueContainer() -> SingleValueEncodingContainer
}

登場人物
3種類のContainer
protocol Encoder {
}
- Keyed コンテナ
- Unkeyed コンテナ
- SingleValue コンテナ
実際の変換は彼らが行う

登場人物
3種類のContainer
protocol Encoder {
}
- Keyed コンテナ
- Unkeyed コンテナ
- SingleValue コンテナ
<- Struct
<- Protocol
<- Protocol

登場人物
Encoder
(KeyedEncoding
Container)
Keyed
Encoding
Container
Protocol
Unkeyed
Encoding
Container
SingleValue
Encoding
Container
Keyed
コンテナ
クラス
Unkeyed
コンテナ
クラス
SingleValue
コンテナ
クラス

登場人物
Encoder
(KeyedEncoding
Container)
Keyed
Encoding
Container
Protocol
Unkeyed
Encoding
Container
SingleValue
Encoding
Container
Keyed
コンテナ
クラス
Unkeyed
コンテナ
クラス
SingleValue
コンテナ
クラス
構造体 (structure)
プロトコル

登場人物
Decoder
(KeyedDecoding
Container)
Keyed
Decoding
Container
Protocol
Unkeyed
Decoding
Container
SingleValue
Decoding
Container
Keyed
コンテナ
クラス
Unkeyed
コンテナ
クラス
SingleValue
コンテナ
クラス
デコーダも同様

登場人物
CodingKey
struct Student: Codable {
var studentName: String
let grade: Int
let roomNumber: Int
enum Key: String, CodingKey {
case studentName = "student_name"
case grade
case roomNumber = "room_number"
}
}
エンコードとデコードでキーとして使う型
Codableではストアドプロパティの名前をもって
キーが自動的に決定する
カスタマイズもできる

コンテナを実装する
Encoder
Keyed
コンテナ
Unkeyed
コンテナ
SingleValue
コンテナ
Decoder
Keyed
コンテナ
Unkeyed
コンテナ
SingleValue
コンテナ
それぞれ3つのコンテナ x 2 = 6つのコンテナ

共通するインターフェイス
mutating func nestedContainer<NestedKey>(keyedBy keyType:
NestedKey.Type, forKey key: Key) ->
KeyedEncodingContainer<NestedKey> where NestedKey : CodingKey
mutating func nestedUnkeyedContainer(forKey key: Key) ->
UnkeyedEncodingContainer
mutating func superEncoder() -> Encoder
コーディングキー系
ネストコンテナ系

ネストコンテナとは?
struct User: Codable {
let name: String
let email: String
}
{
“name” : “Nakayasu”
“attribute” : {
“email” : “nakayasu.yuichi@classmethod.jp”,
“tel” : “06-1234-5678”,
“dept” : “mobile app service”
}
}
相互変換

struct User: Encodable {
let name: String
let email: String
enum CodingKeys: String, CodingKey {
case name
case attribute
}
enum AttributeCodingKeys: String, CodingKey {
case email
}
func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(name, forKey: .name)
var attributeContainer = container.nestedContainer(keyedBy:
AttributeCodingKeys.self, forKey: .attribute)
try attributeContainer.encode(email, forKey: .email)
}
}
話し出すとややこしいので割愛 m(> <)m

mutating func encodeNil(forKey key: Key) throws
mutating func encode(_ value: Bool, forKey key: Key) throws
mutating func encode(_ value: String, forKey key: Key) throws
mutating func encode(_ value: Double, forKey key: Key) throws
mutating func encode(_ value: Float, forKey key: Key) throws
mutating func encode(_ value: Int, forKey key: Key) throws
mutating func encode(_ value: Int8, forKey key: Key) throws
mutating func encode(_ value: UInt, forKey key: Key) throws
mutating func encode(_ value: UInt8, forKey key: Key) throws
mutating func encode<T>(_ value: T, forKey key: Key) throws where T : Encodable
エンコード処理系

- Nil
- String
- Bool
- Int (5種類)
- UInt (5種類)
- Float
- Double
- Encodable
mutating func encode(_ value: 型, forKey key: Key) throws
要はプリミティブな型を全部対応しなさいよということ
共通メソッドを呼び出すようにしておけばよい

Keyedコンテナ
キー : 値になっている形式はこれが呼ばれる
departure : "Osaka",
destination : "Sapporo",
date : Date(),
stay : 3,
persons : 1,
keyword : "朝食付き"
)
Codableな型は
プロパティ名( = キー) とその値でできているので、
おのずとKeyedになっている

Keyedコンテナ
private class URLQueryItemEncoderKeyedContainer<Key>:
KeyedEncodingContainerProtocol where Key: CodingKey {
private var encoder: URLQueryItemEncoder
var codingPath: [CodingKey] {
return encoder.codingPath
}
init(encoder: URLQueryItemEncoder) {
self.encoder = encoder
}

Keyedコンテナ
}
}
外側からは存在は知らなくていいので、privateクラス

Keyedコンテナ
}
}
エンコーダの参照を持っておく

Keyedコンテナ
private func store(_ value: Any, forKey key: Key) {
let name = key.stringValue
let stringValue = String(describing: value)
let queryItem = URLQueryItem(name: name, value:
stringValue)
encoder.append(queryItem: queryItem)
}
共通メソッド

Keyedコンテナ
stringValue)
}
共通メソッド
- CodingKeyからキー名をstringValueで取得できる
- キャメル=>スネークの変換はここでできる

Keyedコンテナ
stringValue)
}
共通メソッド
- URLパラメータは文字列なので、どの型も文字列で扱う
- プリミティブ以外は色々対策が必要

Keyedコンテナ
stringValue)
}
共通メソッド
- URLQueryItemを作ってエンコーダに流し込み
- appendは後でエンコーダに実装する

Keyedコンテナ
func encodeNil(forKey key: Key) throws { /* NOP */ }
func encode(_ value: Bool, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: String, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Double, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Float, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Int, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Int8, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: UInt, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: UInt8, forKey key: Key) throws { store(value, forKey: key) }
共通メソッド

func encodeNil(forKey key: Key) throws { /* NOP */ }
func encode(_ value: Bool, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: String, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Double, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Float, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: Int, forKey key: Key) throws { store(value, forKey: key) }
func encode(_ value: UInt, forKey key: Key) throws { store(value, forKey: key) }
Keyedコンテナ
{ store(value, forKey: key) }
共通メソッド

エンコーダを実装する
class URLQueryItemEncoder: Encoder {
var codingPath = [CodingKey]()
var userInfo = [CodingUserInfoKey : Any]()
private var queryItems: [URLQueryItem]?
fileprivate func append(queryItem: URLQueryItem) {
if queryItems == nil {
queryItems = []
}
queryItems!.append(queryItem)
}

class URLQueryItemEncoder: Encoder {
var codingPath = [CodingKey]()
var userInfo = [CodingUserInfoKey : Any]()
fileprivate func append(queryItem: URLQueryItem) {
if queryItems == nil {
queryItems = []
}
queryItems!.append(queryItem)
}
コンテナから呼び出すためのﬁleprivateなメソッド

func container<Key>(keyedBy type: Key.Type)
-> KeyedEncodingContainer<Key> where Key : CodingKey {
let container =
URLQueryItemKeyedEncodingContainer<Key>(encoder: self)
return KeyedEncodingContainer(container)
}
Keyedコンテナを返す
func unkeyedContainer() -> UnkeyedEncodingContainer {
}
func singleValueContainer() -> SingleValueEncodingContainer {
}
↑ すいません割愛します m(> <)m

func container<Key>(keyedBy type: Key.Type)
-> KeyedEncodingContainer<Key> where Key : CodingKey {
let container =
URLQueryItemKeyedEncodingContainer<Key>(encoder: self)
return KeyedEncodingContainer(container)
}
Keyedコンテナを返す

func encode<T>(_ value: T) throws
-> [URLQueryItem]? where T : Encodable {
try value.encode(to: self)
return queryItems
}
encodeメソッドは自前で作る

func encode<T>(_ value: T) throws
-> [URLQueryItem]? where T : Encodable {
try value.encode(to: self)
return queryItems
}
encodeメソッドは自前で作る
public protocol Encodable {
public func encode(to encoder: Encoder) throws
}

https://hogehoge.com?
departure=Osaka&destination=Sapporo&date=20
18-05-08%2009:25:04%20+0000&stay=3&persons=
1&keyword=%E6%9C%9D%E9%A3%9F%E4%BB%98%E3%81
%8D

ほんとに汎用性を持たせようとすると、
Unkeyedコンテナ、SingleValueコンテナを
意識した設計にしなければならない
作ってみて
デコーダの作成はエンコーダの逆ではあるが
頭が整理できてないとややこしい
ネストコンテナも意識した設計にしなければ
ならない

作ってみて
Appleさん作ってよ

でも楽しいよ
作ってみて

ありがとうございました

CodableのためのEncoderとDecoderを自作してみた

Recommended

Recommended

More Related Content

Similar to CodableのためのEncoderとDecoderを自作してみた

Similar to CodableのためのEncoderとDecoderを自作してみた (20)