百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

C# .NET 6 校园图书管理系统:第六章 .Net6之NLog日志的配置与使用

bigegpt 2024-08-18 14:04 2 浏览

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的链接

相关推荐

悠悠万事,吃饭为大(悠悠万事吃饭为大,什么意思)

新媒体编辑:杜岷赵蕾初审:程秀娟审核:汤小俊审签:周星...

高铁扒门事件升级版!婚宴上‘冲喜’老人团:我们抢的是社会资源

凌晨两点改方案时,突然收到婚庆团队发来的视频——胶东某酒店宴会厅,三个穿大红棉袄的中年妇女跟敢死队似的往前冲,眼瞅着就要扑到新娘的高额钻石项链上。要不是门口小伙及时阻拦,这婚礼造型团队熬了三个月的方案...

微服务架构实战:商家管理后台与sso设计,SSO客户端设计

SSO客户端设计下面通过模块merchant-security对SSO客户端安全认证部分的实现进行封装,以便各个接入SSO的客户端应用进行引用。安全认证的项目管理配置SSO客户端安全认证的项目管理使...

还在为 Spring Boot 配置类加载机制困惑?一文为你彻底解惑

在当今微服务架构盛行、项目复杂度不断攀升的开发环境下,SpringBoot作为Java后端开发的主流框架,无疑是我们手中的得力武器。然而,当我们在享受其自动配置带来的便捷时,是否曾被配置类加载...

Seata源码—6.Seata AT模式的数据源代理二

大纲1.Seata的Resource资源接口源码2.Seata数据源连接池代理的实现源码3.Client向Server发起注册RM的源码4.Client向Server注册RM时的交互源码5.数据源连接...

30分钟了解K8S(30分钟了解微积分)

微服务演进方向o面向分布式设计(Distribution):容器、微服务、API驱动的开发;o面向配置设计(Configuration):一个镜像,多个环境配置;o面向韧性设计(Resista...

SpringBoot条件化配置(@Conditional)全面解析与实战指南

一、条件化配置基础概念1.1什么是条件化配置条件化配置是Spring框架提供的一种基于特定条件来决定是否注册Bean或加载配置的机制。在SpringBoot中,这一机制通过@Conditional...

一招解决所有依赖冲突(克服依赖)

背景介绍最近遇到了这样一个问题,我们有一个jar包common-tool,作为基础工具包,被各个项目在引用。突然某一天发现日志很多报错。一看是NoSuchMethodError,意思是Dis...

你读过Mybatis的源码?说说它用到了几种设计模式

学习设计模式时,很多人都有类似的困扰——明明概念背得滚瓜烂熟,一到写代码就完全想不起来怎么用。就像学了一堆游泳技巧,却从没下过水实践,很难真正掌握。其实理解一个知识点,就像看立体模型,单角度观察总...

golang对接阿里云私有Bucket上传图片、授权访问图片

1、为什么要设置私有bucket公共读写:互联网上任何用户都可以对该Bucket内的文件进行访问,并且向该Bucket写入数据。这有可能造成您数据的外泄以及费用激增,若被人恶意写入违法信息还可...

spring中的资源的加载(spring加载原理)

最近在网上看到有人问@ContextConfiguration("classpath:/bean.xml")中除了classpath这种还有其他的写法么,看他的意思是想从本地文件...

Android资源使用(android资源文件)

Android资源管理机制在Android的开发中,需要使用到各式各样的资源,这些资源往往是一些静态资源,比如位图,颜色,布局定义,用户界面使用到的字符串,动画等。这些资源统统放在项目的res/独立子...

如何深度理解mybatis?(如何深度理解康乐服务质量管理的5个维度)

深度自定义mybatis回顾mybatis的操作的核心步骤编写核心类SqlSessionFacotryBuild进行解析配置文件深度分析解析SqlSessionFacotryBuild干的核心工作编写...

@Autowired与@Resource原理知识点详解

springIOCAOP的不多做赘述了,说下IOC:SpringIOC解决的是对象管理和对象依赖的问题,IOC容器可以理解为一个对象工厂,我们都把该对象交给工厂,工厂管理这些对象的创建以及依赖关系...

java的redis连接工具篇(java redis client)

在Java里,有不少用于连接Redis的工具,下面为你介绍一些主流的工具及其特点:JedisJedis是Redis官方推荐的Java连接工具,它提供了全面的Redis命令支持,且...