ASP.NET 通過攔截器記錄錯誤日志的示例代碼

前言

    主要是記錄一下實現的錯誤日志攔截,可以在攔截器裡面控制返回的信息,把錯誤信息處理後返回給請求端。

攔截器

攔截器又稱過濾器。

asp.net mvc本身是自帶3種攔截器:Action攔截器、Result攔截器、Exception攔截器。 應用中常見的攔截器有日志攔截器(Action攔截器)和異常處理攔截器(Exception攔截器)。

java裡spring mvc也常用攔截器來做些非幹預業務邏輯的事,諸如實現HandlerInterceptor接口。

攔截器是AOP(面向切面編程)的一種應用。

攔截器要解決的問題:

1.代碼復用。攔截器可被復用
2.職責單一。比如廚師隻負責炒菜,不管前期的洗菜、後續的送菜工作。菜變質瞭也是直接喊一聲就有人來處理。

這次我們用來記錄錯誤日志

代碼實戰

攔截器

    /// <summary>
    /// 接口異常捕捉過濾器
    /// </summary>
    [AttributeUsage(AttributeTargets.All, AllowMultiple = false, Inherited = true)]
    public class ApiErrorHandleAttribute : ExceptionFilterAttribute
    {
        public override void OnException(HttpActionExecutedContext actionExecutedContext)
        {
            base.OnException(actionExecutedContext);
            actionExecutedContext.Response = GetResponse(actionExecutedContext);
        }

        /// <summary>
        /// 捕捉異常後響應方法
        /// </summary>
        private HttpResponseMessage GetResponse(HttpActionExecutedContext actionExecutedContext)
        {
            var requesthost = actionExecutedContext.ActionContext.Request.RequestUri.ToString();//當前請求的地址,包括ip加接口地址
            var method = actionExecutedContext.ActionContext.Request.Method.ToString();//當前請求是POST/GET/PUT/DELETE ……
            var controller = actionExecutedContext.ActionContext.ActionDescriptor.ControllerDescriptor.ControllerType.FullName;//當前請求的控制器所在全路徑:xxx.WebAPI.Controllers.xxxController
            var action = actionExecutedContext.ActionContext.ActionDescriptor.ActionName; //當前請求的方法
            var paramters = actionExecutedContext.ActionContext.ActionArguments; //獲取當前請求的參數
            var ip = HttpContext.Current.Request.UserHostAddress;
           
            LogHelper.Error($"錯誤信息:URL:{actionExecutedContext.Request.RequestUri},--參數信息:{paramters.ToJson()},--actionExecutedContext.Exception:{actionExecutedContext.Exception.ToJson()}");
            var response = new { code = 506, message = $"{actionExecutedContext.Exception.Message},URL:{actionExecutedContext.Request.RequestUri}", ex = actionExecutedContext.Exception };
           
            return JsonHelper.ToHttpResponseMessage(response);
        }

    }

工具類方法

    public static class JsonHelper
    {
        /// <summary>
        /// 轉化為json格式的HttpResponseMessage
        /// </summary>
        public static HttpResponseMessage ToHttpResponseMessage(object obj)
        {
            string str;
            if (obj is string || obj is char)
            {
                str = obj.ToString();
            }
            else
            {
                str = obj.ToJson();
            }
            var result = new HttpResponseMessage { Content = new StringContent(str, Encoding.GetEncoding("UTF-8"), "application/json") };
            return result;
        }

        /// <summary>
        /// 轉化為json字符串,默認的時間格式
        /// </summary>
        /// <param name="obj">要被轉化的對象</param>
        /// <returns>json字符串</returns>
        public static string ToJson(this object obj)
        {
            return JsonConvert.SerializeObject(obj, new JsonSerializerSettings { ReferenceLoopHandling = ReferenceLoopHandling.Ignore, DateFormatString = "yyyy-MM-dd HH:mm:ss" });
        }
    }

以上就是ASP.NET 通過攔截器記錄錯誤日志的示例代碼的詳細內容,更多關於ASP.NET 記錄錯誤日志的資料請關註WalkonNet其它相關文章!