1. 程式人生 > >asp.net web api 異常捕獲

asp.net web api 異常捕獲

resp int 反序列化 存儲 cut type easyn esp https

1 向客戶端發送錯誤消息

使用throw new HttpResponseException()向客戶端拋出錯誤信息。

HttpResponseException包含兩個重載的構造函數,其中一個是構造函數參數類型為HttpResponseMessage,通過其設置狀態碼,錯誤消息短語以及消息體內容來向客戶端拋出比較詳細的錯誤信息。另一個參數類型為HttpStatusCode,只能設定狀態碼。

2自定義異常過濾器

擴展IExceptionFilter來定義異常過濾器。異常過濾器不會捕獲類型為HttpResponseException的異常,下面的異常也無法被異常過濾器捕獲:

1)controller構造器拋出的異常

2)消息處理器拋出的異常

3)路由過程中拋出的異常

4)響應內容序列化與反序列化過程中拋出的異常

代碼示例:

public class CustomExceptionFilterAttribute : ExceptionFilterAttribute 
    {
        public override void OnException(HttpActionExecutedContext context)
        {
            if (context.Exception!=null)
            {
                LogHelper.LogError(context.Exception);
            }
        }
    }

3 擴展ExceptionHandler和ExceptionLogger

擴展ExceptionHandler可以捕獲大部分異常,包括一些無法被異常過濾器捕獲的異常。但是HttpResponseException類型的異常不會被捕獲。

示例代碼:

/// <summary>
    /// 自定義的異常處理程序
    /// </summary>
    public class GlobalExceptionHandler : ExceptionHandler
    {
        /// <summary>
        /// 處理異常
        /// </summary>
/// <param name="context"></param> /// <param name="cancellationToken"></param> /// <returns></returns> public override Task HandleAsync(ExceptionHandlerContext context,CancellationToken cancellationToken) { if (!ShouldHandle(context)) { return Task.FromResult(0); } context.Result = new ErrorResult { Request = context.ExceptionContext.Request, Content = "呀! 有異常,請聯系管理員" }; return Task.FromResult(0); } /// <summary> /// 判斷是否應該處理 /// 後期擴展,重寫方法可過濾掉不需處理的異常 /// </summary> /// <param name="context"></param> /// <returns></returns> public override bool ShouldHandle(ExceptionHandlerContext context) { return true; } private class ErrorResult : IHttpActionResult { public HttpRequestMessage Request { get; set; } public string Content { get; set; } public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken) { HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.InternalServerError); response.Content = new StringContent(Content); response.RequestMessage = Request; return Task.FromResult(response); } } } public class GlobalExceptionLogger : ExceptionLogger { public override Task LogAsync(ExceptionLoggerContext context,CancellationToken cancellationToken) { if (!ShouldLog(context)) { return Task.FromResult(0); } if (context.Exception != null) { string msg = ClientInfoAnalysis.GetClientInfo(); LogHelper.LogError(context.Exception, msg); } return Task.FromResult(0); } /// <summary> /// 判斷是否應記錄異常 /// 後期重寫此方法,可過濾掉不需要記錄的異常信息 /// </summary> /// <param name="context"></param> /// <returns></returns> public override bool ShouldLog(ExceptionLoggerContext context) { if ((context.Exception is System.Web.HttpException)) { return false; } return true; } } public static class WebApiConfig { public static void Register(HttpConfiguration config) { // 加載log4net配置文件 LogConfigLoading.Load(AppSettings.Log4netPathForWeb); // 加載Web API服務 config.Services.Replace(typeof(IAssembliesResolver), new ServiceAssembliesResolver(AppSettings.ServicesLocation)); // 全局異常信息處理 config.Services.Replace(typeof(IExceptionHandler), new GlobalExceptionHandler()); // 全局異常記錄 config.Services.Add(typeof(IExceptionLogger), new GlobalExceptionLogger()); } }

4某些異常無法被捕獲的異常

問題描述

對於在服務加載過程中的異常,無法通過異常過濾器,即實現了System.Web.Http.Filters.IExceptionFilter接口的過濾器來捕獲,也不能通過註冊ExceptionLogger來達到目的。解決方法如下:

public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            try
            {
                config.Services.Replace(typeof(IAssembliesResolver), new ServiceAssembliesResolver(SysSettings.ServicesLocation));
            }
            catch (Exception ex)
            {
                LogHelper.Error(ex);
            }

//其他代碼
}
}

其中ServiceAssembliesResolver為:

public class ServiceAssembliesResolver : DefaultAssembliesResolver
    {
        //服務插件路徑
        private string path;
        public ServiceAssembliesResolver(string path):base()
        {
            this.path = path;
        }
        public override ICollection<Assembly> GetAssemblies()
        {
            //獲得已有的服務
            ICollection<Assembly> baseAssemblies = base.GetAssemblies();
            //初始化
            List<Assembly> assemblies = new List<Assembly>(baseAssemblies);
            //加載每一個服務插件
            foreach (string file in Directory.GetFiles(path, "*.dll"))
            {
                var controllersAssembly = Assembly.LoadFrom(file);
                assemblies.Add(controllersAssembly);
            }

            return assemblies;
        }
    }

但上述方法很可能不起作用,根本原因在於將config.Services.Replace(typeof(IAssembliesResolver), new ServiceAssembliesResolver(SysSettings.ServicesLocation));放入try-catch塊中ServiceAssembliesResolver在實例化的時候不拋出異常,而是當調用GetAssemblies時拋出異常(例如服務插件存儲文件夾被刪除),此時無法記錄異常。那麽問題就在於GetAssemblies方法何時被調用,通過跟蹤代碼發現Register中的所有代碼都執行完成才會加載服務解決辦法ServiceAssembliesResolver.GetAssemblies中捕獲異常並記錄下來。

asp.net web api 異常捕獲