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

Question

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

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

有什么建议吗？ 多谢

Answer 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"));
}

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

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

Answer 3

看起来像彼得的回答不适用于 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 参数：

<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（或其他）枚举值。

Answer 4

简单的怎么样：

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

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

Answer 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();
            }
        }
    }
}

Answer 6

这对我有用：

  <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”。

也请参阅这些：
如何为log4net指定通用应用程序数据文件夹？ == https://stackoverflow.com/a/1889591/503621 和评论
&
https://superuser.com/q/405097/47628
https://stackoverflow.com/a/5550502/503621

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

Answer 8

LINQ 的绝佳用例 OfType过滤器：

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

Answer 9

在当前版本的 Log4Net (2.0.8.0) 中，您可以简单地使用 表示 C:\ProgramData\ .. 和 ${LocalAppData} 用于 C:\Users\user\AppData\Local\

Answer 10

作为以编程方式执行此操作的替代方法，您可以在配置文件中使用环境变量和可自定义模式。 查看对类似问题的回复。

请参阅Log4Net V1.2.10 发行说明<中的“基于模式的配置的PatternString” /a>.

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

• 所有用户的应用程序的所有实例是否都具有对日志文件的写访问权限？例如，我不相信非管理员能够写入 Enviroment.SpecialFolder.CommonApplicationData。

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

Answer 11

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

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

Answer 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>();
        });

谢谢！

Answer 13

//Make sure you include System.Linq
//Though is an answer to old question, 
//but more concise, just two lines of code. 
((FileAppender)LogManager.GetRepository().GetAppenders().Select(a => a).First()).File = @"C:\log.txt";
((FileAppender)LogManager.GetRepository().GetAppenders().Select(a => a).First()).ActivateOptions();