nanoFramework.Logging.Stream 1.1.108

欢迎来到 .NET nanoFramework nanoFramework.Logging 库存储库

构建状态

组件	构建状态	NuGet 包
nanoFramework.Logging
nanoFramework.Logging.Serial
nanoFramework.Logging.Stream
nanoFramework.Logging.Syslog

反馈和文档

有关文档、提供反馈、问题以及了解如何贡献，请参阅 主页存储库。

加入我们的 Discord 社区 此处。

致谢

此项目的贡献者列表可在 CONTRIBUTORS 中找到。

许可证

nanoFramework 类库根据 MIT 许可证 许可。

用法

在您的类中，确保您有一个全局 ILogger 声明，并在构造函数中调用 _logger = this.GetCurrentClassLogger();

using Microsoft.Extensions.Logging;
using nanoFramework.Logging;
using System;

namespace UnitTestDebugLogging
{
    internal class MyTestComponent
    {
        private ILogger _logger;

        public MyTestComponent()
        {
            _logger = this.GetCurrentClassLogger();
        }

        public void DoSomeLogging()
        {
            _logger.LogInformation("An informative message");
            _logger.LogError("An error situation");
            _logger.LogWarning(new Exception("Something is not supported"), "With exception context");
        }
    }
}

在您的主代码中，您需要创建一个日志记录器

LogDispatcher.LoggerFactory = new DebugLoggerFactory();
// Then you can create your object and the logging will happen
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

您可以有 3 种不同类型的日志记录器：调试、串行和流。

调试日志记录器

如前所述，您可以使用工厂模式

LogDispatcher.LoggerFactory = new DebugLoggerFactory();
// Then you can create your object and the logging will happen
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

您还可以直接创建一个DebugLogger

DebugLogger _logger;
_logger = new DebugLogger("test");
_logger.MinLogLevel = LogLevel.Trace; 
_logger.LogTrace("This is a trace");

串行日志记录器

您还可以使用工厂模式

LogDispatcher.LoggerFactory = new SerialLoggerFactory("COM6");
// Then you can create your object and the logging will happen
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

注意，您可以调整波特率以及所有其他元素。

或者直接使用SerialLogger

SerialPort _serial;
_serial = new SerialPort("COM6", 115200);
SerialLogger _logger = new SerialLogger(ref _serial);
_logger.MinLogLevel = LogLevel.Trace; 
_logger.LogTrace("This is a trace");

重要：确保参考您的电路板文档来了解如何正确设置串行端口。以下示例是针对ESP32的。

流日志记录器

与其他类似，您可以在LoggerFactory中使用FileStream或Stream

MemoryStream memoryStream = new MemoryStream();
LogDispatcher.LoggerFactory = new StreamLoggerFactory(memoryStream);
MyTestComponent test = new MyTestComponent();
test.DoSomeLogging();

您同样也可以直接使用它

var _stream = new FileStream("D:\\mylog.txt", FileMode.Open, FileAccess.ReadWrite);
StreamLogger _logger = new StreamLogger(_stream);
_logger.MinLogLevel = LogLevel.Trace; 
_logger.LogTrace("This is a trace");

重要：请参考USB和SD卡读卡器的文档，确保在尝试设置日志记录器之前它们被正确设置。

创建自己的日志记录器

您可以使用ILogger和ILoggerFactory接口创建自己的日志记录器。DebugLogger是最简单的一个。

日志扩展

提供了不同的日志扩展，可以帮助您按自己的喜好进行日志记录。您可以简单记录一个字符串或带有参数，以及异常和EventId

_logger.LogTrace("TRACE {0} {1}", new object[] { "param 1", 42 });
_logger.LogDebug("DEBUG {0} {1}", new object[] { "param 1", 42 });
_logger.LogInformation("INFORMATION and nothing else");
_logger.LogWarning("WARNING {0} {1}", new object[] { "param 1", 42 });
_logger.LogError(new Exception("Big problem"), "ERROR {0} {1}", new object[] { "param 1", 42 });
_logger.LogCritical(42, new Exception("Insane problem"), "CRITICAL {0} {1}", new object[] { "param 1", 42 });

注意，所有日志级别扩展都具备最低的字符串记录功能，从EventId、字符串、参数到异常。参数存在时，您有责任正确格式化字符串。

日志级别

您可以调整所有预定义日志记录器的日志级别。例如

DebugLogger _logger;
_logger = new DebugLogger("test");
_logger.MinLogLevel = LogLevel.Trace;
_logger.LogTrace("This will be displayed");
_logger.LogCritical("Critical message will be displayed");
_logger.MinLogLevel = LogLevel.Critical;
_logger.LogTrace("This won't be displayed, only critical will be");
_logger.LogCritical("Critical message will be displayed");

创建自己的格式

您可以使用自定义格式化程序，这将为您提供日志记录器的名称、日志级别、事件ID、消息本身以及潜在的异常。函数定义应遵循以下模式

public interface IMessageFormatter
{     
    string MessageFormatter(string className, LogLevel logLevel, EventId eventId, string state, Exception exception);
}

重要：此函数将直接调用，而不会实例化该函数所属的类。因此，请确保该函数是静态的，或者是使用日志记录器的类的一部分。静态选项始终有效。该接口提供方便，并且给出格式。

要设置格式，请使用以下行。需要包含函数所在的类的类型和函数的确切名称。

LoggerExtensions.MessageFormatter = typeof(MyFormatter).GetType().GetMethod("MessageFormatterStatic");

public class MyFormatter
{        
    public string MessageFormatterStatic(string className, LogLevel logLevel, EventId eventId, string state, Exception exception)
    {
        string logstr = string.Empty;
        switch (logLevel)
        {
            case LogLevel.Trace:
                logstr = "TRACE: ";
                break;
            case LogLevel.Debug:
                logstr = "I love debug: ";
                break;
            case LogLevel.Warning:
                logstr = "WARNING: ";
                break;
            case LogLevel.Error:
                logstr = "ERROR: ";
                break;
            case LogLevel.Critical:
                logstr = "CRITICAL:";
                break;
            case LogLevel.None:
            case LogLevel.Information:
            default:
                break;
        }

        string eventstr = eventId.Id != 0 ? $" Event ID: {eventId}, " : string.Empty;
        string msg = $"[{className}] {eventstr}{logstr} {state}";
        if (exception != null)
        {
            msg += $" {exception}";
        }

        return msg;
    }
}

您可以使用任何所需的内容并按自己的喜好格式化消息。

注意：不需要在结尾添加\r\n，这由每个日志记录器自动完成。

行为准则

本项目已采用贡献者协议中定义的行为准则，以阐明我们社区中预期的行为。有关更多信息，请参阅.NET Foundation行为准则。

.NET Foundation

本项目由.NET Foundation支持。