ASP.net 核心根据请求的内容类型返回 view() 或 json/xml

Question

question here 是关于我想要实现的目标。在控制器中，来自 repos 的所有数据都将放入 ViewModel 对象中。要求是：

if (requested content type = "json"){
    return convert-to-json(ViewModel);
else
    return view(ViewModel);

但是，question here（检查Request.Headers["Accept"].Contains("application/json")）中建议的解决方案看起来不太好。

Microsoft 的 content negotiation article 谈论标准内容协商（JSON/XML 等...）

我可以有一个单独的 WebAPI 项目，但在这种情况下，我不能证明编写另一组代码只是调用存储库并返回 JSON。

Answer 1

不要试图重新发明轮子......

首先，我认为您应该认真考虑使用内容协商 ASP Core 采用的开箱即用策略（您链接了那篇文章）并使用不同的格式化程序，因为该框架通过为您查询 Accept headers 使用正确的 HTTP 标准。

如果你必须...

如果您需要其他东西，我认为您需要的解决方案是使用Filters 来“隐藏”您提到的脏位。您仍然需要检查 Accept headers MIME Type 的内容，但您可以使用基于属性的系统来执行此操作（如果您真的不想使用 Formatters）。

这是简单的属性。注意IActionFilter 接口，它要求我们在OnActionExecuted 和OnActionExecuting 方法中构建一些功能

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public sealed class FormatReponseFilterAttribute : Attribute, IActionFilter
{
    private enum FormatResponseType { Json, Xml, Unknown }
    private FormatResponseType _requestedType { get; set; }
    public void OnActionExecuted(ActionExecutedContext filterContext)
    {
        var _result = (ObjectResult)filterContext.Result;
        switch (_requestedType)
        {

            case FormatResponseType.Json:
                var data = new { Data = _result.Value };
                filterContext.Result = new JsonResult(data);
                break;
            case FormatResponseType.Xml:
                filterContext.Result = new XmlResult(_result.Value);
                break;
            case FormatResponseType.Unknown:
            default:
                throw new InvalidOperationException("Uknown Content Type ain Accept Header");
        }
    }

    public void OnActionExecuting(ActionExecutingContext filterContext)
    {

        var _contentType = filterContext.HttpContext.Request.Headers["Accept"];

        switch (_contentType)
        {
            case string s when (s.Contains("application/json")):
                _requestedType = FormatResponseType.Json;
                break;
            case string e when (e.Contains("/xml")):
                _requestedType = FormatResponseType.Xml;
                break;
            default:
                throw new ArgumentException("Unknown Accept Type - dont know how to handle: " + _contentType);
        }
    }
}

• OnActionExecuting ：在访问 Action 方法之前运行。这使我们能够保存有关请求本身的信息。这是我们检查标头以查看是否有我们识别的 Accept MIME 内容类型的地方。

• OnActionExecuted ：此方法在控制器的 Action 方法完成后执行。这将查询上下文的Result 并使用内置的JsonResult 或使用Wallsmedias XmlResult 对其进行更新。您需要在此处添加更多逻辑，例如在转换之前检查 Result 是否确实有某些内容。您可以在此处找到安装说明以及如何使用XmlResult：

  https://github.com/Wallsmedia/XmlResult

  然后你只需像这样用FormatResponseFilter 装饰你的控制器方法：

  // GET api/values
  [HttpGet]
  [FormatReponseFilter]
  public IActionResult Get()
  {
      TestModel model = new TestModel { Id = 24, Name = "Gareth" };
      return new ObjectResult(model);
  }
  

完成这项工作的最后一步是将 XML 格式化程序添加到可用的服务中，在 Startup.cs 内：

        services.AddMvc()
                .AddXmlFormaterExtensions();

这是一个很好的 Postman 显示 XML：

这是一个显示 JSON 的漂亮 Postman：

另外，如果您想使用我在此处发布到 Github 上的代码，其中包括 Postman 配置，以便您可以尽快起床并进行测试：

Source Code