SAEA.RPC 26.4.23.1

SAEA.RPC - 高性能远程过程调用框架 🚀

English Version | 中文版

基于 SAEA.Sockets IOCP 技术的高性能 RPC 框架，二进制传输，性能远超 HTTP/JSON RPC。

快速导航 🧭

30秒快速开始 ⚡

最快上手方式，只需3步即可运行 RPC 服务：

Step 1: 安装 NuGet 包

dotnet add package SAEA.RPC

Step 2: 创建 RPC 服务端（仅需5行代码）

using SAEA.RPC;

[RPCService]
public class HelloService
{
    public string SayHello(string name) => $"Hello, {name}!";
}

var provider = new ServiceProvider(port: 39654);
provider.Start();

Step 3: 创建 RPC 客户端调用

var proxy = new RPCServiceProxy("rpc://127.0.0.1:39654");
var result = proxy.HelloService.SayHello("SAEA");
Console.WriteLine(result);  // 输出: Hello, SAEA!

就这么简单！ 🎉 你已经实现了一个高性能的 RPC 远程调用系统。

核心特性 🎯

架构设计 📐

组件架构图

┌─────────────────────────────────────────────────────────────┐
│                     SAEA.RPC 架构                            │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  ┌─────────────────────┐      ┌─────────────────────┐      │
│  │    Client 端        │      │    Server 端        │      │
│  │                     │      │                     │      │
│  │  ┌───────────────┐  │      │  ┌───────────────┐  │      │
│  │  │RPCServiceProxy│  │      │  │ ServiceProvider│  │      │
│  │  │  (动态代理)    │  │      │  │  (服务提供者)  │  │      │
│  │  └───────┬───────┘  │      │  └───────┬───────┘  │      │
│  │          │          │      │          │          │      │
│  │  ┌───────▼───────┐  │      │  ┌───────▼───────┐  │      │
│  │  │ServiceConsumer│  │      │  │ [RPCService]  │  │      │
│  │  │  (消费者)     │  │      │  │  (服务类)     │  │      │
│  │  └───────┬───────┘  │      │  └───────┬───────┘  │      │
│  │          │          │      │          │          │      │
│  │  ┌───────▼───────┐  │      │  ┌───────▼───────┐  │      │
│  │  │ConsumerMulti- │  │      │  │ RPCMapping    │  │      │
│  │  │ plexer(连接池) │  │      │  │ (服务映射)    │  │      │
│  │  └───────┬───────┘  │      │  └───────┬───────┘  │      │
│  └──────────┼──────────┘      └──────────┼──────────┘      │
│             │                            │                  │
│             └────────────┬───────────────┘                  │
│                          │                                  │
│                 ┌────────▼────────┐                        │
│                 │  SAEA.Sockets   │                        │
│                 │   (IOCP 传输)   │                        │
│                 └─────────────────┘                        │
│                                                             │
└─────────────────────────────────────────────────────────────┘

RPC 调用流程图

客户端调用流程:

Client                        Server
  │                             │
  │  proxy.Method(args)         │
  │         │                   │
  │    ┌────▼────┐              │
  │    │ 动态代理 │              │
  │    │生成调用  │              │
  │    └────┬────┘              │
  │         │                   │
  │    ┌────▼────┐              │
  │    │Protobuf │              │
  │    │ 序列化  │              │
  │    └────┬────┘              │
  │         │                   │
  │    ┌────▼────┐   TCP/IOCP  ┌▼────────┐
  │    │发送请求 ├──────────────►接收请求 │
  │    └─────────┘              └────┬────┘
  │                                  │
  │                            ┌─────▼─────┐
  │                            │ RPCMapping│
  │                            │ 查找服务  │
  │                            └─────┬─────┘
  │                                  │
  │                            ┌─────▼─────┐
  │                            │ 调用方法  │
  │                            │执行逻辑   │
  │                            └─────┬─────┘
  │                                  │
  │                            ┌─────▼─────┐
  │                            │Protobuf   │
  │                            │ 序列化    │
  │                            └─────┬─────┘
  │                                  │
  │         ┌────────────────────────┘
  │    ┌────▼────┐              ┌────▼────┐
  │    │接收响应 ◄──────────────┤发送响应 │
  │    └────┬────┘              └─────────┘
  │         │
  │    ┌────▼────┐
  │    │Protobuf │
  │    │ 反序列化│
  │    └────┬────┘
  │         │
  │    ┌────▼────┐
  │    │返回结果 │
  │    └─────────┘
  │                             │

应用场景 💡

✅ 适合使用 SAEA.RPC 的场景

❌ 不适合的场景

性能对比 📊

与 HTTP RPC 对比

序列化性能对比

💡 提示: SAEA.RPC 使用 Protobuf 二进制序列化，数据体积小、速度快，是高性能 RPC 的最佳选择。

常见问题 ❓

Q1: SAEA.RPC 与 gRPC 有什么区别？

A: | 特性 | SAEA.RPC | gRPC | |------|----------|------| | 学习曲线 | 简单 | 中等 | | 跨语言 | 仅 .NET | 多语言支持 | | 传输协议 | 自定义 TCP | HTTP/2 | | 适用场景 | .NET 内部通信 | 跨语言微服务 |

推荐在纯 .NET 环境下使用 SAEA.RPC，更简单高效。

Q2: 如何实现服务注册与发现？

A: 配合 ConsumerMultiplexer 实现多地址负载均衡：

var urls = new[] 
{
    "rpc://192.168.1.1:39654",
    "rpc://192.168.1.2:39654"
};
var multiplexer = new ConsumerMultiplexer(urls);
var proxy = new RPCServiceProxy(multiplexer);

