Streaming 通信

流实现原理

Triple 协议的流模式与 gRPC 所定义的流模式在概念和编程模式上基本保持对等能力。

• 从协议层来说，Triple 流是建立在 HTTP2 基础上的，所以直接复用所有 HTTP2 的能力，故拥有了 stream 和全双工的能力。

• 框架层来说，org.apache.dubbo.common.stream.StreamObserver 作为流的接口提供给用户，用于入参和出参提供流式处理。框架在收发 stream data 时进行相应的接口调用, 从而保证流的生命周期完整。

流使用方式

Stream 流

Stream 是 Dubbo3 新提供的一种调用类型，在以下场景时建议使用流的方式:

• 接口需要发送大量数据，这些数据无法被放在一个 RPC 的请求或响应中，需要分批发送，但应用层如果按照传统的多次 RPC 方式无法解决顺序和性能的问题，如果需要保证有序，则只能串行发送
• 流式场景，数据需要按照发送顺序处理, 数据本身是没有确定边界的
• 推送类场景，多个消息在同一个调用的上下文中被发送和处理

Stream 分为以下三种:

• SERVER_STREAM(服务端流)
• CLIENT_STREAM(客户端流)
• BIDIRECTIONAL_STREAM(双向流)

由于 java 语言的限制，BIDIRECTIONAL_STREAM 和 CLIENT_STREAM 的实现是一样的。

在 Dubbo3 中，流式接口以 org.apache.dubbo.common.stream.StreamObserver 声明和使用，用户可以通过使用和实现这个接口来发送和处理流的数据、异常和结束。

对于 Dubbo2 用户来说，可能会对StreamObserver感到陌生，这是Dubbo3定义的一种流类型，Dubbo2 中并不存在 Stream 的类型，所以对于迁移场景没有任何影响。

前面我们提到了，对于 Triple 协议，Dubbo 支持 IDL 和 Interface 两种编码模式。对于流模式来说，同样支持这两种编码和通信模式。

Protobuf 流（IDL 模式）。

关于这部分的详细说明，请参见 dubbo-samples-triple-streaming 示例

非 Protobuf 流（Interface 模式）

非 Protobuf 模式的 Streaming 部分示例在 Interface 模式 中有详细说明。

Stream 方法的方法入参和返回值是严格约定的，为防止写错而导致问题，Dubbo3 框架侧做了对参数的检查, 如果出错则会抛出异常。 对于 双向流(BIDIRECTIONAL_STREAM), 需要注意参数中的 StreamObserver 是响应流，返回参数中的 StreamObserver 为请求流。