使用 JSON.net（JsonConvert.SerializeObject 或 JsonConvert.DeSerializeObject）為缺少的復雜屬性設置默認值

Question

我有一個要求，我需要使用JsonProperty和DefaultValue為以下復雜屬性Instances設置默認值。

我知道我們可以為下面鏈接中提到的原始屬性實現這一點，但需要知道如何為復雜的屬性做到這一點。

JSON.net 的缺失屬性的默認值

下面是我需要使用DefaultValue()設置的默認Instances值。 請讓我知道如何實現這一目標。

要設置為Instances屬性的默認值：

Instance instance = new Instance();
instance.Name = "XYZ";
instance.MyProperty = 11;

List<Instance> Instances = new List<Instance>();
Instances.Add(instance);

代碼片段：

public class DataSettings
{
  public DataSettings()
  {
    Instances = new List<Instance>();
  }

  [DefaultValue()] //How can I mention the above default value here ?
  [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]
  public List<Instance> Instances { get; set; }
}

public class Instance
{
  public string Name { get; set; }
  public int MyProperty { get; set; }
}

Answer 1

如您所見，屬性僅支持常量值，因此您不能在屬性中設置復雜值。 如果要在反序列化過程中為復雜屬性設置默認值，一個好的方法是使用序列化回調方法，如下所示。

這個想法是向 class 添加一個方法，序列化程序將在 object 的反序列化完成后調用該方法。 回調必須是接受StreamingContext作為其唯一參數的void方法，並且必須使用[OnDeserialized]屬性進行標記。 方法的名稱無關緊要。 在回調方法中，您可以檢查Instances列表是否已填充，如果沒有，您可以根據需要設置默認值。

public class DataSettings
{
    public DataSettings()
    {
        Instances = new List<Instance>();
    }

    public List<Instance> Instances { get; set; }

    [OnDeserialized]
    internal void SetDefaultValuesAfterDeserialization(StreamingContext context)
    {
        if (Instances == null || !Instances.Any())
        {
            Instances = new List<Instance>
            {
                new Instance { Name = "XYZ", MyProperty = 11 }
            };
        }
    }
}

這是一個演示這個概念的工作小提琴： https://dotnetfiddle.net/uCGP5X