.net core Blazor+自定義日誌提供器實現實時日誌查看器
- 2022 年 10 月 30 日
- 筆記
- Asp.Net Core, Blazor
場景
我們經常遠程連接伺服器去查看日誌，比較麻煩，如果直接訪問項目的某個頁面就能實時查看日誌就比較奈斯了，花了1天研究了下.net core 日誌的原理，結合blazor實現了基本效果。
實現原理
- 自定義日誌提供器，將日誌記錄到記憶體中，滾動10W條刪除。
- 提供blazor組件，實時從記憶體中讀取後顯示，搞了個簡單的條件搜索。
為毛用記憶體存儲？因為快，主要目的是實時監控，方便調試，只需要最近一段時間的數據，所以記憶體是最合適的。
由於數據是存儲在全局靜態變數中的（執行緒安全的），所以多個人同時打開頁面查看日誌其實看的是同一份數據。
這個庫默認提供了與.net core默認的日誌框架的繼承，但你也可以用自己的方式把數據存儲到那個靜態變數中。
如何使用？
必須是asp.net 6.x的項目，至於是mvc webapi razorpages還是blazor無所謂，都可以簡單配置支援blazor server，assembly模式按沒考慮過。
我的項目是webapi，啟用blazor server有影響嗎？完全木有，asp.net core本就是基礎web框架，同一個項目可以同時支援webapi mvc razorpage和blazor的。
1、啟用blazor server（若你本來是，直接跳過）
若你不熟悉如何在現有項目集成blazor server，可以建個空的blazor server項目，然後按下面的步驟操作
在startup.cs或program.cs中
//註冊服務
services.AddRazorPages();
services.AddServerSideBlazor();
//配置路由
app.UseEndpoints(endpoints =>
{
endpoints.MapDefaultControllerRoute();
endpoints.MapBlazorHub();
endpoints.MapFallbackToPage(“/_Host”);
});
然後將你新建的空的blazor server項目中的如下文件和目錄拷貝過來
- wwwroot：裡面包含默認樣式，若你完全決定自己搞樣式，可以不拷貝
- Pages：裡面包含blazor server中基礎的頁面，其中_Host.cshtml（用來放blazor server根組件的）、_Layout.cshtml（_Host.cshtml依賴這個布局，我們還會在裡面放公用的css js引用）文件必拷
- Shared、公共組件，比如blazor的布局、菜單等組件
- _Imports.razor、為所有blazor組件做全局命名空間導入的，注意它只為blazor組件服務，並不是global using，這個是給整個項目用的
- App.razor ，blazor server的根組件，它被放在_Host.cshtml中的。在此頁面頂部：<Router AppAssembly=”@typeof(App).Assembly” AdditionalAssemblies=”new Assembly[]{ typeof(BlazorServerLogger).Assembly}”>
注意修改命名空間，尤其注意_Layout.cshtml head部分<link href=”ZLJ.FYJIOT.ApiHost.styles.css” rel=”stylesheet” />前面的命名空間替換為你當前項目的命名空間，這個是當前項目中的組件的樣式文件，自動生成的
2、安裝咱的日誌包：BXJG.BlazorServerLogger
3、配置
在program.cs中
public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureLogging(b=>b.AddBlazorServerLogger())
現在啟動，導航到 /log-blazor 頁面看效果。
自定義配置和樣式
目前做的比較簡單，默認滾動刪除10W條、記錄所有類別和級別的日誌、以及組件的樣式都是固定的，有興趣可以自己改。
默認為你建好了頁面 /log-blazor，這要求你在App.razor中配置AdditionalAssemblies=”new Assembly[]{ typeof(BlazorServerLogger).Assembly}”，如果你不想要這個頁面，可以自己建頁面，然後引入BlazorServerLogger組件，升值你也可以直接讀取BlazorServerLoggerExt.MsgContainer中的當前日誌資訊，自己做顯示。
非微軟的日誌框架的集成
如果你記錄日誌使用的不是微軟的ILogger介面，或者你使用的第三方日誌框架沒有與微軟的日誌框架集成，那麼上面的步驟3就不用做了，而是在記錄日誌時直接調用BlazorServerLoggerExt.Add靜態方法就行了。
不過這樣你原來的程式碼得改，最好與你自己目前的框架做個集成，舉個例子：若你原來是直接使用的log4net，則你需要自定義一個Appender，然後調用BlazorServerLoggerExt.Add，這樣你原來記錄日誌的方式不變。
資源
源碼：//gitee.com/bxjg1987_admin/abp/tree/master/src/Libs/BXJG.BlazorServerLogger
