SwiftでJSONを操作する

JSONを使用したことがない開発者を教えてください。 シンプルさ、柔軟性、可視性により、このデータ表示形式は非常に人気があり、現在どこでも使用されています。 そのため、Swiftの実験中に、JSONデータを解析する必要性にすぐに気付きました。



実際、標準のFoundation API（ NSJSONSerialization）は、テキスト表現からオブジェクトモデルへのJSONの直接および逆変換のタスクに完全に対応しています。 AppleはSwiftとObjective-Cコード間の直接および逆の相互作用を確実にするために多くの作業を行いました（ ScoftとCocoaおよびObjective-Cを使用する）、使い慣れたCocoa APIの使用は実際に可能であるだけでなく、便利で不自然に見えません：

let jsonString = "{\"name\":\"John\",\"age\":32,\"phoneNumbers\":[{\"type\":\"home\",\"number\":\"212 555-1234\"}]}" let jsonData = jsonString.dataUsingEncoding(NSUTF8StringEncoding, allowLossyConversion: true) let jsonObject: AnyObject! = NSJSONSerialization.JSONObjectWithData(jsonData, options: NSJSONReadingOptions(0), error: nil)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

しかし、静的に型指定されたSwiftで結果を操作するのは不便です。値を取得するには、チェックと型変換のチェーンが必要です。 次に、この問題の解決策を検討すると同時に、Swiftのいくつかの機能に精通します。



NSJSONSerializationによって正式に取得されたJSON表現は、NSNull、NSNumber、NSString、NSArray、NSDictionaryのFoundationタイプのインスタンスで構成されています。 しかし、 ランタイムブリッジングは、これらの型と対応するSwiftプリミティブ（数値型（Int、Doubleなど）、文字列、配列、辞書）の完全な互換性と互換性を提供します。 したがって、Swiftコードでは、生成されたオブジェクトを「ネイティブに」処理できます。 最初の電話番号の値を確認する必要があるとします。 Objective-Cでは、これは次のようになります。

 NSString *number = jsonObject[@“phoneNumbers”][0][@“number”]; NSAssert(["212 555-1234" isEqualToString:number], @”numbers should match”);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

動的な型指定を使用することにより、JSONオブジェクトの階層をナビゲートしても、Objective-Cで問題は発生しません。 これとは対照的に、Swiftは厳密な静的型付けを使用するため、階層の「より深い」各ステップで明示的な型キャストを使用する必要があります。

 let person = jsonObject! as Dictionary<String,AnyObject> let phoneNumbers = person["phoneNumbers"] as Array<AnyObject> let phoneNumber = phoneNumbers[0] as Dictionary<String,AnyObject> let number = phoneNumber["number"] as String assert(number == "212 555-1234")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

残念ながら、現在のバージョンのコンパイラ（Xcode 6ベータ2）はこのコードに対してエラーを生成します- 添字を使用したオペランドを持つ明示的な型変換の式の解析に問題があります 。 これは中間変数によって回避できます：

 let person = jsonObject! as Dictionary<String,AnyObject> let phoneNumbers : AnyObject? = person["phoneNumbers"] let phoneNumbersArray = phoneNumbers as Array<AnyObject> let phoneNumber : AnyObject? = phoneNumbersArray[0] let phoneNumberDict = phoneNumber as Dictionary<String,AnyObject> let number : AnyObject? = phoneNumberDict["number"] let numberString = number as String assert(numberString == "212 555-1234")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このオプションは正しく機能しますが、確かにひどいように見えます。 1つの式で値を取得することと、 オプションのダウンキャストおよびオプションの連鎖を組み合わせます 。

 let maybeNumber = (((jsonObject as? NSDictionary)?["phoneNumbers"] as? NSArray)?[0] as? NSDictionary)?["number"] as? NSString assert(maybeNumber == "212 555-1234")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

すでに優れていますが、もちろんそのようなレコードを便利なものと呼ぶことは困難です-読書や特に編集のために。



これは、よくある問題の特殊なケース、つまり厳密に型指定された言語で動的データ構造を操作する複雑さだけであることは明らかです。 この問題を解決するにはさまざまなアプローチがあり、データの処理方法を変えるものもあります。 しかし、JSONオブジェクトを解析する特定のケースでは、次の要件を満たす簡単なソリューションを探していました。

