首页
/ MethodDecorator.Fody 技术文档

MethodDecorator.Fody 技术文档

2024-12-28 00:19:09作者:田桥桑Industrious

1. 安装指南

NuGet 安装

在您的项目中,您需要通过 NuGet 包管理器安装以下两个包:

  1. Fody
  2. MethodDecorator.Fody

您可以通过以下 PowerShell 命令进行安装:

PM> Install-Package Fody
PM> Install-Package MethodDecorator.Fody

请注意,您必须安装 Fody 包,因为 NuGet 默认安装的是最新版本的依赖项,这可能导致出现bug。

2. 项目的使用说明

MethodDecorator.Fody 是一个通过 IL 重写实现的编译时装饰者模式插件。它作为 Fody 的插件使用。

在使用之前,您需要定义一个装饰者属性,如下所示:

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Constructor | AttributeTargets.Assembly | AttributeTargets.Module)]
public class InterceptorAttribute : Attribute, IMethodDecorator {
    public void Init(object instance, MethodBase method, object[] args) {
        // 在这里捕获 instance, method 和 args,以便在 OnEntry/OnExit/OnException 中使用
    }

    public void OnEntry() {
        // 方法调用前执行
    }

    public void OnExit() {
        // 方法调用后执行
    }

    public void OnException(Exception exception) {
        // 发生异常时执行
    }
}

然后,在您的类中,您可以对需要装饰的方法添加 Interceptor 属性:

public class Sample {
    [Interceptor]
    public void Method() {
        Debug.WriteLine("Your Code");
    }
}

3. 项目API使用文档

当您在方法上应用 Interceptor 属性时,MethodDecorator.Fody 会在编译时修改您的代码,使其在每个方法的调用前后执行特定的逻辑。以下是可用的API:

  • Init(object instance, MethodBase method, object[] args): 在方法被调用前初始化。
  • OnEntry(): 在方法执行前调用。
  • OnExit(): 在方法执行后调用。
  • OnException(Exception exception): 当方法中发生异常时调用。

此外,如果您的方法是异步的,并且发生了异常,OnException 将不会被调用,而是调用 OnTaskContinuation(Task task)

4. 项目安装方式

项目的安装方式主要通过 NuGet 包管理器完成,具体步骤如下:

  1. 打开您项目的NuGet包管理器。
  2. 搜索并安装 Fody 包。
  3. 搜索并安装 MethodDecorator.Fody 包。

安装完成后,您可以根据本文档中的“项目的使用说明”部分开始使用该方法。

登录后查看全文
热门项目推荐