介绍

根据Microsoft.Extensions.Logging.Console改造的本地文件日志输出组件，轻量便捷，运行平台：asp.net core。

1. 为什么要写这个项目，开源的日志组件不够用吗？

• 第一：微软提供了一个很好的日志输出框架，也提供了基本的控制台输出组件，但没有提供输出到文件的日志组件，很是遗憾；

• 第二：第三方日志组件（如：NLog、Serialog、Log4net）功能虽然比较全，但也引入了其他大量的概念和规则。而对于中小型项目来说，它们仅需要输出日志到本地文件即可，所以在使用的便捷上总是差强人意；

• 第三：第三方日志组件在某些功能上也不尽如人意，比如：是否能将日志消息按照日志类别输出到不同文件中？在程序工作时，是否占用日志文件？是否能排除某个类别的日志文件不输出？

• 第四：练手。

2. 这个项目的特点

• 不引入新的规则概念，不引入额外的配置文件，力求轻量级，所有配置均在appsetting.json中实现；

• 实现非占用文件式输出, 方便日志文件浏览，其内部文件的输出是基于内存的单线程队列，高并发下不影响主线程运行；

• 提供按照日志类别、级别过滤输出到不同的文件；

• 提供按文件大小滚动输出的功能;

• 提供定时净化日志目录的功能；

3. 这个项目的实现思路

大量参考控制台输出组件的源码（Microsoft.Extensions.Logging.Console）

4. 快速使用

• 第一步：安装包

  <ItemGroup><PackageReference Include="DotNetCommon.Filelog" Version="1.1.0" />
  </ItemGroup>

