摘要：StreamJSONRpc 是微软开发的一个开源库，用于在 .NET 平台中实现基于 JSON-RPC 2.0 规范 的远程过程调用（RPC）。它通过流（如管道、网络流等）实现高效的跨进程或跨网络通信，特别适用于需要轻量级、灵活通信的场景。以下是对 Strea
StreamJSONRpc 是微软开发的一个开源库，用于在 .NET 平台中实现基于 JSON-RPC 2.0 规范 的远程过程调用（RPC）。它通过流（如管道、网络流等）实现高效的跨进程或跨网络通信，特别适用于需要轻量级、灵活通信的场景。以下是对 StreamJsonRpc 的详细介绍，结合你提供的参考文章中的关键点：
基于流的通信支持通过 Stream、Pipe或IDuplexPipe进行数据传输，适用于管道、网络套接字、WebSocket 等多种底层传输机制。
双向通信允许客户端和服务端互相调用方法，实现双向交互（如客户端发起请求，服务端主动推送通知）。
强类型支持通过接口定义契约，方法调用和参数传递均支持强类型，减少手动序列化/反序列化的工作。
异步模型所有方法默认支持异步（async/await），适合高并发和低延迟场景。
跨平台兼容兼容 .NET Standard 2.0，可在 .NET Core、.NET Framework 和 Xamarin 等环境中使用。
扩展性提供自定义消息格式化（如 MessagePack或自定义 JSON 序列化器）、错误处理、日志记录等扩展点。
参考文章展示了如何将 StreamJsonRpc 集成到 ASP.NET Core 应用中，实现基于 HTTP 或 WebSocket 的 RPC 通信。以下是关键步骤：
2.1 配置服务端添加 NuGet 包
Install-Package StreamJsonRpcPlain Text
定义 RPC 接口
public interface IGreeterRpcService{
Task GreetAsync(string name);
}
Plain Text
实现服务
public class GreeterRpcService : IGreeterRpcService{
public Task GreetAsync(string name) => Task.FromResult($"Hello, {name}!");
}
Plain Text
配置 ASP.NET Core 中间件使用UseWebSockets启用 WebSocket 支持，并处理 RPC 请求：
app.UseWebSockets;app.Use(async (context, next) =>
{
if (context.WebSockets.IsWebSocketRequest)
{
using var webSocket = await context.WebSockets.AcceptWebSocketAsync;
var service = new GreeterRpcService;
await StreamJsonRpc.Attach(webSocket, service);
}
else await next;
});
Plain Text
2.2 客户端实现客户端通过 WebSocket 或其他流连接到服务端，并调用远程方法：
var webSocket = new ClientWebSocket;await webSocket.ConnectAsync(new Uri("ws://localhost:5000"), CancellationToken.None);var greeter = StreamJsonRpc.JsonRpc.Attach(webSocket);
string result = await greeter.GreetAsync("World");
Console.WriteLine(result); // 输出 "Hello, World!"
双向方法调用客户端和服务端均可定义接口，实现双向通信。例如，服务端可以主动通知客户端：
// 定义客户端可调用的接口public interface IClientcallback
{
Task NotifyAsync(string message);
}
// 服务端方法中调用客户端
public async Task SendNotificationAsync
{
var callback = JsonRpc.GetRpcTarget;
await callback.NotifyAsync("New event!");
}
Plain Text
自定义序列化默认使用System.Text.Json，但可替换为其他序列化器（如 Newtonsoft.Json）：
var options = new JsonRpcOptions{
MessageFormatter = new SystemTextJsonFormatter
};
StreamJsonRpc.Attach(stream, service, options);
Plain Text
错误处理通过JsonRpcException捕获远程调用异常，支持自定义错误码和数据：
try{
await greeter.GreetAsync("error");
}
catch (JsonRpcException ex)
{
Console.WriteLine($"Error Code: {ex.ErrorCode}, Message: {ex.Message}");
}
Plain Text
性能优化使用 MemoryPool或BufferManager减少内存分配。
启用 MessagePack二进制协议以降低传输开销：
Install-Package StreamJsonRpc.MessagePackvar formatter = new MessagePackFormatter;
Plain Text
微服务间通信：轻量级替代 gRPC 或 REST。
AI应用：ModelContextProtocol(MCP)和Agent2Agent(A2A)协议都是使用JSON-RPC 2.0。
桌面应用插件系统：主进程与插件进程通信。
实时应用：如聊天、实时数据推送（结合 WebSocket）。
跨语言集成：通过标准 JSON-RPC 与其他语言（如 Python、JavaScript）交互。
线程安全：确保服务实现是线程安全的。
超时控制：为长时间运行的方法配置 CancellationToken。
通过 StreamJsonRpc，开发者可以快速构建高效、灵活的 RPC 系统，尤其适合需要自定义通信协议或与现有基础设施集成的场景。
来源：opendotnet