• コードのコンパクトさと読みやすさ。
• 明示的な型キャストの必要性を最小限にします。
• チェーン内の1つの式で階層のいくつかのレベルを「開示」する可能性と利便性。
• JSON構造と期待値との不一致による実行時エラーの可能性を排除します-そのような場合、式全体の値はゼロでなければなりません。
• CPUとメモリのオーバーヘッドを最小限に抑えます。

まず、既成のソリューションを見つけて分析しようとしました。

列挙表現

数人の著者がすぐに同様のアプローチを提案しています：

• github.com/owensd/json-swift
• github.com/lingoer/SwiftyJSON
• github.com/maxpow4h/swiftz/blob/master/swiftz/JSON.swift

例としてjson-swiftを使用したデバイスについて簡単に考えてみましょう。

1. JSONオブジェクトを表す新しい列挙型（ github ）が導入されました
2. 関連する値のメカニズムを使用して、この列挙型の可能な値は、JSON型（ github ）に対応するプリミティブなSwift型に設定されます
3. メインの型コンストラクターは、渡されたオブジェクトの型をチェックし、目的の列挙値（ github ）を持つインスタンスを返します
4. 同時に、コンテナ（配列および辞書）の場合、要素は再帰的に処理されます（ github ）
5. JSON階層をナビゲートするために、配列と辞書に適切な要素を返す添え字が実装されています（ github ）
6. JSON列挙型から対応するプリミティブSwift型への逆変換では、 計算されたプロパティが使用され 、型が一致する場合にのみ関連付けられた値を返します（ github ）

元のオブジェクトモデルをこのような表現に変換すると、階層をナビゲートして期待されるタイプの値を取得するために使用できる便利なインターフェイスが得られます。

 let number = JSON(jsonObject)?[“phoneNumbers”]?[0]?[“number”]?.string assert(number == "212 555-1234")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここでは、オプションの連鎖メカニズムにより、ランタイムエラーがないことを保証します。 不適切な構造を持つオブジェクトを解析する場合、式全体の値はnilになります（配列の外部でインデックスにアクセスする場合を除く）。



このようなソリューションは、1つを除くすべての要件を満たしていることがわかります。 これを使用すると、JSONオブジェクトの階層全体の必須の再帰トラバーサルが発生し、データの新しいオブジェクト表現が作成されます。 もちろん、場合によっては、このようなオーバーヘッドは基本的な役割を果たしません。 しかし、それでも、CPUリソースとメモリリソースの使用に関して、ソリューション全体を最適とは言えません。



この問題を解決する基本的な方法は、テキスト表現からの変換の段階でそのようなオブジェクトJSON表現を使用することです。 しかし、そのようなアプローチはすでに検討中の問題の範囲を超えています-JSONのネイティブオブジェクト表現を使用した便利な作業です。

遅延処理

完全な変換の問題を解決する別のアプローチは、JSONをトラバースするときに「遅延」ロジックを使用して型をチェックおよびキャストすることです。 必要なタイプの値を使用してJSON階層全体をすぐに再作成する代わりに、要求された1つの要素のみに対して、「詳細」の各ステップでこれを実行できます。 このようなアプローチの実装は、悪名高いマイクアッシュによって提供されています： gist.github.com/mikeash/f443a8492d78e1d4dd10



残念ながら、このアプローチでは、個別のJSON値を同じ便利な形式（enum +関連する値）で提示することはできません。 しかし、このようなソリューションは明らかに最適です。 一見したところ、階層の深い各ステップで追加のラッパーオブジェクトを作成するという形で小さなオーバーヘッドもあります。 ただし、これらのオブジェクトは構造体（構造体値）として定義されているため、Swiftのコンパイラーによって初期化と使用を適切に最適化できます。

解決策

新しい型を使用せず、必要に応じて標準型の動作を拡張するソリューションを探していました。 標準構文を使用して式を詳しく見てみましょう

 (((jsonObject as? NSDictionary)?["phoneNumbers"] as? NSArray)?[0] as? NSDictionary)?["number"] as? NSString
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

実際、辞書と配列の要素への移行だけがここで問題を引き起こします。 これは、添え字呼び出し（ [1]



または[“number”]



）が適用される値のタイプに要件を課すためです。この場合、NSDictionaryまたはNSArrayにキャストしています。 または、NSArrayおよびNSDictionaryから取得した値はAnyObject型であるため、コールチェーンの後半で使用する型キャストが必要です。



