在 ASP.NET 中包含 log4Net 外部配置文件的最佳实践

Question

我至少看到了两种在 ASP.NET Web 应用程序中包含外部 log4net 配置文件的方法：

在 AssemblyInfo.cs 文件中具有以下属性：

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "Log.config", Watch = true)]

在 Global.asax.cs 中调用 XmlConfigurator：

protected void Application_Start()
{
    XmlConfigurator.Configure(new FileInfo("Log.config"));
}

最佳实践是什么去做吗？

Answer 1

启动时，调用：

XmlConfigurator.Configure();

在您的 Web.config 中，在 appSettings 中指定 log4net.Config：

<add key="log4net.Config" value="Log.config" />

此特殊设置允许您更改日志配置，而无需重新编译。对于在多个环境之间移动特别有帮助。

示例

考虑以下项目文件结构：

\config\log4net\debug.config
\config\log4net\staging.config
\config\log4net\release.config
\config\appSettings\debug.config
\config\appSettings\staging.config
\config\appSettings\release.config

每个环境的应用程序和日志记录配置都是不同的。对日志记录配置的引用保留在应用程序设置中。

\config\appSettings\debug.config：

<appSettings>
    <add key="log4net.Config" value="config\log4net\debug.config" />
    ...
</appSettings>

\config\appSettings\staging.config：

<appSettings>
    <add key="log4net.Config" value="config\log4net\staging.config" />
    ...
</appSettings>

\config\appSettings\release.config：

<appSettings>
    <add key="log4net.Config" value="config\log4net\release.config" />
    ...
</appSettings>

更改环境只需更新 Web.config 中的 appSettings 文件即可。

<appSettings file="config\appSettings\staging.config">
    ...
</appSettings>

Answer 2

我对“神奇”的配置方法不满意，因为我想在带有环境变量（%PUBLIC%\MyApp\MySettings.config）的路径中指定我的配置。

因此，我在 app.config 中添加了以下内容：

<add key="MyLog4NetConfigFile" value="%PUBLIC%\MyApp\MySettings.config"/>

并执行此操作来设置我的 log4net 配置：

var configFile = ConfigurationManager.AppSettings.Get("MyLog4NetConfigFile");
if( !string.IsNullOrEmpty(configFile))
{
    configFile = Environment.ExpandEnvironmentVariables(configFile);
    XmlConfigurator.Configure(new FileInfo(configFile));
}