JSON.NET 規定値の設定の仕方

Question

###目的
JSON.NETを使用してserializeする際にプロパティに対して規定値を設定したい。

###問題
serializeして結果を見てみると規定値が設定してあるはずのプロパティがnullになっている。
nullではなく規定値を設定したい。

###ソースコード

UserModel.cs

using Newtonsoft.Json;
using System.ComponentModel;

namespace JsonTest
{
    [JsonObject("user")]
    public class UserModel
    {
        [JsonProperty("id")]
        public int UserID { get; set; }
        [JsonProperty("name")]
        public string Username { get; set; }
        [JsonProperty("bloodType", DefaultValueHandling = DefaultValueHandling.Include)]
        [DefaultValue("A")]
        public string BloodType { get; set; }
    }
}

Program.cs

using System;

using Newtonsoft.Json;

namespace JsonTest
{
    class Program
    {
        static void Main(string[] args)
        {
            DeserializeSample(SerializeSample());
        }

        static string SerializeSample()
        {
            var data = new UserModel();
            data.UserID = 100;
            data.Username = "太郎";

            string serializedJson = Newtonsoft.Json.JsonConvert.SerializeObject(data);

            Console.Write($"{serializedJson}\n");

            return serializedJson;
        }

        static void DeserializeSample(string jsonstring)
        {
            UserModel model1 = JsonConvert.DeserializeObject<UserModel>(jsonstring);

            Console.Write($"model1.UserID = {model1.UserID}\n");
            Console.Write($"model1.Username = {model1.Username}\n");
            Console.Write($"model1.BloodType = {model1.BloodType}\n");
        }
    }
}

###実行結果

{"id":100,"name":"太郎","bloodType":null}
model1.UserID = 100
model1.Username = 太郎
model1.BloodType =

bloodTypeがAになってほしいのですが...。

###開発環境

• OS Windows10 professional x64
• IDE VisualStudio2017 community
• 言語 C#
• プロジェクト形式 コンソールアプリ（.NET framework）

Answer 1

JSONの問題ではなく、プロパティのデフォルト値の問題が気がするのですが。

        public string BloodType { get; set; } = "A";

で良いのでは？

Comments

[makoyang]

う～ん、そうですよねぇ。
私もそう考えたのですが、じゃあそもそもDefaultValueとかDefaultValueHandlingとかは、
そもそもこの様な用途に使うものじゃないって事なのでしょうか...？

以下のサイトを参考にしていました。（”規定値”のところです）
http://qiita.com/ta-yamaoka/items/a7ff1d9651310ade4e76

[ebiryo]

hidoriさんが指摘されているように、　"bloodType":null　と出力されているのなら、nullがbloodTypeの値になるわけですからデフォルト値とか関係ないと思うのですが。

DefaultValueHandlingとかDefaultValueが効果を発揮するのは出力結果が
{
"UserID":100,
"Username":"太郎"
}
のような場合だと思います。

[makoyang]

なにか私が勘違いしているような気がしてきました。
ちょっと確認させてください。

上記のSerializeSampleメソッドでUserModelを作成した後で
data.UserID = 100;
data.Username = "太郎";
とBloodTypeは設定しないでserializeしています。
このserialize時に規定値が設定されるような仕組みがDefaultValueとかと思っていたのですが、
これがそもそも間違っているのでしょうか。

[ebiryo]

serializeでは対象となるインスタンスの内容をあるがままserializeするわけですから、値がnullならそのままserializeされます。DefaultValueは関係ないです。

ではDefaultValueとは何なのかについては以下など参考になるのではないでしょうか。
http://neareal.net/index.php?Programming%2F.NetFramework%2FTips%2FProperty%2FDefaultValueAttribute

http://d.hatena.ne.jp/atsukanrock/20090205/1233836005

[hihijiji]

DefaultValueHandling は、プロパティがその型の DefaultValue だった場合 ノードを出力するかのセッティングみたいですね。
http://www.newtonsoft.com/json/help/html/DefaultValueHandlingIgnore.htm

[makoyang]

＞ebiryoさん
なるほど、やはり私が勘違いしていたみたいです。
頂いたURLを見てみました。私と同じように勘違いする人をベースに書いてあって参考になりました。
＞hihijijiさん
おお、動きは理解できました。
が、serializeの時のIncludeとかIgnoreってどんな時に使われるのでしょうか...。

[hihijiji]

単純に、値の 0 や null が意図したものなのか、未設定状態なのかで出力するか否かを決めたら良いと思います。

[makoyang]

あ...そうですよね。
有難うございます。

Answer 2

string serializedJson = Newtonsoft.Json.JsonConvert.SerializeObject(data);

の時点で JSON に

"bloodType":null

が出力されていたりはしませんか？

Comments

[makoyang]

そうなんです。
DefaultValueHandling.Includeとしているので、
JSONにserializeする時点でnullではなくて"A"が入ってほしいのですが。

[hidori]

そこが問題なら、null 値が JSON に出力されないよう、シリアライズ時の JSON.NET にオプションを指定してください。
```DefaultValueHandling.Include``` が効果を発揮するのは、デシリアライズ対象の JSON に bloodType フィールドが含まれていない場合のはずです。

[makoyang]

http://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_DefaultValueHandling.htm
ここを見てみると
DefaultValueHandling.Includeの説明に「Has no effect when deserializing.」となっていますが...。

ちなみに
```C#
static string SerializeSample()
{
var data = new UserModel();
data.UserID = 100;
data.Username = "太郎";

//string serializedJson = Newtonsoft.Json.JsonConvert.SerializeObject(data);
string serializedJson = Newtonsoft.Json.JsonConvert.SerializeObject(data, Formatting.Indented, new JsonSerializerSettings { DefaultValueHandling = DefaultValueHandling.Include });

Console.Write($"{serializedJson}\n");

return serializedJson;
}
```
これもやってみましたが、ダメでした。

[hidori]

```cs#
[JsonObject("user")]
public class UserModel
{
[JsonProperty("id")]
public int UserID { get; set; }
[JsonProperty("name")]
public string Username { get; set; }
[JsonProperty("bloodType", DefaultValueHandling = DefaultValueHandling.Populate)]
[DefaultValue("A")]
public string BloodType { get; set; }
}

void Main()
{
var json = @"{""id"":1, ""name"":""davec""}";
var model = JsonConvert.DeserializeObject<UserModel>(json);
Console.WriteLine(model.BloodType);
}
```
でどーですか？

[hidori]

>JSONにserializeする時点でnullではなくて"A"が入ってほしいのですが。

というのは、「オブジェクトインスタンスでは BloodType = null だけど、そのオブジェクトのシリアライズ出力には BloodType = 'A' であってほしい」ということですか？

だと、ちょっと JSON.NET に期待するのは間違いなような気が。。カスタムなシリアライズ動作を自分で定義することも可能だったような気もしますが、そんなことをするくらいなら、別コメントにあるように初期化した方がシンプルな気がします。

[makoyang]

hidoriさん、有難うございます。先ほどのサンプルコードで
DefaultValueHandling.Populate
については理解できました。最後の回答についても理解できました。

ただ、よくわからないのが
DefaultValueHandling.include
DefaultValueHandling.Ignore
はどのようなケースで使われるのでしょうか。

[hidori]

http://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_DefaultValueHandling.htm を素直に読むと「 メンバーの値が DefaultValue と等しい時に、JSON に含める（include）か含めない(ignore)」ということのようですね。