在C#中使用 NLog 库进行日志记录

2024-06-04 06:52

本文主要是介绍在C#中使用 NLog 库进行日志记录,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

NLog 是 .NET 的日志记录框架。具有丰富的日志路由和管理能力,极大地帮助您生成和管理日志。NLog 是一个库,可以轻松地同时记录和管理多个不同区域(例如控制台、数据库或文本文件)中的数据。我们可以按如下方式列出 NLog 的功能:

扩展:

在日志记录时,您可能希望将日志记录保存在不同的位置,例如数据库、文本文件或控制台。NLog 允许您通过单个配置文件执行这些操作。
此外,还有一些解决方案适用于缓冲、负载平衡、异步写入和许多其他场景。

易于配置:

配置文件非常简单。您可以通过单个配置文件控制和管理整个过程。

可模板:

日志记录时最重要的步骤之一是为遇到的不同方案创建不同的模板。例如,如果您想为要记录的文件指定不同的名称,NLog 库将轻松为您提供此名称。

NLog 在最简单的小型应用程序以及大型和复杂的项目中非常有用。由于其丰富的配置功能,您可以在所有项目中使用它。

如何在 .NET 项目中使用 Nlog 库?

1)安装依赖:

在开始处理应用程序之前,必须安装一些依赖项包。

打开 NuGet 包管理器:
Visual Studio 提供了多种使用 NuGet 包管理器的方法。

图片

要做的第一件事是打开包管理器控制台。可以使用**“工具”>“NuGet 包管理器”>“包管理器控制台**”执行此操作,如图 1–1–1 所示。

图片

在打开的控制台中,在打开的控制台中运行图 1–1–2 (Install-Package NLog.Extensions.Logging) 中的命令。

2)创建记录器:

对于我们的项目,我们将使用最简单的方法在 NLog 的 LogManager 类中创建一个记录器。它提供了 GetCurrentClassLogger() 方法,用于获取每个类的唯一记录器。与全局配置的记录器不同,每个类的记录器可帮助您轻松捕获日志消息的来源。

我们创建的记录器将使用 NLog 的默认日志级别系统。日志系统由以下 6 个级别组成:

致命:用于报告强制关闭应用程序的错误。
错误:用于记录程序执行期间发生的严重问题。
警告:用于报告非关键异常行为。
信息:用于向系统管理员和最终用户突出显示应用程序进度的信息性消息。
调试:用于调试包含有关应用程序处理的扩展信息的消息。
跟踪:用于跟踪代码。

让我们看看如何在代码中使用 logger。

图片

Program.cs文件应如图 1–2–1 中的代码所示。

3)配置记录器:

NLog 具有丰富的配置能力,提供了两种配置记录器的方法;以编程方式或通过配置文件。您可以在 Nlog 配置选项文档中找到有关它们的详细信息。

在本文中,我们将使用 nlog.config 文件配置记录器。

图片

首先,我们需要做的是在项目的根目录下创建一个 nlog.config 文件。您可以通过按 CTRL + SHIFT + A,选择 XML 文件类型并在打开的窗口中输入名称 nlog.config 来完成,如图 1–3–1 所示。

图片

然后,我们必须将文件的“复制到输出目录”属性设置为“始终复制”,如图 1-3-2 所示。可以通过右键单击解决方案资源管理器中的文件并选择“属性”选项来完成此操作。

图片

我们的配置文件必须如图 1-3-3 所示。在图 1-3-3 中,我们的配置由两部分组成:设置日志记录目标和设置日志记录规则。

我们决定为项目添加 3 个日志记录目标:控制台和 2 个日志文件。在配置文件中,它们中的每一个都将由一个单独的 XML 元素表示。让我们在 nlog.config 文件中编写目标。

然后,我们可以创建规则。在 NLog 中,每个规则都可以应用于多个记录器和目标,并且必须编写为单独的 XML 元素。

第一条规则强制所有记录器将具有调试日志和更高严重性日志的日志写入名为 all_logs_file 的目标。

第二条规则强制所有记录器将警告和更高严重性的日志写入名为 important_logs_file 的目标。

第三条规则强制所有记录器将应用程序生成的所有日志写入控制台。

4)为项目场景创建类:

我们将使用 2 个额外的类来展示如何使用我们的日志记录配置。

图片

为类创建一个新文件,如图 1–4–1 所示;可以通过右键单击项目“添加”>“新项”在打开的窗口中选择 C# 类,也可以按 CTRL + SHIFT + A 添加类。

图片

