rpc通信

什么是RPC

RPC 全称 Remote Procedure Call——远程过程调用，是一种进程间的通信方式，允许像调用本地的服务一样调用远程服务。是为了解决远程调用服务的一种技术，使得调用者像调用本地服务一样方便透明。简单的说，RPC就是从一台机器（客户端）上通过参数传递的方式调用另一台机器（服务器）上的一个函数或方法（可以统称为服务）并得到返回的结果。

RPC框架的目标就是让远程过程调用更加简单、透明，RPC框架负责屏蔽底层的传输方式(TCP或UDP)、序列化方式(XML/JSON/二进制)和通信细节。框架使用者只需要了解谁在什么位置提供了什么样的远程服务接口即可，开发者不需要关心底层通信细节和调用过程。

RPC通信有如下特点：

RPC 会隐藏底层的通讯细节（不需要直接处理Socket通讯或Http通讯）
RPC 是一个请求响应模型。客户端发起请求，服务器返回响应（类似于Http的工作方式）
RPC 在使用形式上像调用本地函数（或方法）一样去调用远程的函数（或方法）。

一个RPC框架由三部分组成：

服务提供者: 它运行在服务端,负责提供服务接口定义和服务实现类。
服务发布者：它运行在RPC服务端,负责将本地服务发布成远程服务,供其他消费者调用。
本地服务代理: 它运行在RPC客户端,通过代理调用远程服务提供者,然后将结果进行封装给本地消费者。

Rpc框架原理

RPC框架的目标就是让远程过程调用更加简单、透明。RPC框架负责屏蔽底层的传输方式（TCP或是HTTP或是UDP）、序列化方式（JSON/二进制）和通信细节。框架使用者只需要了解谁在什么位置提供了什么样的远程服务接口即可，开发者不需要关心底层的通信细节和调用过程。

RPC通信模型如下图所示:

SilkyRpc框架实现

silky 框架使用 RPC 协议实现服务之间的通信。我们知道,要实现一个RPC框架,需要解决几个如下技术点:

远程服务提供者：需要以某种形式提供服务调用相关的信息，包括但不限于服务接口定义、数据接口、或者中间态的服务定义文件；在Silky框架中，服务提供者以服务应用接口的方式提供服务调用的相关信息，服务调用者通过引用服务提供者的应用服务接口层(项目、包)的方式获取远程服务调用的相关信息。
远程代理对象：服务调用者调用的服务实际上是远程服务的本地代理，对于Silky框架而言，是通过Autofac.Extras.DynamicProxy组件实现的动态代理，将本地调用封装成远程服务调用,隐藏了底层的通信细节。
通信：RPC框架于具体的通信协议无关；Silky框架使用dotnetty框架作为底层的通信框架。
序列化：远程通信，需要将对象转换成二进制码流进行网络传输，不同的序列化框架，支持的数据类型/数据包大小、异常类型以及性能等都不同。Silky框架默认使用json格式作为序列化格式。

远程服务的调用方式

通过应用服务接口的代理调用

在开发过程中,我们一般需要将服务的定义(接口)和服务的实现(类)分别定义在两个不同的程序集，方便服务的接口被其他微服务应用引用，在Silky框架中,服务调用者(消费者)通过引用服务提供者的应用接口层(包),就可以通过动态代理代理机制为服务应用接口生成本地代理,通过该代理与应用服务提供者进行通信,并将执行的结果返回给消费者，步骤如下所述：

将服务提供者的应用接口单独定义为一个应用程序集(包)。定义的应用接口需要通过ServiceRouteAttribute对服务应用接口的路由进行标识，服务提供者需要实现应用接口。关于应用接口的定义和实现请查看。
服务调用者服务需要通过项目(或是通过nuget包安装)的方式引用服务提供者的应用接口所定义的项目(包)。
开发者可以通过构造注入的方式使用应用服务接口，服务调用者就可以通过服务调用者的应用接口生成的动态代理与服务提供者进行通信。

