Anotar.Fody 技术文档

本文档将详细介绍如何安装、使用以及项目API的调用方式，帮助用户更好地理解和运用Anotar.Fody项目。

1. 安装指南

Anotar.Fody 是 Fody 的一个插件，用于简化日志记录过程。以下是安装步骤：

• 安装 Fody NuGet 包：

  PM> Install-Package Fody
  

• 安装对应日志库的 Anotar.Fody NuGet 包。例如，对于 Catel 日志库，安装如下：

  PM> Install-Package Anotar.Catel.Fody
  

• 在 FodyWeavers.xml 文件中添加对应的日志库配置。例如，对于 Catel 日志库，添加如下配置：

  <Weavers>
    <Anotar.Catel/>
  </Weavers>
  

2. 项目使用说明

Anotar.Fody 支持多种日志库，包括 Catel、CommonLogging、NLog、NServiceBus、Serilog、Splat 等。以下是使用方法：

• 在代码中使用静态类 LogTo 记录日志。例如：

  public class MyClass
  {
      void MyMethod()
      {
          LogTo.Debug("TheMessage");
      }
  }
  

• 根据所使用的日志库，编译后的代码会自动生成对应的日志记录代码。例如，使用 Catel 日志库时：

  public class MyClass
  {
      static ILog logger = LogManager.GetLogger(typeof(MyClass));
  
      void MyMethod()
      {
          logger.WriteWithData("Method: 'Void MyMethod()'. Line: ~12. TheMessage", null, LogEvent.Debug);
      }
  }
  

3. 项目API使用文档

Anotar.Fody 提供了多种日志记录方法，包括 Debug、Info、Warn、Error 等。以下是部分API使用示例：

显式日志记录

• 使用 LogTo.Debug 方法记录调试信息：

  LogTo.Debug("TheMessage");
  

• 使用 LogTo.IsDebugEnabled 属性检查是否启用调试日志：

  if (LogTo.IsDebugEnabled)
  {
      LogTo.Debug("TheMessage");
  }
  

委托日志记录

• 使用委托延迟构造日志信息，仅在日志级别启用时构造消息：

  LogTo.Debug(() => "TheMessage");
  

异常日志记录

• 使用 LogToErrorOnException 特性自动记录方法内的异常信息：

  [LogToErrorOnException]
  void MyMethod(string param1, int param2)
  {
      // Do Stuff
  }
  

自定义日志

• 通过自定义日志工厂和实例，支持使用非标准或自定义的日志库。

4. 项目安装方式

请参考上述“安装指南”部分，使用 NuGet 包管理器安装所需的 Anotar.Fody NuGet 包及其依赖项。