最初に添え字オプションの両方をサポートし、同じタイプのオブジェクトを返すユニバーサルタイプを操作すると、キャストの必要性がなくなることがわかります。 Swiftでは、プロトコルは正式にこの定義を満たしています。

 protocol JSONValue { subscript(key: String) -> JSONValue? { get } subscript(index: Int) -> JSONValue? { get } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

したがって、プロトコルはJSON値を決定します。これには、添え字（IntまたはStringパラメーターを使用）によって常にアクセスできます。 その結果、コレクション要素（オブジェクトがコレクションである場合、そのタイプは下付き文字タイプに対応し、そのような下付き文字を持つ要素はコレクション内にあります）またはnilを取得できます。



この方法で標準型を使用するには、それらがJSONValueと一致することを確認する必要があります。 Swiftでは、拡張機能を使用してプロトコル実装を追加できます。 その結果、ソリューション全体は次のようになります。

 protocol JSONValue { subscript(#key: String) -> JSONValue? { get } subscript(#index: Int) -> JSONValue? { get } } extension NSNull : JSONValue { subscript(#key: String) -> JSONValue? { return nil } subscript(#index: Int) -> JSONValue? { return nil } } extension NSNumber : JSONValue { subscript(#key: String) -> JSONValue? { return nil } subscript(#index: Int) -> JSONValue? { return nil } } extension NSString : JSONValue { subscript(#key: String) -> JSONValue? { return nil } subscript(#index: Int) -> JSONValue? { return nil } } extension NSArray : JSONValue { subscript(#key: String) -> JSONValue? { return nil } subscript(#index: Int) -> JSONValue? { return index < count && index >= 0 ? JSON(self[index]) : nil } } extension NSDictionary : JSONValue { subscript(#key: String) -> JSONValue? { return JSON(self[key]) } subscript(#index: Int) -> JSONValue? { return nil } } func JSON(object: AnyObject?) -> JSONValue? { if let some : AnyObject = object { switch some { case let null as NSNull: return null case let number as NSNumber: return number case let string as NSString: return string case let array as NSArray: return array case let dict as NSDictionary: return dict default: return nil } } else { return nil } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

いくつかのメモ：

• NSDictionaryおよびNSArrayの標準添え字との競合を避けるために、名前付きパラメーターを持つ添え字が使用されます-＃key、＃index;
• 標準の検証演算子とキャスト演算子は@objc
  
  
  
  属性でマークされたプロトコルでのみ機能するため、ヘルパー関数を使用して任意の値をJSONValue型にキャストします （これは、 @objc
  
  
  
  プロトコルをそのようなSwift型に追加できるためです。実行時に利用できないデータ）;
• コードはFoundationタイプで動作しますが、ランタイムブリッジングにより、Swiftプリミティブが正しく動作することが保証されます。

その結果、式を使用してJSONを操作できます。

 let maybeNumber = JSON(jsonObject)?[key:"phoneNumbers"]?[index:0]?[key:"number"] as? NSString assert(maybeNumber == "212 555-1234")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これは検討対象の中で最もコンパクトなオプションではありませんが、このようなソリューションは上記のすべての要件を完全に満たしています。

代替オプション

同じ考えに基づいて、 @objc



属性を持つプロトコルを使用するバリアントが@objc



です。 これにより、補助関数の代わりに明示的な型キャストを使用できますが、添え字の使用は禁止されます-代わりに通常のメソッドを使用する必要があります。 ただし、これらのメソッドは@optional



として宣言できます。

 @objc protocol JSON { @optional func array(index: Int) -> JSON? @optional func object(key: String) -> JSON? } extension NSArray : JSON { func array(index: Int) -> JSON? { return index < count && index >= 0 ? self[index] as? JSON : nil } } extension NSDictionary: JSON { func object(key: String) -> JSON? { return self[key] as? JSON } } extension NSNull : JSON {} extension NSNumber : JSON {} extension NSString : JSON {}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

使用例：

 let maybeNumber = (jsonObject as? JSON)?.object?(“phoneNumbers”)?.array?(0)?.object?(“number”) as? NSString assert(maybeNumber == "212 555-1234")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

添え字付きオプションほどコンパクトではありません。 疑問符の数に戸惑う人もいるかもしれませんが、その一方で、それぞれの使用は理解可能であり、意味的な負荷がかかります。



私の意見では、見つかったソリューションは指定された要件を満たし、検討されている他のオプションよりも望ましいように見えます。 そして、使用されるアイデア-オプションの値を返すメソッドを使用したユニバーサルプロトコルの割り当て-は、JSONだけでなく、他の動的データ構造でも便利に使用できます。



コードと使用例はgithubで入手できます。