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記事」まとめページはこちらから

参考

page_footer_300rect




page_footer_300rect




-iOS
-

執筆者:


comment

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

CAPTCHA


関連記事

[Swift]AlamofireでファイルのUploadをしてみる

1 はじめに2 CarthageでAlamofireを導入する2.1 CartFileの作成とライブラリのダウンロード2.2 Xcodeの設定3 Alamofireとは3.1 AlamofireのHT ...

swift

Swiftでシェア機能や外部アプリ起動の導線を簡単に実装できるライブラリ「SwiftShareBubbles」

1 はじめに2 準備3 実装3.1 表示3.2 用意されているパターン4 さいごに はじめに こんにちは、nukkyです。 今回はSNSでのシェア機能や外部アプリ起動の導線を追加したいときに 簡単に実 ...

swift

[Swift4]UITextViewにプレースホルダをつける

1 はじめに1.1 前提条件2 実装3 さいごに はじめに こんにちは、nukkyです。 UITextFieldにはプレースホルダが標準で用意されていますが、UITextViewには用意されていません ...

swift

Swiftの配列、辞書関連メソッドの基本

1 はじめに2 配列(Array)2.1 filter2.2 map2.3 reduce3 辞書(Dictionary)3.1 filter3.2 map3.3 reduce4 さいごに はじめに 普 ...

swift

Swift3 [XIBファイル] コードでの呼び出し方まとめ

1 はじめに1.1 前提条件2 TableViewCell2.1 XIBの準備2.2 ViewControllerでの呼び出し3 CollectionView3.1 XIBの準備3.2 ViewCon ...

フォロー

follow us in feedly

page_side_300rect

2018年9月
« 8月 10月 »
 1
2345678
9101112131415
16171819202122
23242526272829
30 

アプリ情報

目標を達成したい方を応援する、TODOアプリもリリースしております。 下記のアイコンから無料でダウンロードできます。

Web版MyCoach

私たちはより広い方にコーチングを知ってもらいたいと考えています。 下記のサイトにて、コーチの方々を紹介しておりますので、よろしければご覧ください。