public class TestProxyAppService : ITestProxyAppService
{
    private readonly ITestAppService _testAppServiceProxy; // 应用提供者的应用接口，通过其生成服务调用者的本地动态代理
    private readonly ICurrentServiceKey _currentServiceKey;

    public TestProxyAppService(ITestAppService testAppService,
        ICurrentServiceKey currentServiceKey)
    {
        _testAppServiceProxy = testAppService;
        _currentServiceKey = currentServiceKey;
    }

    public async Task<TestOut> CreateProxy(TestInput testInput)
    {
        // _currentServiceKey.Change("v2");
        // 通过应用接口生成的本地动态代理与服务提供者进行rpc通信
        return await _testAppServiceProxy.Create(testInput);
    }
}

注意

在rpc通信过程中,通过指定的ServiceKey来指定服务提供者的应用接口的实现类,可以在服务调用前,通过IServiceKeyExecutor来指定该rpc通信的serviceKey的值。

通过调用模板代理调用远程服务

开发者可以通过调用模板IInvokeTemplate接口提供的API实现远程服务的调用。调用模板接口IInvokeTemplate提供了丰富的API方便远程服务的调用。使用调用模板接口的一个优势在于开发者无需通过引用服务提供者的应用接口,就可以通过指定服务条目Id或是WebAPI + Http方法的方式与远程服务进行通信。

在消费者端,开发者只需要通过构造器注入IInvokeTemplate的实例,就可以通过服务条目Id与远程服务进行通信。

    private readonly IInvokeTemplate _invokeTemplate;

    private const string CheckPermissionServiceEntryId =
        "Silky.Permission.Application.Contracts.Permission.IPermissionAppService.CheckPermissionAsync.permissionName:Get";

    public AuthorizationHandler(IInvokeTemplate invokeTemplate)
    {
        _invokeTemplate = invokeTemplate;
    }

    protected override async Task<bool> PolicyPipelineAsync(AuthorizationHandlerContext context,
        HttpContext httpContext,
        IAuthorizationRequirement requirement)
    {
        if (requirement is PermissionRequirement permissionRequirement)
        {
            if (EngineContext.Current.HostEnvironment.EnvironmentName == SilkyHeroConsts.DemoEnvironment &&
                httpContext.Request.Method != "GET")
            {
                throw new UserFriendlyException("演示环境不允许修改数据");
            }

            var serviceEntryDescriptor = httpContext.GetServiceEntryDescriptor();
            if (serviceEntryDescriptor.GetMetadata<bool>("IsSilkyAppService"))
            {
                // todo 
                return true;
            }

            return await _invokeTemplate.InvokeForObjectByServiceEntryId<bool>(CheckPermissionServiceEntryId,
                permissionRequirement.PermissionName);
        }

        return true;
    }

开发者也可以通过指定服务提供者提供的WebApi和对应请求谓词的API方法与服务提供者通信,客户端会根据WebAPI + Http方法路由到指定的服务条目

  private readonly IInvokeTemplate _invokeTemplate;

    public TemplateTestAppService(IInvokeTemplate invokeTemplate)
    {
        _invokeTemplate = invokeTemplate;
    }
    public async Task<dynamic> CallTest(string name, string address)
    {
        // var result =
        //     await _invokeTemplate.PostForObjectAsync<dynamic>("api/another/test", new Dictionary<string, object>()
        //     {
        //         { "input", new { Name = name, Address = "beijing" } }
        //     });
        
        var result =
            await _invokeTemplate.PostForObjectAsync<dynamic>("api/another/test",  new { Name = name, Address = "beijing" });
        
        return result;
    }

使用模板调用IInvokeTemplate与远程服务进行通信,可以通过字典或是匿名对象的方式指定服务提供者的参数。

RPC 通信机制详解

序列化

silky RPC 默认使用 JSON 作为传输格式。消息载体为 TransportMessage，其核心结构如下：

请求消息（RemoteInvokeMessage）：包含 ServiceEntryId、Parameters（参数数组）、DictParameters（字典参数）、Attachments（附件头信息，如用户 Id、租户 Id、TraceId 等）
响应消息（RemoteResultMessage）：包含返回值或异常信息