也可结合 Consul、Nacos 等服务发现组件动态更新地址列表。

Q3: 如何处理超时和异常？

A: 通过 OnErr 事件捕获异常：

var proxy = new RPCServiceProxy(url);
proxy.OnErr += (ex) => 
{
    Console.WriteLine($"RPC 调用异常: {ex.Message}");
};

服务端同样支持：

var provider = new ServiceProvider(port);
provider.OnErr += (ex) => Console.WriteLine(ex.Message);

Q4: 如何实现日志记录和权限验证？

A: 使用 AOP 过滤器 ActionFilterAttribute：

public class AuthAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(string service, string method, object[] args)
    {
        // 权限验证逻辑
        if (!ValidateToken())
            throw new UnauthorizedAccessException();
    }
}

[RPCService]
public class AdminService
{
    [Auth]
    public void DeleteUser(int id) { }
}

Q5: 支持异步方法吗？

A: 支持 async/await：

[RPCService]
public class UserService
{
    public async Task<User> GetUserAsync(int id)
    {
        return await _repository.FindAsync(id);
    }
}

Q6: 如何隐藏某些方法不对外暴露？

A: 使用 [NoRpc] 特性：

[RPCService]
public class UserService
{
    public string Login(string name) => "OK";  // 暴露
    
    [NoRpc]
    public void InternalMethod() { }  // 不暴露
}

Q7: 如何实现服务端推送？

A: 使用 Notice<T> 方法：

// 服务端推送
provider.Notice("updates", new { Message = "系统更新" });

// 客户端订阅
proxy.Subscribe("updates", (msg) => 
{
    Console.WriteLine($"收到推送: {msg}");
});

核心类 🔧

使用示例 📝

完整服务端示例

using SAEA.RPC;
using SAEA.RPC.Model;

// 定义用户实体
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public DateTime CreateTime { get; set; }
}

// 定义日志过滤器
public class LogAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(string serviceName, string methodName, object[] args)
    {
        Console.WriteLine($"[{DateTime.Now}] 调用: {serviceName}.{methodName}");
    }

    public override void OnActionExecuted(string serviceName, string methodName, object result, Exception ex)
    {
        if (ex != null)
            Console.WriteLine($"[错误] {ex.Message}");
        else
            Console.WriteLine($"[完成] 返回: {result}");
    }
}

// 定义 RPC 服务
[RPCService]
public class UserService
{
    private List<User> _users = new List<User>();

    [Log]
    public string Register(string name)
    {
        var user = new User 
        { 
            Id = _users.Count + 1, 
            Name = name,
            CreateTime = DateTime.Now 
        };
        _users.Add(user);
        return $"用户 {name} 注册成功，ID: {user.Id}";
    }

    public User GetUser(int id)
    {
        return _users.FirstOrDefault(u => u.Id == id);
    }

    public List<User> GetAllUsers()
    {
        return _users;
    }

    [NoRpc]
    public void InternalMethod()
    {
        // 此方法不会暴露为 RPC 服务
    }
}

// 启动服务
var provider = new ServiceProvider(port: 39654);
provider.OnErr += (ex) => Console.WriteLine($"服务错误: {ex.Message}");
provider.Start();

Console.WriteLine("RPC 服务已启动，端口: 39654");
Console.ReadKey();

完整客户端示例

using SAEA.RPC;

// 连接 RPC 服务
var url = "rpc://127.0.0.1:39654";
var proxy = new RPCServiceProxy(url);
proxy.OnErr += (ex) => Console.WriteLine($"调用错误: {ex.Message}");

// 调用远程方法 - 注册用户
var result = proxy.UserService.Register("张三");
Console.WriteLine(result);  // 输出: 用户 张三 注册成功，ID: 1

// 调用远程方法 - 获取用户
var user = proxy.UserService.GetUser(1);
Console.WriteLine($"用户信息: {user.Name}, 注册时间: {user.CreateTime}");

// 调用远程方法 - 获取所有用户
var users = proxy.UserService.GetAllUsers();
Console.WriteLine($"总用户数: {users.Count}");

多服务地址负载均衡

using SAEA.RPC;

// 配置多个服务地址
var urls = new[] 
{
    "rpc://192.168.1.1:39654",
    "rpc://192.168.1.2:39654",
    "rpc://192.168.1.3:39654"
};

// 创建多路复用连接池
var multiplexer = new ConsumerMultiplexer(urls);
var proxy = new RPCServiceProxy(multiplexer);

// 自动负载均衡调用
for (int i = 0; i < 100; i++)
{
    var result = proxy.UserService.Register($"User_{i}");
    Console.WriteLine(result);
}

服务端推送示例

using SAEA.RPC;

// 服务端
var provider = new ServiceProvider(port: 39654);
provider.Start();

// 定时推送消息
var timer = new Timer(_ => 
{
    provider.Notice("news", new 
    { 
        Title = "系统公告", 
        Content = $"当前时间: {DateTime.Now}" 
    });
}, null, 0, 5000);

// 客户端订阅
var proxy = new RPCServiceProxy("rpc://127.0.0.1:39654");
proxy.Subscribe("news", (msg) => 
{
    Console.WriteLine($"收到推送: {msg}");
});

传输协议

RPC 消息格式：

| Type(1字节) | Total(4字节) | SeqNo(8字节) | SLen(4字节) | ServiceName | MLen(4字节) | MethodName | Data |

消息类型：

• Ping/Pong - 心跳保活
• Request/Response - 请求响应
• Notice - 服务端推送
• Error - 错误消息
• Close - 关闭连接

依赖项

更多资源

• GitHub 仓库
• NuGet 包
• 作者博客

许可证

Apache License 2.0