您现在的位置是：网站首页> 编程资料编程资料

.Net Core日志记录的核心机制_实用技巧_

2023-05-24 276人已围观

简介 .Net Core日志记录的核心机制_实用技巧_

一、前言

回顾：日志记录之日志配置揭秘 
在上一篇中，我们已经了解了内置系统的默认配置和自定义配置的方式，在学习了配置的基础上，我们进一步的对日志在程序中是如何使用的深入了解学习。所以在这一篇中，主要是对日志记录的核心机制进行学习说明。

二、说明

在上一篇中，我们留下了两个问题

日志记录的输出可以在哪里查看？而又由什么实现决定的呢？

如何管理输出不同的日志呢？都有哪些方式呢？

第一个问题：在官方的实现有：Console 、Debug 、EventSource 、EventLog 、TraceSource 、Azure App Service，还有一些第三方实现，当然了我们自己也是可以实现的。 是由ILoggerProvider 接口来决定实现的。

第二个问题：由 log Level、EventId、Logger Provider、Log filtering、Log category、Log scopes 合作解决。

由上面的问题可以发现，我们可以实现多种不同的输出目标方式来实现写日志记录，但是又如何控制在写日志这个操作不变的情况下，实现不同的输入目标，这个时候我们就会想到，可以通过抽象的方式，将写日志这个操作动作抽象出来，而输出目标依赖这个动作实现具体的操作。所以当我们调用写日志操作方法的时候，由此依次调用对应的具体实现方法，把日志写到具体的目标上。

这个过程具体是怎么实现的呢？我们接着往下看。

三、开始

其实在学习之前，我们应该都已经了解.net core框架有一个重要的特征就是依赖注入，通过在应用启动时候，将各种定义好的实现类型放入到一个集合容器中，通过在运行时，将从集合容器中取出放入对应的类型中。

日志记录的的实现方式也离不开这个。下面让我们一起来看看。

3.1 日志记录器工厂

3.1.1 ILoggerFactory 接口

public interface ILoggerFactory : IDisposable { ILogger CreateLogger(string categoryName); void AddProvider(ILoggerProvider provider); }

ILoggerFactory是日志记录器的工厂接口类，用于配置日志记录系统并创建Logger实例的类，默认实现两个接口方法为，通过CreateLogger()方法来创建ILogger实例，（其中参数categoryName是一个日志类别，用于调用Logger所在类的全名，类别指明日志消息是谁写入的，一般我们将日志所属的的组件、服务或者消息类型名称作为日志类别。） 而AddProvider()添加日志记录提供程序，向日志系统注册添加一个ILoggerProvider。工厂接口类的默认实现类为LoggerFactory , 我们继续往下看：

3.1.2 LoggerFactory 实现

ILoggerFactory 的默认实现是 LoggerFactory ,在构造函数中，如下：

 public class LoggerFactory : ILoggerFactory { private static readonly LoggerRuleSelector RuleSelector = new LoggerRuleSelector(); private readonly Dictionary _loggers = new Dictionary(StringComparer.Ordinal); private readonly List _providerRegistrations = new List(); private readonly object _sync = new object(); private volatile bool _disposed; private IDisposable _changeTokenRegistration; private LoggerFilterOptions _filterOptions; private LoggerExternalScopeProvider _scopeProvider; public LoggerFactory() : this(Enumerable.Empty()) { } public LoggerFactory(IEnumerable providers) : this(providers, new StaticFilterOptionsMonitor(new LoggerFilterOptions())) { } public LoggerFactory(IEnumerable providers, LoggerFilterOptions filterOptions) : this(providers, new StaticFilterOptionsMonitor(filterOptions)) { } public LoggerFactory(IEnumerable providers, IOptionsMonitor filterOption) { foreach (var provider in providers) { AddProviderRegistration(provider, dispose: false); } _changeTokenRegistration = filterOption.OnChange(RefreshFilters); RefreshFilters(filterOption.CurrentValue); } private void AddProviderRegistration(ILoggerProvider provider, bool dispose) { _providerRegistrations.Add(new ProviderRegistration { Provider = provider, ShouldDispose = dispose }); if (provider is ISupportExternalScope supportsExternalScope) { if (_scopeProvider == null) { _scopeProvider = new LoggerExternalScopeProvider(); } supportsExternalScope.SetScopeProvider(_scopeProvider); } } }

从LoggerFactory 中 的构造函数中可以发现，通过注入的方式获取到ILoggerProvider（这个在下文中会说明），并调用AddProviderRegistration方法添加注册程序，将ILoggerProvider保存到ProviderRegistration集合中。

AddProviderRegistration 方法：

这是一个日志程序提供器，将ILoggerProvider保存到ProviderRegistration集合中。当日志提供器实现 ISupportExternalScope 接口将单例 LoggerExternalScopeProvider 保存到 provider._scopeProvider 中。

ProviderRegistration集合:

private struct ProviderRegistration { public ILoggerProvider Provider; public bool ShouldDispose; }

