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

[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型にデシリアライズされる。
```
object obj = 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?

設定値	動作
Include	シリアライズ時に既定値の項目をJSONに含める（既定）。
Ignore	シリアライズ時に既定値の項目をJSONに含めない。
Populate	デシリアライズ時にJSON文字列中に要素が存在しない場合でも既定値を設定。
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 });

↑

応用 †

上記のリンク先の記事に

「階層構造を持った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);
  
  aaa1 = JsonConvert.DeserializeObject<AAA>(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);

↑

継承を使用する †

派生型をシリアライズできるが、問題は派生型にデシリアライズできないこと。

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

↑