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

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

日志必须转到特殊文件夹

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

此路径根据您使用的是 WindowsServer2008还是 WindowsXP 或 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?
}
}

我只是需要想想怎样才能把东西记录到我想要的地方。

有什么建议吗？ 非常感谢

97947 次浏览
小开
最佳答案

Log4net 可以为您处理这个问题。在这种情况下，可以使用 Log4net. Util. PatternString选项处理程序格式化任何类型为 string 的 appender 属性。PatternString 甚至支持 特殊文件夹枚举，它支持以下优雅的配置:

<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 =”将使您的配置更具可读性。

小开

作为以编程方式执行此操作的替代方法，您可以在配置文件中使用环境变量和可定制的模式。请参阅对类似问题的回答.

查看 Log4Net V1.2.10发行说明中的“ PatternString for pattern based configuration”。

此外，如果您正在考虑写入一个目录，例如 Environment. SpecialFolder.CommonApplicationData，您需要考虑:

小开

看来 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 参数如下:

<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 (或其他任何东西)枚举值。

小开

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

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 (例如，您可以使用 Server。MapPath ()如果这是一个 Web 应用程序) ，以满足您的需要。

小开

这对我很有效:

  <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://stackoverflow.com/a/1889591/503621和注释
&
Https://superuser.com/q/405097/47628
Https://stackoverflow.com/a/5550502/503621

小开

简单来说:

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

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

小开

如果您必须部署到未知的系统，并且希望使用 Philipp M 提供的简单解决方案，即使使用不同的特殊文件夹，也可以检索所需的特殊文件夹路径，并在加载 log4net 配置之前设置自定义 env 变量。 String localData = Environment. GetFolderPath (Environment. SpecialFolder.LocalApplicationData) ; SetEnvironment 变量(“ MY _ FOLDER _ DATA”，localData) ; 配置(..。

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

小开

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

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

要回答操作系统最初的问题，应该是:

ChangeLogFile(path => Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), path));
小开

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

小开

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

那些希望将文件路径设置为“项目根目录路径”的用户可以参考下面的代码。我已经在。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>();
});

谢谢！

小开 
//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();

提交答案