如何以编程方式更改文件位置？答案

【问题标题】：How can I change the file location programmatically?如何以编程方式更改文件位置？
【发布时间】：2010-12-04 21:04:21
【问题描述】：

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

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

有什么建议吗？非常感谢

【问题讨论】：

您需要深入了解记录器的 IAppender 并将 FileAppender.File 设置为所需的输出路径。这是really good example。

标签： c# log4net

【解决方案1】：

log4net 可以为您处理这个问题。在这种情况下，可以使用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"));
}

注意：我强烈建议使用上面示例中演示的紧凑属性语法。删除所有这些“

【讨论】：

嗨，谢谢，我已经尝试过了，但仍然没有登录应用程序数据我在网上查看过我发现了一个名为 PatternString 的东西，但我不知道如何使用它。有人举个例子吗？
@brix - 我最初的答案没有奏效，所以我必须向自己证明 log4net 可以做到这一点。 PatternString 是解决方案:)
%envFolderPath{} 似乎不是 log4net 当前 (1.2.10) 版本的一部分。我必须从他们的 subversion 存储库中提取 r606477 才能启用这个非常有用的功能。我希望这将包含在下一个 (1.2.11) 版本中。
@rschuler：我添加了一个适用于 1.2.10 的答案，见下文
来自@JackAce 下面的回答，重置文件路径后，一定要调用“.ActivateOptions()”来激活它。调用 .file 将设置它，但在 ActivateOptions 调用之前不会使用它

【解决方案2】：

我在互联网上发现了这段代码的突变：

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

【讨论】：

我觉得这样可以更好地控制文件位置。

【解决方案3】：

看起来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 的转换器，它将它指向SpecialFolderPatternConverter 类。然后它在该类上调用 Convert，传入 CommonApplicationData（或其他）枚举值。

【讨论】：

谢谢。顺便说一句，我认为 MyAppName 中的 App 指的是 Project 而不是 App。
如果您正在查看 log4net.config 文件的更改，这是唯一有效的选项 (logging.apache.org/log4net/release/sdk/html/…)

【解决方案4】：

简单的怎么样：

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

为什么做一件非常简单的事情会这么复杂？

【讨论】：

因为，路径会根据您是在 windows Server 2008 还是 winxp 或 vista 等而改变... 在 XP 中没有 c:\ProgramData 文件夹，只有在 Win7/Vista 中。因此，如果我们要部署这个应用程序，它必须与所有操作系统兼容。 :-) 硬编码不是一个好习惯。
我正在使用 log4net v2.0.3，并且此属性在 XmlConfigurator 上不可用。自发布答案以来必须已被删除。
感谢 Jason 纠正我的英语，这不是我的主要语言；）谢谢！
@Irshad：是的，但是我们可以从数据库中读取配置（例如）。如果我们可以通过编程方式改变这条路径，有时会更好

【解决方案5】：

这对我有用：

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

如果需要写入特殊文件夹，我找到了帮助 here（第二个和第三个示例）。

编辑：

回答 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 和 cmets
&
https://superuser.com/q/405097/47628
https://stackoverflow.com/a/5550502/503621

【讨论】：

Environment.SpecialFolder.CommonApplicationData 和 $(APPDATA) 不是同一个文件夹
你也可以试试“${ALLUSERSPROFILE}”。 .

【解决方案6】：

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

【讨论】：

【解决方案7】：

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

【讨论】：

【解决方案8】：

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 继续写入旧名称。

【解决方案9】：

作为以编程方式执行此操作的替代方法，您可以在配置文件中使用环境变量和可自定义的模式。 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。

【讨论】：

【解决方案10】：

在当前版本的 Log4Net (2.0.8.0) 中，您可以简单地将<file value="${ProgramData}\myFolder\LogFiles\" /> 用于C:\ProgramData\.. 和${LocalAppData} 用于C:\Users\user\AppData\Local\

【讨论】：

【解决方案11】：

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

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

【讨论】：

【解决方案12】：

那些希望将文件路径设置为项目根目录路径的人可以参考下面的代码。我已经在 .NET 5 API 项目中实现了这个

Log4net.config 文件的更改。记住 type="log4net.Util.PatternString" 这一行很重要

<appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
<file type="log4net.Util.PatternString" value="%property{LoggerFilePath}\Logs\server.log" />
<appendToFile value="true" />
<maximumFileSize value="100KB" />
<maxSizeRollBackups value="2" />
<layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="%date %5level %logger.%method [%line] - MESSAGE: %message%newline %exception" />
</layout>

然后，在Program.cs 文件中

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureLogging((context,loggerBuilder) => 
        {
            log4net.GlobalContext.Properties["LoggerFilePath"] = context.HostingEnvironment.ContentRootPath;
            loggerBuilder.ClearProviders();
            loggerBuilder.AddLog4Net();
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

谢谢！

【讨论】：