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

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

阿新 • • 發佈：2018-11-25

前言

    在業務系統，異常處理是所有開發人員必須面對的問題，在一定程度上，異常處理的能力反映出開發者對業務的駕馭水平；本章將著重介紹如何在 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 的使用，都是一樣的，沒有任何差別，程式碼無需改動；實際專案中，也是應當區分不同的業務場景，輸出不同的
日誌資訊，不管是從安全或者是使用者體驗友好性上面來說，都是非常值得推薦的方式，全域性異常捕獲處理，完全和業務剝離。

相關推薦

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

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

C#反射與特性(六)：設計一個仿ASP.NETCore依賴注入Web

目錄 1，編寫依賴注入框架 1.1 路由索引 1.2 依賴例項化 1.3 例項化型別、依賴注入、呼叫方法 2，編寫控制器和引數型別 2.1 編寫型別

JAVA中的異常處理及日誌(log4j為例)的使用

ble 包括 啟動 fatal try-catch stat 異常捕獲 資源 大於 Java的異常 1.Java中所有異常和錯誤的基類：Throwable 　　　　Throwable error 　　　　　　 Exception 　　　　　　（檢查時異常）（運行時

Spring MVC學習-----------異常處理以及日誌記錄

如何實現全域性的異常處理？ 在spring MVC的配置檔案中： Xml程式碼   <!-- 總錯誤處理-->   <bean id="exceptionResolver

ASP.NET Core 中文文件 第四章 MVC（4.4）依賴注入和控制器

ASP.NET Core MVC 控制器應通過它們的構造器明確的請求它們的依賴關係。在某些情況下，單個控制器的操作可能需要一個服務，在控制器級別上的請求可能沒有意義。在這種情況下，你也可以選擇將服務作為 action 方法的引數。 章節： 依賴注入 依賴注入（Dependency injection，

Spring依賴注入的普通方式和註解方式

純屬自己的筆記本，方便複習用 Spring主要作用就是為程式碼“解耦”，降低程式碼間的耦合度 spring注入是指在啟動spring容器載入bean的時候，完成對變數的賦值行為 第一種： 在建立Product的時候注入一個Category物件  這裡為什麼要把Ca

輕鬆理解-中高階java開發必知必會之 依賴注入和控制反轉

關於Ioc和DI在網上隨便一搜都有很多，但是很多人的講解呢，就是讓人感覺深奧，看多了反而有些摸不清了，下面是我找到的一個利於理解的講解可以看下 Ioc (控制反轉) 　　首先想說說Ioc（Inversion of Control，控制反轉）。這是spring的核心，貫穿始終。所謂Ioc，對於

依賴注入和Butter Knife原始碼分析

一、控制反轉和依賴注入: 兩圖的區別： （1）圖一有高度的耦合性，多個物件相互依賴，如果ObjectA想讓ObjectB跟隨自己轉動應該怎麼做？ 在ObjectA中建立一個ObjectB的物件，然後呼叫ObjectB的某個方法進行轉動。ObjectA主動控制Objec

spring的依賴注入 -------基於註解方式

前言： 做了2年的軟體，剛開始入行的時候，沒有個目標基本上都是在摸索，技術看的我眼花繚亂，這個想學，那個也想學結果是對很多技術一知半解的，工作中才發現，我們要掌握的一門可以搞定快速開發搞定所有業務需求的技術， 所以現在我要對spring的東西達到一個深層次的掌握，儘量避免百度，在開發

PHP反射實現對類的方法依賴注入和建構函式依賴注入

前段時間一直在看tp5 發現他內部實現了控制器的依賴注入。。下面 我通過程式碼來說明一下是怎麼實現的。 首先我們準備好幾個類檔案  我們先看目錄安排 其中 start.php是啟動檔案 <?php /** * Created by PhpStorm. * User: A

依賴注入和控制反轉

學習過Spring框架的人一定都會聽過Spring的IoC(控制反轉) 、DI(依賴注入)這兩個概念，對於初學Spring的人來說，總覺得IoC 、DI這兩個概念是模糊不清的，是很難理解的，今天和大家分享網上的一些技術大牛們對Spring框架的IOC的理解以及談談我對

依賴注入和控制反轉的理解

學習過Spring框架的人一定都會聽過Spring的IoC(控制反轉) 、DI(依賴注入)這兩個概念，對於初學Spring的人來說，總覺得IoC 、DI這兩個概念是模糊不清的，是很難理解的，今天和大家分享網上的一些技術大牛們對Spring框架的IOC的理解以及談談我對Spri

php 簡單理解依賴注入和自動載入

       因為在學習tp5框架，經常看到一種寫法__construct(Request $request){$this->request=$request}的寫法，不知道這是什麼意思，後來百度了一下，這個叫做依賴注入，具體的含義找了很多文章來看，有了一些比較

【AutoFac】依賴注入和控制反轉的使用

在開始之前首先解釋一下我認為的依賴注入和控制反轉的意思。（新手理解，哪裡說得不正確還請指正和見諒） 控制反轉：我們向IOC容器發出獲取一個物件例項的一個請求，IOC容器便把這個物件例項“注入”到我們的手中，在這個時候我們不是一個建立者，我們是以一個請求者的身份去請求容器給我們這個物件例項。我們所有的物件依賴

依賴注入和控制反轉的理解，寫的太好了

　學習過Spring框架的人一定都會聽過Spring的IoC(控制反轉) 、DI(依賴注入)這兩個概念，對於初學Spring的人來說，總覺得IoC 、DI這兩個概念是模糊不清的，是很難理解的，今天和大家分享網上的一些技術大牛們對Spring框架的IOC的理解以

ASP .NetCore 部署500錯誤 查看異常詳情

項目 pid 教程 進程 fin 殺死 .net core 右鍵 ets 部署.net core 網站後，訪問報錯：500 按照教程設置完成，但訪問時總是提示 服務器內部錯誤，沒有詳細的異常信息，無從下手。 解決辦法： 1.在站點根目錄下按住shift+鼠標右鍵，選擇

通俗易懂的spring的依賴注入(和控制反轉)的講解。

Spring 能有效地組織J2EE應用各層的物件。不管是控制層的Action物件，還是業務層的Service物件，還是持久層的DAO物件，都可在Spring的管理下有機地協調、執行。Spring將各層的物件以鬆耦合的方式組織在一起，Action物件無須關心Service物件的具體實現，Service

依賴注入和註解，為什麼 Java 比你想象的要好

我坦白\: 我喜歡 Java。 我真的喜歡！ 也許這並不會讓你感到吃驚，因為我畢竟確實參與編著過一本滿是 Java 程式碼的書。但是事實上，當我開始編寫 Android 應用的時候我並不是一個喜歡 Java 的人，而當我開始編寫書蟲程式設計指南的時候，我也很難稱得上是粉絲，甚至當我們完成編寫的時

依賴注入和Dagger2

1.依賴 如果在 Class A 中，有 Class B 的例項，則稱 Class A 對 Class B 有一個依賴。例如下面類 Human 中用到一個 Father 物件，我們就說類 Human 對類 Father 有一個依賴。 public class

[轉]Spring依賴注入和例項化(new)的差別

Spring依賴注入和例項化(new)的差別。 Sping為什麼使用依賴注入而不使用例項化物件的方式？ 首先說明一下概念 依賴注入(Dependency of Injection)和控制反轉(Inversion of Control 簡稱