SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

特集記事

.NET FrameworkでJSONデータを処理する

DataContractJsonSerializerとDynamicJsonの使用方法

  • X ポスト
  • このエントリーをはてなブックマークに追加

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]リンクをクリックします。

DynamicJSONページ
DynamicJSONページ

 以下のようにライセンス条項が表示されますので、確認の上[I Agree]をクリックします。

DynamicJSONのライセンス条項
DynamicJSONのライセンス条項

 ダウンロード完了後、DynamicJson_1.2.0.0.zipを任意の場所に展開します。

DynamicJSONを使用するための設定

 続いて、Visual StudioのプロジェクトからDynamicJSONライブラリを使用するための設定を行います。

 先ほどと同様にVisual Studioの[プロジェクト]メニューから[参照の追加]を選択し、[参照]タブから以下のように、DynamicJSONを展開したフォルダのDynamicJson.dllファイルを選択して[OK]ボタンを押します。

DynamicJson.dllへの参照を追加
DynamicJson.dllへの参照を追加

 あるいは、DynamicJsonは1つのソースコードだけで構成されていますので、そのファイルを直接プロジェクトに追加することも可能です。その場合は、展開したフォルダにあるDynamicJson.csファイルをプロジェクトに追加し、DataContractJsonSerializerの場合と同じ手順で、System.Runtime.Serializationコンポーネントへの参照を追加します。

 DynamicJSONを使用するのに必要なusingステートメントは以下のように宣言します。

usingステートメント(Program.cs)
using Codeplex.Data;

DynamicJSONでのJSONデータの読み書き

 DynamicJSONでのJSONデータの読み書きは、DataContractJsonSerializerの場合よりもシンプルなコードになります。例えばJSONデータの読み込みの場合、事前のクラス定義は不要で、以下のようなコードだけで行えます。

JSONデータの読み込み(Program.cs)
//読み込む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で使ったものと同様です。

.NETオブジェクトからJSONデータへの変換(Program.cs)
//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クラスをインスタンス化することで、任意のプロパティを動的に追加していくことも可能です。

任意のプロパティの動的な追加(Program.cs)
//(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データを出力しています。出力結果は以下のようになります。

DynamicJsonオブジェクトからのJSONデータ書き込みサンプルの実行結果
{"Name":"Doi","TelNo":"03-xxxx-xxxx","MobileTelNo":"090-xxxx-xxxx"}

 このように、DynamicJsonクラスを使うことで、非常にシンプルなコードでJSONデータの読み書きを行えます。

次のページ
まとめ

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
特集記事連載記事一覧

もっと読む

この記事の著者

山田 祥寛(ヤマダ ヨシヒロ)

静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるReact実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

WINGSプロジェクト 土井 毅(ドイ ツヨシ)

WINGSプロジェクトについて> 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書記事多数。 RSS Twitter: @yyamada(公式)、@yyamada/wings(メンバーリスト) Facebook

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/5868 2011/04/21 14:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング