筛选出ASP.NET Core API中的属性

Question

我想在我的API中提供以下JSON：

{
  "id": 1
  "name": "Muhammad Rehan Saeed",
  "phone": "123456789",
  "address": {
    "address": "Main Street",
    "postCode": "AB1 2CD"
  }
}

我想赋予客户端过滤掉他们不感兴趣的属性的能力。因此，以下URL返回JSON的子集：

`/api/contact/1?include=name,address.postcode

{
  "name": "Muhammad Rehan Saeed",
  "address": {
    "postCode": "AB1 2CD"
  }
}

在ASP.NET Core中实现此功能的最佳方法是什么，以便：

1. 该解决方案可以全局应用，也可以应用于单个控制器或类似过滤器的操作。
2. 如果该解决方案使用反射，则还必须有一种方法可以通过为其提供一些代码以出于性能原因手动滤除属性来优化特定的控制器动作。
3. 它应该支持JSON，但是很好地支持XML等其他序列化格式。

我发现这个解决方案，它使用了自定义JSON.Net ContractResolver。可以通过将合同解析器添加到ASP.Net Core使用的默认合同解析器中来全局应用该合同解析器，也可以将其手动添加到此代码示例之类的单个操作中，而不是添加到控制器中。另外，这是JSON特定的实现。

Answer 1

您可以使用dynamicwithExpandoObject创建包含所需属性的动态对象。ExpandoObjectdynamic是关键字在底层使用的对象，它允许在运行时动态添加和删除属性/方法。

[HttpGet("test")]
public IActionResult Test()
{
    dynamic person = new System.Dynamic.ExpandoObject();

    var personDictionary = (IDictionary<string, object>)person;
    personDictionary.Add("Name", "Muhammad Rehan Saeed");

    dynamic address = new System.Dynamic.ExpandoObject();
    var addressDictionary = (IDictionary<string, object>)address;
    addressDictionary.Add("PostCode", "AB1 2CD");

    personDictionary.Add("Address", address);

    return Json(person);
}

这导致

{"Name":"Muhammad Rehan Saeed","Address":{"PostCode":"AB1 2CD"}}

您只需要创建一个服务/转换器或类似的东西，它将使用反射来循环您的输入类型，并且仅保留您指定的属性。