.Net Core中间件和过滤器实现错误日志记录
1.中間件的概念
ASP.NET Core的處理流程是一個管道,中間件是組裝到應用程序管道中用來處理請求和響應的組件。每個中間件可以:
選擇是否將請求傳遞給管道中的下一個組件。
可以在調用管道中的下一個組件之前和之后執行業務邏輯。
中間件是一個請求委托(?public?delegate?Task RequestDelegate(HttpContext context)?)的實例,所以中間件的本質就是一個方法,方法的參數是HttpContext,返回Task。傳入的HttpContext參數包含了請求和響應信息,我們可以在中間件中對這些信息就行修改。中間件的管道處理流程如下:
我們知道中間件是配置請求處理管道的組件,那么誰來負責構建管道呢?負責構建管道的角色是ApplicationBuilder。ApplicationBuilder通過Use、Run、Map及MapWhen方法來注冊中間件,構建請求管道。我們簡單看下這幾個方法。
1 Run
新建一個WebAPI項目,修改StartUp中的Configure方法如下,用Run方法注冊的中間件可以叫做終端中間件,即該中間件執行完成后不再執行后續的中間件。
運行程序,我們看到只執行了第一個中間件,后邊的中間件不會執行。
2 Use
Use方法的參數是一個委托實例,委托的第一個參數是HttpContext,這是待處理的請求上下文;第二個參數next是下一個中間件,我們可以通過next.Invoke()調用下一個中間件,并且可以在調用下一個中間件之前/之后對HttpContext做一個邏輯處理。
? 運行程序如下所示。注意如果我們沒有調用next.Invoke()方法,會造成管道短路,后續的所有中間件都不再執行。
3 Map
在業務簡單的情況下,使用一個請求處理管道來處理所有的請求就可以了,當業務復雜的時候,?我們可能考慮把不同業務的請求交給不同的管道中處理。?Map?基于給定請求路徑的匹配項來創建請求管道分支。?如果請求路徑以給定路徑開頭,則執行分支??匆粋€栗子,需求是/userinfo開頭的請求使用用戶分支管道來處理,/product開頭的請求使用產品分支管道處理,代碼如下:
運行程序執行結果如下:
4 MapWhen
MapWhen和Map的思想比較相似,MapWhen基于自定義條件來創建請求管道分支,并將請求映射到管道的新分支。看一個栗子就明白了,下邊栗子的需求是查詢參數包含name的請求交給一個分支管道處理,url包含/userinfo的請求交給用戶分支來處理,代碼如下:
? 程序執行結果如下:
到這里我們對中間件已經有了一個基本的了解,接下了通過一個異常日志?中間件來了解開發中怎么去使用中間件。
2?使用中間件記錄錯誤日志
這里使用的日志組件為nlog,首先創建一個WebAPI項目,添加一個自定義日志處理中間件CostomErrorMiddleware,當程序出錯時會記錄日志,同時開發環境下會把異常的詳細信息打印在頁面上,非開發環境隱藏詳細信息,代碼如下:
修改StartUp類中的Configure方法如下,注入nlog?需要先安裝 NLog.Web.AspNetCore?,使用app.UseMiddleware<CostomErrorMiddleware>()注冊我們自定義的中間件,代碼如下:
到這里異常處理中間件就注冊完成了,修改ValueController自己制造一個異常來測試一下,代碼如下:
運行程序,在開發環境下訪問/Values/1,顯示結果如下,同時這些錯誤信息也會通過nlog寫入到錯誤日志中:
? 非開發環境下,訪問/values/1,顯示如下:
3?使用過濾器記錄錯誤日志
過濾器大家應該都很熟悉,在ASP.NET Core中過濾器的使用沒有太大的變化,這里也實現一個使用過濾器記錄錯誤日志的栗子,直接看代碼吧,首先創建一個過濾器,代碼如下:
修改StartUp類,注入nlog,配置全局過濾器,代碼如下,其中nlog.config和中間件栗子中一樣:
然后修改ValuesController,設置錯誤和上邊中間件的栗子一樣,運行代碼訪問/values/1時,在開發環境中顯示如下,同時錯誤信息也會寫入錯誤日志中:
? 在生產環境中訪問/values/1的話,錯誤詳細也會寫入錯誤日志中,瀏覽器顯示如下:
本文介紹了中間件的基本使用,同時使用中間件和過濾器兩種方式實現了異常日志的記錄,如果文中有錯誤的地方希望大家可以指出,我會及時改正。
參考文章
【1】https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/logging/?view=aspnetcore-3.0
【2】https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/?view=aspnetcore-3.0
原文鏈接:https://www.cnblogs.com/wyy1234/p/11373999.html
.NET社區新聞,深度好文,歡迎訪問公眾號文章匯總?http://www.csharpkit.com?
總結
以上是生活随笔為你收集整理的.Net Core中间件和过滤器实现错误日志记录的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 沈向洋对于工程技术人员的十点经验分享
- 下一篇: 使用Helm将ASP.NET Core应