• 第二步：修改Program.cs文件，引入组件

  public class Program
  {public static void Main(string[] args){CreateHostBuilder(args).Build().Run();}public static IHostBuilder CreateHostBuilder(string[] args) =>Host.CreateDefaultBuilder(args).ConfigureLogging(loggingBuilder =>{loggingBuilder.ClearProviders();loggingBuilder.AddConsole();//一行代码即可引入loggingBuilder.AddFile();}).ConfigureWebHostDefaults(webBuilder =>{webBuilder.UseStartup<Startup>();});
  }
  

• 第三步：没有了。

5. 输出效果

引入日志组件后，为了测试输出效果，我们可以新建一个控制器代码如下：

[HttpGet]
public string Get()
{_logger.LogTrace("trace");_logger.LogDebug("debug");_logger.LogInformation("info");_logger.LogWarning("warn");_logger.LogError("error");_logger.LogCritical("critical");using (_logger.BeginScope("测试日志的Scope")){_logger.LogTrace("scope-trace");_logger.LogDebug("scope-debug");_logger.LogInformation("scope-info");_logger.LogWarning("scope-warn");_logger.LogError("scope-error");_logger.LogCritical("scope-critical");}_logger.LogTrace("Scope已经结束了。。。");//多行日志_logger.LogInformation($@"第几次
小明小红
小花小龙圣诞节哦我按实际大地阿斯顿");_logger.LogInformation($@"hah
小明小红
小花小龙圣诞节哦我按实际大地阿斯顿end");//throw new Exception("测试异常日志");return "ok";
}

当程序启动并且访问到这个api后，我们将会看到程序目录下多了个文件夹logs,它里面的日志文件如下：

app-all-2021-06-09.log     4KB  //应用类别的日志都会记录到这里
app-crit-2021-06-09.log 1KB  //应用类别中Critical级别的日志都会记录到这里
app-fail-2021-06-09.log 1KB  //应用类别中Error级别的日志都会记录到这里
app-info-2021-06-09.log 2KB  //应用类别中Information级别的日志都会记录到这里
app-warn-2021-06-09.log 1KB  //应用类别中Warning级别的日志都会记录到这里
system-2021-06-09.log   1KB  //系统类别的日志都会记录到这里//system-2021-06-09.log 内容
[2021-06-09 20:44:52.676]-[info]: Microsoft.Hosting.Lifetime[0]-[threed:1]Now listening on: https://localhost:5501
[2021-06-09 20:44:52.679]-[info]: Microsoft.Hosting.Lifetime[0]-[threed:1]Now listening on: http://localhost:5500
[2021-06-09 20:44:52.680]-[info]: Microsoft.Hosting.Lifetime[0]-[threed:1]Application started. Press Ctrl+C to shut down.
[2021-06-09 20:44:52.680]-[info]: Microsoft.Hosting.Lifetime[0]-[threed:1]Hosting environment: Development
[2021-06-09 20:44:52.680]-[info]: Microsoft.Hosting.Lifetime[0]-[threed:1]Content root path: E:\gitee\DotNetCommon.Filelog\samples\SimpleFileLog//app-warn-2021-06-09.log 内容
[2021-06-09 20:44:53.604]-[warn]: SimpleFileLog.Controllers.HomeController[0]-[threed:11]=> RequestPath:/home RequestId:0HM9B8HGAQOQF:00000001, SpanId:|85fcc31f-49a39d824a1949ba., TraceId:85fcc31f-49a39d824a1949ba, ParentId:      => SimpleFileLog.Controllers.HomeController.Get (SimpleFileLog)warn
[2021-06-09 20:44:53.604]-[warn]: SimpleFileLog.Controllers.HomeController[0]-[threed:11]=> RequestPath:/home RequestId:0HM9B8HGAQOQF:00000001, SpanId:|85fcc31f-49a39d824a1949ba., TraceId:85fcc31f-49a39d824a1949ba, ParentId:      => SimpleFileLog.Controllers.HomeController.Get (SimpleFileLog)      => 测试日志的Scopescope-warn

注意：虽然代码中有输出Information级别以下的日志，但由于工程的appsettings.json中的配置导致Debug和Trace级别的日志并没有记录到文件。

{
"Logging": {"LogLevel": {"Default": "Information", //设置默认类别日志的输出级别"Microsoft": "Warning", //设置Microsoft开头的类别日志的输出级别"Microsoft.Hosting.Lifetime": "Information" //设置Microsoft.Hosting.Lifetime开头的类别日志的输出级别}
},
"AllowedHosts": "*"
}

为了能输出Information级别以下的日志，我们可以调整appsettings.json的配置如下：

{
"Logging": {"LogLevel": {"Default": "Trace", "Microsoft": "Trace", "Microsoft.Hosting.Lifetime": "Trace" }
},
"AllowedHosts": "*"
}

如果仅想设置FileLog组件的日志输出级别，也可以如下设置：

{"Logging": {"LogLevel": {"Default": "Information", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information" },"File":{"LogLevel": {"Default": "Trace", "Microsoft": "Trace", "Microsoft.Hosting.Lifetime": "Trace" }}},"AllowedHosts": "*"
}

关于日志的类别和级别参考MSDN文档：https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/logging/?view=aspnetcore-5.0#log-level

6. 轻量配置

上面引入FileLog的时候虽然仅使用了loggingBuilder.AddFile();一行代码，但FileLog组件内部加载了默认的配置，如下：

{"Logging": {"LogLevel": {"Default": "Information","Microsoft": "Warning","Microsoft.Hosting.Lifetime": "Information"},"File": {"IncludeScopes": true, //表示是否输出日志范围，默认输出"InternalLogFile": "logs/internal-#datetime{yyyy-MM-dd}#.log","AutoClear": {"Enable": false,"ExpireSpan": 0,"TriggerCount": 200,"Dirs": [ "logs" ],"Exts": [ "*.log" ]},"Writers": [{"FirstInclude": [ "Microsoft", "System" ],"Path": "logs/system-#datetime{yyyy-MM-dd}#.log","RollingSize": 10485760,"MinLogLevel": "Trace","MaxLogLevel": "None"},{"FirstInclude": [ "*" ],"Path": "logs/app-#level#-#datetime{yyyy-MM-dd}#.log","SecondExclude": [ "Microsoft", "System" ],"RollingSize": 10485760,"MinLogLevel": "Trace","MaxLogLevel": "None"},{"FirstInclude": [ "*" ],"Path": "logs/app-all-#datetime{yyyy-MM-dd}#.log","SecondExclude": [ "Microsoft", "System" ],"RollingSize": 10485760,"MinLogLevel": "Trace","MaxLogLevel": "None"}]}},"AllowedHosts": "*"
}

配置详解：

注意：

• 上面AutoClear.Exts的配置是调用 var _files = Directory.GetFiles(_dir, pattern); 生效的。

• Writers配置默认是有三个Writer的数组，如果自己做了配置的话会将这三个Writer一起覆盖掉。

7. 示例工程

https://gitee.com/jackletter/DotNetCommon.Filelog/tree/master/samples/SimpleFileLog