MethodTimer.Fody 技术文档

1. 安装指南

在开始之前，请确保你已经安装了 Fody。以下为安装 MethodTimer.Fody 的步骤：

1. 使用 NuGet 包管理器安装 Fody：

   PM> Install-Package Fody
   

2. 安装 MethodTimer.Fody：

   PM> Install-Package MethodTimer.Fody
   

安装完成后，需要在 FodyWeavers.xml 文件中添加以下内容：

<Weavers>
  <MethodTimer/>
</Weavers>

2. 项目使用说明

MethodTimer.Fody 是一个 Fody 插件，用于在方法中注入基本的计时代码。你可以通过在方法上添加 [Time] 属性来使用它。

以下是一个简单的示例：

public class MyClass
{
    [Time]
    public void MyMethod()
    {
        // 代码块执行时间
        Console.WriteLine("Hello");
    }
}

这将编译为以下代码：

public class MyClass
{
    public void MyMethod()
    {
        var stopwatch = Stopwatch.StartNew();
        try
        {
            // 代码块执行时间
            Console.WriteLine("Hello");
        }
        finally
        {
            stopwatch.Stop();
            Trace.WriteLine("MyClass.MyMethod " + stopwatch.ElapsedMilliseconds + "ms");
        }
    }
}

3. 项目API使用文档

以下为 MethodTimer.Fody 提供的 API 文档：

Interceptor

你可以定义一个静态类来拦截日志记录。拦截器有两种形式：

使用 long 类型表示的经过时间（毫秒）

public static class MethodTimeLogger
{
    public static void Log(MethodBase methodBase, long milliseconds, string message)
    {
        // 在这里进行日志记录
    }
}

使用 TimeSpan 表示的经过时间

public static class MethodTimeLogger
{
    public static void Log(MethodBase methodBase, TimeSpan elapsed, string message)
    {
        // 在这里进行日志记录
    }
}

如果同时提供了这两种方法，拦截器将优先使用 TimeSpan 形式。

使用参数进行日志记录

如果你想在日志中获取参数值，可以在特性定义中使用字符串格式：

public class MyClass
{
    [Time("文件名: '{fileName}'")]
    public void MyMethod(string fileName)
    {
        // 代码块执行时间
        Console.WriteLine("Hello");
    }
}

这将编译为以下代码：

public class MyClass
{
    public void MyMethod(string fileName)
    {
        var stopwatch = Stopwatch.StartNew();
        try
        {
            // 代码块执行时间
            Console.WriteLine("Hello");
        }
        finally
        {
            stopwatch.Stop();
            var message = string.Format("文件名: '{0}'", fileName);
            MethodTimeLogger.Log(methodof(MyClass.MyMethod), stopwatch.ElapsedMilliseconds, message);
        }
    }
}

支持的值包括：

• 任何参数名（例如 {fileName}）
• {this}（在实例本身上调用 ToString()） - 注意，静态方法不支持此值，如果在静态方法中使用，编织器将抛出错误

注意：

1. 子属性目前不支持。如果你支持 Fody，这个功能可能会实现。
2. 此功能需要带有消息参数的以下日志方法定义。如果没有找到此方法，编织器将引发错误。

public static void Log(MethodBase methodBase, long milliseconds, string message)

4. 项目安装方式

MethodTimer.Fody 通过 NuGet 包进行安装。请按照以下步骤进行操作：

1. 使用 NuGet 包管理器安装 Fody 和 MethodTimer.Fody。
2. 在 FodyWeavers.xml 文件中添加 <MethodTimer/>。

这样就可以在项目中使用 MethodTimer.Fody 了。