JSONのparseを色々試してみた。のバックアップ(No.22)

#	出力したいJSON	定義するクラス・プロパティ
1	{ "key1" : "value1", "key2" : "value2" }	public class Sample { string key1 { get; set; } string key2 { get; set; } } 若しくは、 Dictionary<string, string> dic;
2	[ "1", "2", "3" ]	List<string> listData { get; set; }
3	{ "key1" : [ "1", "2", "3" ] }	public class Sample { List<string> key1 { get; set; } }
4	{ "key" : { "key1" : "value1", "key2" : "value2" } }	public class Sample { string key1 { get; set; } string key2 { get; set; } } public class Sample2 { Sample key { get; set; } } 若しくは、 Dictionary<string, Sample> dic; 若しくは、 Dictionary<string, Dictionary<string, string>> dic;
5	[ { "key1" : "value1", "key2" : "value2" }, { "key1" : "value3", "key2" : "value4" } ]	public class Sample { string key1 { get; set; } string key2 { get; set; } } List<Sample> list;

補足

ただし、DictionaryをDataContractJsonSerializer?で
シリアライズ・デシリアライズする場合、下記の様に、相互運用性に問題があるので注意する。

上記のように、public class Sampleを定義するのが面倒な場合は、
以下のように、匿名型を使用することで、簡単にJSONを作成することができる。

JsonConvert.SerializeObject(new
    {
        date = DateTime.Now,
        command = SqlExecuteType.Reader,
        text = this.ClearText(this._commandText),
        param = this._commandParameters,
        ms = this._stopwatch.ElapsedMilliseconds
    }, Formatting.None));

↑

Web Essentialsを使用 †

Visual Studio の拡張機能である、Web Essentials を使うと、JSON からクラスを自動生成できる。
Web Essentials は、Visual Studio のメニューから、[ツール] - [拡張機能と更新プログラム] で追加できる。

JSON 文字列をコピーし、Visual Studio のエディターで、右クリックまたは [編集] メニューから、
[形式を選択して貼り付け] - [JSON をクラスとして貼り付ける] を選択すると、
その JSON フォーマットに合ったクラスが生成される。

↑

JSON.NET †

ココが参考になる。

C#でJSONを扱うライブラリ「Json.NET」を使ってみました - Qiita
http://qiita.com/ta-yamaoka/items/a7ff1d9651310ade4e76

↑

基本（Bean, POCO） †

↑

シリアライズ・デシリアライズ †

[JsonObject("aaa")]
public class AAA
{
  [JsonProperty("prop1")]
  public int Property1 { get; set; }
  [JsonProperty("prop2")]
  public string Property2  { get; set; }
}

シリアライズ

コード

AAA aaa = new AAA();
aaa.Property1 = 100;
aaa.Property2 = "xxx";
string json = JsonConvert.SerializeObject(aaa);

文字列
```
{"prop1":100,"prop2":"xxx"}
```

デシリアライズ

型を指定してデシリアライズ
- コード
  AAA型にデシリアライズされる。
```
AAA aaa = JsonConvert.DeserializeObject<AAA>(json);
```

型を指定せずにデシリアライズ
- コード
  JObject型にデシリアライズされる。
```
JObject jobj = (JObject)JsonConvert.DeserializeObject(json);
```

参考
- JsonConvert?.SerializeObject? Method
  http://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_JsonConvert_SerializeObject.htm
- JsonConvert?.DeserializeObject? Method
  http://www.newtonsoft.com/json/help/html/Overload_Newtonsoft_Json_JsonConvert_DeserializeObject.htm

↑

既定値を制御する属性 †

プロパティの既定値の設定方法
プロパティの属性にSystem.ComponentModel?.DefaultValue?属性を指定する。

[JsonObject("aaa")]
public class AAA
{
  [JsonProperty("prop1")]
  public int Property1 { get; set; }
  [JsonProperty("prop2")]
  [DefaultValue("hogehoge")]
  public string Property2  { get; set; }
}

シリアライズ（デシリアライズ時）の既定値の取り扱い
DefaultValueHandling? 列挙体でシリアライズ（デシリアライズ時）の既定値の取り扱い方法を制御できる。

DefaultValueHandling?

#	設定値	動作
1	Include	シリアライズ時に既定値の項目をJSONに含める（既定）。
2	Ignore	シリアライズ時に既定値の項目をJSONに含めない。
3	Populate	デシリアライズ時にJSON文字列中に要素が存在しない場合でも既定値を設定。
4	IgnoreAndPopulate?	IgnoreとPopulateの同時指定。

指定方法

プロパティの属性として指定

