如何动态定义匿名对象属性？ASP.NET Core API场景咨询

嘿，这个问题我之前做接口开发的时候也碰到过，刚好有几个实用的方案能帮你实现「动态生成属性、避免返回null字段」的需求，咱们一个个来看：

方案1：使用ExpandoObject动态构建对象 #

ExpandoObject允许你在运行时动态添加属性，返回时会被序列化为标准的JSON对象，完全不会出现未请求的null字段。代码示例如下：

[HttpGet("GetUserInfo/{user_id}/{fields?}")]
public IActionResult GetUserInfo(string user_id, params string[] fields)
{
    var userProfile = _userManager.GetUserProfile(user_id);
    if (userProfile == null)
    {
        return Ok(null);
    }

    // 先定义所有可对外暴露的属性映射
    var allAvailableProps = new Dictionary<string, object>
    {
        { "id", userProfile.UserId },
        { "email", userProfile.Email },
        { "name", userProfile.Name },
        { "picture_url", userProfile.PictureUrl } // 假设你的实体有这个属性
    };

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

    if (fields == null || fields.Length == 0)
    {
        // 如果没有指定fields，返回所有属性
        foreach (var prop in allAvailableProps)
        {
            resultDict.Add(prop.Key, prop.Value);
        }
    }
    else
    {
        // 只添加请求中指定的、且存在的属性
        foreach (var field in fields)
        {
            if (allAvailableProps.TryGetValue(field.ToLowerInvariant(), out var propValue))
            {
                resultDict.Add(field, propValue);
            }
        }
    }

    return Ok(resultObj);
}

这个方案的优势是灵活性高，返回的对象和匿名对象序列化后的格式完全一致，前端感知不到区别。

方案2：直接返回Dictionary<string, object>（推荐） #

如果不需要严格的对象类型，直接返回字典是更简洁的选择——字典序列化后的JSON和普通对象几乎没有区别，代码量更少，维护起来也更方便：

[HttpGet("GetUserInfo/{user_id}/{fields?}")]
public IActionResult GetUserInfo(string user_id, params string[] fields)
{
    var userProfile = _userManager.GetUserProfile(user_id);
    if (userProfile == null)
    {
        return Ok(null);
    }

    var allAvailableProps = new Dictionary<string, object>
    {
        { "id", userProfile.UserId },
        { "email", userProfile.Email },
        { "name", userProfile.Name },
        { "picture_url", userProfile.PictureUrl }
    };

    var result = new Dictionary<string, object>();

    if (fields == null || fields.Length == 0)
    {
        result = allAvailableProps;
    }
    else
    {
        foreach (var field in fields)
        {
            var normalizedField = field.ToLowerInvariant();
            if (allAvailableProps.ContainsKey(normalizedField))
            {
                result.Add(field, allAvailableProps[normalizedField]);
            }
        }
    }

    return Ok(result);
}

我个人更推荐这个方案，因为它没有额外的类型转换开销，代码逻辑清晰，后续要新增属性的话，只需要在allAvailableProps里加一行就行。

方案3：利用反射自动映射属性（适合属性较多的场景） #

如果你的UserProfile实体有很多属性，手动维护映射表太麻烦，可以用反射自动获取属性并完成映射，不过要注意处理属性名的转换（比如实体里的UserId对应返回的id）：

[HttpGet("GetUserInfo/{user_id}/{fields?}")]
public IActionResult GetUserInfo(string user_id, params string[] fields)
{
    var userProfile = _userManager.GetUserProfile(user_id);
    if (userProfile == null)
    {
        return Ok(null);
    }

    var result = new Dictionary<string, object>();
    var profileProps = userProfile.GetType().GetProperties();

    if (fields == null || fields.Length == 0)
    {
        // 返回所有允许对外暴露的属性
        foreach (var prop in profileProps)
        {
            // 过滤掉不需要对外暴露的属性
            if (!new[] { "UserId", "Email", "Name", "PictureUrl" }.Contains(prop.Name))
                continue;

            // 转换属性名到前端期望的格式
            var responseKey = prop.Name switch
            {
                "UserId" => "id",
                "PictureUrl" => "picture_url",
                _ => prop.Name.ToLowerInvariant()
            };
            result.Add(responseKey, prop.GetValue(userProfile));
        }
    }
    else
    {
        // 只返回请求指定的属性
        foreach (var field in fields)
        {
            // 把请求的字段名转换为实体属性名
            var entityPropName = field switch
            {
                "id" => "UserId",
                "picture_url" => "PictureUrl",
                _ => field.ToUpperFirstLetter() // 辅助方法：首字母大写
            };
            var targetProp = profileProps.FirstOrDefault(p => p.Name == entityPropName);
            if (targetProp != null)
            {
                result.Add(field, targetProp.GetValue(userProfile));
            }
        }
    }

    return Ok(result);
}

// 辅助方法：将字符串首字母大写，其余小写
private static string ToUpperFirstLetter(this string input)
{
    if (string.IsNullOrEmpty(input))
        return input;
    return char.ToUpper(input[0]) + input.Substring(1).ToLowerInvariant();
}

这个方案适合属性较多的场景，但反射会有一定的性能开销，如果是高频接口，可以考虑缓存PropertyInfo集合来优化性能。

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