第一个文件将包含一个 Person 类。您可以在图 1–4–2 中看到代码片段。

第二个文件将包含 Product 类。您可以在图 1–4–3 中看到代码片段。

我们可以将对象分解为具有“@”解构运算符的值的属性,如图 1-4-2 和图 1-4-3 所示。

5)使用记录器记录:

我们将记录一些应用程序消息来演示记录器的工作原理,每个级别至少一个。NLog API 对于此类任务非常有用。

在我们的项目中,NLog 记录器提供了 6 种日志记录方法:Trace、Info、Warn、Debug、Error 和 Fatal。

图片

如图 1–5–1 所示,我们的应用程序现在已准备好写入一些日志。现在,让我们构建并运行程序以查看结果。

图片

执行后,控制台的输出应如图 1–5–2 所示。

图片

现在,让我们检查写入文件中的日志。如图 1–5–3 所示,这些文件位于 C:\\logs 中。

图片

首先,检查您的important.json文件,它应该如图 1–5–4 所示。

图片

然后,检查您的all.json文件,它应该如图 1–5–5 所示。

恭喜!所有步骤都成功完成!现在,你已使用 NLog 为 .NET 控制台应用程序配置了具有多个日志记录目标的日志记录系统。

这篇关于在C#中使用 NLog 库进行日志记录的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1029372

相关文章

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3

springboot security使用jwt认证方式

《springbootsecurity使用jwt认证方式》:本文主要介绍springbootsecurity使用jwt认证方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录前言代码示例依赖定义mapper定义用户信息的实体beansecurity相关的类提供登录接口测试提供一

go中空接口的具体使用

《go中空接口的具体使用》空接口是一种特殊的接口类型,它不包含任何方法,本文主要介绍了go中空接口的具体使用,具有一定的参考价值,感兴趣的可以了解一下... 目录接口-空接口1. 什么是空接口?2. 如何使用空接口?第一,第二,第三,3. 空接口几个要注意的坑坑1:坑2:坑3:接口-空接口1. 什么是空接

SpringBoot日志配置SLF4J和Logback的方法实现

《SpringBoot日志配置SLF4J和Logback的方法实现》日志记录是不可或缺的一部分,本文主要介绍了SpringBoot日志配置SLF4J和Logback的方法实现,文中通过示例代码介绍的非... 目录一、前言二、案例一:初识日志三、案例二:使用Lombok输出日志四、案例三:配置Logback一

springboot security快速使用示例详解

《springbootsecurity快速使用示例详解》:本文主要介绍springbootsecurity快速使用示例,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝... 目录创www.chinasem.cn建spring boot项目生成脚手架配置依赖接口示例代码项目结构启用s

Python如何使用__slots__实现节省内存和性能优化

《Python如何使用__slots__实现节省内存和性能优化》你有想过,一个小小的__slots__能让你的Python类内存消耗直接减半吗,没错,今天咱们要聊的就是这个让人眼前一亮的技巧,感兴趣的... 目录背景:内存吃得满满的类__slots__:你的内存管理小助手举个大概的例子:看看效果如何?1.

java中使用POI生成Excel并导出过程

《java中使用POI生成Excel并导出过程》:本文主要介绍java中使用POI生成Excel并导出过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录需求说明及实现方式需求完成通用代码版本1版本2结果展示type参数为atype参数为b总结注:本文章中代码均为

golang 日志log与logrus示例详解

《golang日志log与logrus示例详解》log是Go语言标准库中一个简单的日志库,本文给大家介绍golang日志log与logrus示例详解,感兴趣的朋友一起看看吧... 目录一、Go 标准库 log 详解1. 功能特点2. 常用函数3. 示例代码4. 优势和局限二、第三方库 logrus 详解1.

Spring Boot3虚拟线程的使用步骤详解

《SpringBoot3虚拟线程的使用步骤详解》虚拟线程是Java19中引入的一个新特性,旨在通过简化线程管理来提升应用程序的并发性能,:本文主要介绍SpringBoot3虚拟线程的使用步骤,... 目录问题根源分析解决方案验证验证实验实验1:未启用keep-alive实验2:启用keep-alive扩展建

MySQL INSERT语句实现当记录不存在时插入的几种方法

《MySQLINSERT语句实现当记录不存在时插入的几种方法》MySQL的INSERT语句是用于向数据库表中插入新记录的关键命令,下面:本文主要介绍MySQLINSERT语句实现当记录不存在时... 目录使用 INSERT IGNORE使用 ON DUPLICATE KEY UPDATE使用 REPLACE