ASP.NET Core+Xamarin场景下可空int属性值为0序列化未忽略问题

• 特性与序列化库不匹配：你当前使用的[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]是System.Text.Json（微软官方.NET序列化库）的专属特性，但你序列化调用的是Newtonsoft.Json（俗称Json.NET）的JsonConvert.SerializeObject方法，两个库的注解互不兼容，因此配置完全不生效。
• 默认值匹配逻辑不符：int?（可空整数）的类型默认值是null而非0，即使你用了对应库的WhenWritingDefault配置，值为0的时候也不会被判定为默认值，不会被忽略。

你需要实现的是当TeamId为null或0时，自动跳过序列化，根据你使用的序列化库不同，可选以下两种方案： #

方案1：继续使用Newtonsoft.Json（推荐，无需改现有序列化调用逻辑） #

二选一即可：

方式A：使用ShouldSerialize约定方法（最灵活无额外依赖） #

在Player类中添加如下方法，Newtonsoft.Json序列化时会自动识别该命名规则的方法，返回false时跳过对应字段序列化：

public bool ShouldSerializeTeamId()
{
    // 仅当TeamId有值且不等于0时才序列化该字段
    return TeamId.HasValue && TeamId.Value != 0;
}

方式B：使用特性配置 #

首先引用Newtonsoft.Json和System.ComponentModel命名空间，给TeamId添加如下特性：

using Newtonsoft.Json;
using System.ComponentModel;

[DefaultValue(0)]
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
public int? TeamId { get; set; }

序列化时传入配置即可：

var json = JsonConvert.SerializeObject(Player, new JsonSerializerSettings 
{ 
    DefaultValueHandling = DefaultValueHandling.Ignore 
});

方案2：切换为System.Text.Json序列化 #

如果你要保留原来的JsonIgnore特性，将序列化逻辑替换为System.Text.Json的实现即可，同时调整属性逻辑适配0值的忽略需求：
修改TeamId属性的定义，自动将0转为null：

using System.Text.Json.Serialization;

private int? _teamId;
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? TeamId
{
    get => _teamId;
    set => _teamId = value == 0 ? null : value;
}

替换序列化调用代码：

var json = System.Text.Json.JsonSerializer.Serialize(Player);

内容的提问来源于stack exchange，提问作者dotnetdevcsharp