Как игнорировать null-свойства при сериализации JSON в C# с помощью Json.NET

Решение: настройка NullValueHandling в Json.NET

В Json.NET есть встроенная поддержка игнорирования null-значений при сериализации. Для этого используется перечисление NullValueHandling с опцией Ignore. Вы можете применить её двумя способами: глобально через настройки сериализатора или локально с помощью атрибута.

Способ 1: Глобальная настройка (рекомендуется)

Самый простой способ — передать настройки в метод JsonConvert.SerializeObject:

using Newtonsoft.Json;

var settings = new JsonSerializerSettings
{
    NullValueHandling = NullValueHandling.Ignore
};

string json = JsonConvert.SerializeObject(user, settings);
Console.WriteLine(json);
// Вывод: {"Name":"Иван","Email":"ivan@example.com"}

Теперь все null-свойства будут автоматически исключены из JSON. Если вы хотите, чтобы это поведение применялось по умолчанию во всём проекте, можно настроить глобальный дефолтный конвертер:

JsonConvert.DefaultSettings = () => new JsonSerializerSettings
{
    NullValueHandling = NullValueHandling.Ignore
};

// Теперь все вызовы SerializeObject без явных настроек будут игнорировать null
string json = JsonConvert.SerializeObject(user);

Способ 2: Атрибут на уровне свойства

Если нужно, чтобы только конкретное свойство игнорировалось при null, используйте атрибут [JsonProperty] с параметром NullValueHandling:

public class User
{
    public string Name { get; set; }
    public string Email { get; set; }

    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
    public string Phone { get; set; }

    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
    public string Address { get; set; }
}

В этом случае только Phone и Address будут скрыты при null, а остальные свойства — нет. Это удобно, когда у вас есть обязательные поля, которые должны присутствовать даже с null.

Способ 3: Использование контрактов (для сложных сценариев)

Если вам нужно динамически управлять сериализацией, можно реализовать интерфейс IContractResolver или унаследоваться от DefaultContractResolver. Например, чтобы игнорировать null только для свойств определённого типа:

public class CustomContractResolver : DefaultContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var property = base.CreateProperty(member, memberSerialization);
        if (property.PropertyType == typeof(string))
        {
            property.NullValueHandling = NullValueHandling.Ignore;
        }
        return property;
    }
}

// Использование:
var settings = new JsonSerializerSettings
{
    ContractResolver = new CustomContractResolver()
};
string json = JsonConvert.SerializeObject(user, settings);

Важные нюансы:

• DeserializeObject — при десериализации NullValueHandling.Ignore не влияет. Если в JSON отсутствует свойство, оно останется со значением по умолчанию (null для ссылочных типов).
• Производительность — глобальная настройка через DefaultSettings может снизить производительность, если вы часто меняете настройки. Лучше создавать отдельный экземпляр JsonSerializerSettings и переиспользовать его.
• NullValueHandling.Include — это значение по умолчанию, которое включает null-свойства в JSON.

Таким образом, для вашей задачи идеально подходит первый способ с глобальной настройкой NullValueHandling.Ignore. Это чистое и простое решение, которое не требует изменения класса.

public class User
{
    public string Name { get; set; }
    public string Email { get; set; }
    public string Phone { get; set; }
    public string Address { get; set; }

    public bool ShouldSerializePhone()
    {
        return Phone != null;
    }

    public bool ShouldSerializeAddress()
    {
        return Address != null;
    }
}