如何使用json.net忽略类中的属性（如果为null）

我正在使用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; }
}

我只想在is 时JsonIgnore()向Test2List属性添加属性。如果它不为null，那么我想将其包含在json中。Test2Listnull

根据James Newton King的说法：如果您自己创建序列化程序而不是使用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的回答，也JSON.NET尊重的EmitDefaultValue特性上DataMemberAttribute：

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

如果你已经使用了，这可能是可取的[DataContract]，并[DataMember]在模型类型，不希望添加JSON.NET特定的属性。

你可以写： [JsonProperty("property_name",DefaultValueHandling = DefaultValueHandling.Ignore)]

它还注意不要使用默认值（不仅是null）来序列化属性。例如，它对于枚举很有用。

您可以执行此操作以忽略要序列化的对象中的所有null，并且所有null属性都不会出现在JSON中

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

从他们网站（http://james.newtonking.com/archive/2009/10/23/efficiency-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
// }

适应@ Mrchief / @ amit的答案，但适用于使用VB的人

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

请参见： “对象初始化程序：命名和匿名类型（Visual Basic）”

https://msdn.microsoft.com/zh-CN/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并不总是“显而易见”），您还可以装饰单个类的属性来管理如何处理空值。如果这样做，请不要使用GlennG建议中的全局JsonSerializerSettings，否则它将覆盖各个装饰。如果您希望在JSON中显示一个空项目，则此方法很方便，这样使用者就不必进行任何特殊处理。例如，如果消费者需要知道通常有可用的可选项目数组，但是当前为空...属性声明中的修饰如下所示：

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

对于这些属性，您根本不想在JSON更改中出现：== NullValueHandling.Include到：= NullValueHandling.Ignore。顺便说一句-我发现您可以很好地装饰XML和JSON序列化的属性（只需将它们彼此紧靠在一起即可）。这使我可以选择在dotnet中调用XML序列化器，也可以随意调用NewtonSoft序列化器-两者并排工作，我的客户可以选择使用XML或JSON。因为我有同时需要这两个功能的客户，所以在门把手上像as鼻涕一样光滑！

这是一个类似的选项，但提供了另一个选择：

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

然后，我像这样使用它：

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

这里的区别是：

• 通过实例化和配置JsonSerializerSettings每个使用位置来减少重复的代码。
• 节省配置要序列化的每个对象的每个属性的时间。
• 仍然为其他开发人员提供了序列化选项方面的灵活性，而不是在可重用对象上显式指定了属性。
• 我的用例是该代码是第3方库，并且我不想对希望重用我的类的开发人员强加序列化选项。
• 潜在的缺点是，这是其他开发人员需要了解的另一个对象，或者您的应用程序是否较小，并且这种方法对于单个序列化都没有关系。

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