Cách bỏ qua một thuộc tính trong lớp nếu null, sử dụng json.net

Tôi đang sử dụng Json.NET để tuần tự hóa một lớp thành JSON.

Tôi có lớp học như thế này:

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

Tôi muốn thêm một JsonIgnore()thuộc tính cho Test2Listtài sản chỉ khi Test2Listcó null. Nếu nó không phải là null thì tôi muốn đưa nó vào json của tôi.

Theo James Newton King: Nếu bạn tự tạo serializer thay vì sử dụng JavaScriptConvert, có một thuộc NullValueHandlingtính mà bạn có thể đặt để bỏ qua.

Đây là một mẫu:

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

Ngoài ra, theo đề xuất của @amit

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

Một giải pháp thay thế bằng cách sử dụng JsonPropertythuộc tính:

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

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

Như đã thấy trong tài liệu trực tuyến này .

Tương tự như câu trả lời của @ sirthomas, JSON.NET cũng tôn trọng thuộc EmitDefaultValuetính trên DataMemberAttribute:

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

Điều này có thể được mong muốn nếu bạn đã sử dụng [DataContract]và [DataMember]trong loại mô hình của mình và không muốn thêm các thuộc tính dành riêng cho JSON.NET.

Bạn có thể viết: [JsonProperty("property_name",DefaultValueHandling = DefaultValueHandling.Ignore)]

Nó cũng quan tâm đến việc không tuần tự hóa các thuộc tính với các giá trị mặc định (không chỉ null). Nó có thể hữu ích cho enums chẳng hạn.

Bạn có thể làm điều này để bỏ qua tất cả các null trong một đối tượng bạn đang tuần tự hóa và mọi thuộc tính null sẽ không xuất hiện trong JSON

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

Như có thể thấy trong liên kết này trên trang web của họ (http://james.newtonking.com/archive/2009/10/23/ffic-json-with-json-net-reducing-serialized-json-size.aspx) Tôi hỗ trợ sử dụng [Mặc định ()] để chỉ định giá trị mặc định

Lấy từ liên kết

   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
// }

Một sự thích ứng với câu trả lời của @ Mrchief / @ amit, nhưng đối với những người sử dụng VB

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

Xem: "Khởi tạo đối tượng: Các loại được đặt tên và ẩn danh (Visual Basic)"

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

Trong .Net Core, điều này bây giờ dễ dàng hơn nhiều. Trong startup.cs của bạn chỉ cần thêm tùy chọn json và bạn có thể định cấu hình cài đặt ở đó.

public void ConfigureServices(IServiceCollection services)

....

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

Với 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 });

Kết quả sẽ là:

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

Với System.Text.Jsonvà .NET Core 3.0, điều này làm việc với tôi:

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

Để giải thích một chút về câu trả lời rất hữu ích của GlennG (dịch cú pháp từ C # sang VB.Net không phải lúc nào cũng "rõ ràng"), bạn cũng có thể trang trí các thuộc tính lớp riêng lẻ để quản lý cách xử lý các giá trị null. Nếu bạn làm điều này, đừng sử dụng JsonSerializerSinstall toàn cầu từ đề xuất của GlennG, nếu không nó sẽ ghi đè lên các trang trí riêng lẻ. Điều này rất hữu ích nếu bạn muốn một mục null xuất hiện trong JSON để người tiêu dùng không phải thực hiện bất kỳ xử lý đặc biệt nào. Ví dụ, nếu người tiêu dùng cần biết một loạt các mặt hàng tùy chọn thường có sẵn, nhưng hiện đang trống ... Trang trí trong tờ khai tài sản trông như thế này:

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

Đối với những thuộc tính mà bạn không muốn xuất hiện ở tất cả trong thay đổi JSON : = NullValueHandling.Include to : = NullValueHandling.Ignore . Nhân tiện - tôi đã thấy rằng bạn có thể trang trí một thuộc tính cho cả tuần tự hóa XML và JSON tốt (chỉ cần đặt chúng ngay cạnh nhau). Điều này cho tôi tùy chọn gọi trình tuần tự hóa XML bằng dotnet hoặc trình tuần tự hóa NewtonSoft theo ý muốn - cả hai hoạt động song song và khách hàng của tôi có tùy chọn để làm việc với XML hoặc JSON. Điều này là trơn tru như snot trên một tay nắm cửa vì tôi có khách hàng yêu cầu cả hai!

Đây là một tùy chọn tương tự, nhưng cung cấp một lựa chọn khác:

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

Sau đó, tôi sử dụng nó như thế này:

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

Sự khác biệt ở đây là:

• Giảm mã lặp lại bằng cách khởi tạo và cấu hình JsonSerializerSettings từng nơi được sử dụng.
• Tiết kiệm thời gian trong việc cấu hình mọi thuộc tính của mọi đối tượng sẽ được tuần tự hóa.
• Vẫn cho phép các nhà phát triển khác linh hoạt trong các tùy chọn tuần tự hóa, thay vì có thuộc tính được chỉ định rõ ràng trên một đối tượng có thể sử dụng lại.
• Trường hợp sử dụng của tôi là mã là thư viện của bên thứ 3 và tôi không muốn buộc các tùy chọn tuần tự hóa đối với các nhà phát triển muốn sử dụng lại các lớp của tôi.
• Hạn chế tiềm năng là đó là một đối tượng khác mà các nhà phát triển khác sẽ cần biết hoặc nếu ứng dụng của bạn nhỏ và cách tiếp cận này sẽ không quan trọng đối với một tuần tự hóa.

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