复合应用程序的最佳日志记录方法？

Question

我正在创建一个包含多个不同项目（Shell、模块等）的复合 WPF (Prism) 应用程序。我正准备使用 Log4Net 实现日志记录。似乎有两种方法可以设置日志记录：

• 让 Shell 项目执行所有实际日志记录。它获取对 Log4Net 的引用，其他项目会触发复合事件，让 Shell 知道它需要记录某些内容。这些项目仅在 Shell 的 app.config 文件中打开日志记录的级别（DEBUG、ERROR 等）触发事件，以免降低性能。

• 为每个项目（包括模块）提供一个 Log4Net 参考，并让项目将自己的日志记录到一个公共日志文件中，而不是将消息发送到 Shell 进行日志记录。

哪种方法更好？或者，我应该考虑另一种方法吗？感谢您的帮助。

Answer 1

登录 Prism 的最简单方法是覆盖 Bootstrapper 中的 LoggerFacade 属性。通过重写 LoggerFacade，您可以传入任何您想要的 Logger 实例以及所需的任何配置，只要该 Logger 实现了 ILoggerFacade 接口即可。

我发现以下内容对于日志记录非常有效（我正在使用 Enterprise Libary Logging 块，但对 Log4Net 应用类似的内容应该很简单）：

在 Shell 中创建 Boostrapper：

-My Project
  -Shell Module (add a reference to the Infrastructure project)
    -Bootstrapper.cs

在基础设施项目中创建日志适配器，即：

-My Project
  -Infrastructure Module
    -Adapters
      -Logging
        -MyCustomLoggerAdapter.cs
        -MyCustomLoggerAdapterExtendedAdapter.cs
        -IFormalLogger.cs

MyCustomLoggerAdapter 类将用于覆盖 Bootstrapper 中的“LoggerFacade”属性。它应该有一个默认的构造函数来更新所有内容。

注意：通过覆盖 Bootstrapper 中的 LoggerFacade 属性，您可以为 Prism 提供一个日志记录机制，用于记录其自己的内部消息。您可以在整个应用程序中使用此记录器，也可以扩展该记录器以获得功能更齐全的记录器。 （请参阅 MyCustomLoggerAdapterExtendedAdapter/IFormalLogger）

public class MyCustomLoggerAdapter : ILoggerFacade
{

    #region ILoggerFacade Members

    /// <summary>
    /// Logs an entry using the Enterprise Library logging. 
    /// For logging a Category.Exception type, it is preferred to use
    /// the EnterpriseLibraryLoggerAdapter.Exception methods."
    /// </summary>
    public void Log( string message, Category category, Priority priority )
    {
        if( category == Category.Exception )
        {
            Exception( new Exception( message ), ExceptionPolicies.Default );
            return;
        }

        Logger.Write( message, category.ToString(), ( int )priority );
    }

    #endregion


    /// <summary>
    /// Logs an entry using the Enterprise Library Logging.
    /// </summary>
    /// <param name="entry">the LogEntry object used to log the 
    /// entry with Enterprise Library.</param>
    public void Log( LogEntry entry )
    {
        Logger.Write( entry );
    }

    // Other methods if needed, i.e., a default Exception logger.
    public void Exception ( Exception ex ) { // do stuff }
}

MyCustomLoggerAdapterExtendedAdapter 派生自 MyCustomLoggerAdapter，并且可以提供额外的构造函数以实现更完整的功能。 -成熟的记录器。

public class MyCustomLoggerAdapterExtendedAdapter : MyCustomLoggerAdapter, IFormalLogger
{

    private readonly ILoggingPolicySection _config;
    private LogEntry _infoPolicy;
    private LogEntry _debugPolicy;
    private LogEntry _warnPolicy;
    private LogEntry _errorPolicy;

    private LogEntry InfoLog
    {
        get
        {
            if( _infoPolicy == null )
            {
                LogEntry log = GetLogEntryByPolicyName( LogPolicies.Info );
                _infoPolicy = log;
            }
            return _infoPolicy;
        }
    }

    // removed backing code for brevity
    private LogEntry DebugLog... WarnLog... ErrorLog


    // ILoggingPolicySection is passed via constructor injection in the bootstrapper
    // and is used to configure various logging policies.
    public MyCustomLoggerAdapterExtendedAdapter ( ILoggingPolicySection loggingPolicySection )
    {
        _config = loggingPolicySection;
    }


    #region IFormalLogger Members

    /// <summary>
    /// Info: informational statements concerning program state, 
    /// representing program events or behavior tracking.
    /// </summary>
    /// <param name="message"></param>
    public void Info( string message )
    {
        InfoLog.Message = message;
        InfoLog.ExtendedProperties.Clear();
        base.Log( InfoLog );
    }

    /// <summary>
    /// Debug: fine-grained statements concerning program state, 
    /// typically used for debugging.
    /// </summary>
    /// <param name="message"></param>
    public void Debug( string message )
    {
        DebugLog.Message = message;
        DebugLog.ExtendedProperties.Clear();
        base.Log( DebugLog );
    }

    /// <summary>
    /// Warn: statements that describe potentially harmful 
    /// events or states in the program.
    /// </summary>
    /// <param name="message"></param>
    public void Warn( string message )
    {
        WarnLog.Message = message;
        WarnLog.ExtendedProperties.Clear();
        base.Log( WarnLog );
    }

    /// <summary>
    /// Error: statements that describe non-fatal errors in the application; 
    /// sometimes used for handled exceptions. For more defined Exception
    /// logging, use the Exception method in this class.
    /// </summary>
    /// <param name="message"></param>
    public void Error( string message )
    {
        ErrorLog.Message = message;
        ErrorLog.ExtendedProperties.Clear();
        base.Log( ErrorLog );
    }

