【Swift】JSONSerializationクラスって、どう使うの？

こんにちは！文系出身、独学で個人開発をしている「ゆとりくん」です????
当サイトでは自分が過去に躓いた内容を中心に、アプリ開発初心者の方に有益な情報を紹介しています。

今回のテーマは「JSONSerializationクラスって、どう使うの？」です。
初心者の方が理解しやすいようになるべく優しい言葉でまとめましたので、ぜひ参考にしてみてください！

当ブログでは記事内で紹介する参考文献にアフィリエイトリンクを付与する場合がございます。それらはすべて著者が実際に利用している文献ですので、安心して参照いただけます。

※本記事は、著者が学習した内容をまとめたものとなります。
内容の精査につきましては、執筆時の技術力で可能な限りの注意を払っていますが、万が一誤りがございましたらフォームからご一報いただけると幸いです。

この記事はこんな方におすすめ！

ゆとりくん

自分が躓いた点を中心に、初心者の方に向けて記事を書いています！

環境

この記事は以下のバージョン時点での情報をまとめています。

【XCode】15.3
【Swift】5.10
【iOS】17.1.2
【macOS】Sonoma 14.2

JSONSerializationクラスとは

JSONSerializationクラスとは、JSON形式のデータと、Swiftの標準的なデータ型(Dictionary型など)とを、相互に変換するためのクラスです。

そもそもJSONってなに？

JSONは、データの記述形式の1種です。

データ形式として有名なものはCSVやXMLなどがありますが、JSONはもともとJavaScriptでデータ通信を行う際のフォーマットとして開発されたようです。

たとえば、「Apple製品」を表すJSONは以下のように記述されます。

[
      {
         "id" : "0001",
         "name" : "iPhone", 
         "price" : 100000
      },
      {
         "id" : "0002",
         "name" : "iPad", 
         "price" : 60000
      }
      {
         "id" : "0003",
         "name" : "iMac", 
         "price" : 140000
      }
]

JavaScriptの文法が分からなくても「idと名前と値段が記載されたAppleの製品が3つ並べられているな〜」ということがなんとなく推測できますね！

上記のJSONを、Swiftの辞書型を用いて表現すると以下のようになります。

let products: [[String : Any]] = [
    [
        "id": "0001",
        "name": "iPhone",
        "price": 100000
    ],
    [
        "id": "0002",
        "name": "iPad",
        "price": 60000
    ],
    [
        "id": "0003",
        "name": "iMac",
        "price": 140000
    ]
]

キーをString型・バリューをAny型とした辞書型のオブジェクトを3つ、配列に格納しました。
こうすることで、JSONと同じ内容のデータをSwiftでも扱うことができます。

しかし、データの数が10個・100個・1000個と増えた場合、上記のように手動で変換を行うにはとても手間がかかってしまいます。

そこでJSON⇆Swift間のデータ変換を簡単に行える、JSONSerializationクラスの出番というわけです✨

JSONSerializationは、あくまでもJSONをSwiftのFoundationフレームワークの型(Dictionary, Arrayなど)へ変換するために用いられます。

JSONとSwiftのカスタムクラス間で変換を行いたい場合には、Codable, Decodable, Encodableなどの方法を利用します。

JSONSerializationクラスの使い方

概要が掴めたところで、さっそく具体的な使い方を見ていきましょう。

Swiftの型(Dictionary)から、JSONへ変換する方法

まずは、SwiftのDictionary型をJSONへ変換する方法です。
先ほども例として挙げた、[[String : Any]]型の定数productsを、JSONに変換していきます。

//これをJSON形式に変換する
let products: [[String : Any]] = [
    [
        "id": "0001",
        "name": "iPhone",
        "price": 100000
    ],
    [
        "id": "0002",
        "name": "iPad",
        "price": 60000
    ],
    [
        "id": "0003",
        "name": "iMac",
        "price": 140000
    ]
]

let jsonData = try? JSONSerialization.data(withJSONObject: products)

//if-let文を利用して、アンラップする
if let jsonData = try? JSONSerialization.data(withJSONObject: products){
    print(jsonData)
}

131 bytes

if let jsonData = try? JSONSerialization.data(withJSONObject: products){
    
    //表示可能な形式に変更する
    if let jsonDataForDisplay = String(data: jsonData, encoding: .utf8){
        
    //データを出力する
        print(jsonDataForDisplay)
    }
    
}

[{"name":"iPhone","id":"0001","price":100000},{"id":"0002","name":"iPad","price":60000},{"id":"0003","price":140000,"name":"iMac"}]

JSONをSwiftの型(Dictionary型)に変換する方法

続いて、さきほど作成したJSONのデータをSwiftで利用可能な元の形([[String: Any]]型)に戻してみましょう。

//変換元のJSONデータ
if let jsonData = try? JSONSerialization.data(withJSONObject: products){
    
    //JSONをSwiftで利用可能な型に変換する
    if let swiftData = try? JSONSerialization.jsonObject(with: jsonData){
        //定数swiftDataはAny型
        //追加の処理をSTEP2で記述する
    }
    
}

if let jsonData = try? JSONSerialization.data(withJSONObject: products){
    
    //JSONをSwiftで利用可能な型に変更する
    if let swiftData = try? JSONSerialization.jsonObject(with: jsonData){
        
        //Any型を[[String : Any]]型にダウンキャストし、表示する
        if let swiftDataForDisplay = swiftData as? [[String : Any]]{
            print(swiftDataForDisplay)
        }
    }
    
}

[["id": 0001, "name": iPhone, "price": 100000], ["name": iPad, "price": 60000, "id": 0002], ["name": iMac, "id": 0003, "price": 140000]]

まとめ

以上、参考になれば嬉しいです！

まだまだ勉強中ですので、間違い等ありましたらフォームよりご連絡ください????????

参考資料

• 生形可奈子. スラスラわかるJavaScript. 翔泳社, 2019, p325~P328
• 山田祥寛. 改定新版 JavaScript 本格入門~モダンスタイルによる基礎から現場の応用まで~. 技術評論社, 2020, p174
• Swiftful Thinking. “Codable, Decodable, and Encodable in Swift | Continued Learning #21”. Youtube. 2021-04, (参照 2024-04-21)
• Paul Hudson. Hacking with iOS(SwiftUI Edition). Hacking with Swift. 2024.
• Apple. “JSONSerialization”. AppleDeveloper, (参照 2024-04-21)
• Apple. “data(withJSONObject:options:)”. AppleDeveloper, (参照 2024-04-21)
• Apple. “jsonObject(with:options:)”. AppleDeveloper, (参照 2024-04-21)
• Apple. “init(data:encoding:)”. AppleDeveloper, (参照 2024-04-21)