Asp.NetCore依賴注入和管道方式的異常處理及日誌記錄

時間  2019-11-07
標籤 asp.netcore asp netcore 依賴 注入 管道 方式 異常 處理 日誌 記錄 欄目 ASP 简体版
原文   原文鏈接

前言

    在業務系統，異常處理是全部開發人員必須面對的問題，在必定程度上，異常處理的能力反映出開發者對業務的駕馭水平；本章將着重介紹如何在 WebApi 程序中對異常進行捕獲，而後利用 Nlog 組件進行記錄；同時，還將介紹兩種不一樣的
異常捕獲方式：管道捕獲/服務過濾；經過本練習，將學習到如何捕獲異常、處理異常跳轉、記錄異常信息。git

1. 搭建框架

    首先，建立一個 WebApi 項目，選擇 Asp.Net Core Web 應用程序；github

1.1 進一步選擇 Api 模板，這裏使用的 .netcore 版本爲 2.1

  • 取消勾選 「啓用 Docker 支持(E)」 和 「爲 Https 配置(C)」，點擊肯定，獲得一個完整的 WebApi 項目框架，如圖

1.2 直接按 F5 運行項目，一切正常，程序啓動後進入默認路由調用，並輸出結果

2. 異常路由

2.1 一切看起來都很是正常和美好，但，禍之福所倚；接下來咱們在 接口 Get() 中人爲的製造一點麻煩。
[HttpGet]
        public ActionResult<IEnumerable<string>> Get()
        {
            throw new Exception("出錯了.....");

            return new string[] { "value1", "value2" };
        }
2.2 這是因爲項目配置了運行環境變量 ASPNETCORE_ENVIRONMENT=Development 後，Startup.cs 中配置了開發環境下，使用系統默認頁，因此咱們才能夠看到上面的異常信息

若是你把環境變量設置爲 ASPNETCORE_ENVIRONMENT=Production ，你會發現，在異常發生的時候，你獲得了一個空白頁。web

3. 異常處理方式一：服務過濾

    在傳統的 Asp.Net MVC 應用程序中，咱們通常都使用服務過濾的方式去捕獲和處理異常，這種方式很是常見，並且可用性來講，體驗也不錯，幸運的是 Asp.Net Core 也完整的支持該方式，接下來建立一個全局異常處理類 CustomerExceptionFilterjson

public class CustomerExceptionFilter : Attribute, IExceptionFilter
{
    private readonly ILogger logger = null;
    private readonly IHostingEnvironment environment = null;
    public CustomerExceptionFilter(ILogger<CustomerExceptionFilter> logger, IHostingEnvironment environment)
    {
        this.logger = logger;
        this.environment = environment;
    }

    public void OnException(ExceptionContext context)
    {
        Exception exception = context.Exception;
        string error = string.Empty;

        void ReadException(Exception ex)
        {
            error += string.Format("{0} | {1} | {2}", ex.Message, ex.StackTrace, ex.InnerException);
            if (ex.InnerException != null)
            {
                ReadException(ex.InnerException);
            }
        }

        ReadException(context.Exception);
        logger.LogError(error);

        ContentResult result = new ContentResult
        {
            StatusCode = 500,
            ContentType = "text/json;charset=utf-8;"
        };

        if (environment.IsDevelopment())
        {
            var json = new { message = exception.Message, detail = error };
            result.Content = JsonConvert.SerializeObject(json);
        }
        else
        {
            result.Content = "抱歉，出錯了";
        }
        context.Result = result;
        context.ExceptionHandled = true;
    }
}
3.1 CustomerExceptionFilter 繼承自 IExceptionFilter 接口，並實現 void OnException(ExceptionContext context) 方法，在 CustomerExceptionFilter

構造方法中，定義了兩個參數，用於記錄異常日誌和獲取程序運行環境變量api

private readonly ILogger logger = null;
    private readonly IHostingEnvironment environment = null;
    public CustomerExceptionFilter(ILogger<CustomerExceptionFilter> logger, IHostingEnvironment environment)
    {
        this.logger = logger;
        this.environment = environment;
    }
3.2 在接下來的 OnException 方法中，利用 environment 進行產品環境的判斷，並使用 logger 將日誌寫入硬盤文件中，爲了將日誌寫入硬盤，

須要引用 Nuget 包 NLog.Extensions.Logging/NLog.Web.AspNetCore ，並在 Startup.cs 文件的 Configure 方法中添加擴展安全

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory factory)
        {
            // 將 NLog
            factory.AddConsole(Configuration.GetSection("Logging"))
                   .AddNLog()
                   .AddDebug();

            var nlogFile = System.IO.Path.Combine(env.ContentRootPath, "nlog.config");
            env.ConfigureNLog(nlogFile);

            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseMvc();
        }
