如何以编程方式更改文件位置?

问题描述 投票:69回答:11

我对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?
    }
}

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

有什么建议?非常感谢

c# log4net
11个回答
86
投票

log4net可以为您处理。在这种情况下,可以使用log4net.Util.PatternString选项处理程序格式化任何类型字符串的appender属性。 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"));
}

注意:我强烈建议使用上面示例中演示的compact属性语法。删除所有那些“<property name =”使您的配置更具可读性。


0
投票

作为以编程方式执行此操作的替代方法,您可以在配置文件中使用环境变量和可自定义的模式。 See this response to a similar question

the Log4Net V1.2.10 release notes中查看“PatternString for pattern based configuration”。

此外,如果您正在考虑写入Enviroment.SpecialFolder.CommonApplicationData等目录,您需要考虑:

  • 您的应用程序的所有实例是否都具有对日志文件的写入权限?例如。我不相信非管理员可以写入Enviroment.SpecialFolder.CommonApplicationData。
  • 如果应用程序的多个实例(针对相同或不同的用户)尝试使用同一文件,则会发生争用。您可以使用“最小锁定模型”(请参阅​​http://logging.apache.org/log4net/release/config-examples.html以允许多个进程写入同一日志文件,但可能会对性能产生影响。或者您可以为每个进程提供不同的日志文件,例如通过包含进程ID在文件名中使用可自定义的模式。

0
投票

如果必须部署到未知系统,并且想要使用Philipp M的简单解决方案,即使使用不同的特殊文件夹,也可以检索所需的特殊文件夹路径,并在加载log4net配置之前设置自定义env变量。 string localData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); Environment.SetEnvironmentVariable("MY_FOLDER_DATA", localData); XmlConfigurator.Configure( ...

...只是为了确保env变量存在并具有您想要的值。


41
投票

我在互联网上发现了这个代码的变异:

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())以满足您的需要。


14
投票

看起来像Peter's answer不适用于Log4net v1.2.10.0。另一种方法是here

基本上,该方法是为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参数,如下所示:

<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的转换器,它将它指向Sp​​ecialFolderPatternConverter类。然后它在该类上调用Convert,传入CommonApplicationData(或其他)枚举值。


6
投票

怎么样简单:

XmlConfigurator.LogFullFilename = @"c:\ProgramData\MyApp\Myapp.log";

做一个非常简单的事情为什么这么复杂?


4
投票

这对我有用:

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

如果需要写入特殊文件夹我​​找到了帮助here(第2和第3例)。

编辑:

回答OP ..这适用于'所有用户'区域:

      ...
      <file value="${ALLUSERSPROFILE}\MyApp\MyApp Client\logs\Log.txt"/>
      ...

在较新版本的Windows中,这通常是“C:\ ProgramData”。

看到这些: How to specify common application data folder for log4net? == https://stackoverflow.com/a/1889591/503621和评论 & https://superuser.com/q/405097/47628 https://stackoverflow.com/a/5550502/503621


3
投票

还要更改错误日志的路径(基于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();
            }
        }
    }
}

3
投票

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()

2
投票

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

1
投票

在当前版本的Log4Net(2.0.8.0)中,您只需将<file value="${ProgramData}\myFolder\LogFiles\" />用于C:\ProgramData\..${LocalAppData}用于C:\Users\user\AppData\Local\

© www.soinside.com 2019 - 2024. All rights reserved.