Microsoft.Extensions.Logging.Abstractions 8.0.1

关于

Microsoft.Extensions.Logging.Abstractions提供了日志的抽象。该包中定义的接口由Microsoft.Extensions.Logging和其他日志库中的类实现。

此包包含一个日志源生成器，可生成用于日志消息方法的高效和优化代码。

主要功能

• 定义主要的日志抽象接口，如 ILogger、ILoggerFactory、ILoggerProvider 等。

如何使用

自定义日志提供者实现示例

using Microsoft.Extensions.Logging;

public sealed class ColorConsoleLogger : ILogger
{
    private readonly string _name;
    private readonly Func<ColorConsoleLoggerConfiguration> _getCurrentConfig;

    public ColorConsoleLogger(
        string name,
        Func<ColorConsoleLoggerConfiguration> getCurrentConfig) =>
        (_name, _getCurrentConfig) = (name, getCurrentConfig);

    public IDisposable? BeginScope<TState>(TState state) where TState : notnull => default!;

    public bool IsEnabled(LogLevel logLevel) =>
        _getCurrentConfig().LogLevelToColorMap.ContainsKey(logLevel);

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

        ColorConsoleLoggerConfiguration config = _getCurrentConfig();
        if (config.EventId == 0 || config.EventId == eventId.Id)
        {
            ConsoleColor originalColor = Console.ForegroundColor;

            Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
            Console.WriteLine($"[{eventId.Id,2}: {logLevel,-12}]");

            Console.ForegroundColor = originalColor;
            Console.Write($"     {_name} - ");

            Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
            Console.Write($"{formatter(state, exception)}");

            Console.ForegroundColor = originalColor;
            Console.WriteLine();
        }
    }
}

创建日志

// Worker class that uses logger implementation of teh interface ILogger<T>

public sealed class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;

    public Worker(ILogger<Worker> logger) =>
        _logger = logger;

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogInformation("Worker running at: {time}", DateTimeOffset.UtcNow);
            await Task.Delay(1_000, stoppingToken);
        }
    }
}

使用源生成器

public static partial class Log
{
    [LoggerMessage(
        EventId = 0,
        Level = LogLevel.Critical,
        Message = "Could not open socket to `{hostName}`")]
    public static partial void CouldNotOpenSocket(this ILogger logger, string hostName);
}

public partial class InstanceLoggingExample
{
    private readonly ILogger _logger;

    public InstanceLoggingExample(ILogger logger)
    {
        _logger = logger;
    }

    [LoggerMessage(
        EventId = 0,
        Level = LogLevel.Critical,
        Message = "Could not open socket to `{hostName}`")]
    public partial void CouldNotOpenSocket(string hostName);
}

主要类型

本库提供的主要类型包括

• Microsoft.Extensions.Logging.ILogger
• Microsoft.Extensions.Logging.ILoggerProvider
• Microsoft.Extensions.Logging.ILoggerFactory
• Microsoft.Extensions.Logging.ILogger
• Microsoft.Extensions.Logging.LogLevel
• Microsoft.Extensions.Logging.Logger
• Microsoft.Extensions.Logging.LoggerMessage
• Microsoft.Extensions.Logging Abrams

附加文档

• 概念性文档
• API 文档

相关包

反馈与贡献

Microsoft.Extensions.Logging Abrams 以开源形式发布，许可协议为 MIT 协议。欢迎提交错误报告和贡献至 GitHub 仓库。