2.2.1 核心模块--日志的基础使用
官方文档:https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/logging/?view=aspnetcore-5.0
1、ILogger 的使用
在 Get 方法中添加日志
WeatherForecastController.cs
private readonly ILogger<WeatherForecastController> _logger; public WeatherForecastController(ILogger<WeatherForecastController> logger) { _logger = logger; } _logger.LogInformation("Get action executed");
2、日志的 ID
_logger.LogInformation(new EventId(1001, "Action"), "Get action executed");
3、日志的分类
根据不同的类名区分
private readonly ILogger<WeatherForecastController> _logger; private readonly ILogger _myLogger; public WeatherForecastController(ILogger<WeatherForecastController> logger, ILoggerFactory loggerFactory) { _logger = loggerFactory.CreateLogger<WeatherForecastController>(); _myLogger = loggerFactory.CreateLogger("MyLogger");// 通过自己的分类 MyLogger 创建 }
4、日志的级别
LogLevel | Value | Method | Description | 推荐使用场景 |
---|---|---|---|---|
Trace | 0 | LogTrace | 跟踪日志:粒度细,非常详细跟踪日志,包括方法的进入结束。一般是用于sdk、或者一些基础设施上 | 开发环境/特殊环境 |
Debug | 1 | LogDebug | 调试日志:记录一些比较容易出错的一些跟踪信息 | 开发环境/特殊环境 |
Information | 2 | LogInformation | 信息:生产级别开启。相对来说比较重要的节点:比如订单支付成功、取消成功 | 生产 |
Warning | 3 | LogWarning | 警告:有一定错误,但不影响结果执行 | 生产 |
Error | 4 | LogError | 错误:导致程序不能正常往下执行业务的错误 | 生产 |
Critical | 5 | LogCritical | 致命:记录信息要求,系统崩溃 | 生产 |
None | 6 |
5、LoggerProvider
ILoggerProvider.cs
using System; namespace Microsoft.Extensions.Logging { /// <summary> /// Represents a type that can create instances of <see cref="ILogger"/>. /// </summary> public interface ILoggerProvider : IDisposable { /// <summary> /// Creates a new <see cref="ILogger"/> instance. /// </summary> /// <param name="categoryName">The category name for messages produced by the logger.</param> /// <returns></returns> ILogger CreateLogger(string categoryName); } }
6、日志的设计模式
支持不同类型的日志输出,可以自定义一个 LoggerProvider
打印容器中所有注入的 LoggerProvider
Program.cs
var providers = host.Services.GetServices<ILoggerProvider>();// 获取容器中所有注入的实例 foreach (var provider in providers) { Console.WriteLine(provider.GetType().ToString()); }
启动程序,输出如下:
Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider
Microsoft.Extensions.Logging.Debug.DebugLoggerProvider
Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider
Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider
添加,清除LoggerProvider
public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureLogging((ctx, logger) => { //logger.AddProvider();// 添加 logger.ClearProviders();// 清除 })