.NET Web API开发：如何精简DTO无需新建类即可忽略指定属性

可直接落地的无新增DTO实现方案 #

按实现成本从低到高排序，可根据实际业务场景选择：

• 方案1：直接返回匿名类型（最推荐单接口字段裁剪场景使用）
  完全不需要新增DTO类，也不需要配置AutoMapper映射规则。接口拿到业务层返回的完整PartnerDto后，直接构造只包含目标字段的匿名对象返回即可，JSON序列化器只会输出你显式声明的属性，不会带上多余的brand字段：

[HttpGet("{id}")]
public async Task<IActionResult> Get(int id)
{
    var partner = await _partnerManager.GetById(id);
    if (partner == null)
    {
        return NotFound();
    }
    // 按需声明要返回的字段，无需额外定义类型
    return Ok(new 
    {
        partner.PartnerId,
        partner.BrandId,
        partner.CobrandIdId
    });
}

这个方案没有任何额外依赖，需要返回什么字段在接口处一目了然，后续调整字段直接改这里就行，完全不影响业务逻辑层对PartnerDto完整属性（包括brand字段）的正常使用。唯一的小缺点是如果多个接口需要完全一致的精简字段结构，会有少量重复代码，但相比维护一堆MiniPartnerDto、SimplePartnerDto之类的碎片化类，这个成本几乎可以忽略。

• 方案2：给属性加序列化忽略特性（适合全局统一忽略场景）
  如果你所有对外接口返回PartnerDto时都不需要返回brand属性，直接给对应属性加序列化框架内置的忽略特性即可，业务层代码仍然可以正常读写该属性，只是序列化输出时会自动跳过。
  如果用ASP.NET Core默认的System.Text.Json序列化器：

using System.Text.Json.Serialization;

public class PartnerDto
{
    public int PartnerId { get; set; }
    public int BrandId { get; set; }
    public int CobrandIdId { get; set; }
    
    [JsonIgnore] // 序列化时自动跳过该属性
    public Brand brand { get; set; }
}

如果项目用的是Newtonsoft.Json，替换成对应命名空间下的[JsonIgnore]特性即可。注意这个方案是全局生效的，加了特性后所有接口序列化PartnerDto都会忽略brand字段，如果有接口需要返回完整的品牌信息，这个方法就不适用。

• 方案3：单接口动态配置序列化规则（适合多接口差异化输出场景）
  如果不想用匿名类型，又需要不同接口返回不同的字段组合，可以在单个接口返回时动态指定序列化规则，忽略不需要的属性。以System.Text.Json为例，.NET 7+可以通过自定义TypeInfo修饰符实现，不需要修改原有类：
  先写个通用的扩展方法，支持给指定类型动态设置忽略属性：

public static class JsonSerializerExtensions
{
    public static JsonSerializerOptions IgnoreProperties<T>(this JsonSerializerOptions options, params string[] propertyNames)
    {
        options.TypeInfoResolver = new DefaultJsonTypeInfoResolver
        {
            Modifiers = { context =>
            {
                if (context.Type != typeof(T)) return;
                foreach (var propName in propertyNames)
                {
                    var targetProp = context.Properties.FirstOrDefault(p => p.Name == propName);
                    if (targetProp != null) targetProp.ShouldSerialize = (_, _) => false;
                }
            }}
        };
        return options;
    }
}

接口里直接调用即可，按需指定要忽略的属性：

[HttpGet("{id}")]
public async Task<IActionResult> Get(int id)
{
    var partner = await _partnerManager.GetById(id);
    if (partner == null)
    {
        return NotFound();
    }
    var serializeOptions = new JsonSerializerOptions()
        .IgnoreProperties<PartnerDto>(nameof(PartnerDto.brand));
    return new JsonResult(partner, serializeOptions);
}

这个方案灵活度很高，不同接口可以根据需求忽略不同属性，不需要新增任何DTO类，也不需要修改业务层代码。

不建议为了这个场景引入额外的对象映射库或者动态类生成库，只会增加项目依赖和调试成本，上面三个方案完全可以覆盖绝大多数字段裁剪的需求。

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