目錄

• 1.需求
• 2.目標
• 3.原理和思路
• 4.實現
• 4.1日誌配置實現
  
• 4.2主程式配置
  
• 4.3注入使用
  
• 5.驗證

1.需求

在我們專案開發的過程中，使用.NET 6自帶的日誌系統有時是不能滿足實際需求的，比如有的時候我們需要將日誌輸出到第三方平臺上，最典型的應用就是在各種雲平臺上，為了集中管理日誌和查詢日誌，通常會選擇對應平臺的日誌SDK進行整合。使用SerppmeJwHNilog提供的多種Sink，可以實現將日誌寫入不同雲平臺或者是非雲平臺的日誌儲存中去，這是我們這篇文章講要研究的內容。

2.目標

我們將為TodoList新增一個方便替換和擴充套件的日誌策略，簡單來說就是在與具體第三方打交道的Infrastructure

3.原理和思路

查閱Serilog的官方文件和一些示例後確定，

我們要做的事情有這麼幾件：

• 引入Serilog.AspNetCore包（很多文章或者教程裡都讓你根據需要使用的Sink去繼續引入類似Serilog.Sink.File之類的包，但是實際上Serilog.AspNetCore包的依賴項裡已經包含了File這個Sink，所以實際上沒有必要再去新增一次）；
• 二是需要為Serilog的Logger物件提供一個LoggerConfiguration，可以以程式碼的方式進行配置，也可以通過載入.on檔案的方式進行配置，看自己的需求和對配置熱更新的有沒有獨特的要求決定；
• 在程式啟動構造WebApplicationBuilder物件的時候宣告UseSerilog()；
• 在需要使用日誌的地方注入ILogger<T>物件即可，我們一般是在建構函式裡進行注入，當然也可以選擇其他兩種注入方式。
  

好了，瞭解了原理，接下來一步就是想一下我們要在哪裡做這幾件事。

在第二篇文章中，我提到了Clean Architecture，裡面有一條原則可以理解為：如果系統需要與外部（第三方）系統進行整合或互動，那麼具體的整合工作應該放入Infrastructure層進行處理，而程式的其他部分只對外部服務進行抽象的使用。好處是今後如果需要替換第三方系統，比如原本日誌是寫到本地檔案裡，後來有了上雲和日誌集中化處理的需求，需要將日誌服務對接到諸如Azure App Service Logging

4.實現

4.1日誌配置實現

我們在TodoList.Infrastructure專案中新增一個資料夾，取名Log，在其中新建檔案ConfigureLogProvider.cs，實現一個針對WebApplicationBuilder的擴充套件方法，為了演示在這裡配置的擴充套件性，我多用了一個appsettings.json中的欄位來控制配置過程，缺失的包需要安裝一下。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Serilog;

namespace TodoList.Infrastructure.Log;

public static class ConfigureLogProvider
{
    public static void ConfigureLog(this WebApplicationBuilder builder)
    {
        if (builder.Configuration.GetValue<bool>("UseFileToLog"))
        {
            // 配置同時輸出到控制檯和檔案，並且指定檔名和檔案轉儲方式（形如log-20211219.txt格式），轉儲檔案保留的天數為15天，以及日誌格式
            // 配置Enrich.FromLogContext()的目的是為了從日誌上下文中獲取一些關鍵資訊諸如使用者ID或請求ID，我們的應用中暫時不使用這些。
            Serilog.Log.Logger = new LoggerConfiguration()
                .Enrich.FromLogContext()
                .WriteTo.Console()
                .WriteTo.File(
                    "logs/log-.txt",outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}",rollingInterval: RollingInterval.Day,retainedFileCountLimit: 15)
                .CreateLogger();
        }
        else
        {
            // 僅配置控制檯日誌
            Serilog.Log.Logger = new LoggerConfiguration()
                .Enrich.FromLogContext()
                .WriteTo.Console()
                .CreateLogger();
        }

        // 使用Serilog作為日誌框架，注意這裡和.NET 5及之前的版本寫法是不太一樣的。
        builder.Host.UseSerilog();
    }
}

4.2主程式配置

在TodoList.Api專案的Main.cs中，使用該擴充套件方法：

using TodoLi客棧st.Infrastructure.Log;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
// 配置日誌
builder.ConfigureLog();

builder.Services.AddControllers();
// ... 省略以下

並向appsettings.Development.json檔案中新增用於測試的配置項：

{
  "Logging": {
    "LogLevel": {
      "Defhttp://www.cppcns.comault": "Information","Microsoft.AspNetCore": "Warning"
    }
  },"UseFileToLog": true
}

4.3注入使用

嗯……我把第二篇文章結束時刪除的示例WeatherForecastController.cs和WeatherForecast.cs又加回來了。Controller中已經注入了ILogger<WeatherForecastController>，我們就在示例的接口裡試一下：

[HttpGet(Name = "GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get()
{
    // 記錄日誌
    _logger.LogInformation($"maybe this log is provided by Serilog...");

    return Enumerable.Range(1,5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),TemperatureC = Random.Shared.Next(-20,55),Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

好了，到此為止我們就可以驗證一下了。

5.驗證

執行TodoList.Api專案，和第二篇文章一樣，我們使用Hoppscotch測試示例介面，觀察控制檯和日誌檔案的輸出內容和格式：

控制檯輸出

檔案輸出

總結：

在這篇文章中，我向大家展示瞭如何在.NET 6 Web API專案中新增第三方日誌服務框架，下一篇文章將會引入資料儲存服務。

到此這篇關於.NET 6開發TodoList應用引入第三方日誌庫的文章就介紹到這了,更多相關使用.NET 6 TodoList引入第三方日誌庫內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！