在.net中透過自定義LoggerProvider將日誌儲存到資料庫方法（以mysql為例）

架構師老盧發表於2023-12-07
IDE資料庫MySql
在.net中透過自定義LoggerProvider將日誌儲存到資料庫方法（以mysql為例）

 

在.NET中，
Microsoft.Extensions.Logging是一個靈活的日誌庫，它允許你將日誌資訊記錄到各種不同的目標，包括資料庫。在這個示例中，我將詳細介紹如何使用Microsoft.Extensions.Logging將日誌儲存到MySQL資料庫。我們將使用Entity Framework Core來與MySQL資料庫進行互動。

步驟一：建立.NET Core專案

首先，我們需要建立一個.NET Core專案。你可以使用Visual Studio、Visual Studio Code或者命令列工具來建立專案。在建立專案時，確保選擇一個合適的專案型別，比如控制檯應用程式或Web應用程式，以便測試和演示日誌記錄到MySQL資料庫的功能。

步驟二：安裝必要的NuGet包

為了能夠將日誌記錄到MySQL資料庫，我們需要安裝一些必要的NuGet包。開啟專案的.csproj檔案，新增以下包引用：

<ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="5.0.0" />
    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="5.0.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="5.0.0" />
    <PackageReference Include="MySql.EntityFrameworkCore" Version="5.0.5" />
</ItemGroup>

這些包包括
Microsoft.Extensions.Logging用於日誌記錄，Microsoft.EntityFrameworkCore和MySql.EntityFrameworkCore用於與MySQL資料庫進行互動。

執行以下命令以還原專案中的NuGet包：

dotnet restore

步驟三：配置日誌記錄

在專案的Program.cs檔案中，配置Logger和資料庫上下文。以下是示例程式碼：

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Console;
using Microsoft.Extensions.Logging.Configuration;

class Program
{
    static void Main()
    {
        var serviceProvider = new ServiceCollection()
            .AddLogging(builder =>
            {
                builder.AddConsole(); // 輸出到控制檯
                builder.AddMySqlDatabase("Server=localhost;Database=mydatabase;User=root;Password=mypassword;");
            })
            .BuildServiceProvider();

        var logger = serviceProvider.GetRequiredService<ILogger<Program>>();

        logger.LogInformation("這是一條資訊日誌");
        logger.LogWarning("這是一條警告日誌");
        logger.LogError("這是一條錯誤日誌");
    }
}

在上述程式碼中，我們首先建立了一個ServiceCollection，然後配置了Logger以將日誌輸出到控制檯和MySQL資料庫。在AddMySqlDatabase方法中，我們傳遞了MySQL資料庫的連線字串。你需要將其替換為你自己的資料庫連線資訊。

步驟四：建立資料庫上下文

我們需要建立一個資料庫上下文，以便Entity Framework Core知道如何與MySQL資料庫進行互動。建立一個名為AppDbContext的類，繼承自DbContext，並新增一個DbSet來表示日誌表。以下是示例程式碼：

using Microsoft.EntityFrameworkCore;

public class AppDbContext : DbContext
{
    public DbSet<LogEntry> LogEntries { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseMySql("Server=localhost;Database=mydatabase;User=root;Password=mypassword;");
    }
}

在上述程式碼中，我們定義了一個LogEntries DbSet來表示日誌表。我們還在OnConfiguring方法中配置了資料庫連線字串。

步驟五：建立日誌實體

我們需要建立一個表示日誌的實體類。建立一個名為LogEntry的類，包括一些基本屬性，如時間戳、日誌級別和訊息。以下是示例程式碼：

public class LogEntry
{
    public int Id { get; set; }
    public DateTimeOffset Timestamp { get; set; }
    public LogLevel LogLevel { get; set; }
    public string Message { get; set; }
}

在上述程式碼中，我們定義了Id、Timestamp、LogLevel和Message屬性來儲存日誌資訊。

步驟六：編寫MySQL日誌提供程式

為了將日誌記錄到MySQL資料庫，我們需要編寫一個自定義的日誌提供程式。建立一個名為
MySqlDatabaseLoggerProvider的類，繼承自LoggerProvider，並實現相關方法。以下是示例程式碼：

using System;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.EntityFrameworkCore;

public class MySqlDatabaseLoggerProvider : LoggerProvider
{
    private readonly IServiceProvider _serviceProvider;

    public MySqlDatabaseLoggerProvider(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public override ILogger CreateLogger(string categoryName)
    {
        return new MySqlDatabaseLogger(categoryName, _serviceProvider);
    }

    public override void Dispose()
    {
    }
}

在上述程式碼中，我們建立了一個
MySqlDatabaseLoggerProvider類，它負責建立MySqlDatabaseLogger例項。

步驟七：編寫MySQL日誌記錄器

建立一個名為MySqlDatabaseLogger的類，繼承自ILogger，並實現相關方法。以下是示例程式碼：

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.EntityFrameworkCore;
using System;

public class MySqlDatabaseLogger : ILogger
{
    private readonly string _categoryName;
    private readonly IServiceProvider _serviceProvider;

    public MySqlDatabaseLogger(string categoryName, IServiceProvider serviceProvider)
    {
        _categoryName = categoryName;
        _serviceProvider = serviceProvider;
    }

    public IDisposable BeginScope<TState>(TState state)
    {
        return null;
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return true;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }

        var message = formatter(state, exception);
        var timestamp = DateTimeOffset.Now;

        using (var scope = _serviceProvider.CreateScope())
        {
            var dbContext = scope.ServiceProvider.GetRequiredService<AppDbContext>();
            dbContext.LogEntries.Add(new LogEntry
            {
                Timestamp = timestamp,
                LogLevel = logLevel,
                Message = message
            });
            dbContext.SaveChanges();
        }
    }
}

在上述程式碼中，我們建立了一個MySqlDatabaseLogger類，它實現了ILogger介面的方法。在Log方法中，我們將日誌訊息儲存到

MySQL資料庫中。

步驟八：註冊MySQL日誌提供程式

在Program.cs檔案中，我們需要註冊自定義的MySQL日誌提供程式。以下是示例程式碼：

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Console;
using Microsoft.Extensions.Logging.Configuration;

class Program
{
    static void Main()
    {
        var serviceProvider = new ServiceCollection()
            .AddLogging(builder =>
            {
                builder.AddConsole(); // 輸出到控制檯
                builder.AddProvider(new MySqlDatabaseLoggerProvider(serviceProvider));
            })
            .BuildServiceProvider();

        var logger = serviceProvider.GetRequiredService<ILogger<Program>>();

        logger.LogInformation("這是一條資訊日誌");
        logger.LogWarning("這是一條警告日誌");
        logger.LogError("這是一條錯誤日誌");
    }
}

在上述程式碼中，我們透過AddProvider方法註冊了自定義的MySQL日誌提供程式。

步驟九：執行應用程式

現在，你可以執行應用程式，它將記錄日誌到MySQL資料庫中。你可以在資料庫中檢視日誌資訊並進行分析。

透過上述步驟，你可以將日誌記錄到MySQL資料庫中，使用了
Microsoft.Extensions.Logging、Entity Framework Core和自定義的日誌提供程式。這使你能夠更靈活地管理日誌，並能夠輕鬆地將日誌資訊儲存到資料庫中以供進一步分析和監控。

 

相關文章