如何为Log4Net的RollingFileAppender添加自定义属性参数并保存到文本文件

嘿，我来帮你一步步实现log4net的自定义属性配置～ 主要分配置文件定义占位符和代码中设置属性值两个步骤，下面结合你的现有配置来详细说明：

第一步：在配置文件的PatternLayout中添加自定义属性占位符 #

你需要在<layout>的<conversionPattern>里，用%property{你的自定义属性名}的格式来声明要输出的自定义属性。比如我们添加AppName（应用名称）和UserId（当前用户ID）两个自定义属性，修改后的完整配置如下：

<log4net debug="true">
  <appender name="file" type="log4net.Appender.RollingFileAppender, log4net">
    <file value="Log.txt" />
    <appendToFile value="true" />
    <rollingStyle value="Size" />
    <maxSizeRollBackups value="10" />
    <maximumFileSize value="1MB" />
    <staticLogFileName value="true" />
    <layout type="log4net.Layout.PatternLayout">
      <!-- 新增自定义属性占位符：%property{AppName} 和 %property{UserId} -->
      <conversionPattern value="%date [%thread] %-5level %property{AppName} - %property{UserId} - %message%newline" />
    </layout>
  </appender>
  <!-- 务必配置根Logger关联你的file appender -->
  <root>
    <level value="INFO" />
    <appender-ref ref="file" />
  </root>
  
  <!-- 可选：全局静态属性配置（比如固定的应用名称），配置后无需在代码重复设置 -->
  <contextProperties>
    <property name="AppName" value="MyDotNetApplication" />
  </contextProperties>
</log4net>

第二步：在代码中设置自定义属性值 #

根据属性的作用范围，分两种常用场景：

场景1：全局静态属性（比如应用名称、部署环境） #

如果是整个应用生命周期都不变的值，除了配置文件的<contextProperties>方式，也可以在程序启动时（比如Program.cs初始化段）通过代码设置：

// 全局上下文设置，整个应用进程内生效
log4net.GlobalContext.Properties["AppName"] = "MyDotNetApplication";

场景2：动态上下文属性（比如当前用户ID、请求ID） #

如果是随请求/线程变化的值（比如每个请求的用户ID），推荐用LogicalThreadContext（跨异步线程也能保留属性）或者ThreadContext（仅当前线程有效）：

// 在请求开始时设置，比如ASP.NET的Action过滤器、接口入口处
log4net.LogicalThreadContext.Properties["UserId"] = CurrentLoggedInUser.Id.ToString();

// 记录日志
ILog logger = log4net.LogManager.GetLogger(typeof(YourBusinessClass));
logger.Info("用户完成了订单提交操作");

// 可选：请求结束后清除属性，避免线程池复用导致的脏数据
log4net.LogicalThreadContext.Properties.Remove("UserId");

验证效果 #

配置完成后，日志文件会输出类似这样的内容：

2024-05-20 15:40:22 [456] INFO MyDotNetApplication - 10086 - 用户完成了订单提交操作

这样就成功把自定义属性嵌入到日志内容里啦～

内容的提问来源于stack exchange，提问作者Heidi T.