    /// <summary>
    /// Logs an Exception using the Default EntLib Exception policy
    /// as defined in the Exceptions.config file.
    /// </summary>
    /// <param name="ex"></param>
    public void Exception( Exception ex )
    {
        base.Exception( ex, ExceptionPolicies.Default );
    }

    #endregion


    /// <summary>
    /// Creates a LogEntry object based on the policy name as 
    /// defined in the logging config file.
    /// </summary>
    /// <param name="policyName">name of the policy to get.</param>
    /// <returns>a new LogEntry object.</returns>
    private LogEntry GetLogEntryByPolicyName( string policyName )
    {
        if( !_config.Policies.Contains( policyName ) )
        {
            throw new ArgumentException( string.Format(
              "The policy '{0}' does not exist in the LoggingPoliciesCollection", 
              policyName ) );
        }

        ILoggingPolicyElement policy = _config.Policies[policyName];

        var log = new LogEntry();
        log.Categories.Add( policy.Category );
        log.Title = policy.Title;
        log.EventId = policy.EventId;
        log.Severity = policy.Severity;
        log.Priority = ( int )policy.Priority;
        log.ExtendedProperties.Clear();

        return log;
    }

}


public interface IFormalLogger
{

    void Info( string message );

    void Debug( string message );

    void Warn( string message );

    void Error( string message );

    void Exception( Exception ex );

}

在 Bootstrapper 中：

public class MyProjectBootstrapper : UnityBootstrapper
{

  protected override void ConfigureContainer()
  {
    // ... arbitrary stuff

    // create constructor injection for the MyCustomLoggerAdapterExtendedAdapter
      var logPolicyConfigSection = ConfigurationManager.GetSection( LogPolicies.CorporateLoggingConfiguration );
      var injectedLogPolicy = new InjectionConstructor( logPolicyConfigSection as LoggingPolicySection );

      // register the MyCustomLoggerAdapterExtendedAdapter
      Container.RegisterType<IFormalLogger, MyCustomLoggerAdapterExtendedAdapter>(
              new ContainerControlledLifetimeManager(), injectedLogPolicy );

  }

    private readonly MyCustomLoggerAdapter _logger = new MyCustomLoggerAdapter();
    protected override ILoggerFacade LoggerFacade
    {
        get
        {
            return _logger;
        }
    }

}

最后，要使用任一记录器，您所需要做的就是将适当的接口添加到类的构造函数中，UnityContainer 将为您注入记录器：

public partial class Shell : Window, IShellView
{
    private readonly IFormalLogger _logger;
    private readonly ILoggerFacade _loggerFacade;

    public Shell( IFormalLogger logger, ILoggerFacade loggerFacade )
    {
        _logger = logger;
        _loggerFacade = loggerFacade

        _logger.Debug( "Shell: Instantiating the .ctor." );
        _loggerFacade.Log( "My Message", Category.Debug, Priority.None );

        InitializeComponent();
    }


    #region IShellView Members

    public void ShowView()
    {
        _logger.Debug( "Shell: Showing the Shell (ShowView)." );
         _loggerFacade.Log( "Shell: Showing the Shell (ShowView).", Category.Debug, Priority.None );
       this.Show();
    }

    #endregion

}

我认为您不需要用于日志记录策略的单独模块。通过将日志记录策略添加到基础设施模块，所有其他模块都将获得所需的引用（假设您将基础设施模块添加为对其他模块的引用）。通过将记录器添加到 Boostrapper，您可以让 UnityContainer 根据需要注入日志记录策略。

CodePlex 上的 CompositeWPF contrib 项目上有一个 uisng Log4Net 的简单示例以及。

HTH 的

Answer 2

我终于回到了这个问题，结果发现答案真的很简单。在 Shell 项目中，将 Log4Net 配置为自定义记录器。 Prism 文档（2009 年 2 月）第 12 页解释了如何执行此操作。 287）。 Shell 项目是唯一需要引用 Log4Net 的项目。要访问记录器（假设所有模块都传递了对 Prism IOC 容器的引用），只需解析 IOC 容器中的 ILoggerFacade，这将为您提供对自定义记录器的引用。以正常方式向此记录器传递消息。

因此，不需要将任何事件返回到 Shell，也不需要模块具有 Log4Net 引用。天哪，我喜欢 IOC 容器！

Answer 3

上面建议的 LoggerFacade 的问题是应用程序的非棱镜部分不会知道它。恕我直言，记录器需要比复合框架内的更低级别和更普遍的可访问性。

我的建议是，为什么不只依赖标准的Debug/Trace并实现您自己的TraceListener。这样，它对于 Prism/nonPrism 部件都适用。您可以通过此实现所需的灵活性。

Answer 4

为每个模块设置单独的记录器配置可能会在部署时出现问题。请记住，高级用户或管理员可能会完全更改您的日志记录目标，重定向到数据库或中央存储库聚合日志记录服务（例如 我公司的一个）。如果所有单独的模块都有单独的配置，则高级用户/管理员必须为每个模块重复配置（在每个 .config 文件中，或在主 app.config 中的每个模块部分中），并在每次位置更改时重复此操作/发生格式化。此外，考虑到附加程序是在运行时从配置中添加的，并且可能存在您目前不了解的附加程序，有人可能会使用锁定文件的附加程序并导致应用程序模块之间发生冲突。 Hsving 一个 log4.net 配置简化了管理。

各个模块仍然可以根据每个模块的需要单独进行配置（例如 DB 层的 INFO，UI 层的 ERROR）。每个模块都会通过询问自己的类型来获取记录器：LogManager.GetLogger(typeof(MyModule);，但只有 Shell 会使用自己的应用程序配置记录器（例如，调用 XmlConfigurator.Configure） .config。