您可以在代码中配置 log4net 而不是使用配置文件吗？
Posted
技术标签:
【中文标题】您可以在代码中配置 log4net 而不是使用配置文件吗？【英文标题】：Can you configure log4net in code instead of using a config file? 【发布时间】：2013-04-26 13:24:45 【问题描述】：我理解为什么 log4net 使用 app.config 文件来设置日志记录 - 这样您就可以轻松更改记录信息的方式，而无需重新编译您的代码。但就我而言，我不想将app.config 文件与我的可执行文件打包在一起。而且我不想修改我的日志记录设置。
有没有办法让我设置登录代码而不是使用app.config？
这是我的简单配置文件：
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
</configSections>
<log4net>
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="Logs\EventLog.txt" />
<appendToFile value="false" />
<rollingStyle value="Size" />
<maxSizeRollBackups value="5" />
<maximumFileSize value="1GB" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
</layout>
</appender>
<appender name="MemoryAppender" type="log4net.Appender.MemoryAppender">
</appender>
<root>
<level value="Info" />
<appender-ref ref="RollingLogFileAppender" />
<appender-ref ref="MemoryAppender" />
</root>
</log4net>
</configuration>
编辑：
完全清楚：我的目标是没有 XML 文件。甚至不是作为我变成流的嵌入式资源。我的目标是完全以编程方式定义记录器。只是好奇这是否可能，如果可以，我可能会在哪里找到语法示例。
【问题讨论】：
相关帖子 - Configuring log4net with xml file 【参考方案1】：最终解决方案：1
对于将来可能偶然发现此问题的任何人，这就是我所做的。我在下面制作了静态类：
using log4net;
using log4net.Repository.Hierarchy;
using log4net.Core;
using log4net.Appender;
using log4net.Layout;
namespace Spectrum.Logging
public class Logger
public static void Setup()
Hierarchy hierarchy = (Hierarchy)LogManager.GetRepository();
PatternLayout patternLayout = new PatternLayout();
patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions();
RollingFileAppender roller = new RollingFileAppender();
roller.AppendToFile = false;
roller.File = @"Logs\EventLog.txt";
roller.Layout = patternLayout;
roller.MaxSizeRollBackups = 5;
roller.MaximumFileSize = "1GB";
roller.RollingStyle = RollingFileAppender.RollingMode.Size;
roller.StaticLogFileName = true;
roller.ActivateOptions();
hierarchy.Root.AddAppender(roller);
MemoryAppender memory = new MemoryAppender();
memory.ActivateOptions();
hierarchy.Root.AddAppender(memory);
hierarchy.Root.Level = Level.Info;
hierarchy.Configured = true;
然后我所要做的就是用以下调用替换我调用 XML 文件的代码：
//XmlConfigurator.Configure(new FileInfo("app.config")); // Not needed anymore
Logger.Setup();
1（此答案已被 OP 编辑为问题，我冒昧将其设为社区答案，see here why）
【讨论】：
请注意，如果您在roller.File 字符串中使用变量，您可以在将结果分配给foller.File 之前使用log4net.Util.PatternString 类对其进行格式化。 我最终使用这种方法获得了重复的日志条目。我通过添加“hierarchy.Root.RemoveAllAppenders();”解决了这个问题到 Setup() 的开头。 从这一切中，我如何获得 ILog ？ 对我不起作用，除非我调用BasicConfigurator.Configure(hierarchy); 而不是设置 hierarchy.Configured = true;。
确保您希望写入日志文件的进程在您希望写入日志文件的文件夹中具有写入权限。要诊断 log4net 问题，请在任何其他 log4net 调用之前添加log4net.Util.LogLog.InternalDebugging = true;，然后在调试器下运行并检查输出。 log4net 会告诉你哪里出了问题。【参考方案2】：
你也可以完全转义XML，我写了一个带有最小程序配置的示例here。
简而言之，这就是您所需要的
var tracer = new TraceAppender();
var hierarchy = (Hierarchy)LogManager.GetRepository();
hierarchy.Root.AddAppender(tracer);
var patternLayout = new PatternLayout ConversionPattern = "%m%n";
patternLayout.ActivateOptions();
tracer.Layout = patternLayout;
hierarchy.Configured = true;
【讨论】：
Hierarchy 类有什么用？【参考方案3】：是的，你可以通过调用来配置 log4net：
log4net.Config.XmlConfigurator.Configure(XmlElement element)
见the log4net documentation。
【讨论】：
链接已失效 @TobySmith - 已修复。【参考方案4】：或者，您可以创建一个继承自 log4net.Config.ConfiguratorAttribute 的自定义属性并在其中硬编码您的配置：
using log4net.Appender;
using log4net.Config;
using log4net.Core;
using log4net.Layout;
using log4net.Repository;
using log4net.Repository.Hierarchy;
using System;
using System.Reflection;
namespace ConsoleApplication1
[AttributeUsage(AttributeTargets.Assembly)]
public class MyConfiguratorAttribute : ConfiguratorAttribute
public MyConfiguratorAttribute()
: base(0)
public override void Configure(Assembly sourceAssembly, ILoggerRepository targetRepository)
var hierarchy = (Hierarchy)targetRepository;
var patternLayout = new PatternLayout();
patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions();
var roller = new RollingFileAppender();
roller.AppendToFile = false;
roller.File = @"Logs\EventLog.txt";
roller.Layout = patternLayout;
roller.MaxSizeRollBackups = 5;
roller.MaximumFileSize = "1GB";
roller.RollingStyle = RollingFileAppender.RollingMode.Size;
roller.StaticLogFileName = true;
roller.ActivateOptions();
hierarchy.Root.AddAppender(roller);
hierarchy.Root.Level = Level.Info;
hierarchy.Configured = true;
然后将以下内容添加到 .cs 文件中：
[assembly: ConsoleApplication1.MyConfigurator]
【讨论】：
【参考方案5】：对于那些不想将 appender 添加到 Root 记录器，但要添加到当前/其他记录器的人：
//somewhere you've made a logger
var logger = LogManager.GetLogger("MyLogger");
// now add appender to it
var appender = BuildMyAppender();
((log4net.Repository.Hierarchy.Logger)logger).AddAppender(appender);
logger.Debug("MyLogger with MyAppender must work now");
// and remove it later if this code executed multiple times (loggers are cached, so you'll get logger with your appender attached next time "MyLogger")
((log4net.Repository.Hierarchy.Logger)logger).RemoveAppender(sbAppender);
【讨论】：
【参考方案6】：虽然接受的答案在大多数情况下都有效，但它有一些缺点。
它只保留 5 个最后的日志。 日志大小设置为 1GB，对于大多数记事本应用程序来说太大而无法打开。 由于它会锁定日志文件，因此不适合多线程应用，例如 Web 应用。 由于文件名有日期前缀，在windows中使用不方便 它会在每次应用程序重新启动时覆盖日志，如果您打算保留日志，这又不适合。 如 cmets 中所述，它需要进行一些修改才能使其在某些情况下正常工作。因此配置更广泛。我创建了一个类，它使日志记录更容易一些。显然，您可以根据需要选择配置部分。
using log4net;
using log4net.Appender;
using log4net.Config;
using log4net.Core;
using log4net.Layout;
using log4net.Repository.Hierarchy;
using System;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.Text;
using System.Web;
public enum LogType Info, Debug, Warn, Error, Fatal ;
public class Logger
private const string LOG_NAMESPACE = "APP_NAME";
private const string LOG_FILENAME_PREFIX = @"D:\Logs\";
private static readonly Level LOG_LEVEL = Level.Debug;
private static readonly ILog log = LogManager.GetLogger(LOG_NAMESPACE);
#region static Logger()
// Static constructor is called automatically to initialize the class before the first instance is created or any static members are referenced
static Logger()
Hierarchy hierarchy = (Hierarchy) LogManager.GetRepository();
hierarchy.Root.RemoveAllAppenders(); // Clear all previously added repositories.
hierarchy.Root.Level = LOG_LEVEL; // Set Log level
PatternLayout layout = new PatternLayout() ConversionPattern = "%dyyyy-MM-dd HH:mm:ss.fff %4t %-5p %m%n" ; // Log line format: Include millisecond precision, thread ID, Log type,
layout.ActivateOptions(); // Apply Configuration
RollingFileAppender RFA = new RollingFileAppender();
RFA.Name = LOG_NAMESPACE; // Set name of appender
RFA.File = LOG_FILENAME_PREFIX + LOG_NAMESPACE; // Set file name prefix
RFA.LockingModel = new FileAppender.MinimalLock(); // Minimum lock time required, makes file available for reading
RFA.AppendToFile = true; // Do not overwrite existing logs, append to them.
RFA.DatePattern = ".yyyy.MM.dd'.log'"; // Add file extension here, to preserve the file extension
RFA.Encoding = Encoding.UTF8; // Set format of file to UTF8 for international characters.
RFA.CountDirection = 1; // Increment file name in bigger number is newest, instead of default backward.
RFA.MaximumFileSize = "100MB"; // Maximum size of file that I could open with common notepad applications
RFA.RollingStyle = RollingFileAppender.RollingMode.Composite; // Increment file names by both size and date.
RFA.StaticLogFileName = false;
RFA.MaxSizeRollBackups = -1; // Keep all log files, do not automatically delete any
RFA.PreserveLogFileNameExtension = true; // This plus extension added to DatePattern, causes to rolling size also work correctly
RFA.Layout = layout;
RFA.ActivateOptions(); // Apply Configuration
hierarchy.Root.AddAppender(RFA);
BasicConfigurator.Configure(hierarchy); // Apply Configuration
#endregion
#region public static int Log(...)
public static void Log(string Description, LogType logtype = LogType.Info)
switch (logtype)
case LogType.Debug:
log.Debug(Description);
break;
case LogType.Info:
log.Info(Description);
break;
case LogType.Warn:
log.Warn(Description);
break;
case LogType.Error:
log.Error(Description);
break;
case LogType.Fatal:
log.Fatal(Description);
break;
#endregion
#region public static int Log(...)
public static void Log(string Message, Exception ex)
log.Fatal(Message, ex);
#endregion
然后像下面这样调用它来记录消息和异常
Logger.Log("I was here", LogType.Debug);
Logger.Log("I am info message");
Logger.Log("An error", LogType.Error);
Logger.Log("An Exception", ex); // ex is of type Exception
由于 log4net 将滚动数据添加到文件名（添加在文件扩展名之后）的奇怪方式，文件松散了 Windows 资源管理器关联。为了解决这个问题，.log 被添加到 DatePattern 中。它还将在扩展之前正确添加文件增量（可能是由于错误）在版本1.2.11.0上测试
注意事项：
不需要外部调用初始化，这将在应用程序启动时初始化（或者当您第一次调用 Logger.Log 时） 您可以将所有类常量移出到您自己的配置文件中，并使此类更加通用和可重用。 请注意，没有指定命名空间，这将使 Logger 类在所有命名空间中都可用。 Log4net 提供了 5 种记录消息的方法，记起来有点不方便。因此Logger.Log 方法默认使用info。
不相关的说明：如果您的应用程序在服务器或 Web 上运行，请将您的日志文件远离操作系统驱动器和应用程序文件夹。
【讨论】：
【参考方案7】：在我发现两个警告后，接受的答案有效：
起初它对我不起作用，但在为roller.File 属性使用完整的绝对路径后，它开始起作用了。
我不得不在 F# 中使用它（在 fsx 脚本中），所以从 C# 转换它时出现了一些问题。如果您对最终结果感兴趣（包括下载 log4net nuget 包的方法），请参见下文：
nuget_log4net.fsx：
#!/usr/bin/env fsharpi
open System
open System.IO
open System.Net
#r "System.IO.Compression.FileSystem"
open System.IO.Compression
type DummyTypeForLog4Net () =
do ()
module NetTools =
let DownloadNuget (packageId: string, packageVersion: string) =
use webClient = new WebClient()
let fileName = sprintf "%s.%s.nupkg" packageId packageVersion
let pathToUncompressTo = Path.Combine("packages", packageId)
if (Directory.Exists(pathToUncompressTo)) then
Directory.Delete(pathToUncompressTo, true)
Directory.CreateDirectory(pathToUncompressTo) |> ignore
let fileToDownload = Path.Combine(pathToUncompressTo, fileName)
let nugetDownloadUri = Uri (sprintf "https://www.nuget.org/api/v2/package/%s/%s" packageId packageVersion)
webClient.DownloadFile (nugetDownloadUri, fileToDownload)
ZipFile.ExtractToDirectory(fileToDownload, pathToUncompressTo)
let packageId = "log4net"
let packageVersion = "2.0.5"
NetTools.DownloadNuget(packageId, packageVersion)
let currentDirectory = Directory.GetCurrentDirectory()
// https://***.com/a/19538654/6503091
#r "packages/log4net/lib/net45-full/log4net"
open log4net
open log4net.Repository.Hierarchy
open log4net.Core
open log4net.Appender
open log4net.Layout
open log4net.Config
let patternLayout = PatternLayout()
patternLayout.ConversionPattern <- "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions()
let roller = RollingFileAppender()
roller.AppendToFile <- true
roller.File <- Path.Combine(currentDirectory, "someLog.txt")
roller.Layout <- patternLayout
roller.MaxSizeRollBackups <- 5
roller.MaximumFileSize <- "1GB"
roller.RollingStyle <- RollingFileAppender.RollingMode.Size
roller.StaticLogFileName <- true
roller.ActivateOptions ()
let hierarchy = box (LogManager.GetRepository()) :?> Hierarchy
hierarchy.Root.AddAppender (roller)
hierarchy.Root.Level <- Level.Info
hierarchy.Configured <- true
BasicConfigurator.Configure(hierarchy)
let aType = typedefof<DummyTypeForLog4Net>
let logger = LogManager.GetLogger(aType)
logger.Error(new Exception("exception test"))
【讨论】：
以上是关于您可以在代码中配置 log4net 而不是使用配置文件吗？的主要内容，如果未能解决你的问题，请参考以下文章