# ProxyDispatch

**Repository Path**: dotnetchina/ProxyDispatch

## Basic Information

- **Project Name**: ProxyDispatch
- **Description**: 基于 DispatchProxy 和 Roslyn 实现的高性能轻量级代理库，支持类、接口、同步方法、异步方法拦截。
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 38
- **Forks**: 9
- **Created**: 2023-05-03
- **Last Updated**: 2025-02-25

## Categories & Tags

**Categories**: utils

**Tags**: None

## README

# ProxyDispatch

[![license](https://img.shields.io/badge/license-MIT-orange?cacheSeconds=10800)](https://gitee.com/dotnetchina/ProxyDispatch/blob/master/LICENSE) [![nuget](https://img.shields.io/nuget/v/ProxyDispatch.svg?cacheSeconds=10800)](https://www.nuget.org/packages/ProxyDispatch) [![dotNET China](https://img.shields.io/badge/organization-dotNET%20China-yellow?cacheSeconds=10800)](https://gitee.com/dotnetchina)

基于 DispatchProxy 和 Roslyn 实现的高性能轻量级代理库，支持类、接口、同步方法、异步方法拦截。

## 安装

```powershell
dotnet add package ProxyDispatch
```

## 快速入门

我们在[主页](https://furion.baiqian.ltd/docs/job/)上有不少例子，这是让您入门的第一个：

1. 定义代理拦截器，并实现 `AspectDispatchProxy` 抽象方法：

```cs
public class YourClassProxy : AspectDispatchProxy
{
    // 拦截同步
    public override object Invoke(Invocation invocation)
    {
        Console.WriteLine($"~~~调用同步方法：{invocation.Method}");
        var result = invocation.Proceed();
        Console.WriteLine($"~~~调用同步方法结束，返回值：{result}");
        return result;
    }

    // 拦截异步
    public override async Task InvokeAsync(Invocation invocation)
    {
        Console.WriteLine($"~~~调用异步 Task 方法：{invocation.Method}");
        await invocation.ProceedAsync();
        Console.WriteLine("~~~调用异步 Task 方法结束");
    }

    // 拦截异步带返回值
    public override async Task<T> InvokeAsync<T>(Invocation invocation)
    {
        Console.WriteLine($"~~~调用异步 Task<T> 方法：{invocation.Method}");
        var result = await invocation.ProceedAsync<T>();
        Console.WriteLine($"~~~调用异步 Task<T> 方法结束，返回值：{result}");
        return result;
    }
}
```

2. 定义需要拦截的类和接口：

```cs
public class YourClass : IYourClass
{
    // 同步方法
    public string SyncMethod(string str)
    {
        return str;
    }

    // 异步方法
    public async Task AsyncMethod()
    {
        await Task.CompletedTask;
    }

    // 异步方法带返回值
    public async Task<int> AsyncMethodWithResult(int num)
    {
        await Task.Delay(10);
        return num + 100;
    }

    // 泛型方法
    public T GenericMethod<T>(T x)
    {
        return x;
    }
}

public interface IYourClass
{
    // 同步方法
    string SyncMethod(string str);

    // 异步方法
    Task AsyncMethod();

    // 异步方法带返回值
    Task<int> AsyncMethodWithResult(int num);

    // 泛型方法
    T GenericMethod<T>(T x);
}
```

3. 创建拦截代理对象：

```cs
// 创建拦截对象
var yourClass = AspectDispatchProxy.Decorate<IYourClass, YourClassProxy>(new YourClass());

yourClass.SyncMethod("百小僧");
await yourClass.AsyncMethod();
await yourClass.AsyncMethodWithResult(100);
Console.WriteLine("泛型方法 GenericMethod 调用，返回值：" + yourClass.GenericMethod("Furion"));
```

输出如下：

```bash
~~~调用同步方法：System.String SyncMethod(System.String)
~~~调用同步方法结束，返回值：百小僧
~~~调用异步 Task 方法：System.Threading.Tasks.Task AsyncMethod()
~~~调用异步 Task 方法结束
~~~调用异步 Task<T> 方法：System.Threading.Tasks.Task`1[System.Int32] AsyncMethodWithResult(Int32)
~~~调用异步 Task<T> 方法结束，返回值：200
泛型方法 GenericMethod 调用，返回值：Furion
```

4. 还可以直接代理类，无需接口：

```cs
// 创建拦截对象（无依赖接口）
var yourClassNoInterface = AspectDispatchProxy.DecorateClass<YourClass, YourClassProxy>(new YourClass());

yourClassNoInterface.SyncMethod("百小僧");
await yourClassNoInterface.AsyncMethod();
await yourClassNoInterface.AsyncMethodWithResult(100);
Console.WriteLine("泛型方法 GenericMethod 调用，返回值：" + yourClassNoInterface.GenericMethod("Furion"));
```

[更多文档](https://gitee.com/dotnetchina/ProxyDispatch)

## 文档

您可以在[主页](https://gitee.com/dotnetchina/ProxyDispatch)找到 ProxyDispatch 文档。

## 贡献

该存储库的主要目的是继续发展 ProxyDispatch 核心，使其更快、更易于使用。ProxyDispatch 的开发在 [Gitee](https://gitee.com/dotnetchina/ProxyDispatch) 上公开进行，我们感谢社区贡献错误修复和改进。

## 许可证

ProxyDispatch 采用 [MIT](./LICENSE) 开源许可证。