.NET?6開發(fā)TodoList應用引入第三方日志庫

更新時間：2021年12月27日 10:51:07 作者：CODE4NOTHING

這篇文章主要介紹了.NET?6開發(fā)TodoList應用引入第三方日志庫，在我們項目開發(fā)的過程中，使用.NET?6自帶的日志系統(tǒng)有時是不能滿足實際需求的，比如有的時候我們需要將日志輸出到第三方平臺，更多詳細內(nèi)容請需要的小伙伴參考下面文章內(nèi)容

1.需求

在我們項目開發(fā)的過程中，使用.NET 6自帶的日志系統(tǒng)有時是不能滿足實際需求的，比如有的時候我們需要將日志輸出到第三方平臺上，最典型的應用就是在各種云平臺上，為了集中管理日志和查詢?nèi)罩?，通常會選擇對應平臺的日志SDK進行集成。使用Serilog提供的多種Sink，可以實現(xiàn)將日志寫入不同云平臺或者是非云平臺的日志存儲中去，這是我們這篇文章講要研究的內(nèi)容。

2.目標

我們將為TodoList添加一個方便替換和擴展的日志策略，簡單來說就是在與具體第三方打交道的Infrastructure項目中實際設(shè)置使用的日志服務，并在Api項目中進行依賴注入，方便在整個應用程序中無具體日志配置感知地使用日志服務。

3.原理和思路

查閱Serilog的官方文檔和一些示例后確定，

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

引入Serilog.AspNetCore包（很多文章或者教程里都讓你根據(jù)需要使用的Sink去繼續(xù)引入類似Serilog.Sink.File之類的包，但是實際上Serilog.AspNetCore包的依賴項里已經(jīng)包含了File這個Sink，所以實際上沒有必要再去添加一次）；
二是需要為Serilog的Logger對象提供一個LoggerConfiguration，可以以代碼的方式進行配置，也可以通過加載.json文件的方式進行配置，看自己的需求和對配置熱更新的有沒有獨特的要求決定；
在程序啟動構(gòu)造WebApplicationBuilder對象的時候聲明UseSerilog()；
在需要使用日志的地方注入ILogger<T>對象即可，我們一般是在構(gòu)造函數(shù)里進行注入，當然也可以選擇其他兩種注入方式。

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

在第二篇文章中，我提到了Clean Architecture，里面有一條原則可以理解為：如果系統(tǒng)需要與外部（第三方）系統(tǒng)進行集成或交互，那么具體的集成工作應該放入Infrastructure層進行處理，而程序的其他部分只對外部服務進行抽象的使用。好處是今后如果需要替換第三方系統(tǒng)，比如原本日志是寫到本地文件里，后來有了上云和日志集中化處理的需求，需要將日志服務對接到諸如Azure App Service Logging或者AWS CloudWatch，那么我們只需要去修改（擴展）Infrastructure中進行日志具體配置的邏輯就可以了。雖然日志服務本身相對比較簡單，還不能很好地體現(xiàn)這個優(yōu)點，我們姑且遵循這個原則，將配置工作放到Infrastructure里面去。

4.實現(xiàn)

4.1日志配置實現(xiàn)

我們在TodoList.Infrastructure項目中新增一個文件夾，取名Log，在其中新建文件ConfigureLogProvider.cs，實現(xiàn)一個針對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"))
        {
            // 配置同時輸出到控制臺和文件，并且指定文件名和文件轉(zhuǎn)儲方式（形如log-20211219.txt格式），轉(zhuǎn)儲文件保留的天數(shù)為15天，以及日志格式
            // 配置Enrich.FromLogContext()的目的是為了從日志上下文中獲取一些關(guān)鍵信息諸如用戶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 TodoList.Infrastructure.Log;

var builder = WebApplication.CreateBuilder(args);

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

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

并向appsettings.Development.json文件中添加用于測試的配置項：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "UseFileToLog": true
}

4.3注入使用

嗯……我把第二篇文章結(jié)束時刪除的示例WeatherForecastController.cs和WeatherForecast.cs又加回來了。Controller中已經(jīng)注入了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();
}

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