1.需求

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

2.目標(biāo)

我們將為TodoList添加一個(gè)方便替換和擴(kuò)展的日志策略，簡(jiǎn)單來(lái)說(shuō)就是在與具體第三方打交道的Infrastructure項(xiàng)目中實(shí)際設(shè)置使用的日志服務(wù)，并在Api項(xiàng)目中進(jìn)行依賴注入，方便在整個(gè)應(yīng)用程序中無(wú)具體日志配置感知地使用日志服務(wù)。

3.原理和思路

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

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

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

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

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

4.實(shí)現(xiàn)

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

我們?cè)赥odoList.Infrastructure項(xiàng)目中新增一個(gè)文件夾，取名Log，在其中新建文件ConfigureLogProvider.cs，實(shí)現(xiàn)一個(gè)針對(duì)WebApplicationBuilder的擴(kuò)展方法，為了演示在這里配置的擴(kuò)展性，我多用了一個(gè)appsettings.json中的字段來(lái)控制配置過(guò)程，缺失的包需要安裝一下。

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"))
        {
            // 配置同時(shí)輸出到控制臺(tái)和文件，并且指定文件名和文件轉(zhuǎn)儲(chǔ)方式（形如log-20211219.txt格式），轉(zhuǎn)儲(chǔ)文件保留的天數(shù)為15天，以及日志格式
            // 配置Enrich.FromLogContext()的目的是為了從日志上下文中獲取一些關(guān)鍵信息諸如用戶ID或請(qǐng)求ID，我們的應(yīng)用中暫時(shí)不使用這些。
            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
        {
            // 僅配置控制臺(tái)日志
            Serilog.Log.Logger = new LoggerConfiguration()
                .Enrich.FromLogContext()
                .WriteTo.Console()
                .CreateLogger();
        }

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

4.2主程序配置

在TodoList.Api項(xiàng)目的Main.cs中，使用該擴(kuò)展方法：

using TodoList.Infrastructure.Log;

var builder = WebApplication.CreateBuilder(args);

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

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

并向appsettings.Development.json文件中添加用于測(cè)試的配置項(xiàng)：

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

4.3注入使用

嗯……我把第二篇文章結(jié)束時(shí)刪除的示例WeatherForecastController.cs和WeatherForecast.cs又加回來(lái)了。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();
}

好了，到此為止我們就可以驗(yàn)證一下了。

5.驗(yàn)證

運(yùn)行TodoList.Api項(xiàng)目，和第二篇文章一樣，我們使用Hoppscotch測(cè)試示例接口，觀察控制臺(tái)和日志文件的輸出內(nèi)容和格式：

控制臺(tái)輸出

文件輸出

總結(jié)：

在這篇文章中，我向大家展示了如何在.NET 6 Web API項(xiàng)目中添加第三方日志服務(wù)框架，下一篇文章將會(huì)引入數(shù)據(jù)存儲(chǔ)服務(wù)。

到此這篇關(guān)于.NET 6開(kāi)發(fā)TodoList應(yīng)用引入第三方日志庫(kù)的文章就介紹到這了,更多相關(guān)使用.NET 6 TodoList引入第三方日志庫(kù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論