【问题标题】:What should I return when my oData V4 method returns SingleResult<T> and nothing is found?当我的 oData V4 方法返回 SingleResult<T> 并且没有找到任何东西时,我应该返回什么?
【发布时间】:2016-01-20 22:41:24
【问题描述】:

我在一个返回 SingleResult 的 oData V4 项目中有一个控制器方法。它查询一个表,当它有数据时,它会返回它应该返回的内容。但是,当应用程序是新的并且表为空时,它会给出一个无法描述的错误:

"'SingleResult`1' cannot be serialized using the ODataMediaTypeFormatter."

我的方法如下所示:

    [EnableQuery]
    public virtual SingleResult<LoggerEntry> Get([FromODataUri] int key)
    {
        using (var gateway = this.Gateway.GetChild())
        {
            var model = gateway.GetLoggerEntry(key);
            // TODO: Check for null and tell the client NotFound
            return SingleResult.Create((new List<LoggerEntry>(){ model }).AsQueryable());
        }
    }

因为我使用的是 SingleResult,所以我不能只使用 return NotFound();。我试图使用一个空列表,但这给了我同样的错误。在这种情况下,我找不到要返回的示例或文档。我应该返回什么。

【问题讨论】:

    标签: asp.net odata asp.net-web-api2


    【解决方案1】:

    保留您的原始代码并尝试使用 ODataNullValueMessageHandler

            configuration.MapODataServiceRoute(
                "odata", 
                "odata", 
                GetEdmModel(configuration),
                defaultHandler: HttpClientFactory.CreatePipeline(innerHandler: new HttpControllerDispatcher(configuration), handlers: new[] { new ODataNullValueMessageHandler()}));
    

    【讨论】:

    • 问题是它返回“序列不包含元素”错误。我宁愿返回类似于 NotFound() 的东西。虽然这可能是 SingleResult 的预期功能?
    • 我想澄清一下这个评论,它返回一个 InvalidOperationException 和一个 500。我认为用 404 返回更有用的东西会更好。我只是不知道是什么。
    【解决方案2】:

    正如您正确指出的那样,我们可能希望向用户报告许多可能不同的响应,200 和 404 是不够的。

    我们可以添加处理程序或过滤器来解释异常并返回更有意义的 http 响应代码,如其他答案中所述,但是当您想要显式返回不同的 HTTP 响应代码(例如 400-BadRequest 或404-未找到。

    如果您发现自己抛出任意异常只是为了让另一个进程可以解释消息并将其重新格式化为可用响应或更有意义的东西,这就是我们首先抛出异常的原因,那么您应该评估异常是否是首先是表达响应的最佳机制。

    通过将您的 Web 方法的响应类型更改为 IHttpActionResult,我们可以通过异常代码响应更具表现力。在大多数情况下,此更改将与您的 Web API 运行时的其余部分兼容。

    现在,在您的方法中,我们可以轻松地表达不同的常见响应,如果您的控制器类继承自 ApiController,那么以下示例应该可以工作:

    [EnableQuery]
    public virtual IHttpActionResult Get([FromODataUri] int key)
    {
        // HACK: Example of a specific case that we want to disallow
        if(key <= 0)
            return BadRequest("Keys must be positive values");
    
        using (var gateway = this.Gateway.GetChild())
        {
            var model = gateway.GetLoggerEntry(key);
    
            // Check for null and tell the client NotFound
            if(model == null)
                return NotFound();
    
            // NOTE: SingleResult does not implement IHttpActionResult and the ApiController 
            // does not provide a simple helper for SingleResult, so I've added one for you.
            return Single((new List<LoggerEntry>(){ model }).AsQueryable());
        }
    }
    
    /// <summary>
    /// Helper to Create a SingleResult (200 OK) Response as IHttpActionResult
    /// </summary>
    /// <typeparam name="T">The type of item in query.</typeparam>
    /// <param name="itemQuery">The query to get the item.</param>
    /// <returns>A System.Web.Http.Results.JsonResult`1 with the specified values.</returns>
    protected IHttpActionResult Single<T>(IQueryable<T> itemQuery)
    {
        return Content(HttpStatusCode.OK, System.Web.Http.SingleResult.Create(itemQuery));
    }
    

    注意:许多转换为使用 IHttpActionResult 的 api 开发人员可能会选择使用 protected internal virtual OkNegotiatedContentResult&lt;T&gt; Ok&lt;T&gt;(T content); 方法来生成 IHttpActionResult 响应,但这将始终返回一个数组,即使您的查询结果为单行,这就是我包含的原因我回复中的Single 助手。

    在这种情况下,Single&lt;T&gt; 帮助方法演示了如何轻松自定义控制器类中的响应处理程序并让您完全控制输出,包括如何指定可能有助于使您的代码更具表现力的不同状态响应并且可供其他团队成员阅读。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2012-02-20
      • 1970-01-01
      • 2016-07-09
      • 2023-01-29
      • 1970-01-01
      • 1970-01-01
      • 2017-10-06
      • 1970-01-01
      相关资源
      最近更新 更多