我正在使用RestSharp构建HTTP客户端,我注意到当服务器返回一个HTTP错误代码时(401未经授权,404没有找到,500个内部服务器错误等等)。RestClient.Execute()
不会抛出异常,相反,我会得到一个带有空.Data
属性的有效.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属性仍然是空的。我能看到
RestResponse.StatusCode
和RestResponse.StatusDescription
属性中的未授权状态代码和错误消息--但我不明白为什么未经授权的响应不会导致填充ErrorException
字段。
发布于 2015-10-13 09:34:59
在试图为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;
}
但是,在测试期间,我发现当我没有为这种情况配置错误处理时,当请求未映射的URL时,我的web序列化返回一个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);
}
发布于 2018-03-06 19:06:33
RestSharp添加了包含用例的布尔属性IRestResponse.IsSuccessful
。我找不到任何关于这个属性的文档,但是下面是定义属性方法的行。
值得注意的是,RestSharp认为代码200-299是成功的,而CodeCaster则认为代码200-399是成功的。
发布于 2015-07-20 12:34:05
它应该足够检查一个成功的代码,并抛出或报告错误,如果您得到任何其他代码以外的成功。这通常意味着在每次请求之后检查HTTP状态200。如果您创建了一个新的资源,您应该期望状态201。
在大多数API/框架中,看到任何其他状态代码都是非常不寻常的,除非这些代码没有出错。
https://stackoverflow.com/questions/31516501
复制相似问题