[英]MVC3 and WebApi Error Handling
我正在編輯使用MVC3的舊項目。 它具有處理以下錯誤的Global.asax文件:
protected void Application_Error(object sender, EventArgs e)
{
var currentController = " ";
var currentAction = " ";
var currentRouteData = RouteTable.Routes.GetRouteData(new HttpContextWrapper(Context));
if (currentRouteData != null)
{
if (currentRouteData.Values["controller"] != null && !String.IsNullOrEmpty(currentRouteData.Values["controller"].ToString()))
currentController = currentRouteData.Values["controller"].ToString();
if (currentRouteData.Values["action"] != null && !String.IsNullOrEmpty(currentRouteData.Values["action"].ToString()))
currentAction = currentRouteData.Values["action"].ToString();
}
var ex = Server.GetLastError();
var controller = new ErrorController();
var routeData = new RouteData();
var action = "Index";
var code = (ex is HttpException) ? (ex as HttpException).GetHttpCode() : 500;
switch (code)
{
case 400:
action = "BadRequest";
break;
case 401:
action = "Unauthorized";
break;
case 403:
action = "Forbidden";
break;
case 404:
action = "NotFound";
break;
case 500:
action = "InternalServerError";
break;
default:
action = "Index";
break;
}
Server.ClearError();
Response.Clear();
Response.StatusCode = code;
Response.TrySkipIisCustomErrors = true;
routeData.Values["controller"] = "Error";
routeData.Values["action"] = action;
controller.ViewData.Model = new HandleErrorInfo(ex, currentController, currentAction);
((IController)controller).Execute(new RequestContext(new HttpContextWrapper(Context), routeData));
}
當我的MVC項目中出現錯誤時,這可以正常工作。 還有一個基類,可以像這樣對外部API進行調用:
/// <summary>
/// Used to make a Get request to a specified url
/// </summary>
/// <param name="url">The target url</param>
/// <returns>Returns a string</returns>
public async Task<string> MakeApiCall(string url)
{
return await MakeApiCall(url, HttpMethod.GET, null);
}
/// <summary>
/// Used to make a Post request to a specified url
/// </summary>
/// <param name="url">The target url</param>
/// <param name="method">The Http method</param>
/// <param name="data">The object to send to the api</param>
/// <returns>Returns a string</returns>
public async Task<string> MakeApiCall(string url, HttpMethod method, object data)
{
// Create our local variables
var client = new HttpClient();
var user = Session["AccessToken"];
var authenticating = user == null;
// If we are not authenticating, set our auth token
if (!authenticating)
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", Session["AccessToken"].ToString());
// Check to see what HTTP method is being used
switch (method)
{
case HttpMethod.POST:
// If we are POSTing, then perform a post request
return await PostRequest(client, url, data, authenticating);
default:
// If we are GETing, then perform a get request
return await GetRequest(client, url);
}
}
#region Helper methods
/// <summary>
/// Posts data to a specifed url
/// </summary>
/// <param name="client">The HttpClient used to make the api call</param>
/// <param name="url">The target url</param>
/// <param name="data">The object to send to the api</param>
/// <param name="authenticating">Used to set the content type when authenticating</param>
/// <returns>Returns a string</returns>
private async Task<string> PostRequest(HttpClient client, string url, object data, bool authenticating)
{
// If the data is a string, then do a normal post, otherwise post as json
var response = (data is string) ? await client.PostAsync(this.apiUrl + url, new StringContent(data.ToString())) : await client.PostAsJsonAsync(this.apiUrl + url, data);
// If we are authenticating, set the content type header
if (authenticating == true)
response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/x-www-form-urlencoded");
// Handle our response
return await HandleResponse(response);
}
/// <summary>
/// Gets data from a specifed url
/// </summary>
/// <param name="client">The HttpClient used to make the api call</param>
/// <param name="url">The target url</param>
/// <returns>Returns a string</returns>
private async Task<string> GetRequest(HttpClient client, string url)
{
// Perform the get request
var response = await client.GetAsync(this.apiUrl + url);
// Handle our response
return await HandleResponse(response);
}
/// <summary>
/// Used to handle the api response
/// </summary>
/// <param name="response">The HttpResponseMessage</param>
/// <returns>Returns a string</returns>
private async Task<string> HandleResponse(HttpResponseMessage response)
{
// Read our response content
var result = await response.Content.ReadAsStringAsync();
// If there was an error, throw an HttpException
if (response.StatusCode != HttpStatusCode.OK)
throw new HttpException((int)response.StatusCode, result);
// Return our result if there are no errors
return result;
}
#endregion
這種方法的問題是HandleResponse方法。 進行API調用時,如果調用失敗,它將到達以下行:
// If there was an error, throw an HttpException
if (response.StatusCode != HttpStatusCode.OK)
throw new HttpException((int)response.StatusCode, result);
依次由Global.asax中的Application_Error方法捕獲。 問題在於,由於這是API調用,因此控制器無法重定向到ErrorController ...
所以我的問題是:
如果您有任何問題,請詢問。 我已嘗試確保帖子不只是一堵牆。
更新1
因此,我嘗試使用AttributeFilter來解決此問題。 我使用了2個用戶建議的2種方法。 首先,我創建了一個自定義異常,如下所示:
/// <summary>
/// Custom Api Exception
/// </summary>
public class ApiException : Exception
{
/// <summary>
/// Default constructor
/// </summary>
public ApiException()
{
}
/// <summary>
/// Constructor with message
/// </summary>
/// <param name="message">The error message as a string</param>
public ApiException(string message)
: base(message)
{
}
/// <summary>
/// Constructor with message and inner exception
/// </summary>
/// <param name="message">The error message as a string</param>
/// <param name="inner">The inner exception</param>
public ApiException(string message, Exception inner)
: base(message, inner)
{
}
}
然后,我在基本控制器中更新了HandleResponse方法,如下所示:
/// <summary>
/// Used to handle the api response
/// </summary>
/// <param name="response">The HttpResponseMessage</param>
/// <returns>Returns a string</returns>
private async Task<string> HandleResponse(HttpResponseMessage response)
{
// Read our response content
var result = await response.Content.ReadAsStringAsync();
// If there was an error, throw an HttpException
if (response.StatusCode != HttpStatusCode.OK)
throw new ApiException(result);
// Return our result if there are no errors
return result;
}
然后創建一個過濾器,添加到FilterConfig中 ,如下所示:
public class ExceptionAttribute : IExceptionFilter
{
/// <summary>
/// Handles any exception
/// </summary>
/// <param name="filterContext">The current context</param>
public void OnException(ExceptionContext filterContext)
{
// If our exception has been handled, exit the function
if (filterContext.ExceptionHandled)
return;
// If our exception is not an ApiException
if (!(filterContext.Exception is ApiException))
{
// Set our base status code
var statusCode = (int)HttpStatusCode.InternalServerError;
// If our exception is an http exception
if (filterContext.Exception is HttpException)
{
// Cast our exception as an HttpException
var exception = (HttpException)filterContext.Exception;
// Get our real status code
statusCode = exception.GetHttpCode();
}
// Set our context result
var result = CreateActionResult(filterContext, statusCode);
// Set our handled property to true
filterContext.ExceptionHandled = true;
}
}
/// <summary>
/// Creats an action result from the status code
/// </summary>
/// <param name="filterContext">The current context</param>
/// <param name="statusCode">The status code of the error</param>
/// <returns></returns>
protected virtual ActionResult CreateActionResult(ExceptionContext filterContext, int statusCode)
{
// Create our context
var context = new ControllerContext(filterContext.RequestContext, filterContext.Controller);
var statusCodeName = ((HttpStatusCode)statusCode).ToString();
// Create our route
var controller = (string)filterContext.RouteData.Values["controller"];
var action = (string)filterContext.RouteData.Values["action"];
var model = new HandleErrorInfo(filterContext.Exception, controller, action);
// Create our result
var view = SelectFirstView(context, string.Format("~/Views/Error/{0}.cshtml", statusCodeName), "~/Views/Error/Index.cshtml", statusCodeName);
var result = new ViewResult { ViewName = view, ViewData = new ViewDataDictionary<HandleErrorInfo>(model) };
// Return our result
return result;
}
/// <summary>
/// Gets the first view name that matches the supplied names
/// </summary>
/// <param name="context">The current context</param>
/// <param name="viewNames">A list of view names</param>
/// <returns></returns>
protected string SelectFirstView(ControllerContext context, params string[] viewNames)
{
return viewNames.First(view => ViewExists(context, view));
}
/// <summary>
/// Checks to see if a view exists
/// </summary>
/// <param name="context">The current context</param>
/// <param name="name">The name of the view to check</param>
/// <returns></returns>
protected bool ViewExists(ControllerContext context, string name)
{
var result = ViewEngines.Engines.FindView(context, name, null);
return result.View != null;
}
}
最后,我從Global.asax的Application_Error方法中刪除了邏輯,希望它能起作用。 但事實並非如此。 當出現ApiException時,我仍然會返回文檔。
誰能幫我?
如果您想用最少的代碼完成您想做的事情,那么您可以做的是代替拋出HttpException
而不是拋出HttpException
它可以以字符串形式返回表示您的異常的JSON(因為您的方法返回字符串),如下所示:
if (response.StatusCode != HttpStatusCode.OK)
JsonConvert.SerializeObject("{ StatusCode : " + response.StatusCode.ToString() + "}");
顯然,這是一種hack,不建議這樣做,但不會設置Application_Error
並且您還可以將JSON答復給客戶端代碼。
更好的選擇是重構代碼以返回HttpResponseMessage
或使用過濾器屬性等。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.