iOS

[Swift4]ライブラリをやめてCodableでJSONを取り扱う

投稿日:

はじめに

こんにちは、nukkyです。
私はSwiftでJSONを取り扱う際に、ObjectMapperを使用していたのですが、Swift4から追加されたCodableが便利そうなのでこちらを使用したいと思い備忘録がてら書いていこうと思います。

Codableとは

CodableはSwiftが提供している構造体やクラスなどをJSONに書き出す、読み込むためのプロトコル。(厳密に言うと、JSONだけではなく、他のフォーマットにも使えます) CodableはEncodable(書き出し用)とDecodable(読み込み用)の二つのプロトコルで構成されています。
Codable – Swift Standard Library | Apple Developer Documentation

Codable使いたい理由

いままで、JSONを取り扱おうと思ったらJSONをパースして、Dictionaryのキーを指定してデータクラスに代入(マッピング)するような流れを実装していたと思うのですが、これだとメンテナンス性も悪いうえコード量もそこそこになります、ライブラリを使用していても結局パース後のデータ構造への代入処理を記載したりマッピングは必須だったと思います。
ですがCodableであれば基本的にマッピングは不要になりコードもすっきりかけます!

実装

とりあえずJSONを読み込む

まずCodableで単純なJSONを読み込んで見たいと思います。
読み込むJSONは以下を用意します。

データを入れる構造体を作成します。

JSONデータをデコードして構造体に変換します。

これだけです。printのログを見てもらえばわかりますがマッピング処理を一切書かずに済んでいます。

ObjectMapperの場合

比較用にObjectMapperの場合、同じJSONで処理内容は以下になります。
JSONは同じものを使用するとして構造体を作成します。

JSONデータをデコードして構造体に変換します。

マッピングをしなくてはならないため構造体の処理に明確な差が出てしまいますね。
GitHub – Hearst-DD/ObjectMapper

ネスト配列に対応してみよう

JSONデータがネストしている場合でも大丈夫です、Codableならネストも簡単です。
まずはJSONを用意します。

そうしたら「photos」が配列になっているので以下のようなデータ構造体を用意します。

JSONデータをデコードして構造体に変換します。

JSONのキーがスネークケースの場合(Swift4.0)

Swiftの変数はキャメルケースですが、JSONのキーはスネークケースという場合も結構あります、その際はCodingKeysという機能で対応することが可能です。
JSONのキーはスネークケースのJSONを用意します。

データを入れる構造体にCodingKeysを追加し作成します。

JSONのキーがスネークケースの場合(Swift4.1)

結局マッピングみたいなことが必要なのかと思っていましたがSwift4.1からEncoderの「keyEncodingStrategy」やDecoderの「keyDecodingStrategy」を設定することで、キャメルケースのプロパティ名からスネークケースのキーが自動作成できるようになりました。

さいごに

Codableオススメですね。個人的には今までライブラリで行なっていたJSONの取り扱いは網羅できて、かつコード量も減るといいことづくめだと思います。Swift4以降で追加されれた機能など深掘りしていなかったのであらためていろいろチェックしていきます。これからiOS12/Xcode10も出ますしどんどん新機能を試してブログにしていきますね。

RE:ENGINESブログ「iOS記事」まとめページはこちらから

参考

blog-page_footer_336




blog-page_footer_336




-iOS
-

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

swift

[Swift3] コードで動的にオートレイアウトを変更する

1 はじめに1.1 前提条件2 事前準備3 1.NSLayoutConstraintのActiveを切り替える4 2.NSLayoutConstraintのActiveを切り替える(複数同時)5 3. ...

[Swift]アプリのフォアグラウンドに特定の処理を行う。

1 はじめに2 今回の目標3 画面構成4 通知の設定4.1 通知の送信4.2 通知の受信と削除-BaseController5 それぞれの画面の設定5.1 初期画面(FirstViewControll ...

iOS14のWidget機能を使ってみた。

1 はじめに2 Xcode 12 betaの入れ方3 WidgetExtensionの追加方法4 デフォルトのコード説明5 Configurationについて6 プロバイダー6.1 snapshot6 ...

[Swift]クラスタされているPINを取得する

1 はじめに2 前回からの修正箇所3 クラスタリングされたPINの内容を取得する3.1 クラスタリングされているPINか判別3.2 クラスタリングされているPINを取得する4 TableViewとの連 ...

swift

SwiftでPDFを表示する(iOS11以前対応版)

1 はじめに1.1 前提条件2 実装3 さいごに はじめに こんにちは、nukkyです。 SwiftでPDFを表示したい場合iOS11以降ならPDFKitがありますが、自分の様にまだ11以前のOSにも ...

フォロー

follow us in feedly

blog-page_side_responsive

東京改造計画(NewsPicks Book)
2018年9月
 1
2345678
9101112131415
16171819202122
23242526272829
30 

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。