.NET 扩展官方 Logger 实现将日志保存到本地文件

.NET 项目默认情况下 日志是使用的 ILogger 接口，默认提供一下四种日志记录程序：

• 控制台
  
• 调试
  
• EventSource
  
• EventLog
  

这四种记录程序都是默认包含在 .NET 运行时库中。关于这四种记录程序的详细介绍可以直接查看微软的官方文档 https://docs.microsoft.com/zh-cn/dotnet/core/extensions/logging-providers
今天给大家分享自己实现一个日志记录程序，继承自  ILogger 接口，实现将日志记录到本地的 txt 文件中，并包含一个自动清理过期日志的功能任务。
类库的整体代码结构如下：

 
 Models 文件夹中存放 LoggerSetting.cs 是 该模块注入服务时需要的配置参数

1. namespace Logger.LocalFile.Models
2. {
3.     public class LoggerSetting
4.     {
5.         /// <summary>
6.         /// 保存天数
7.         /// </summary>
8.         public int SaveDays { get; set; } = 7;
9.     }
10. }

复制代码

 
Tasks 文件夹中存放的 LogClearTask.cs 是用于自动清理过期日志的任务，会在日志服务注入的同时启动，会通过配置的保存天数参数，定期删除超过实现的日志文件

1. using Common;
2. using Logger.LocalFile.Models;
3. using Microsoft.Extensions.Hosting;
4. using Microsoft.Extensions.Options;
6. namespace Logger.LocalFile.Tasks
7. {
8.     public class LogClearTask : BackgroundService
9.     {
11.         private readonly int saveDays;
14.         public LogClearTask(IOptionsMonitor<LoggerSetting> config)
15.         {
16.             saveDays = config.CurrentValue.SaveDays;
17.         }
19.         protected override async Task ExecuteAsync(CancellationToken stoppingToken)
20.         {
21.             while (!stoppingToken.IsCancellationRequested)
22.             {
23.                 try
24.                 {
26.                     string basePath = Directory.GetCurrentDirectory().Replace("\", "/") + "/Logs/";
28.                     if (Directory.Exists(basePath))
29.                     {
30.                         List<string> logPaths = IOHelper.GetFolderAllFiles(basePath).ToList();
32.                         var deleteTime = DateTime.UtcNow.AddDays(-1 * saveDays);
34.                         if (logPaths.Count != 0)
35.                         {
36.                             foreach (var logPath in logPaths)
37.                             {
38.                                 var fileInfo = new FileInfo(logPath);
40.                                 if (fileInfo.CreationTimeUtc < deleteTime)
41.                                 {
42.                                     File.Delete(logPath);
43.                                 }
45.                             }
46.                         }
47.                     }
49.                 }
50.                 catch
51.                 {
52.                 }
54.                 await Task.Delay(1000 * 60 * 60 * 24, stoppingToken);
55.             }
56.         }
58.     }
59. }

复制代码

 
ILoggingBuilderExtensions 是应用注入服务的扩展方法，内容如下

1. using Logger.LocalFile.Models;
2. using Logger.LocalFile.Tasks;
3. using Microsoft.Extensions.DependencyInjection;
4. using Microsoft.Extensions.Hosting;
5. using Microsoft.Extensions.Logging;
7. namespace Logger.LocalFile
8. {
10.     public static class ILoggingBuilderExtensions
11.     {
13.         public static void AddLocalFileLogger(this ILoggingBuilder builder, Action<LoggerSetting> action)
14.         {
15.             builder.Services.Configure(action);
16.             builder.Services.AddSingleton<ILoggerProvider, LocalFileLoggerProvider>();
17.             builder.Services.AddSingleton<IHostedService, LogClearTask>();
18.         }
19.     }
20. }

复制代码

 
LocalFileLogger 是日志的保存执行方法，内容如下

1. using Common;
2. using Microsoft.Extensions.Logging;
3. using System.Text;
5. namespace Logger.LocalFile
6. {
7.     public class LocalFileLogger : ILogger
8.     {
9.         private readonly string categoryName;
10.         private readonly string basePath;
12.         public LocalFileLogger(string categoryName)
13.         {
14.             this.categoryName = categoryName;
16.             basePath = Directory.GetCurrentDirectory().Replace("\", "/") + "/Logs/";
18.             if (Directory.Exists(basePath) == false)
19.             {
20.                 Directory.CreateDirectory(basePath);
21.             }
22.         }
24.         public IDisposable BeginScope<TState>(TState state)
25.         {
26.             return default!;
27.         }
29.         public bool IsEnabled(LogLevel logLevel)
30.         {
31.             if (logLevel != LogLevel.None)
32.             {
33.                 return true;
34.             }
35.             else
36.             {
37.                 return false;
38.             }
39.         }
41.         public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
42.         {
43.             if (IsEnabled(logLevel))
44.             {
45.                 if (state != null && state.ToString() != null)
46.                 {
47.                     var logContent = state.ToString();
49.                     if (logContent != null)
50.                     {
51.                         if (exception != null)
52.                         {
53.                             var logMsg = new
54.                             {
55.                                 message = logContent,
56.                                 error = new
57.                                 {
58.                                     exception?.Source,
59.                                     exception?.Message,
60.                                     exception?.StackTrace
61.                                 }
62.                             };
64.                             logContent = JsonHelper.ObjectToJson(logMsg);
65.                         }
67.                         var log = new
68.                         {
69.                             CreateTime = DateTime.UtcNow,
70.                             Category = categoryName,
71.                             Level = logLevel.ToString(),
72.                             Content = logContent
73.                         };
75.                         string logStr = JsonHelper.ObjectToJson(log);
77.                         var logPath = basePath + DateTime.UtcNow.ToString("yyyyMMddHH") + ".log";
79.                         File.AppendAllText(logPath, logStr + Environment.NewLine, Encoding.UTF8);
81.                     }
82.                 }
83.             }
84.         }
85.     }
86. }

复制代码

 
LocalFileLoggerProvider 是Logger执行方法向外部的供应者，内容如下：

1. using Microsoft.Extensions.Logging;
2. using System.Collections.Concurrent;
4. namespace Logger.LocalFile
5. {
6.     public class LocalFileLoggerProvider : ILoggerProvider
7.     {
8.         private readonly ConcurrentDictionary<string, LocalFileLogger> loggers = new();
10.         public ILogger CreateLogger(string categoryName)
11.         {
12.             return loggers.GetOrAdd(categoryName, new LocalFileLogger(categoryName));
13.         }
15.         public void Dispose()
16.         {
17.             loggers.Clear();
18.             GC.SuppressFinalize(this);
19.         }
20.     }
21. }

复制代码

 
当我们其他项目想要使用我们这个 Logger.LocalFile 类库时，只要添加该类库的引用，然后在启动服务时进行注入即可，注入方法如下：
Web 项目注入方式

1. //注册本地文件日志服务
2. builder.Logging.AddLocalFileLogger(options => { options.SaveDays = 7; });

复制代码

 
控制台项目注入方式

1. .ConfigureLogging((hostContext, builder) =>
2.                 {
3.                     //注册本地文件日志服务
4.                     builder.AddLocalFileLogger(options => { options.SaveDays = 7; });
5.                 })
6.                 .Build();

复制代码

 
Web 项目直接在 builder 后面编写注入就可以，控制台项目需要先 .ConfigureLogging 才可以，这是两者的区别。
这样就注入了我们自己编写的日志记录程序，项目运行时会在项目的 Logs 文件夹中产生日志文件，如下图

 
 
  
至此 .NET 扩展 官方 Logger 实现将日志保存到本地文件就讲解完了，有任何不明白的，可以在文章下面评论或者私信我，欢迎大家积极的讨论交流，有兴趣的朋友可以关注我目前在维护的一个 .net 基础框架项目，项目地址如下https://github.com/berkerdong/NetEngine.githttps://gitee.com/berkerdong/NetEngine.git
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！