当前位置:首页 > 技术 > 正文内容

C# 项目中集成与配置 log4net 日志框架指南

访客 技术 2026年5月28日 1

一、 定义 log4net 配置文件

在项目中添加一个名为 log4net.config 的 XML 配置文件。以下配置示例使用了 RollingFileAppender,按日期滚动生成日志文件,并自定义了输出格式。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>
  <log4net>
    <appender name="DailyRollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <file value="logs/app-log-" />
      <appendToFile value="true" />
      <rollingStyle value="Date" />
      <datePattern value="yyyy-MM-dd'.log'" />
      <staticLogFileName value="false" />
      <maxSizeRollBackups value="30" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger - %message%newline" />
      </layout>
    </appender>
    <root>
      <level value="DEBUG" />
      <appender-ref ref="DailyRollingFileAppender" />
    </root>
  </log4net>
</configuration>

请确保在 Visual Studio 中将该配置文件的"复制到输出目录"属性设置为"始终复制"或"如果较新则复制"。

二、 在程序集中加载配置

为了让 log4net 在应用程序启动时自动读取配置文件,需要在 AssemblyInfo.cs 文件中添加以下程序集级别的特性声明:

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", Watch = true)]

Watch = true 参数允许 log4net 监控配置文件的更改,并在文件被修改时自动重新加载配置,这在开发调试阶段非常实用。

三、 在业务代码中记录日志

在具体的类中,通过 LogManager.GetLogger 获取日志记录器实例。以下示例展示了一个订单处理服务,演示了不同日志级别(Info, Debug, Warn, Error)的使用场景:

using System;
using log4net;

namespace LoggingDemo
{
    public class OrderProcessingService
    {
        // 使用 typeof 获取当前类的日志记录器,便于在日志中追踪来源
        private static readonly ILog _logger = LogManager.GetLogger(typeof(OrderProcessingService));

        public void ProcessOrder(string orderId)
        {
            _logger.Info($"开始处理订单,订单号: {orderId}");

            try
            {
                if (string.IsNullOrEmpty(orderId))
                {
                    throw new ArgumentException("订单号不能为空");
                }
                
                _logger.Debug($"订单 {orderId} 数据验证通过,正在执行核心逻辑...");
            }
            catch (ArgumentException ex)
            {
                _logger.Warn($"订单参数校验失败: {ex.Message}");
            }
            catch (Exception ex)
            {
                // 记录错误时传入异常对象,以便记录完整的堆栈跟踪信息
                _logger.Error($"处理订单 {orderId} 时发生系统异常", ex);
            }
            finally
            {
                _logger.Info($"订单 {orderId} 处理流程结束");
            }
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            var service = new OrderProcessingService();
            
            // 测试正常流程
            service.ProcessOrder("ORD-9527");
            
            // 测试参数异常流程
            service.ProcessOrder(null);
            
            Console.WriteLine("业务执行完毕,请检查 logs 目录下的日志文件。");
            Console.ReadKey();
        }
    }
}
标签: log4netC#.NET

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。