logo标签列表

我该如何通过编程更改文件位置？

c#log4net
78

我完全不了解Log4net。通过添加配置文件和简单的日志记录，我已经成功地实现了一些功能。我已经将值硬编码为"C:\temp\log.txt"，但这还不够好。

日志必须进入特殊文件夹。

path = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData);

这个路径会根据您使用的Windows Server 2008、Windows XP或Vista等不同而发生变化...

我如何通过编程方式只更改log4net文件的位置？

这是我所做的：

<configSections>
<section name="log4net"
         type="log4net.Config.Log4NetConfigurationSectionHandler,Log4net"/>
</configSections>
<log4net>         
    <root>
        <level value="DEBUG" />
        <appender-ref ref="LogFileAppender" />
    </root>
    <appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
        <param name="File" value="C:\temp\log.txt" />
        <param name="AppendToFile" value="true" />
        <rollingStyle value="Size" />
        <maxSizeRollBackups value="10" />
        <maximumFileSize value="10MB" />
        <staticLogFileName value="true" />
        <layout type="log4net.Layout.PatternLayout">
            <param name="ConversionPattern" value="%-5p%d{yyyy-MM-dd hh:mm:ss} – %m%n" />
        </layout>
    </appender>
</log4net>

class Program
{
    protected static readonly ILog log = LogManager.GetLogger(typeof(Program));

    static void Main(string[] args)
    {
        log4net.Config.XmlConfigurator.Configure();
        log.Warn("Log something");

        path = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData);


        // How can I change where I log stuff?
    }
}

我只需要弄清楚如何将日志记录到我想要的位置。

有什么建议吗？非常感谢。

你需要深入了解你的日志记录器的IAppenders，并将FileAppender.File设置为你需要输出的路径。这里有一个[非常好的例子]（http://insario.com/blog/jfk/archive/2004/11/30/164.aspx）。 - Cam Soper
13个回答
90

log4net可以为你处理这个问题。 任何类型为字符串的appender属性都可以被格式化，此时可以使用log4net.Util.PatternString选项处理程序。PatternString甚至支持SpecialFolder枚举，使得以下优雅的配置成为可能:

<appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender" >
    <file type="log4net.Util.PatternString" 
        value="%envFolderPath{CommonApplicationData}\\test.txt" />
    ...
</appender>

这里有一个单元测试，证明布丁的可靠性：

[Test]
public void Load()
{
    XmlConfigurator.Configure();
    var fileAppender = LogManager.GetRepository()
        .GetAppenders().First(appender => appender is RollingFileAppender);

    var expectedFile = 
        Path.Combine(
            Environment.GetFolderPath(
                Environment.SpecialFolder.CommonApplicationData),
                "test.txt");

    Assert.That(fileAppender, 
        Is.Not.Null & Has.Property("File").EqualTo(expectedFile));
}

以下测试验证了log4net是否实际写入磁盘（这基本上使其成为“集成”测试，而不是单元测试，但我们暂且不管它）：

[Test]
public void Log4net_WritesToDisk()
{
    var expectedFile = 
        Path.Combine(
            Environment.GetFolderPath(
                Environment.SpecialFolder.CommonApplicationData),
                "test.txt");

    if (File.Exists(expectedFile))
        File.Delete(expectedFile);

    XmlConfigurator.Configure();

    var log = LogManager.GetLogger(typeof (ConfigTest));
    log.Info("Message from test");

    LogManager.Shutdown();

    Assert.That(File.ReadAllText(expectedFile), 
        Text.Contains("Message from test"));
}

注意：我强烈建议使用上述示例中演示的紧凑属性语法。删除所有那些“<property name=”将使您的配置更加易读。

1
嗨， 谢谢。我已经尝试了，但仍然无法登录应用程序数据。 我在网上找到了一个叫做PatternString的东西，但我不知道如何使用它。 有人有例子吗？ - user186134
2
%envFolderPath{}似乎不是log4net当前版本（1.2.10）的一部分。我不得不从他们的子版本库中提取r606477以启用这个非常有用的功能。我期望这将包含在下一个（1.2.11）版本中。 - Rodney Schuler
1
@rschuler：我添加了一个答案，适用于1.2.10版本，请见下文。 - codeulike
3
从@JackAce的下面的回答中，重置文件路径后，请确保调用“.ActivateOptions()”以激活它。调用.file会设置它，但在ActivateOptions调用之前不会使用它。 - Jeffrey Knight
1
请注意，如果您正在监视log4net配置文件的更改（https://logging.apache.org/log4net/release/sdk/html/P_log4net_Config_XmlConfiguratorAttribute_Watch.htm），则此方法不起作用。 - cbp
显示剩余4条评论
51

