DynamicJsonでのJSON処理
前項で解説したDataContractJsonSerializerは、すでに存在する.NETのオブジェクトとJSONデータの相互変換を行う上では有用ですが、さまざまなWebサービスで公開されているJSONデータを処理する上では、事前の.NETクラスの定義が必須であるという点が問題となります。JSONには厳密なスキーマがあるわけではないため、取得したJSONデータを見ながら、そこから構造を推測しながら.NETクラスの定義を行うという作業になります。実際、複雑なデータ構造を持つJSONデータの場合、対応する.NETクラスの定義を行うだけでも一苦労です。
「もっとお手軽にJSONデータを扱いたい」、そんな希望に応えるのが、DynamicJSONライブラリです。このライブラリは.NET Framework 4の新機能である動的な型(dynamic型)を使うことにより、事前のクラス定義を行うことなく、すぐにJSONデータの読み書きを行うことができます。
それではDynamicJSONをダウンロードし、基本的な使い方を概観しましょう。なお、以降のコードは、配布サンプルのDynamicJsonSampleプロジェクトに含まれています。
DynamicJSONのダウンロード
DynamicJSONはCodePlexからダウンロードできます。以下のページの右の[Download]リンクをクリックします。
以下のようにライセンス条項が表示されますので、確認の上[I Agree]をクリックします。
ダウンロード完了後、DynamicJson_1.2.0.0.zipを任意の場所に展開します。
DynamicJSONを使用するための設定
続いて、Visual StudioのプロジェクトからDynamicJSONライブラリを使用するための設定を行います。
先ほどと同様にVisual Studioの[プロジェクト]メニューから[参照の追加]を選択し、[参照]タブから以下のように、DynamicJSONを展開したフォルダのDynamicJson.dllファイルを選択して[OK]ボタンを押します。
あるいは、DynamicJsonは1つのソースコードだけで構成されていますので、そのファイルを直接プロジェクトに追加することも可能です。その場合は、展開したフォルダにあるDynamicJson.csファイルをプロジェクトに追加し、DataContractJsonSerializerの場合と同じ手順で、System.Runtime.Serializationコンポーネントへの参照を追加します。
DynamicJSONを使用するのに必要なusingステートメントは以下のように宣言します。
using Codeplex.Data;
DynamicJSONでのJSONデータの読み書き
DynamicJSONでのJSONデータの読み書きは、DataContractJsonSerializerの場合よりもシンプルなコードになります。例えばJSONデータの読み込みの場合、事前のクラス定義は不要で、以下のようなコードだけで行えます。
//読み込むJSONデータ var jsonString = @"{""Address"":""Tokyo"",""Age"":32,""Name"":""Doi""}"; //(1)DynamicJsonクラスのParseメソッドでJSONデータを解析してdynamic型として返す var obj = DynamicJson.Parse(jsonString); //(2)変換したクラスのプロパティ内容を確認(実行結果は前と同じため省略) Console.WriteLine("Name:{0}, Address:{1}, Age:{2}", obj.Name, obj.Address, obj.Age);
(1)では、DynamicJsonクラスのParseメソッドで、文字列型のJSONデータを解析しています。返値はdynamic型のオブジェクトとなります。(2)ではこのオブジェクトのName, Address, Ageといったプロパティを参照していますが、これらのプロパティが事前に定義されていないことに注目してください。DynamicJSONがJSONデータを解析し、含まれるフィールドを.NETのプロパティに動的に変換してくれるため、このような簡潔なコードとなるわけです。.NET Framework 4のdynamic型の本領発揮といったところですね。
書き込みについても同様にシンプルです。以下は、任意の.NETオブジェクトをJSONデータとして変換するコードです。FriendInfoクラスの定義はDataContractJsonSerializerで使ったものと同様です。
//FriendInfo型オブジェクトを生成 var friend = new FriendInfo() { Name = "Doi", Address = "Tokyo", Age = 32 }; //DynamicJsonクラスのSerializeメソッドで.NETオブジェクトをJSONデータに変換 Console.Write(DynamicJson.Serialize(friend));
ここでは、DynamicJsonクラスのSerializeメソッドを使ってFriendInfo型の.NETオブジェクトをJSONデータに変換しています。出力結果はDataContractJsonSerializerの場合と同様のため省略します。
DataContractJsonSerializerの場合はあらかじめFriendInfo型とJSONデータの相互変換を行うための専用のDataContractJsonSerializerインスタンスを作成する必要がありましたが、DynamicJSONでは任意の.NETオブジェクトをJSONデータに変換できます。
さらに、以下のようにDynamicJsonクラスをインスタンス化することで、任意のプロパティを動的に追加していくことも可能です。
//(1)DynamicJsonクラスをインスタンス化 dynamic obj2 = new DynamicJson(); //(2)任意のプロパティを動的に追加できる obj2.Name = "Doi"; obj2.TelNo = "03-xxxx-xxxx"; obj2.MobileTelNo = "090-xxxx-xxxx"; //(3)DynamicJsonオブジェクトのToStringメソッドでJSONデータを出力 Console.WriteLine(obj2.ToString());
(1)では、DynamicJsonクラスをインスタンス化しています。DynamicJsonクラスはインスタンス化することで、動的なオブジェクトとして振る舞うようになり、(2)のように任意のプロパティを動的に追加できます。
(3)では、ToStringメソッドを使い、動的に追加したプロパティを含むJSONデータを出力しています。出力結果は以下のようになります。
{"Name":"Doi","TelNo":"03-xxxx-xxxx","MobileTelNo":"090-xxxx-xxxx"}
このように、DynamicJsonクラスを使うことで、非常にシンプルなコードでJSONデータの読み書きを行えます。