![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
|
「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。 目次 †概要 †とある案件の要件で、
ということを調査した。 結論としては、コチラのLINQ to JSONを使用することで可能。 JSON フォーマットとクラスの定義 †JSON フォーマットの確認 †まず、どのようなフォーマットの JSON を出力したいのかを確認する。 クラスの定義 †次に、出力したい JSON に合わせて、クラスを定義する。 基本 †基本的には、以下のルールに従って、クラス・プロパティを定義する。
ルール †基本的に、以下のようにJSON出力を想定し、クラスを定義する。
Web Essentialsを使用 †Visual Studio の拡張機能である、Web Essentials を使うと、JSON からクラスを自動生成できる。
JSON 文字列をコピーし、Visual Studio のエディターで、右クリックまたは [編集] メニューから、 JSON.NET †ココが参考になる。
基本（Bean, POCO） †シリアライズ・デシリアライズ †[JsonObject("aaa")]
public class AAA
{
[JsonProperty("prop1")]
public int Property1 { get; set; }
[JsonProperty("prop2")]
public string Property2 { get; set; }
}
シリアライズ・デシリアライズを制御する属性 †様々な属性がある。
シリアライズ・デシリアライズの既定値を制御する属性 †
応用 †上記のリンク先の記事に
とあるが、何処までやってくれるか？ ・・・検証の結果、
ということが解った。 以下は、型が特定できる構造のJSONをparseする例。 階層構造を持ったBean, POCOを使用する †
配列（List<AAA>）を使用する †配列（Generic）も問題なく処理できる。 [JsonObject("aaa")]
public class AAA
{
[JsonProperty("prop1")]
public int Property1 { get; set; }
[JsonProperty("prop2")]
public string Property2 { get; set; }
[JsonProperty("prop3")]
public AAA Property3 { get; set; }
}
static void Main(string[] args)
{
AAA aaa1 = new AAA();
AAA aaa2 = new AAA();
aaa1.Property1 = 100;
aaa1.Property2 = "xxx";
aaa2.Property1 = 200;
aaa2.Property2 = "yyy";
aaa1.Property3 = aaa2;
List<AAA> lstaaa = new List<AAA>();
lstaaa.Add(aaa1);
lstaaa.Add(aaa2);
string json = JsonConvert.SerializeObject(lstaaa);
Console.WriteLine(json);
lstaaa = JsonConvert.DeserializeObject<List<AAA>>(json);
Primitive型とGeneric型を使用する †
static void Main(string[] args)
{
List<Dictionary<string, string>> parent = new List<Dictionary<string, string>>();
Dictionary<string, string> child;
child = new Dictionary<string, string>();
child["aaa"] = "AAA";
child["bbb"] = "BBB";
child["ccc"] = "CCC";
parent.Add(child);
child = new Dictionary<string, string>();
child["xxx"] = "XXX";
child["yyy"] = "YYY";
child["zzz"] = "ZZZ";
parent.Add(child);
string json = JsonConvert.SerializeObject(parent);
Console.WriteLine(json);
parent = JsonConvert.DeserializeObject<List<Dictionary<string, string>>>(json);
継承を使用する †
[JsonObject("aaa")]
public class AAA
{
[JsonProperty("prop1")]
public int Property1 { get; set; }
[JsonProperty("prop2")]
public string Property2 { get; set; }
[JsonProperty("prop3")]
public AAA Property3 { get; set; }
}
[JsonObject("bbb")]
public class BBB : AAA
{
[JsonProperty("prop4")]
public int Property4 { get; set; }
}
[JsonObject("ccc")]
public class CCC : AAA
{
[JsonProperty("prop4")]
public string Property4 { get; set; }
}
static void Main(string[] args)
{
AAA aaa1 = new AAA();
AAA aaa2 = new AAA();
aaa1.Property1 = 100;
aaa1.Property2 = "xxx";
aaa1.Property3 = new BBB(); // AAAの派生のBBB
aaa2.Property1 = 200;
aaa2.Property2 = "yyy";
aaa2.Property3 = new CCC(); // AAAの派生のCCC
List<AAA> lstaaa = new List<AAA>();
lstaaa.Add(aaa1);
lstaaa.Add(aaa2);
string json = JsonConvert.SerializeObject(lstaaa);
Console.WriteLine(json);
// BBBとCCCがAAA型のProperty3フィールドにデシリアライズされない。
lstaaa = JsonConvert.DeserializeObject<List<AAA>>(json);
型が特定できない構造のJSON †型が特定できない構造のJSONの例 †シリアライズの対象にobject型を使用しており、 シリアライズの際、
object型を使用せざるを得ないケース †以下の様な構造が一定ではないケースでは、
JSON.NETのJObjectのLINQ to JSONで手動のデシリアライズ †型が特定できない構造の（object型をシリアライズした）JSONを この場合、JSON.NETのJObjectのLINQ to JSONで型の手動のデシリアライズを行う。 参考 †
DataContractJsonSerializer? †WCFの既定のシリアライザ。 流行ってないので基本スルーだが、 JavaやJSON.NETのシリアライザとの違い。 †.NETのDataContractJsonSerializer?はJavaやJSON.NETと、シリアライザの挙動が違う。 Dictionaryのシリアライズ結果 †特に、以下のように Dictionaryの JSON シリアライズ結果が異なる。
Efficient dictionary serialization, Nonsensical dictionary serialization †この違いは、以下の機能のサポート状況によるものらしい。
JSON.parse、JSON.stringify（JavaScript） †JavaScriptでは、JSON.parse（シリアライズ）、JSON.stringify（デシリアライズ）が使用できる。 JSON.parse †JSON 文字列を解析して JavaScript のオブジェクトに変換する（シリアライズ）。 JSON.stringify †JavaScript の値を JSON 文字列に変換する（デシリアライズ）。 参考 †
応用 †JSONを送信するRESTサービスを作成する方法 †JSONを受信するJSON-RPCサービスを作成する方法 †コンボ生成でJSONを使用する際の注意事項（順番保証）。 †順番保証がされないので、
JSON.NETのJObjectを使って手動で任意の型にデシリアライズする。 †
Deserialize †以下のようにデシリアライズできる。 JObject jObject = (JObject)JsonConvert.DeserializeObject(jsonResult);
if (jObject["Message"] != null)
{
// 正常終了
List<Dictionary<string, string>> list =
JsonConvert.DeserializeObject<List<Dictionary<string, string>>>(jObject["Result"].ToString());
this.lstRecords.ItemsSource = list;
message = "正常終了しました";
}
else
{
・・・
Messageの戻りによって、Resultの方が変わる事例。 Serialize †上記のシナリオに合わせて、以下のようにシリアライズできる。 単にobject型を使用したり、匿名型を使用したりして、 object ret = null;
if(・・・)
{
ret = new { ErrorMSG = message };
}
else
{
List<Dictionary<string, string>> list = new List<Dictionary<string, string>>();
・・・
ret = new { Message = "", Result = list };
}
return Request.CreateResponse(HttpStatusCode.OK, ret);
参考 †
参考 †
Tags: :.NET開発, :.NET Core, :ASP.NET, :ASP.NET Web API |
WebEssentials.png