ASP.NET Core MVC 从入门到精通之日志管理

彼

随着技术的发展，ASP.NET Core MVC也推出了好长时间，经过不断的版本更新迭代，已经越来越完善，本系列文章主要讲解ASP.NET Core MVC开发B/S系统过程中所涉及到的相关内容，适用于初学者，在校毕业生，或其他想从事ASP.NET Core MVC 系统开发的人员。
经过前几篇文章的讲解，初步了解ASP.NET Core MVC项目创建，启动运行，以及命名约定，创建控制器，视图，模型，接收参数，传递数据ViewData，ViewBag，路由，页面布局，wwwroot和客户端库，Razor语法，EnityFrameworkCore与数据库，HttpContext，Request，Response，Session，序列化，文件上传，自动映射，Html辅助标签，模型校验，鉴权、授权基础，Identity入门等内容，今天继续讲解ASP.NET Core MVC 中日志等相关内容，仅供学习分享使用。

在实际系统开发中，日志管理是非常重要的一个模块，完整的日志可以方便问题的跟踪定位，可以快速的发现并解决问题。今天以一个简单的小例子，简述日志组件NLog的基础用法。
安装NLog组件库

首先通过Nuget包管理器，安装NLog对应的日志组件【NLog和NLog.Web.AspNetCore】，如下所示：

添加配置文件

在应用程序中添加NLog配置文件nlog.config，配置示例如下所示：

1. 1 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" /><?xml version="1.0" encoding="utf-8" ?>
2. 2 <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
3. 3       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4. 4       autoReload="true"
5. 5       internalLogLevel="Info"
6. 6       internalLogFile="c:\temp\internal-nlog-AspNetCore.txt">
7. 7
8. 8     
9. 9     <extensions>
10. 10         <add assembly="NLog.Web.AspNetCore"/>
11. 11 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />    </extensions>
12. 12
13. 13     
14. 14     <targets>
15. 15         
16. 16         <target xsi:type="File" name="allfile" fileName="c:\temp\nlog-AspNetCore-all-${shortdate}.log"
17. 17                 layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}" />
18. 18
19. 19         
20. 20         <target xsi:type="File" name="ownFile-web" fileName="c:\temp\nlog-AspNetCore-own-${shortdate}.log"
21. 21 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />                layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />
22. 22
23. 23         
24. 24         <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />
25. 25     </targets>
26. 26
27. 27     
28. 28     <rules>
29. 29         
30. 30         <logger name="*" minlevel="Trace" writeTo="allfile" />
31. 31 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />
32. 32         
33. 33         <logger name="Microsoft.Hosting.Lifetime" minlevel="Info" writeTo="lifetimeConsole, ownFile-web" final="true" />
34. 34
35. 35         
36. 36         <logger name="Microsoft.*" maxlevel="Info" final="true" />
37. 37         <logger name="System.Net.Http.*" maxlevel="Info" final="true" />
38. 38
39. 39         <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
40. 40     </rules>
41. 41 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" /></nlog>

复制代码

关于日志组件配置说明，可参考官方文件：https://github.com/NLog/NLog/wiki/Configuration-file
注入日志服务

在启动程序Program.cs中，添加日志组件服务，如下所示：

1. 1 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />// NLog: Setup NLog for Dependency injection
2. 2 builder.Logging.ClearProviders();
3. 3 builder.Host.UseNLog();

复制代码

日志过滤器

在创建项目时，默认在appsettings.json创建日志配置。如下所示：

1. {
2.   "Logging": {
3.     "LogLevel": {
4.       "Default": "Information",
5.       "Microsoft.AspNetCore": "Warning"
6.     }
7.   },
8.   "AllowedHosts": "*"
9. }

复制代码

输出日志

在控制器中输出日志，需要用到ILogger接口，可通过注入的方式实现，如下所示：

1. 1 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />using DemoCoreMVC.Models;
2. 2 using Microsoft.AspNetCore.Authorization;
3. 3 using Microsoft.AspNetCore.Mvc;
4. 4 using System.Diagnostics;
5. 5
6. 6 namespace DemoCoreMVC.Controllers
7. 7 {
8. 8     public class HomeController : Controller
9. 9     {
10. 10         private readonly ILogger<HomeController> _logger;
11. 11 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />
12. 12         public HomeController(ILogger<HomeController> logger)
13. 13         {
14. 14             _logger = logger;
15. 15         }
16. 16
17. 17         public IActionResult Index()
18. 18         {
19. 19             _logger.LogInformation("Hello, 这是首页！");
20. 20             return View();
21. 21 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />        }
22. 22
23. 23
24. 24     }
25. 25 }

复制代码

日志查看

查看日志，通过打开日志配置文件nlog.config中配置的路径，生成了两个对应的日志，如下所示：

nlog-AspNetCore-all-2023-06-18.log中的日志比较全，包含很多程序内部日志。
nlog-AspNetCore-own-2023-06-18.log中的日志比较简约，如下所示：

日志级别

在ASP.NET Core中，日志级别共几种，分别如下所示：
下表列出了 LogLevel 值、方便的 Log{LogLevel} 扩展方法以及建议的用法：

 在上表中，LogLevel 按严重性由低到高的顺序列出。
修改配置级别
在实际生产程序中，一般日志并不输出Trace级别的日志，Debug也是在调试开发时才用。默认情况下，生成的nlog-AspNetCore-all-2023-06-18.log会比较大，则可以通过参数配置来修改。
设置值minlevel="Info"，则不会输出Tracle和Debug级别的程序，如下所示：

1. 1 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />
2. 2 <rules>
3. 3     
4. 4     <logger name="*" minlevel="Info" writeTo="allfile" />
5. 5
6. 6     
7. 7     <logger name="Microsoft.Hosting.Lifetime" minlevel="Info" writeTo="lifetimeConsole, ownFile-web" final="true" />
8. 8
9. 9     
10. 10     <logger name="Microsoft.*" minlevel="Info" final="true" />
11. 11 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />    <logger name="System.Net.Http.*" minlevel="Info" final="true" />
12. 12
13. 13     <logger name="*" minlevel="Info" writeTo="ownFile-web" />
14. 14 </rules>

复制代码

通过设置后，生成的日志文件将会精简很多，如下所示：

日志输出目标

日志不仅可以输出到控制台，也可以输出到文件，或者其他媒介。
日志输出目标可通过targets进行配置。日志可以配置多个输出目标，通过target进行配置。
如下所示：

• name  输出目标名称
  
• type  输出目标类型，如： "File", "Database", "Mail"，"Console". 用 xsi:type.表示
  
• layout 输出格式
  

如输出到控制台，如通过如下配置：

1. 1 <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />

复制代码

设置后，即可输出到控制台，如下所示：

 以上就是ASP.NET Core MVC从入门到精通之日志管理的全部内容。

来源:https://www.cnblogs.com/hsiang/archive/2023/06/19/17490006.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！