5.使用日誌+自定義全局異常過濾器

剛開始寫文章，封裝Base基類的時候，添加了trycatch異常塊，不過當時沒有去記錄日誌，直接return了。有小伙伴勸我不要吃了Exception

 其實沒有啦，項目剛開始，我覺得先做好整體結構比較好。像是蓋樓一樣。先把樓體建造出來，然後再一步一步的美化完善。

基礎的倉儲模式已經ok，Autofac已經註入了項目的實現層。上篇文章新建了一個Test類主要用於測試，加了4個介面增刪改查，執行也是完全沒有問題的。這篇文章開始就是逐步完善優化項目。

關於日誌有很多選擇，我記得上篇我也提到過幾個，好，那我就再重覆一下：Nlog，Log4，Serilog……

我這裡使用的是Nlog，以前用的Log4，都是自己封裝一個Helper類，後來學NetCore的時候看到Nlog使用著好簡單，而且後面也搜了下大佬們對兩者的對比，綜合對比我覺得Nlog更好一點~性能現在應該差不多，因為那篇文章14年的，放個當時大佬的對比（現在應該也差不多少吧，看個人習慣了，用習慣了怎麼都好用）

先稍微梳理一下邏輯。日誌這東西一般程式都會有，但是你真沒有的話，其實也不影響程式跑對吧~再者依賴註入你肯定要在程式層有Nlog的直接或間接引用的，要麼你哪個地方（類庫）用到就安裝一個Nlog包，要麼在最底層倉儲層安裝一個Nlog包，間接引用到程式層。好像也沒啥影響，但我就是覺得怪怪的，感覺這樣會不會增加耦合？ 唉，這方面我還真是學的不到家，希望關於這塊兒有瞭解的可以討論一下，我再學學~

我的做法呢，就是把Nlog安裝到Common公共類庫中。這個類庫是在上個文章新建的。用意就是專門弄一些很多地方都會用到的東西，但是我即便不用也不影響程式跑的東西。比如Autofac……所以日誌我也打算加到此處……

在Common類庫安裝Nlog程式包：NLog.Extensions.Logging

 在Common類庫下新建一個文件  Logs\Nlog\NlogModule.cs 。我搞這麼多文件夾一方面看著比較容易看得懂，另一方面，後面打算添加一些其他的日誌給大家一個參考。

NlogModule是靜態類，添加靜態方法AddNlogModule，註入Nlog：

        public static void AddNlogModule(this IServiceCollection Services)
        {
            Services.AddLogging(logging =>
            {
                logging.AddNLog();
            });
        }

然後，好像沒然後咯~

上篇文章中，將Common添加到IRepository層的項目引用。可以說已經貫穿了整個項目(直接或間接引用)。所以只需要在API程式層的Programs中添加Nlog模塊就好。

        builder.Services.AddNlogModule();//Nlog

（拍頭）忘了一個重要的地方。Nlog的config配置：主要配置你的日誌怎麼記錄，記錄到哪裡，記錄格式等

 配置如下，也無需花心思在這上面，官網和網上都有模板，自己簡單配置一下，保存，以後用到了直接拷貝就好，我做了簡單的註釋，應該都看的明白，所以不多說什麼啦~

<?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">

    <targets async="true">
        <!--maxArchiveDays最長保存N天,archiveAboveSize一個文件最大為N位元組-->
        <target name="LogDebug" xsi:type="File" maxArchiveDays="7" archiveAboveSize="10485760"  fileName="Logs/Debug信息/【${shortdate}】.txt" layout="【${date}】【${logger}】${newline}${message:withexception=true}${newline}${newline} " />
        <target name="LogInfo" xsi:type="File" maxArchiveDays="7" archiveAboveSize="10485760"  fileName="Logs/Info信息/【${shortdate}】.txt" layout="【${date}】【${logger}】${newline}${message:withexception=true}${newline}${newline} " />
        <target name="LogError" xsi:type="File" maxArchiveDays="7" archiveAboveSize="10485760"  fileName="Logs/Error信息/【${shortdate}】.txt" layout="【${date}】【${logger}】${newline}${message:withexception=true}${newline}${newline} " />
    </targets>

    <rules>
        <!--日誌記錄規則,符合規則的writeTo到相應的日誌目標中-->
        <logger name="Microsoft.*"  writeTo="" final="true" />
        <!--日誌記錄規則,符合規則的writeTo到相應的日誌目標中-->
        <logger name="*" level="Error" writeTo="LogError" final="true" />
        <logger name="*" level="Info"  writeTo="LogInfo" final="true" />
        <logger name="*" level="Debug" writeTo="LogDebug" final="true" />
    </rules>
