C# 如何在.NET中配置xml日志记录

来源:这里教程网 时间:2026-02-21 17:28:46 作者:

在.NET中使用XML格式记录日志,通常借助流行的日志框架如 NLoglog4netSerilog 来实现。这些框架支持将日志输出为结构化格式,包括XML。下面以 NLog 为例,介绍如何配置 XML 日志记录。

1. 安装 NLog

在项目中安装 NLog 包:

通过 NuGet 包管理器命令:

Install-Package NLog

或通过 .NET CLI:

dotnet add package NLog

2. 添加 NLog 配置文件 (nlog.config)

在项目根目录添加一个名为 nlog.config 的文件,并设置“复制到输出目录”为“始终复制”。

内容如下,配置将日志写入 XML 文件:

<?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">
<p><targets>
<target name="xmlFile" 
xsi:type="File"
fileName="logs/log-${shortdate}.xml"
archiveFileName="logs/archive/log-${shortdate}-${sequence}.xml"
archiveEvery="Day"
maxArchiveFiles="7"
concurrentWrites="true">
<layout xsi:type="XmlLayout" includeAllProperties="true">
<element name="time" layout="${longdate}" />
<element name="level" layout="${level}" />
<element name="message" layout="${message}" />
<element name="exception" layout="${exception:format=ToString}" />
<element name="logger" layout="${logger}" />
</layout>
</target>
</targets></p><p><rules>
<logger name="*" minlevel="Trace" writeTo="xmlFile" />
</rules>
</nlog></p>

说明:

XmlLayout:将每条日志输出为 XML 元素。 includeAllProperties="true":包含日志上下文中的所有属性。 ${shortdate}:按日期生成文件名。

3. 在代码中使用日志

在 C# 代码中获取 logger 并记录信息:

using NLog;
<p>class Program
{
private static readonly Logger Logger = LogManager.GetCurrentClassLogger();</p><pre class='brush:php;toolbar:false;'>static void Main(string[] args)
{
    try
    {
        Logger.Info("应用程序启动。");
        int result = 100 / int.Parse("0");
    }
    catch (Exception ex)
    {
        Logger.Error(ex, "发生异常");
    }
}

}

运行后会在 logs 目录生成类似以下内容的 XML 文件:

<logevent level="Error" logger="Program">
  <time>2025-04-05 12:34:56.7890</time>
  <level>Error</level>
  <message>发生异常</message>
  <exception>System.DivideByZeroException: Attempted to divide by zero...</exception>
  <logger>Program</logger>
</logevent>

4. 其他选项(Serilog + Compact Framework)

若使用 Serilog,可通过 Serilog.Formatting.Compact 输出结构化日志,再转换为 XML。但原生不支持 XML 输出,需自定义格式化器或使用中间格式(如 JSON 转 XML)。

基本上就这些。NLog 提供了最直接的 XML 日志支持,配置简单且功能强大。

相关推荐