IceRPC for C 使用教程

1. 项目介绍

IceRPC 是一个为 QUIC 设计的 C# RPC 框架，支持双向流、一流的 async/await 语法以及 Protobuf 支持。它旨在帮助开发者以最小的努力构建网络应用。IceRPC 使用自己的应用协议 icerpc 来交换连接设置、传输请求和响应，并确保有序关闭。这个新的面向 RPC 的协议是构建在 QUIC 之上的一个薄层。

IceRPC 不仅限于 QUIC，还提供了一个名为 Slic 的多路复用适配器，它可以在任何双工传输（如 TCP）上实现类似 QUIC 的多路复用传输。这样，你可以使用 QUIC、TCP（通过 Slic），以及各种传统的传输方式，如蓝牙和命名管道。

2. 项目快速启动

首先，确保你已经安装了 .NET SDK。

克隆项目仓库：

git clone https://github.com/icerpc/icerpc-csharp.git
cd icerpc-csharp

编译项目：

build.sh

或者如果你使用的是 Windows：

build.cmd

运行示例：

在 examples 目录下，你可以找到不同的示例项目。例如，运行 HelloWorld 示例：

cd examples/HelloWorld
dotnet run

这将启动一个简单的 RPC 服务，并在控制台上打印信息。

3. 应用案例和最佳实践

定义服务

使用 Slice IDL 定义你的服务。例如，创建一个简单的问候服务：

interface Greeter {
    string Greet(string name);
}

使用 Slice 编译器生成 C# 代码，然后实现服务接口：

public class GreeterService : IGreeterService {
    public async Task<string> Greet(string name) {
        return $"Hello, {name}!";
    }
}

调用服务

客户端可以使用生成的代理类来调用服务：

var client = new GreeterProxy(connection);
var response = await client.GreetAsync("Alice");
Console.WriteLine(response);  // 输出: Hello, Alice!

日志和中间件

IceRPC 支持添加中间件来记录请求和响应，或者添加其他逻辑：

var serviceBuilder = new ServiceBuilder();
serviceBuilder.AddMiddleware<LoggerMiddleware>();

4. 典型生态项目

IceRPC 的生态项目包括但不限于：

• IceRPC.Slic: 一个适配器，允许在非 QUIC 传输上使用 IceRPC。
• IceRPC.ProtoBuf: 一个集成，允许使用 Protobuf 作为序列化格式。
• IceRPC.OpenTelemetry: 集成 OpenTelemetry 进行遥测和跟踪。

开发者可以根据需要选择和集成这些项目，以扩展 IceRPC 的功能。