1.前言
上一章我们进行了项目全局异处理,本章我们继续实现项目日志。闲话少说,进入正题。
2.日志简介
日志对于一个系统而言,特别重要,不管是用于事务审计,还是用于系统排错,还是用于安全追踪.....都扮演了很重要的角色。ASP.NET Core中内置了一个通用日志接口ILogger,并实现了多种内置的日志提供器,例如
除了内置的日志提供器,ASP.NET Core还支持了多种第三方日志工具,例如
3.日志示例
实例演示之前,先了解一下日志级别,后续如果不想输出全部日志,可以通过日志级别进行过滤,同时通过日志级别可以标注日志内容的重要程度。
ASP.NET Core中提供了6种日志级别,分别是Trace, Debug, Information, Warning, Error, Critical。以下是他们的具体使用场景:
- Trace ---> 记录一些对程序员调试问题有帮助的信息,其中可能包含一些敏感信息, 尽量不要在生产环境中启用Trace日志,一般很少使用。
- Debug ---> 记录一些在开发和调试阶段有用的短时变量,尽量不要在生成环境使用。
- Information ---> 记录一些常规信息。
- Warning ---> 记录一些潜在的错误的信息,有些信息不是错误信息,但是也要给程序员的一些提示。
- Error ---> 记录应用程序中某个操作产生的错误和异常信息。
- Critical ---> 记录一些需要立刻修复的问题。例如数据丢失,磁盘空间不足。
3.1日志安装
本项目将使用Nlog来实现日志的记录,至于其他的实现方式,请关注小编即将分享的日志专题。
在NuGet管理器中搜索 NLog.Web.AspNetCore,然后安装到FlyingHat.Web项目。
3.2 日志配置
安装完成后,需要添加一个Nlog的xml配置文档:右键解决方案名,添加新项,如下图:
文件命名为 nlog.config,创建完成以后,将下方的配置代码复制到配置文件中:
<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
autoReload="true"
throwExceptions="false"
internalLogLevel="Off" internalLogFile="Logs/Internal/nlog-internal.log"
>
<extensions>
<add assembly="NLog.Web.AspNetCore"/>
</extensions>
<targets async="true">
<!--普通日志文件-->
<target
name="InfoFile"
xsi:type="File"
fileName="Logs/Info/${shortdate}.log"
layout="日志时间:${longdate}${newline}日志来源:${callsite}${newline}日志级别:${uppercase:${level}}${newline}消息内容:${message}${newline}----------------------------------------------------------------${newline}" >
</target>
<!--错误日志文件-->
<target
name="ErrorFile"
xsi:type="File"
fileName="Logs/Error/${shortdate}.log"
layout="日志时间:${longdate}${newline}日志来源:${callsite}${newline}日志级别:${uppercase:${level}}${newline}消息内容:${message}${newline}异常信息:${exception:format=tostring}${newline}----------------------------------------------------------------${newline}" >
</target>
<!--SQL日志文件-->
<target
name="SQLFile"
xsi:type="File"
fileName="Logs/SQL/${shortdate}.log"
layout="日志时间:${longdate}${newline}日志来源:${callsite}${newline}日志级别:${uppercase:${level}}${newline}消息内容:${message}${newline}异常信息:${exception:format=tostring}${newline}----------------------------------------------------------------${newline}" >
</target>
<!--控制台日志文件-->
<target
name="Console"
xsi:type="ColoredConsole"
useDefaultRowHighlightingRules="false"
layout="日志时间:${longdate}${newline}日志来源:${callsite}${newline}日志级别:${uppercase:${level}}${newline}消息内容:${message}${newline}异常信息:${exception:format=tostring}${newline}----------------------------------------------------------------${newline}" >
<highlight-row condition="level == LogLevel.Error" foregroundColor="Red" />
<highlight-row condition="level == LogLevel.Info" foregroundColor="Gray" />
<highlight-row condition="level == LogLevel.Warn" foregroundColor="Yellow" />
</target>
</targets>
<rules>
<logger name="Microsoft.EntityFrameworkCore.*" levels="Info,Error,Warn" writeTo="SQLFile"/>
<logger name="*" levels="Info,Error,Warn" writeTo="Console"/>
<logger name="FlyingHat.*" level="Info" writeTo="InfoFile" />
<logger name="FlyingHat.*" level="Error" writeTo="ErrorFile" />
</rules>
</nlog>
这个配置文件主要是配置日志规则,和存放日志文件的路径,有兴趣的同学可以去Nlog官网看一下配置文件的所有规则。
注意,配置文件还有很重要的一步,右键配置文件点击属性:查看一下配置是否和下图一致。这样,当你运行或者打包程序的时候,这个日志配置文件也会被打包在内。
接下来,我们要在Program.cs文件中配置使用Nlog,这个方法是用Nlog替代ASP.NetCore 自带的日志系统。
builder.Host.UseServiceProviderFactory(AutofacModuleService.RegisterAutofac()).ConfigureLogging(i =>
{
// 移除已经注册的其他日志处理程序
i.ClearProviders();
i.AddNLog("nlog.config");
}).UseNLog();
3.3 日志使用示例
代码示例:
namespace FlyingHat.Web.Controllers
{
public class HomeController : Controller
{
private readonly ILogger<HomeController> _logger;
public HomeController(ILogger<HomeController> logger)
{
_logger = logger;
}
public IActionResult Index()
{
_logger.LogInformation("LogInformation1233");
_logger.LogError("LogError1233");
return View();
}
}
}
生成的SQL文件夹:Error 错误日志,Info普通信息日志,SQL语句日志。
4. 结语
本章我们实现了项目的日志的使用。下一章我们继续开始接入前端界面。各位同学在阅读实践过程中有看不懂或有其他想法的可以在评论区留言或者私信。教程有帮助的话请各位同学帮忙评论点赞关注三连,感谢大家!
----------------------------------------------------
私信: 校园图书管理系统 可以获取Gitee的链接