如何动态定义匿名对象属性？

Question

我正在我的网站中制作一个小型应用程序，以使用 API 请求获取用户信息。

[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 userInfo = new
    {
        id = userProfile.UserId,
        email = userProfile.Email,
        name = userProfile.Name,
        // I don't want to define a null property here:
        picture_url = fields.Contains("picture_url") ? "path" : null
    };

    if (fields.Contains("picture_url"))
    {
        userInfo.picture_url = "";
    }

    return Ok(userInfo);
}

当请求有效时，它会返回一个 JSON 对象，默认包含 3 个属性：id、email 和 name。

现在，我想检查请求是否要获取有关此用户的更多信息，就像 picture_url。所以，我试过了：

if (fields.Contains("picture_url"))
{
    // error in this line
    userInfo.picture_url = "path";
}

'' 不包含对 'picture_url' 的定义，并且没有扩展方法 'picture_url' 接受类型为 '' 可以找到（您是否缺少 using 指令或程序集引用？）

如何动态地向匿名对象添加一些属性？

Answer 1

匿名类型是不可变的，你只能在创建实例时创建和设置属性。这意味着您需要创建所需的确切对象。所以你可以这样做：

if (fields.Contains("picture_url"))
{
    return Ok(new
    {
        id = userProfile.UserId,
        email = userProfile.Email,
        name = userProfile.Name,
        picture_url = "path"
    });
}

return Ok(new
{
    id = userProfile.UserId,
    email = userProfile.Email,
    name = userProfile.Name
});

另一个选项是使用Dictionary<string, object>。例如：

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

if (fields.Contains("picture_url"))
{
    // error in this line
    userInfo.Add("picture_url", "path");
}

return Ok(userInfo);

此对象将序列化为相同的 JSON 结构：

{"id":1,"email":"email@somewhere.com","name":"Bob","picture_url":"path"}

Answer 2

您可以将对象强制转换为动态并添加属性或使用ExpandoObject 类，它基本上是一个属性包（实现为IDictionary<string, object>）。

var userInfo = new
{
    id = userProfile.UserId,
    email = userProfile.Email,
    name = userProfile.Name
};

dynamic result = userInfo;

if (fields.Contains("picture_url"))
{
    result.picture_url = "<your url here>";

    // alternatively use expando object
    // var expando =  (IDictionary<String, Object>)result;
    // expando.Add("picture_url", "<your url here>");
    // the first parameter is the name of the property
}

return result;

但请注意，使用 dynamic 关键字或 ExpandoObject 您会失去强类型和 Intellisense 支持。

但它允许您在最终的 json 响应中添加或删除属性。

编辑

另见我对类似问题的回答Filtering Out Properties in an ASP.NET Core API 。

虽然在使用 dynamic/ExandoObject 或类似 graphapi 的功能时需要小心，但它应该可以正常工作。要删除属性，您只需使用 exanod.Remove("PropertyName") 方法。

过滤也可以很简单地实现

var dictionaryResult = expando.Where(kv => filter.Contains(kv.Key))
    .ToDictionary(kv => kv.Key, kv => kv.Value);

这将删除所有未在filter 字符串数组中定义的属性。它适用于任何类型，annonymous 或强类型。