Як ігнорувати властивість у класі, якщо null, використовуючи json.net

Я використовую Json.NET для серіалізації класу до JSON.

У мене такий клас:

class Test1
{
    [JsonProperty("id")]
    public string ID { get; set; }
    [JsonProperty("label")]
    public string Label { get; set; }
    [JsonProperty("url")]
    public string URL { get; set; }
    [JsonProperty("item")]
    public List<Test2> Test2List { get; set; }
}

Я хочу додати JsonIgnore()атрибут до Test2Listвластивості лише тоді, коли Test2Listє null. Якщо вона не є нульовою, тоді я хочу включити її до свого json.

Відповідно до Джеймса Ньютона Кінга: Якщо створити серіалізатор самостійно, а не використовувати JavaScriptConvert, є NullValueHandlingвластивість, яку ви можете встановити ігнорувати.

Ось зразок:

JsonSerializer _jsonWriter = new JsonSerializer {
                                 NullValueHandling = NullValueHandling.Ignore
                             };

Як варіант, як пропонує @amit

JsonConvert.SerializeObject(myObject, 
                            Newtonsoft.Json.Formatting.None, 
                            new JsonSerializerSettings { 
                                NullValueHandling = NullValueHandling.Ignore
                            });

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

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

// or for all properties in a class
[JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)]

Як видно з цього інтернет-документа .

Подібний відповідь @ sirthomas'S, JSON.NET також поважає в EmitDefaultValueвласність на DataMemberAttribute:

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

Це може бути бажано, якщо ви вже використовуєте [DataContract]та [DataMember]у своєму типі моделі та не хочете додавати атрибути, характерні для JSON.NET.

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

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

Ви можете зробити це, щоб ігнорувати всі нулі об’єкта, який ви серіалізуєте, і будь-які нульові властивості не з’являться в JSON

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

Як видно з цього посилання на їхньому сайті (http://james.newtonking.com/archive/2009/10/23/efficient-json-with-json-net-reducing-serialized-json-size.aspx) I підтримка за допомогою [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
// }

Адаптація до відповіді @ Mrchief / @ 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

У .Net Core зараз це набагато простіше. У свій startup.cs просто додайте параметри json і ви зможете налаштувати там налаштування.

public void ConfigureServices(IServiceCollection services)

....

services.AddMvc().AddJsonOptions(options =>
{
   options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;               
});

З Json.NET

 public class Movie
 {
            public string Name { get; set; }
            public string Description { get; set; }
            public string Classification { get; set; }
            public string Studio { get; set; }
            public DateTime? ReleaseDate { get; set; }
            public List<string> ReleaseCountries { get; set; }
 }

 Movie movie = new Movie();
 movie.Name = "Bad Boys III";
 movie.Description = "It's no Bad Boys";

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

Результатом буде:

{
   "Name": "Bad Boys III",
   "Description": "It's no Bad Boys"
 }

З System.Text.Jsonі .NET Core 3.0 це працювало для мене:

var jsonSerializerOptions = new JsonSerializerOptions()
{
    IgnoreNullValues = true
};
var myJson = JsonSerializer.Serialize(myObject, jsonSerializerOptions );

Щоб трохи пояснити дуже корисну відповідь GlennG (переклад синтаксису з C # на VB.Net не завжди є "очевидним"), ви також можете прикрасити властивості окремих класів, щоб керувати тим, як обробляються нульові значення. Якщо ви це зробите, не використовуйте глобальні JsonSerializerSettings з пропозицій GlennG, інакше це перекриє окремі прикраси. Це стане в нагоді, якщо ви хочете, щоб нульовий товар з’явився в JSON, тому споживачеві не доведеться робити якісь спеціальні обробки. Якщо, наприклад, споживачеві потрібно знати, що масив необов’язкових елементів зазвичай доступний, але наразі порожній ... Прикраса в декларації властивості виглядає приблизно так:

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

Для тих властивостей, які ви взагалі не бажаєте відображатись у зміні JSON : = NullValueHandling.Include to : = NullValueHandling.Ignore . До речі - я виявив, що ви можете добре прикрасити властивість і для серіалізації XML, і для JSON (просто покладіть їх прямо поруч). Це дає мені можливість закликати серіалізатор XML в dotnet або серіалізатор NewtonSoft за бажанням - і обидва працюють, і мої клієнти мають можливість працювати з XML або JSON. Це гладко, як соплі на дверній ручці, оскільки у мене є клієнти, які вимагають обох!

Ось варіант, подібний, але надає інший вибір:

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

Потім я використовую це так:

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

Різниця тут полягає в тому, що:

• Зменшує повторний код шляхом інстанції та налаштування JsonSerializerSettings кожного використовуваного місця.
• Економить час на налаштування кожної властивості кожного об'єкта, що підлягає серіалізації.
• Все-таки надає іншим розробникам гнучкість у параметрах серіалізації, замість того, щоб властивість було чітко вказано на об'єкт багаторазового використання.
• Моє використання полягає в тому, що код є бібліотекою сторонніх розробників, і я не хочу форсувати параметри серіалізації для розробників, які хочуть повторно використовувати мої класи.
• Потенційні недоліки полягають у тому, що це ще один предмет, про який мали би знати інші розробники, або якщо ваша програма мала, і такий підхід не матиме значення для однієї серіалізації.

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