c# - 正确使用 EnsureSuccessStatusCode 和 IsSuccessStatusCode

Question

我正在使用 HttpClient 调用我的 Web API，我看到有一个 EnsureSuccessStatusCode 方法和一个 IsSuccessStatusCode 属性。哪一个合适？

我读了这篇文章，还有一些其他问题:

Usage of EnsureSuccessStatusCode and handling of HttpRequestException it throws

我遇到的问题是，如果我发送 GET 请求并传递我要检索的对象的 ID，基本上有两种结果:

1. 我拿回状态为 200 的对象
2. 我可以返回 null，因为没有匹配项，但这会导致状态为 404。

如果我调用 EnsureSuccessStatusCode() 状态 404 将导致抛出异常。这并不理想，因为当我测试我的代码时，我不断收到 404 错误，起初让我认为 API URL 不正确，但实际上没有与提供的 ID 匹配的对象。在这种情况下，我宁愿返回一个空对象，也不愿抛出异常。

所以我尝试检查 IsSuccessfulStatusCode 属性的值。这似乎是一个更好的选择，当此属性为 false 时我可以返回一个 null 对象，但是，有许多状态代码可能导致此属性具有 false 值。 404是其中之一，但还有其他几种状态代码，例如400 Bad Request、405 Method Not Allowed等。我想记录一个异常除了 404 之外的所有不成功的错误代码，我想知道是否有比检查响应的 ResponseCode 值然后抛出一个被我的 catch block 捕获的异常更好的方法，这是进行日志记录的地方。

这是我的 GET 方法的代码:

public static Customer GetCustomerByID(int id)
{
    try
        {
            using (var client = GetConfiguredClient())
            {
                Customer customer = null;
                var requestUri = $"Customers/{id}";

                using (var response = client.GetAsync(requestUri).Result)
                {
                    if (response.IsSuccessStatusCode)
                        customer = response.Content.ReadAsAsync<Customer>().Result;
                }

                return customer;
            }
        }
        catch (Exception ex)
        {
          ex.Data.Add(nameof(id), id);

          LogException(ex);

          throw;
        }
    }

如果返回不成功的状态代码并且没有任何记录，此代码将只返回一个空的 Customer。

处理这种情况的最佳方法是什么？

Answer 1

accepted answer采用“异常分支”，这被一些人认为是反模式。以下是如何使用 EnsureSuccessStatusCode 和 IsSuccessStatusCode，仅针对意外或不能或不应“本地”处理的错误使用异常:

1. 如果您想处理特定的错误响应，请使用if 语句 直接处理它们。
2. 如果您想将所有(剩余的)错误响应视为意外错误，请使用 EnsureSuccessStatusCode 和不捕获异常，但假设它将由捕获处理实际上可以对其执行某些操作的处理程序(例如更高级别的应用程序逻辑，或通用的顶级错误处理程序)。
3. 如果您想对所有(剩余的)错误响应(例如日志记录)执行某些操作，但随后会正常进行，或者如果您想抛出您自己的异常类型，请使用 IsSuccessStatusCode。

这种方法为您提供了异常的所有优点，同时最大限度地减少了缺点(例如，在您可能不感兴趣的完全正常的事件中中断调试器，或者用 catch block 塞满您的代码，这些 block 更难阅读和写比 if 语句)。

例子:

using (var response = client.GetAsync(requestUri).Result)
{
  if (response.StatusCode == System.Net.HttpStatusCode.Unauthorized)
  {
    // TODO: Special handling for "401 Unauthorized" goes here
  }
  else
  {
    // All other unsuccessful error codes throw
    response.EnsureSuccessStatusCode();

    // TODO: Handling of successful response goes here
  }
}

...或者如果您想阅读错误响应或进行日志记录等:

using (var response = client.GetAsync(requestUri).Result)
{
  if (response.StatusCode == System.Net.HttpStatusCode.Unauthorized)
  {
    // TODO: Special handling for "401 Unauthorized" goes here
  }
  else if (!response.IsSuccessStatusCode)
  {
    // TODO: Read error response, logging, throw custom exception, etc., goes here

    // TODO: Keep this if you still want to throw the standard exception.
    // TODO: Otherwise, remove this.
    response.EnsureSuccessStatusCode();
  }
  else
  {
    // TODO: Handling of successful response goes here
  }
}