3.3 上面的代碼讀取了配置文件 nlog.config 並設置爲 NLog 的配置，該文件定義以下
<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true" internalLogLevel="info">

  <!-- Load the ASP.NET Core plugin -->
  <extensions>
    <add assembly="NLog.Web.AspNetCore"/>
  </extensions>

  <!-- Layout: https://github.com/NLog/NLog/wiki/Layout%20Renderers -->
  <targets>
    <target xsi:type="File" name="errorfile" fileName="/data/logs/logfilter/error-${shortdate}.log" layout="${longdate}|${logger}|${uppercase:${level}}|  ${message} ${exception}|${aspnet-Request-Url}" />
    <target xsi:type="Null" name="blackhole" />
  </targets>

  <rules>
    <logger name="Microsoft.*" minlevel="Error" writeTo="blackhole" final="true" />
    <logger name="*" minlevel="Error" writeTo="errorfile" />
  </rules>
</nlog>
3.4 爲了在 WebApi 控制器中使用 CustomerExceptionFilter 過濾器，咱們還須要在 Startup.cs 將 CustomerExceptionFilter 注入到容器中
// This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            // 將異常過濾器注入到容器中
            services.AddScoped<CustomerExceptionFilter>();

            services.AddMvc()
                .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

        }
3.5 最後，在控制器 ValuesController 中應用該異常過濾器
[ServiceFilter(typeof(CustomerExceptionFilter))]
    [Route("api/[controller]"), ApiController]
    public class ValuesController : ControllerBase
    {
        // GET api/values
        [HttpGet]
        public ActionResult<IEnumerable<string>> Get()
        {
            throw new Exception("出錯了.....");
            return new string[] { "value1", "value2" };
        }
    }
3.6 如今，按 F5 啓動程序，如預期所料，報錯信息被 CustomerExceptionFilter 捕獲，並轉換爲 json 格式輸出

3.7 同時，NLog 組件也將日誌信息記錄到了硬盤中

4. 異常處理方式二：中間件捕獲

接下來利用 .NetCore 的管道模式，在中間件中對異常進行捕獲，首先，建立一箇中間件app

public class ExceptionMiddleware
{
    private readonly RequestDelegate next;
    private readonly ILogger logger;
    private IHostingEnvironment environment;

    public ExceptionMiddleware(RequestDelegate next, ILogger<ExceptionMiddleware> logger, IHostingEnvironment environment)
    {
        this.next = next;
        this.logger = logger;
        this.environment = environment;
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await next.Invoke(context);
            var features = context.Features;
        }
        catch (Exception e)
        {
            await HandleException(context, e);
        }
    }

    private async Task HandleException(HttpContext context, Exception e)
    {
        context.Response.StatusCode = 500;
        context.Response.ContentType = "text/json;charset=utf-8;";
        string error = "";

        void ReadException(Exception ex)
        {
            error += string.Format("{0} | {1} | {2}", ex.Message, ex.StackTrace, ex.InnerException);
            if (ex.InnerException != null)
            {
                ReadException(ex.InnerException);
            }
        }

        ReadException(e);
        if (environment.IsDevelopment())
        {
            var json = new { message = e.Message, detail = error };
            error = JsonConvert.SerializeObject(json);
        }
        else
            error = "抱歉，出錯了";

        await context.Response.WriteAsync(error);
    }
}
4.1 代碼比較簡單，在管道中使用 try/catch 進行捕獲異常

建立 HandleException(HttpContext context, Exception e) 處理異常，判斷是 Development 環境下，輸出詳細的錯誤信息，非 Development 環境僅提示調用者「抱歉，出錯了」，同時使用 NLog 組件將日誌寫入硬盤；一樣，在 Startup.cs 中將 ExceptionMiddleware 加入管道中框架

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory factory)
        {
            // 將 NLog
            factory.AddConsole(Configuration.GetSection("Logging"))
                   .AddNLog()
                   .AddDebug();

            var nlogFile = System.IO.Path.Combine(env.ContentRootPath, "nlog.config");
            env.ConfigureNLog(nlogFile);

            // ExceptionMiddleware 加入管道
            app.UseMiddleware<ExceptionMiddleware>();

            //if (env.IsDevelopment())
            //{
            //    app.UseDeveloperExceptionPage();
            //}

            app.UseMvc();
        }
4.2 一切就緒，按 F5 運行程序，網頁中輸出了指望中的 json 格式錯誤信息，同時 NLog 組件也將日誌寫入了硬盤

結語

在本例中，經過依賴注入和管道中間件的方式，演示了兩種不一樣的全局捕獲異常處理的過程；值得注意到是，兩種方式對於 NLog 的使用，都是同樣的，沒有任何差異，代碼無需改動；實際項目中，也是應當區分不一樣的業務場景，輸出不一樣的日誌信息，無論是從安全或者是用戶體驗友好性上面來講，都是很是值得推薦的方式，全局異常捕獲處理，徹底和業務剝離。async

源碼下載

https://github.com/lianggx/EasyAspNetCoreDemo/tree/master/Ron.LogFilter學習

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程