我在互联网上找到了这段代码的变异版本：

XmlConfigurator.Configure();
log4net.Repository.Hierarchy.Hierarchy h =
(log4net.Repository.Hierarchy.Hierarchy) LogManager.GetRepository();
foreach (IAppender a in h.Root.Appenders)
{
    if (a is FileAppender)
    {
        FileAppender fa = (FileAppender)a;
        // Programmatically set this to the desired location here
        string logFileLocation = @"C:\MySpecialFolder\MyFile.log";

        // Uncomment the lines below if you want to retain the base file name
        // and change the folder name...
        //FileInfo fileInfo = new FileInfo(fa.File);
        //logFileLocation = string.Format(@"C:\MySpecialFolder\{0}", fileInfo.Name);

        fa.File = logFileLocation;
        fa.ActivateOptions();
        break;
    }
}

这对我来说起作用。我们的应用程序需要将日志文件放在一个目录中，该目录包含根据AssemblyInfo.cs文件生成的应用程序版本号。

您应该能够以编程方式设置logFileLocation（例如，如果这是Web应用程序，则可以使用Server.MapPath（）），以满足您的需求。

4
我觉得这会更加掌控文件的位置。 - fregas
是的，这是唯一可行的方法。另一种方式太令人困惑了，我不敢向开发人员介绍它。 - Nicholas DiPiazza
16

看起来Peter的回答在Log4net v1.2.10.0上不起作用。另一种方法在这里描述。

基本上，这种方法是通过为log4net配置文件实现自定义模式转换器来完成的。

首先将此类添加到您的项目中：

public class SpecialFolderPatternConverter : log4net.Util.PatternConverter
{
    override protected void Convert(System.IO.TextWriter writer, object state)
    {
        Environment.SpecialFolder specialFolder = (Environment.SpecialFolder)Enum.Parse(typeof(Environment.SpecialFolder), base.Option, true);
        writer.Write(Environment.GetFolderPath(specialFolder));
    }
}

然后将FileAppender的文件参数设置如下：

<file type="log4net.Util.PatternString">
    <converter>
      <name value="folder" />
      <type value="MyAppName.SpecialFolderPatternConverter,MyAppName" />
    </converter>
    <conversionPattern value="%folder{CommonApplicationData}\\SomeOtherFolder\\log.txt" />
  </file>

基本上，%folder 告诉它查看名为 folder 的转换器，该转换器指向 SpecialFolderPatternConverter 类。然后它调用该类上的 Convert 方法，传递 CommonApplicationData（或其他）枚举值。

谢谢。顺便说一下，我认为MyAppName中的App指的是项目而不是应用程序。 - Jamie Kitson
如果您正在监视log4net.config文件的更改（https://logging.apache.org/log4net/release/sdk/html/P_log4net_Config_XmlConfiguratorAttribute_Watch.htm），那么这是唯一可行的选项。 - cbp
8
如何提供一个简单的方案：
XmlConfigurator.LogFullFilename = @"c:\ProgramData\MyApp\Myapp.log";

为什么做一件非常简单的事情会变得如此复杂？

（这段内容已经是中文了，无需翻译）
13
因为路径在不同操作系统下会有所变化，例如在Windows Server 2008和WinXP或Vista中。在XP中，没有c：\ ProgramData文件夹，只有在Win7 / Vista中才有。因此，如果要部署此应用程序，必须使其兼容所有操作系统。:-)硬编码并不是一种好的做法。 - Irshad
8
我正在使用log4net v2.0.3，但XmlConfigurator上没有这个属性。自回答发布以来必须已经被删除了。 - Appetere
感谢Jason纠正我的英语，这不是我的母语;) 谢谢！ - Eric
@Irshad：是的，但我们可以从数据库中读取配置（例如）。如果我们可以通过编程方式更改此路径，有时会更好。 - Hoàng Long
5

还可以更改错误日志的路径（基于JackAce的答案）：

