使用RestSharp时如何以惯用方式处理HTTP错误代码？

Question

我正在使用RestSharp构建HTTP API客户端,我注意到当服务器返回HTTP错误代码(401 Unauthorized,404 Not Found,500 Internal Server Error等)时,RestClient.Execute()不会抛出异常 - 而是我得到一个RestResponsenull .Data属性的有效.我不想在我的API客户端中手动检查每个可能的HTTP错误代码 - RestSharp是否提供了将这些错误传递给我的客户端应用程序的更好方法？

更进一步的细节.RestSharp公开一个Response.ErrorException属性 - 如果RestClient.Execute<T>()调用导致任何异常,它将通过ErrorException属性公开而不是被抛出.他们的文档包括以下示例:

// TwilioApi.cs
public class TwilioApi {
    const string BaseUrl = "https://api.twilio.com/2008-08-01";

    public T Execute<T>(RestRequest request) where T : new()
    {
    var client = new RestClient();
    client.BaseUrl = BaseUrl;
    client.Authenticator = new HttpBasicAuthenticator(_accountSid, _secretKey);
    request.AddParameter("AccountSid", _accountSid, ParameterType.UrlSegment); // used on every request
    var response = client.Execute<T>(request);

    if (response.ErrorException != null)
    {
        const string message = "Error retrieving response.  Check inner details for more info.";
        var twilioException = new ApplicationException(message, response.ErrorException);
        throw twilioException;
    }
    return response.Data;
    }

}

我在我的代码中采用了这种模式,但是我的API服务器返回了一个401 Unauthorized但是ErrorException属性仍为null.我可以看到RestResponse.StatusCode和RestResponse.StatusDescription属性中未经授权的状态代码和错误消息- 但我很困惑为什么未经授权的响应不会导致ErrorException字段被填充.

Answer 1

我在尝试为RestSharp WebAPI客户端创建一般错误处理程序时遇到了同样的问题.鉴于这些扩展方法:

public static class RestSharpExtensionMethods
{
    public static bool IsSuccessful(this IRestResponse response)
    {
        return response.StatusCode.IsSuccessStatusCode()
            && response.ResponseStatus == ResponseStatus.Completed;
    }

    public static bool IsSuccessStatusCode(this HttpStatusCode responseCode)
    {
        int numericResponse = (int)responseCode;
        return numericResponse >= 200
            && numericResponse <= 399;
    }
}

我提出了一个要求响应被反序列化的请求:

public async Task<ResponseModel<TResponse>> PerformRequestAsync<TResponse>(IRestRequest request)
{
    var response = await _client.ExecuteTaskAsync<ResponseModel<TResponse>>(request);
    ResponseModel<TResponse> responseData;

    if (response.IsSuccessful())
    {
        responseData = response.Data;
    }
    else
    {
        string resultMessage = HandleErrorResponse<TResponse>(request, response);

        responseData = new ResponseModel<TResponse>         
        {
            Success = false,
            ResultMessage = resultMessage
        };
    }

    return responseData;
}

但是,在测试期间,我发现当我没有为该情况配置错误处理时,我的web服务器在请求未映射的URL时返回了HTML格式的404页面.这导致该response.ErrorException属性包含以下字符串:

引用未声明的实体'nbsp'.线n,位置m.

显然,RestSharp试图将响应解析为XML,即使内容类型是text/html.也许我会为此向RestSharp提出一个问题.

当然在生产中,在调用自己的服务时应该永远不会得到404,但我希望这个客户端是彻底和可重用的.

所以我能想到两个解决方案:

• 检查状态代码并显示说明
• 确保该服务返回可以解析的错误对象

前者很容易完成.在HandleErrorResponse()我根据状态代码的数值构建结果消息(用户可呈现)和错误字符串(可记录):

public string HandleErrorResponse(IRestRequest request, IRestResponse response)
{
    string statusString = string.Format("{0} {1} - {2}", (int)response.StatusCode, response.StatusCode, response.StatusDescription);
    string errorString = "Response status: " + statusString;

    string resultMessage = "";
    if (!response.StatusCode.IsScuccessStatusCode())
    {
        if (string.IsNullOrWhiteSpace(resultMessage))
        {
            resultMessage = "An error occurred while processing the request: "
                          + response.StatusDescription;
        }
    }
    if (response.ErrorException != null)
    {
        if (string.IsNullOrWhiteSpace(resultMessage))
        {
            resultMessage = "An exception occurred while processing the request: "
                          + response.ErrorException.Message;
        }
        errorString += ", Exception: " + response.ErrorException;
    }

    // (other error handling here)

    _logger.ErrorFormat("Error response: {0}", errorString);

    return resultMessage;
}

现在我的API响应总是包含在ResponseModel<T>我的中,我可以设置一个异常过滤器和一个NotFound路由来返回一个可解析的响应模型,其中包含ResultMessage属性中的错误或异常消息:

public class HandleErrorAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext context)
    {
        // (log context.Exception here)

        context.Response = context.Request.CreateResponse(HttpStatusCode.InternalServerError, new ResponseModel<object>
        {
            Success = false,
            ResultMessage = "An exception occurred while processing the request: " + context.Exception.Message
        });
    }
}

和:

public class ErrorController : ApiController
{
    public HttpResponseMessage Handle404()
    {
        const string notFoundString = "The requested resource could not be found";

        var responseMessage = Request.CreateResponse(HttpStatusCode.NotFound, new ResponseModel<object>
        {
            Success = false,
            ResultMessage = notFoundString
        });

        responseMessage.ReasonPhrase = notFoundString;

        return responseMessage;
    }
}

这样我的服务响应总是可以被RestSharp解析,我可以使用通用的日志记录方法:

public string HandleErrorResponse<TResponseModel>(IRestRequest request, IRestResponse<<ResponseModel<TResponseModel>> response)

并记录实际响应// (other error handling here),如果可用:

if (response.Data != null && !string.IsNullOrWhiteSpace(response.Data.ResultMessage))
{
    resultMessage = response.Data.ResultMessage;
    errorString += string.Format(", Service response: \"{0}\"", response.Data.ResultMessage);
}

Answer 2

RestSharp 添加了IRestResponse.IsSuccessful涵盖您的用例的布尔属性。我找不到任何引用此属性的文档，但这是定义该属性的 method 的行。

有趣的是，RestSharp 认为代码 200-299 是成功的，而 CodeCaster 认为代码 200-399 是成功的。

Answer 3

检查成功代码应该足够了，如果您收到除成功之外的任何其他代码，则抛出或报告错误。这通常意味着在每次请求后检查 HTTP 状态 200。如果您创建新资源，您应该会看到状态 201。

对于大多数 API/框架，如果没有出现任何问题，则很少会看到除这些状态代码之外的任何其他状态代码。