[JsonProperty("prop2", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[DefaultValue("hogehoge")]
public string Property2 { get; set; }

シリアライズ時に指定

string json = JsonConvert.SerializeObject(aaa, Formatting.Indented, new JsonSerializerSettings { DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate });

デシリアライズ時に指定

AAA aaa = JsonConvert.DeserializeObject<UserModel>(jsonstring, new JsonSerializerSettings { DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate });

↑

その他、属性 †

様々な属性がある。

JsonProperty?属性
JSONのキーを指定する

JsonIgnore?属性
シリアライズ対象外を設定する

↑

応用 †

上記のリンク先の記事に

「階層構造を持ったJSONでも問題なくデシリアライズ可能。
JSON配列もListなどにパースしてくれる。」

とあるが、何処までやってくれるか？

・・・検証の結果、

型が特定できる構造のJSONはシリアライズできる。
型が特定できない構造のJSONは、シリアライズは可能だが、
デシリアライズ結果は（インデクサが使用可能な）JObjectに格納されるので、
これをそのまま使用するか、手動で任意の型にデシリアライズする必要がある。

ということが解った。

以下は、型が特定できる構造のJSONをparseする例。

↑

階層構造を持ったBean, POCOを使用する †

型を明示

[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 aaa = new AAA();
  aaa.Property1 = 100;
  aaa.Property2 = "xxx";
  aaa.Property3 = new AAA();
  aaa.Property3.Property1 = 200;
  aaa.Property3.Property2 = "yyy";

  string json = JsonConvert.SerializeObject(aaa);
  Console.WriteLine(json);

  aaa = JsonConvert.DeserializeObject<AAA>(json);

型を明示しない
オブジェクト型を使用する（JObject型にデシリアライズされる）。

[JsonObject("aaa")]
public class AAA
{
  [JsonProperty("prop1")]
  public int Property1 { get; set; }
  [JsonProperty("prop2")]
  public string Property2 { get; set; }
  [JsonProperty("prop3")]
  public object 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;
  
  string json = JsonConvert.SerializeObject(aaa1);
  Console.WriteLine(json);
  
  JObject jobj= (JObject)JsonConvert.DeserializeObject(json);

↑

配列（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型を使用する †

Primitive型とGeneric型の範囲であれば、JSONの型が特定できるので、parseできる。
このため、Primitive型とGeneric型の範囲で自由な構造を組むことができる。
しかし、Genericでは、Bean, POCOを使用するため（フィールド名・フィールド型の組み合わせが）自由な構造を組めない。

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);

↑

継承を使用する †

派生型をシリアライズできるが、問題は派生型にデシリアライズできないこと。
バイナリ・シリアライズではこういうことができたが、それは型情報を持たせているから。
型情報を持たないJSONのシリアライズでは、こういうことはできない。
DataContractJsonSerializer?では型情報の出力などもサポートされていたが、
昨今の相互運用性が重視される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型を使用しており、

シリアライズの際、

任意の型が指定される。
出力されるされるJSONの構造が一定ではない。

↑

object型を使用せざるを得ないケース †

以下の様な構造が一定ではないケースでは、
シリアライズの対象にobject型を使用せざるを得ない。

子要素JSONの構造が一定ではない（Fieldにobject型を使用する）
配列内のJSONの構造が一定ではない（object[], Hashtableを使用する）

↑

LINQ to JSONで手動のデシリアライズ †

型が特定できない構造の（object型をシリアライズした）JSONを
デシリアライズするとJSONデータはJObject型に格納される。

この場合、LINQ to JSONでJObject型の手動のデシリアライズを行う。

C# + LINQ でJSONのパースをする - Qiita
http://qiita.com/numa08/items/475ab3e8aa9e10441a26

Json.NET (Newtonsoft.Json) の基本的な使い方 | ITメモ
https://netweblog.wordpress.com/2016/10/24/json-net-newtonsoft-json-usage/

LINQ to JSON
http://www.newtonsoft.com/json/help/html/LINQtoJSON.htm
- Querying JSON with LINQ
  http://www.newtonsoft.com/json/help/html/QueryingLINQtoJSON.htm

LINQ to JSONといっても、単純にインデクサで処理できる模様。

↑

型が特定できない構造のJSONをparseする例 †

memo: C#でJSON配列のパースに苦労した話
https://kazyx.blogspot.com/2013/09/cjson.html
JSON.NETで変なJSONを読み込む方法 - かずきのBlog@hatena
http://blog.okazuki.jp/entry/2014/04/19/235806

↑

参考 †

Json.NET - Newtonsoft
http://www.newtonsoft.com/json

↑

DataContractJsonSerializer? †

WCFの既定のシリアライザ。

流行ってないので基本スルーだが、
使う場合は、以下の点に注意する。

↑

JavaやJSON.NETのシリアライザとの違い。 †

.NETのDataContractJsonSerializer?はJavaやJSON.NETと、シリアライザの挙動が違う。
そのため、同じ形式の POJO または POCO であっても、シリアライズ後の JSON フォーマットが異なる。

↑

Dictionaryのシリアライズ結果 †

特に、以下のように Dictionaryの JSON シリアライズ結果が異なる。

#	技術	POJO / POCO サンプル	シリアライズされた JSON
1	Java, JSON.NET	public class Sample { public String _key1; public String _key2; public void setKey1(String key1) { this._key1 = key1; } public String getKey1() { return this._key1; } public void setKey2(String key2) { this._key2 = key2; } public String getKey2() { return this._key2; } }	{ "key1" : "value1", "key2" : "value2" }
2	Java, JSON.NET	public class Sample { public HashMap?<String, String> _key; public void setKey(HashMap?<String, String> key) { this._key = key; } public void getKey() { return this._key; } }
3	.NETのDataContractJsonSerializer?	public class Sample { public string key1 { get; set; } public string key2 { get; set; } }
4	.NETのDataContractJsonSerializer?	public class Sample { public Dictionary<string, string> key { get; set; } }	[ { "Key": "Prop1", "Value": "Value1" }, { "Key": "Prop2", "Value": "Value2" } ] 同じ形式のジェネリック型であっても、使用するSerializer次第でシリアライズ結果が異なる

↑

Efficient dictionary serialization, Nonsensical dictionary serialization †

この違いは、以下の機能のサポート状況によるものらしい。

Efficient dictionary serialization
http://stackoverflow.com/questions/1207731/how-can-i-deserialize-json-to-a-simple-dictionarystring-string-in-asp-net
Nonsensical dictionary serialization
http://stackoverflow.com/questions/4559991/any-way-to-make-datacontractjsonserializer-serialize-dictionaries-properly

参考
- Json.NET - Home
  http://json.codeplex.com/
- Json.NET - Newtonsoft
  http://www.newtonsoft.com/json

↑

JSON.stringify、JSON.parse（JavaScript） †

JavaScriptでは、JSON.stringify（シリアライズ）、JSON.parse（デシリアライズ）が使用できる。

↑

JSON.parse †

JSON 文字列を解析して JavaScript のオブジェクトに変換する。

↑

JSON.stringify †

JavaScript の値を JSON 文字列に変換する。

↑

参考 †

【JavaScript】JSONのparseとstringifyメソッドの使い方 - TASK NOTES
http://www.task-notes.com/entry/20160719/1468858991

JSON.stringifyを改めて調べる。 - Qiita
http://qiita.com/qoAop/items/57d35a41ef9629351c3c

↑

応用 †

↑

JSONを送信するRESTサービスを作成する方法 †

↑

JSONを受信するJSON-RPCサービスを作成する方法 †

↑

コンボ生成でJSONを使用する際の注意事項。 †

順番保証がされないので、

Dictionary<string, string>ではなく、
```
{ "key1" : "value1", "key2" : "value2" }
```

List<List<String>>を使用する。

[ [ "key1", "value1" ], [ "key2", "value2" ] ]

↑

参考 †

Introduction
http://www.newtonsoft.com/json/help/html/Introduction.htm

[C#] C#でJSONを扱う方法まとめ｜ Developers.IO
http://dev.classmethod.jp/etc/c-sharp-json/

Tags: :.NET開発, :.NET Core, :.NET Standard, :ASP.NET, :ASP.NET Web API

JSONのparseを色々試してみた。 のバックアップ(No.22)

目次 †

概要 †

JSON フォーマットとクラスの定義 †

JSON フォーマットの確認 †

クラスの定義 †

基本 †

ルール †

Web Essentialsを使用 †

JSON.NET †

基本（Bean, POCO） †

シリアライズ・デシリアライズ †

既定値を制御する属性 †

その他、属性 †

応用 †

階層構造を持ったBean, POCOを使用する †

配列（List<AAA>）を使用する †

Primitive型とGeneric型を使用する †

継承を使用する †

型が特定できない構造のJSON †

型が特定できない構造のJSONの例 †

object型を使用せざるを得ないケース †

LINQ to JSONで手動のデシリアライズ †

型が特定できない構造のJSONをparseする例 †

参考 †

DataContractJsonSerializer? †

JavaやJSON.NETのシリアライザとの違い。 †

Dictionaryのシリアライズ結果 †

Efficient dictionary serialization, Nonsensical dictionary serialization †

JSON.stringify、JSON.parse（JavaScript） †

JSON.parse †

JSON.stringify †

参考 †

応用 †

JSONを送信するRESTサービスを作成する方法 †

JSONを受信するJSON-RPCサービスを作成する方法 †

コンボ生成でJSONを使用する際の注意事項。 †

参考 †

JSONのparseを色々試してみた。のバックアップ(No.22)