</nlog>

 到這裡已經完成了。在你需要的地方通過構造函數註入即可，例如：

 這種Ilogger<T>是泛型介面，可以通過尖括弧里的類名找到相關的依賴，簡單來說記錄日誌的時候可以輸出錯誤信息是在哪個地方產生的。也可以根據這個來設置過濾，或輸出日誌到不同的地方。

上上篇文章的代碼生成器是預設是沒有添加Nlog的，所以構造函數里也沒有添加，如果你需要在服務層或倉儲層記錄詳細信息Info或者Debug的話，根據自己的需求去構造註入吧。正常情況下，記錄異常就足夠用了。

欸，那問題就來了，你說我倉儲層服務層沒有構造函數註入，那我異常了怎麼記錄呢？有的人說，throw丟出去呀，丟到程式層……確實可以，但是稍微微有點麻煩吧？倉儲層裹一層，丟到服務層，服務層裹一層丟到程式層，然後程式層再記錄日誌？so~封裝一個全局異常記錄模塊兒~

這個是官方的介面，同時程式一定要對異常進行處理，這個是必要的。不然既不好排查問題，生產使用的時候一報錯就掛掉，那可就涼了……所以這個全局異常處理我將添加在程式層下

新建一個類（自己隨便起名哈，裡面的內容一樣就行）GlobalExceptionFilter，繼承介面IExceptionFilter：異常過濾器

public class GlobalExceptionFilter : IExceptionFilter
    {
        //構造註入Nlog
        private readonly ILogger<GlobalExceptionFilter> logger;
        public GlobalExceptionFilter(ILogger<GlobalExceptionFilter> _)
        {
            logger = _;
        }

        //實現介面,對異常進行處理
        public void OnException(ExceptionContext context)
        {
            //記錄異常到日誌
            StringBuilder exMsg = new();
            exMsg.AppendLine($"【異常方法:】{context.HttpContext.Request.Path}");
            exMsg.AppendLine($"【請求類型:】{context.HttpContext.Request.Method}");
            exMsg.AppendLine($"【異常錯誤:】{context.Exception.Message}");
            exMsg.AppendLine($"【堆棧跟蹤:】{context.Exception.StackTrace}");
            logger.LogError(exMsg.ToString());
            // 創建自定義錯誤響應
            var result = new ObjectResult(new { error = context.Exception.Message })
            {
                StatusCode = 400, // 設置適當的HTTP狀態碼
                DeclaredType = typeof(object) // 聲明類型，以確保內容被正確序列化
            };
            // 取消異常的傳播，以防止預設的500錯誤
            context.ExceptionHandled = true;
            // 設置響應結果
            context.Result = result;
        }
    }

Programs裡面添加註入，將其註入進控制器服務。松耦合，控制器相關的依賴，只要裡面有trycatch都可以接收並處理，簡單來說你這程式裡面的異常最終都到這個方法裡面進行處理，並且可以重寫返回結果，不會只報一個500錯誤和一堆的堆棧錯誤信息。註入的代碼如下，我還是單獨弄成模塊類，感覺這樣拆除比較方便，不知道我這種做法是否合理，還是多餘。但我自己看著還是比較順眼的，希望有更多的建議~~~

    public static class ExceptionModule
    {
        public static void AddExceptionModule(this IServiceCollection Services)
        {
            Services.AddControllers(Ex =>
            {
                Ex.Filters.Add<GlobalExceptionFilter>();
            });
        }
    }

builder.Services.AddExceptionModule();//全局異常

撒花~~~結束~~~手動搞個錯誤信息看下返回內容並且看下記錄的日誌~

 歡迎留言，虛心聽取大家建議，聽人勸吃飽飯~~~掰掰~~