Как игнорировать объект во время сериализации (но использовать его позже) [duplicate]

Вы можете сделать это, чтобы игнорировать все нули в объекте, который вы сериализуете, и все нулевые свойства не будут отображаться в JSON

JsonSerializerSettings settings = new JsonSerializerSettings();
settings.NullValueHandling = NullValueHandling.Ignore;
var myJson = JsonConvert.SerializeObject(myObject, settings);

Чтобы немного разъяснить очень полезный ответ GlennG (перевод синтаксиса с C # на VB.Net не всегда «очевиден»), вы также можете украсить отдельные свойства класса, чтобы управлять обработкой нулевых значений. Если вы это сделаете, не используйте глобальную настройку JsonSerializerSettings из предложения GlennG, иначе она переопределит отдельные украшения. Это пригодится, если вы хотите, чтобы в JSON появился нулевой элемент, поэтому потребителю не нужно выполнять какую-либо специальную обработку. Если, например, потребитель должен знать, что массив необязательных элементов обычно доступен, но в настоящее время пуст ... Украшение в объявлении свойства выглядит следующим образом:

<JsonPropertyAttribute("MyProperty", DefaultValueHandling:=NullValueHandling.Include)> Public Property MyProperty As New List(of String)

Для этих свойств вы не хотят вообще появляться в изменении JSON: = NullValueHandling. Включить в: = NullValueHandling.Ignore. Кстати, я обнаружил, что вы можете украсить свойство как для XML, так и для JSON-сериализации просто отлично (просто поместите их рядом друг с другом). Это дает мне возможность называть сериализатор XML в dotnet или сериализаторе NewtonSoft по своему усмотрению - оба работают бок о бок, а мои клиенты имеют возможность работать с XML или JSON. Это гладкий, как сопли на дверной ручке, так как у меня есть клиенты, которым нужны оба!

Адаптация к ответу @ Mrchief's / @ amit, но для людей, использующих VB

 Dim JSONOut As String = JsonConvert.SerializeObject(
           myContainerObject, 
           New JsonSerializerSettings With {
                 .NullValueHandling = NullValueHandling.Ignore
               }
  )

См.: «Инициализаторы объектов: именованные и анонимные типы (Visual Basic)»

https://msdn.microsoft.com/en-us/library/bb385125.aspx

Вот вариант, похожий, но дает другой выбор:

public class DefaultJsonSerializer : JsonSerializerSettings
{
    public DefaultJsonSerializer()
    {
        NullValueHandling = NullValueHandling.Ignore;
    }
}

Затем я использую его следующим образом:

JsonConvert.SerializeObject(postObj, new DefaultJsonSerializer());

Разница здесь в том, что:

• Уменьшает повторяющийся код путем создания и настройки JsonSerializerSettings каждого используемого места.
• Экономит время при настройке каждого свойства каждого объекта, который будет сериализован.
• Все еще дает другим разработчикам гибкость в параметрах сериализации, вместо того, чтобы явно указывать свойство на многократно используемом объекте.
• Мой случай использования заключается в том, что этот код является сторонней библиотекой, и я не хочу принудительно сериализовать варианты для разработчиков, которые хотели бы повторно использовать мои классы.
• Потенциальными недостатками являются то, что это другой объект, о котором должны знать другие разработчики, или если ваше приложение мало, и этот подход не имеет значения для одного сериализация.

Как видно из этой ссылки на их сайте (http://james.newtonking.com/archive/2009/10/23/efficient-json-with-json-net-reducing-serialized-json-size. aspx) Я поддерживаю использование [Default ()] для указания значений по умолчанию

Взято из ссылки

   public class Invoice
{
  public string Company { get; set; }
  public decimal Amount { get; set; }

  // false is default value of bool
  public bool Paid { get; set; }
  // null is default value of nullable
  public DateTime? PaidDate { get; set; }

  // customize default values
  [DefaultValue(30)]
  public int FollowUpDays { get; set; }
  [DefaultValue("")]
  public string FollowUpEmailAddress { get; set; }
}


Invoice invoice = new Invoice
{
  Company = "Acme Ltd.",
  Amount = 50.0m,
  Paid = false,
  FollowUpDays = 30,
  FollowUpEmailAddress = string.Empty,
  PaidDate = null
};

string included = JsonConvert.SerializeObject(invoice,
  Formatting.Indented,
  new JsonSerializerSettings { });

// {
//   "Company": "Acme Ltd.",
//   "Amount": 50.0,
//   "Paid": false,
//   "PaidDate": null,
//   "FollowUpDays": 30,
//   "FollowUpEmailAddress": ""
// }

string ignored = JsonConvert.SerializeObject(invoice,
  Formatting.Indented,
  new JsonSerializerSettings { DefaultValueHandling = DefaultValueHandling.Ignore });

// {
//   "Company": "Acme Ltd.",
//   "Amount": 50.0
// }

Альтернативное решение с использованием атрибута JsonProperty:

[JsonProperty(NullValueHandling=NullValueHandling.Ignore)]
//or
[JsonProperty("property_name", NullValueHandling=NullValueHandling.Ignore)]

Как показано в , этот онлайн-документ .

var settings = new JsonSerializerSettings();
settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
settings.NullValueHandling = NullValueHandling.Ignore;
//you can add multiple settings and then use it
var bodyAsJson = JsonConvert.SerializeObject(body, Formatting.Indented, settings);

Как и ответ @ sirthomas, JSON.NET также уважает свойство EmitDefaultValue на DataMemberAttribute:

[DataMember(Name="property_name", EmitDefaultValue=false)]

Это может быть желательно, если вы уже используете [DataContract] и [DataMember] в вашем типе модели и не хотите добавлять JSON.NET-специфичные атрибуты.

Вы можете написать: [JsonProperty("property_name",DefaultValueHandling = DefaultValueHandling.Ignore)]

Он также заботится о том, чтобы не сериализовать свойства со значениями по умолчанию (не только null). Он может быть полезен, например, для перечислений.