private static void SetLogPath(string path, string errorPath)
{
    XmlConfigurator.Configure();
    log4net.Repository.Hierarchy.Hierarchy h =
    (log4net.Repository.Hierarchy.Hierarchy)LogManager.GetRepository();
    foreach (var a in h.Root.Appenders)
    {
        if (a is log4net.Appender.FileAppender)
        {
            if (a.Name.Equals("LogFileAppender"))
            { 
                log4net.Appender.FileAppender fa = (log4net.Appender.FileAppender)a;                    
                string logFileLocation = path; 
                fa.File = logFileLocation;                   
                fa.ActivateOptions();
            }
            else if (a.Name.Equals("ErrorFileAppender"))
            {
                log4net.Appender.FileAppender fa = (log4net.Appender.FileAppender)a;
                string logFileLocation = errorPath;
                fa.File = logFileLocation;
                fa.ActivateOptions();
            }
        }
    }
}
5

这对我有用：

  <log4net>
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
..
      <file value="${APPDATA}\MyApp\MyApp Client\logs\Log.txt"/>
..
  </log4net>

如果需要写入特殊文件夹，我在这里找到了帮助（第二个和第三个示例）。
编辑：
为了回答OP的问题.. 这适用于“所有用户”区域：
      ...
      <file value="${ALLUSERSPROFILE}\MyApp\MyApp Client\logs\Log.txt"/>
      ...

在较新的Windows版本中，通常为“C:\ProgramData”。
另请参阅：
如何指定log4net的公共应用程序数据文件夹？ == https://dev59.com/WXRB5IYBdhLWcg3w6bYE#1889591 和评论
&
https://superuser.com/q/405097/47628
https://stackoverflow.com/a/5550502/503621
Environment.SpecialFolder.CommonApplicationData和$(APPDATA)不是同一个文件夹。 - Sebastian Negraszus
你也可以尝试使用 "${ALLUSERSPROFILE}" 代替。 - B. Shea
4

以下是JackAce的回答，使用Linq更加简洁：

C#

XmlConfigurator.Configure();
var appender = (LogManager.GetRepository() as Hierarchy).Root.Appenders
    .OfType<FileAppender>()
    .First();

appender.File = logPath;
appender.ActivateOptions();

VB.NET

XmlConfigurator.Configure()
Dim appender = CType(LogManager.GetRepository(), Hierarchy).Root.Appenders _
    .OfType(FileAppender)() _
    .First()

appender.File = logPath
appender.ActivateOptions()
在我的情况下，第一行 XmlConfigurator.Configure(); 会在控制台输出警告。我只是将其删除，一切都按预期工作。 - Beauty
2
LINQ的一个很好的应用场景是使用OfType<T>过滤器。
/// <summary>
/// Applies a transformation to the filenames of all FileAppenders.
/// </summary>
public static void ChangeLogFile(Func<string,string> transformPath)
{
    // iterate over all FileAppenders
    foreach (var fileAppender in LogManager.GetRepository().GetAppenders().OfType<FileAppender>())
    {
        // apply transformation to the filename
        fileAppender.File = transformPath(fileAppender.File);
        // notify the logging subsystem of the configuration change
        fileAppender.ActivateOptions();
    }
}

如果app.config中的文件名是log.txt，这将把日志输出更改为logs/some_name_log.txt:
ChangeLogFile(path => Path.Combine("logs", $"some_name_{Path.GetFileName(path)}"));

回答OP最初的问题是：
ChangeLogFile(path => Path.Combine(
    Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), path));
当我这样做时，它只是用新名称重新创建了一个空文件，但是Logger.GetLogger仍然继续写入旧名称。 - Jay Sullivan
1
作为以编程方式的替代方案，您可以在配置文件中使用环境变量和可自定义模式。请参阅类似问题的此响应。
请查看Log4Net V1.2.10版本发布说明中的“基于模式的配置的PatternString”。
另外，如果您想要写入到像Enviroment.SpecialFolder.CommonApplicationData这样的目录中，您需要考虑以下几点：

  • 你的应用程序所有用户的所有实例是否都有写入日志文件的权限？例如，我不认为非管理员能够写入Environment.SpecialFolder.CommonApplicationData。

  • 如果多个应用程序实例（针对同一或不同的用户）尝试访问同一个文件，则会发生争用。您可以使用“最小锁定模型”（请参见http://logging.apache.org/log4net/release/config-examples.html），以允许多个进程写入同一个日志文件，但可能会影响性能。或者您可以为每个进程提供不同的日志文件，例如通过在文件名中包含进程ID来使用可自定义的模式。

1
在当前版本的Log4Net（2.0.8.0）中，您可以简单地使用<file value="${ProgramData}\myFolder\LogFiles\" />表示C:\ProgramData\..，并使用${LocalAppData}表示C:\Users\user\AppData\Local\。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接