Web API中动态返回部分对象的合理实现方案探讨

你的思路完全可行——用Newtonsoft.Json的ShouldSerialize方法来动态排除字段，确实能实现需求，但它存在一个明显的短板：业务层仍然要填充所有字段，这会做很多无用功。比如如果某些字段需要复杂计算、远程调用或者数据库多表关联查询，这些开销完全是浪费的，尤其是在高并发场景下，性能损耗会被放大。

下面我给你几个更优的设计思路，按实用性和扩展性排序：

1. 基于DTO的动态投影（最推荐） #

核心思路是只构建和返回用户需要的字段，从数据源头就减少不必要的开销。

如果用EF Core这类ORM，可以直接在查询阶段做投影，只拉取需要的字段：

[HttpGet("api/returnFundInfo")]
public async Task<IActionResult> GetFundInfo([FromQuery] string fields)
{
    var allowedFields = string.IsNullOrEmpty(fields) 
        ? new List<string>() 
        : fields.Split(',').Select(f => f.ToLower()).ToList();

    // 从数据库直接投影需要的字段，避免加载全量数据
    var query = _dbContext.ChargesInfo.AsQueryable();
    if (allowedFields.Any())
    {
        var selectExpressions = new List<Expression<Func<ChargesInfo, object>>>();
        if (allowedFields.Contains("code")) selectExpressions.Add(c => c.Code);
        if (allowedFields.Contains("amc")) selectExpressions.Add(c => c.Amc);
        if (allowedFields.Contains("amcdate")) selectExpressions.Add(c => c.AmcDate);
        // 其他字段同理

        // 用LINQ动态构建投影（可以封装成通用工具类）
        query = query.Select(BuildDynamicSelect(selectExpressions));
    }

    var result = await query.FirstOrDefaultAsync();
    return Ok(result);
}

如果业务逻辑复杂，也可以用AutoMapper的动态投影功能，配合ProjectTo方法实现按需映射，代码会更简洁。

2. 自定义Json ContractResolver（无侵入式） #

不想修改实体类的话，可以自定义一个ContractResolver，在序列化阶段动态过滤字段，比ShouldSerialize更灵活，也不会污染实体类代码：

public class DynamicFieldsContractResolver : DefaultContractResolver
{
    private readonly HashSet<string> _allowedFields;

    public DynamicFieldsContractResolver(IEnumerable<string> allowedFields)
    {
        _allowedFields = new HashSet<string>(allowedFields.Select(f => f.ToLower()));
    }

    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var property = base.CreateProperty(member, memberSerialization);
        // 如果指定了字段，只保留允许的；否则序列化所有字段
        if (_allowedFields.Any())
        {
            property.ShouldSerialize = _ => _allowedFields.Contains(member.Name.ToLower());
        }
        return property;
    }
}

然后在API接口里使用：

[HttpGet("api/returnFundInfo")]
public IActionResult GetFundInfo([FromQuery] string fields)
{
    var fullInfo = _businessLayer.GetChargesInfo(); // 这里如果能改成按需获取更好，暂时不改也能用
    var allowedFields = string.IsNullOrEmpty(fields) ? new List<string>() : fields.Split(',').ToList();

    var jsonSettings = new JsonSerializerSettings
    {
        ContractResolver = new DynamicFieldsContractResolver(allowedFields)
    };

    return Json(fullInfo, jsonSettings);
}

3. 用ExpandoObject构建动态对象 #

如果字段不多，也可以直接用ExpandoObject手动组装返回结果，完全控制输出内容：

[HttpGet("api/returnFundInfo")]
public IActionResult GetFundInfo([FromQuery] string fields)
{
    var fullInfo = _businessLayer.GetChargesInfo();
    var allowedFields = string.IsNullOrEmpty(fields) 
        ? new List<string>() 
        : fields.Split(',').Select(f => f.ToLower()).ToList();

    dynamic result = new ExpandoObject();
    var resultDict = (IDictionary<string, object>)result;

    // 按需添加字段，默认返回所有字段
    if (allowedFields.Contains("code") || !allowedFields.Any())
        resultDict["Code"] = fullInfo.Code;
    if (allowedFields.Contains("amc") || !allowedFields.Any())
        resultDict["Amc"] = fullInfo.Amc;
    if (allowedFields.Contains("amcdate") || !allowedFields.Any())
        resultDict["AmcDate"] = fullInfo.AmcDate;
    // 其他字段同理

    return Ok(result);
}

这个方法的优点是直观，缺点是字段多的时候代码会比较繁琐，适合小范围场景。

4. 集成OData（最成熟的通用方案） #

如果你的项目是ASP.NET Core，可以直接集成OData，它原生支持$select参数（比如api/returnFundInfo?$select=Amc,AmcDate,AnnualChargeNote），不需要自己写任何过滤逻辑，还能自动优化数据库查询，同时支持排序、分页、过滤等其他通用API功能。这是大型项目最推荐的方案，生态成熟，扩展性强。

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