其中的 ShouldDispose 字段标识在在LoggerFactory生命周期结束之后，该ILoggerProvider是否需要释放。虽然在系统中LoggerFactory为单例模式，但是其提供了一个静态方法生成一个可释放的DisposingLoggerFactory。

在LoggerFactory 实现默认的接口方法CreateLogger(),AddProvider()

查看源码如下：

CreateLogger

创建ILogger实例，CreateLogger() 源码如下：

 public class LoggerFactory : ILoggerFactory { private readonly Dictionary _loggers = new Dictionary(StringComparer.Ordinal); private readonly List _providerRegistrations = new List(); private struct ProviderRegistration { public ILoggerProvider Provider; public bool ShouldDispose; } public ILogger CreateLogger(string categoryName) { if (CheckDisposed()) { throw new ObjectDisposedException(nameof(LoggerFactory)); } lock (_sync) { if (!_loggers.TryGetValue(categoryName, out var logger)) { logger = new Logger { Loggers = CreateLoggers(categoryName), }; (logger.MessageLoggers, logger.ScopeLoggers) = ApplyFilters(logger.Loggers); _loggers[categoryName] = logger; } return logger; } } private LoggerInformation[] CreateLoggers(string categoryName) { var loggers = new LoggerInformation[_providerRegistrations.Count]; for (var i = 0; i < _providerRegistrations.Count; i++) { loggers[i] = new LoggerInformation(_providerRegistrations[i].Provider, categoryName); } return loggers; } }

从源码可以看出，CreateLogger方法中，会检测资源是否被释放，在方法中，根据内部定义的字典集合Dictionary _loggers,判断字典中是否存在对应的Logger属性对象，如果不存在，会调用CreateLoggers方法根据之前注册的的所有ILoggerProvider 所创建出来 ProviderRegistration 集合来实现创建Logger属性集合（根据日志类别生成了对应实际的日志写入类FileLogger、ConsoleLogger等），并通过字典集合的方式保存categoryName和对应的Logger。

创建 Logger 需要的 LoggerInformation[]

internal readonly struct LoggerInformation { public LoggerInformation(ILoggerProvider provider, string category) : this() { ProviderType = provider.GetType(); Logger = provider.CreateLogger(category); Category = category; ExternalScope = provider is ISupportExternalScope; } public ILogger Logger { get; } public string Category { get; } public Type ProviderType { get; } public bool ExternalScope { get; } }

根据注册的ILoggerProvider，创建ILogger 其中的字段说明：

Logger ：具体日志类别写入途径实现类

Category ： 日志类别名称

ProviderType ： 日志提供器Type

ExternalScope ：是否支持 ExternalScope

继续看CreateLogger方法，在创建Logger之后，还调用了ApplyFilters方法：

 private (MessageLogger[] MessageLoggers, ScopeLogger[] ScopeLoggers) ApplyFilters(LoggerInformation[] loggers) { var messageLoggers = new List(); var scopeLoggers = _filterOptions.CaptureScopes ? new List() : null; foreach (var loggerInformation in loggers) { RuleSelector.Select(_filterOptions, loggerInformation.ProviderType, loggerInformation.Category, out var minLevel, out var filter); if (minLevel != null && minLevel > LogLevel.Critical) { continue; } messageLoggers.Add(new MessageLogger(loggerInformation.Logger, loggerInformation.Category, loggerInformation.ProviderType.FullName, minLevel, filter)); if (!loggerInformation.ExternalScope) { scopeLoggers?.Add(new ScopeLogger(logger: loggerInformation.Logger, externalScopeProvider: null)); } } if (_scopeProvider != null) { scopeLoggers?.Add(new ScopeLogger(logger: null, externalScopeProvider: _scopeProvider)); } return (messageLoggers.ToArray(), scopeLoggers?.ToArray()); }

由源码可以看出，

MessageLogger[] 集合取值：

在获取LoggerInformation[]后进行传参，进行遍历，根据RuleSelector过滤器，从配置文件中读取对应的日志级别，过滤器会返回获取最低级别和对应的一条过滤规则，如果配置文件中没有对应的配置，默认取全局最低级别（MinLevel）,如果读取到的日志级别大于LogLevel.Critical,则将其加入MessageLogger[]。

过滤器的规则：

选择当前记录器类型的规则，如果没有，请选择未指定记录器类型的规则

选择最长匹配类别的规则

如果没有与类别匹配的内容，则采用所有没有类别的规则

如果只有一条规则，则使用它的级别和过滤器

如果有多个规则，请选择使用最后一条。

如果没有适用的规则，请使用全局最低级别

通过MessageLogger[]添加消息日志集合

internal readonly 
                
                

                

                                            
上一篇：.Net Core日志记录之日志配置_实用技巧_

                                                                
下一篇：.Net Core使用Logger实现log写入本地文件系统_实用技巧_

相关内容

点击排行

本栏推荐

猜你喜欢

-六神源码网