附件（Attachments）机制是 silky RPC 的重要特性，用于在调用链中透传上下文信息（如当前用户、语言、TraceId），无需在每个方法签名中显式传递。

连接池

silky 通过 TransportClientPoolNumber（默认 50）控制单个服务实例的 DotNetty 连接池大小，可通过 UseTransportClientPool（默认 true）开关控制是否启用连接池。

连接池的作用：

复用已建立的 TCP 连接，减少建立连接的开销
控制最大并发连接数，避免连接数爆炸
结合 ConnectTimeout（默认 300ms）保护连接建立阶段

心跳机制

当 EnableHeartbeat = true（默认）时，silky 会定期向已建立连接的对端发送心跳包（Ping），保持 DotNetty 长连接存活，防止因空闲超时被防火墙或 NAT 断开。

心跳间隔由 HeartbeatWatchIntervalSeconds 控制（默认 300s，最小值 60s）
心跳仅在连接已建立后发送，不会因心跳失败重新建立连接

SSL 加密通信

生产环境中可启用 SSL 对 RPC 传输通道进行加密：

Rpc:
  IsSsl: true
  SslCertificateName: "rpc-server.pfx"
  SslCertificatePassword: "your-certificate-password"

SSL 证书文件放置在应用的工作目录（ContentRootPath）下，DotNetty 通道会在握手阶段完成双向认证。

Token 鉴权

Rpc:Token 是集群内所有服务必须配置相同的字符串。该 Token 在每次 RPC 请求中作为凭证进行验证，防止外部程序直接访问 RPC 端口（因为 RPC 端口通常部署在内网）。

注意

Rpc:Token 必须配置，且集群内所有服务（包括网关）必须配置相同的 Token，否则 RPC 通信会因鉴权失败而拒绝请求。

RPC 调用监控（Monitor）

当 Rpc:EnableMonitor = true（默认）时，silky 会对每次 RPC 调用进行统计，采集以下指标：

调用总次数
成功/失败次数
平均响应时间
最大/最小响应时间

统计数据以 CollectMonitorInfoIntervalSeconds（默认 30s）为周期汇总，可在 Dashboard 管理端的服务监控页面中查看。

若不需要监控数据，可关闭以减少少量运行开销：

Rpc:
  EnableMonitor: false

ServiceKey（服务键）

ServiceKey 是 silky RPC 的多实现路由机制。当同一个服务接口有多个实现类时，可以通过 ServiceKey 区分调用哪个实现。

定义多实现

// 默认实现（ServiceKey = null）
public class OrderAppService : IOrderAppService, IScopedDependency { }

// v2 实现（ServiceKey = "v2"）
[ServiceKey("v2")]
public class OrderAppServiceV2 : IOrderAppService, IScopedDependency { }

在调用方指定 ServiceKey

通过 ICurrentServiceKey 在调用前指定本次 RPC 使用的 ServiceKey：

public class ProxyService : IProxyService, IScopedDependency
{
    private readonly IOrderAppService _orderAppService;
    private readonly ICurrentServiceKey _currentServiceKey;

    public ProxyService(IOrderAppService orderAppService, ICurrentServiceKey currentServiceKey)
    {
        _orderAppService = orderAppService;
        _currentServiceKey = currentServiceKey;
    }

    public async Task<OrderDto> GetV2OrderAsync(long id)
    {
        // 切换到 v2 实现
        _currentServiceKey.Change("v2");
        return await _orderAppService.GetByIdAsync(id);
    }
}

_currentServiceKey.Change("v2") 作用范围为当前请求上下文，不会影响其他并发请求。

CIDR 网段配置

当服务器有多张网卡时（如同时接入内网和外网），默认获取的 IP 可能不是用于 RPC 通信的那张网卡。通过 Rpc:Cidr 指定 CIDR 网段，框架会自动筛选出匹配该网段的 IP 用于 RPC 监听和注册：

Rpc:
  Cidr: "192.168.0.0/16"   # 只使用 192.168.x.x 网段的 IP