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

来源:https://www.cnblogs.com/viter/archive/2018/11/25/10013195.html
-Advertisement-
Play Games

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


前言

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

搭建框架

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

  • 進一步選擇 Api 模板，這裡使用的 .netcore 版本為 2.1

  • 取消勾選 “啟用 Docker 支持(E)” 和 “為 Https 配置(C)”，點擊確定，得到一個完整的 WebApi 項目框架，如圖

  • 直接按 F5 運行項目，一切正常，程式啟動後進入預設路由調用，並輸出結果

異常路由

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

            return new string[] { "value1", "value2" };
        }
  • 這是由於項目配置了運行環境變數 ASPNETCORE_ENVIRONMENT=Development 後，Startup.cs 中配置了開發環境下，使用系統預設頁，所以我們才可以看到上面的異常信息

  • 如果你把環境變數設置為 ASPNETCORE_ENVIRONMENT=Production ，你會發現，在異常發生的時候，你得到了一個空白頁。

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

    在傳統的 Asp.Net MVC 應用程式中，我們一般都使用服務過濾的方式去捕獲和處理異常，這種方式非常常見，而且可用性來說，體驗也不錯，幸運的是 Asp.Net Core 也完整的支持該方式，接下來創建一個全局異常處理類 CustomerExceptionFilter

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;
    }
}
  • CustomerExceptionFilter 繼承自 IExceptionFilter 介面，並實現 void OnException(ExceptionContext context) 方法，在 CustomerExceptionFilter
    構造方法中，定義了兩個參數，用於記錄異常日誌和獲取程式運行環境變數
    private readonly ILogger logger = null;
    private readonly IHostingEnvironment environment = null;
    public CustomerExceptionFilter(ILogger<CustomerExceptionFilter> logger, IHostingEnvironment environment)
    {
        this.logger = logger;
        this.environment = environment;
    }
  • 在接下來的 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();
        }
  • 上面的代碼讀取了配置文件 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>
  • 為了在 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);

        }
  • 最後，在控制器 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" };
        }
    }
  • 現在，按 F5 啟動程式，如預期所料，報錯信息被 CustomerExceptionFilter 捕獲，並轉換為 json 格式輸出

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

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

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

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);
    }
}
  • 代碼比較簡單，在管道中使用 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();
        }
  • 一切就緒，按 F5 運行程式，網頁中輸出了期望中的 json 格式錯誤信息，同時 NLog 組件也將日誌寫入了硬碟

結語

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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 【原創】自己手寫實現Boost序列化簡易版
    設計思路 在與多個系統進行網路交互時，序列化是不可缺少的技術。編寫一個C++語言的序列化實現，是練習運用模板元編程的絕佳案例，理解C++模板是如何"面向編譯期編程"的（業內好像沒有這個說法）。序列化對象處理基礎數據類型和類類型，boost的序列化功能劃分得更細緻，基本支持了C++語言的序列化，但是在 ...
  • 進程、線程和協程
    一、進程 1、多任務原理 多任務是指操作系統同時可以運行多個任務。 單核CPU實現多任務原理：操作系統輪流讓各個任務交替執行； 多核CPU實現多任務原理：真正的執行多任務只能在多核CPU上實現，多出來的任務輪流調度到每個核心上執行。 併發：看上去一起執行，任務數多於CPU核心數； 並行：真正的一起執 ...
  • 魔術方法
    類的常用魔術方法：無需人為調用，基本是在特定的時刻自動觸發，方法名被前後兩個下劃線包裹 魔術方法，總結表： __init__：構造函數。初始化的時候調用。__new__：對象實例化方法，其實這才是類裡面第一個被調用的方法，在構造函數之前調用，之後才是__init__，只是這個比較特殊，一般不使用。_ ...
  • 編程測試電腦存儲的大小端模式
    大端模式：低位位元組存在高地址上，高位位元組存在低地址上 小端模式：高位位元組存在高地址上，低位位元組存在低地址上 例如對於0x11223344存儲如下: 用union來測試機器的大小端模式 #include <stdio.h> // 共用體中很重要的一點：a和b都是從u1的低地址開始的。 // 假設u1所 ...
  • Ceres配置（vs2013+Win10）
    主要參考文：Ceres Solver 在Windows下安裝配置筆記 eigen、gflags、glog、suitesparse按照上面的鏈接中的指導配置即可。 配置ceres的時候，按照上面的鏈接內容配置，在點擊configure後會出現在findeigen.camke文件中報錯，提示找不到eig ...
  • 字元串全排列
    void AllSortCore(char *str,int begin,int end); void AllSort(char *str) { if(str == NULL) return ; int n = strlen(str); AllSortCore(str,0,n-1); } void ... ...
  • Git使用教程，從入門到上癮
    Git 是什麼？ Git 是一個分散式的代碼管理容器，本地和遠端都保有一份相同的代碼。 Git 倉庫主要是由是三部分組成：本地代碼，緩存區，提交歷史，這幾乎是所有操作的本質，但是為了文章更加簡單易懂，就不圍繞這塊展開了，有興趣的可以去瞭解下。 開門見山，我們直接來說說 Git 有哪些常見的操作。 G ...
  • Elasticsearch 系列文章彙總(持續更新...)
    Query DSL 1. "Query DSL 概要，MatchAllQuery，全文查詢簡述" 2. " Match Query" 3. "Match Phrase Query 和 Match Phrase Prefix Query" Java Rest Client API 1. "Elasti ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類