Web API返回缺失字段但调试可见，需特殊修饰模型吗？

问题描述 #

Web API返回结果中缺失部分字段，但这些字段在Debug调试模式下能正常查看，是否需要对模型类添加特殊特性修饰？

模型代码 #

public class SampleModel
{
    public string? SampleModelString { get; set; }
    public SampleModel1? SampleModel1Object { get; set; }
}
public class SampleModel1 : List<SampleModel2>
{
    public SampleModel3? SampleModel3Object { get; set; }
    public string? SampleModel1String { get; set; }
}
public class SampleModel2
{
    public string? SampleModel2String { get; set; }
}
public class SampleModel3 : List<SampleModel4>
{        
}
public class SampleModel4
{
    public string? SampleModel4String { get; set; }
}

API代码 #

[HttpGet]
public IActionResult Get()
{
    SampleModel sampleModel = new SampleModel();

    sampleModel.SampleModelString = "SampleModel.String";
    sampleModel.SampleModel1Object = new SampleModel1();
    sampleModel.SampleModel1Object.Add(new SampleModel2 { SampleModel2String = "SampleModel2.String1" });
    sampleModel.SampleModel1Object.Add(new SampleModel2 { SampleModel2String = "SampleModel2.String2" });

    sampleModel.SampleModel1Object.SampleModel1String = "SampleModel1.String";
    sampleModel.SampleModel1Object.SampleModel3Object = new SampleModel3();
    sampleModel.SampleModel1Object.SampleModel3Object.Add(new SampleModel4 { SampleModel4String = "SampleModel4.String1" });
    sampleModel.SampleModel1Object.SampleModel3Object.Add(new SampleModel4 { SampleModel4String = "SampleModel4.String2" });            

    return Ok(sampleModel);
}

问题现象 #

• 调试模式：能看到对象包含完整字段（如SampleModel1String、SampleModel3Object）
• API返回JSON：仅序列化List中的元素，缺失上述额外属性

问题根源 #

继承自List的类在JSON序列化时，默认只会处理集合元素，忽略类中额外添加的属性。不管是.NET自带的System.Text.Json还是第三方的Newtonsoft.Json，都遵循这个逻辑——序列化器优先识别集合类型，不会主动序列化附加属性。

解决方法 #

不需要额外添加特性，优先通过调整模型设计解决，以下是两种可行方案：

方案1：用组合替代继承（推荐） #

把List作为类的一个属性，而非继承List，这样所有属性都会被正常序列化：

public class SampleModel1
{
    public List<SampleModel2> Items { get; set; } = new List<SampleModel2>();
    public SampleModel3? SampleModel3Object { get; set; }
    public string? SampleModel1String { get; set; }
}

public class SampleModel3
{
    public List<SampleModel4> Items { get; set; } = new List<SampleModel4>();
}

修改后API中的添加操作要对应调整为sampleModel.SampleModel1Object.Items.Add(...)，序列化时所有属性都会被包含。

方案2：自定义序列化（仅无法修改模型结构时使用） #

如果必须保留继承结构，可通过配置强制序列化附加属性：

• 若使用Newtonsoft.Json，给继承List的类添加[JsonObject(MemberSerialization.OptOut)]特性：

[JsonObject(MemberSerialization.OptOut)]
public class SampleModel1 : List<SampleModel2>
{
    public SampleModel3? SampleModel3Object { get; set; }
    public string? SampleModel1String { get; set; }
}

注意：需确保项目引用Newtonsoft.Json，并在API配置中指定使用该序列化器（默认ASP.NET Core用System.Text.Json，需修改Program.cs/Startup.cs配置）。

• 若使用System.Text.Json，需自定义JsonConverter，手动处理集合元素和附加属性的序列化逻辑。

总结 #

优先选择组合替代继承的方案，既符合面向对象设计原则，也能彻底避免序列化问题。只有在无法修改模型结构的场景下，再考虑自定义序列化的方式。

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