你可以在代码中配置log4net而不是使用配置文件吗？

Question

我理解为什么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文件，甚至不作为嵌入式资源转换成流。我的目标是完全以编程方式定义记录器。只是好奇是否有可能，如果可能的话，我在哪里可以找到语法示例。

- Michael Mankus

---

相关帖子 - 使用xml文件配置log4net - RBT

Answer 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_{（此答案由提问者编辑到问题中，我有权将其变为社区答案，请看这里为什么）}}

- Philipp M

---

如果您在roller.File字符串中使用变量，那么您可以使用log4net.Util.PatternString类对其进行格式化，然后将结果指定给foller.File。 - Eric Scherrer

我使用这种方法最终得到了重复的日志条目。我通过在Setup()的开头添加“hierarchy.Root.RemoveAllAppenders();”来解决了这个问题。 - Philip Bergström

从所有这些中，我如何获得ILog？ - Mickey Perlstein

除非我调用BasicConfigurator.Configure(hierarchy)，否则设置hierarchy.Configured = true对我没有作用。 - Eivind Gussiås Løkseth

确保您期望写入日志文件的进程在写入目标文件夹时具有写入权限。要诊断log4net问题，请在任何其他log4net调用之前添加log4net.Util.LogLog.InternalDebugging = true;，然后在调试器下运行并检查输出结果。log4net会告诉您出现问题的位置。 - Manfred

Answer 2

你也可以完全避免使用XML，在这里我写了一个最小的编程配置示例。

简而言之，这是您所需的：

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;

- oleksii

---

层级（Hierarchy）类是用来做什么的？ - user20358

Answer 3

是的，你可以通过调用以下方法来配置log4net：

log4net.Config.XmlConfigurator.Configure(XmlElement element)

请参阅log4net文档。

- Joe

---

链接已失效。 - Toby Smith

@TobySmith - 已修复。 - Joe

Answer 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]

- Jas

Answer 5

对于那些不想将appender添加到根记录器，而是添加到当前/其他记录器的人：

最初的回答：

//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);

- Vladislav Kostenko

Answer 6

尽管被接受的答案在大多数情况下是有效的，但它有一些缺点。

• 它只保留最后5个日志。
• 日志大小设置为1GB，对于大多数记事本应用程序来说太大了。
• 由于它锁定了日志文件，因此不适合于多线程应用程序，如Web应用程序。
• 由于日期被添加到文件名前缀中，在Windows中使用不方便
• 每次应用程序重新启动时，它都会覆盖日志，这对于您打算保留日志是不合适的。
• 正如评论中提到的那样，它需要进行一些修改才能在某些情况下正确工作。

因此需要更详细的配置。我创建了一个类，使记录日志变得更加容易。当然，如果您希望，您可以只选择配置部分。

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 = "%d{yyyy-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上运行，请将日志文件保持在操作系统驱动器和应用程序文件夹之外。

- AaA

Answer 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://dev59.com/bWQo5IYBdhLWcg3wE8C2#19538654
#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"))

- ympostor