简体中文

English
简体中文

功能总览

规划功能手册： 按你要完成的通信任务选择 request、SSE、RPC 或 socket。commflow@0.0.2 当前只提供 manifest API；可运行能力单独列在当前版本快速开始。

功能矩阵

功能	通信模型	用户入口	主要能力
request	一次性请求/响应	Request	HTTP 调用、timeout、数字 retry、target、headers、context、hook。
SSE	服务端单向事件流	SSE	订阅、消息处理、重连、关闭、资源释放。
RPC	过程调用	RPC	procedure 调用、参数、返回值、resolver、metadata、typed contract。
socket	长连接双向消息	Socket	connect、send、on、heartbeat、reconnect、backpressure、close。
VextJS adapter	框架接入	接入 VextJS	对照 `app.fetch` 能力并验证兼容迁移。

按场景选择

用户场景	推荐功能	原因
请求 REST API 或内部 HTTP 服务	request	保留 HTTP 语义，适合一次性调用。
订阅任务进度、通知、状态更新	SSE	单向事件流简单稳定。
服务间按过程名调用	RPC	业务代码可以关注 procedure，而不是 URL/method。
聊天、房间、实时协作	socket	需要双向长连接和事件监听。
替换 VextJS fetch 编排	request + VextJS adapter	request 是最先落地的共享通信核心。

能力适用真相矩阵

Shared Capability Truth Matrix：

能力	request	SSE	RPC	socket	用户口径
服务地址	`baseURL` / `target`	`baseURL` + topic/path	`resolver` / endpoint	`url`	名字可以不同，但都要能定位服务。
timeout	单次请求超时	建连或首包超时	单次 procedure 超时	建连/心跳超时	SSE/socket 不能把整个长连接当成一次 request timeout。
retry / reconnect	数字 `retry` + `retryDelay`	`reconnect` 策略	按 procedure 类型决定 retry	`reconnect` 策略	request/RPC 是重试调用；SSE/socket 是重连连接。
headers / auth	HTTP headers	headers 或 token provider	metadata / headers	auth provider	长连接鉴权需要刷新和重连策略。
context / metadata	`contextProvider`	订阅 metadata、Last-Event-ID	per-call metadata	connection metadata	requestId/trace 透传，不由 core 凭空生成。
hooks / events	`beforeRequest` 等 hooks	open/message/error/reconnect/close	invoke/stream/error hooks	connect/message/drain/reconnect/close	生命周期事件按协议差异暴露。
structured error	`timeout/network/aborted/config/hook`	连接、解析、重连耗尽	transport/protocol/business/contract	网络、鉴权、协议、主动关闭	错误类型要能指导重试、重连或停止。

协议场景覆盖矩阵

Transport Scenario Coverage Matrix：

通信方式	触发	执行	状态	失败	恢复	观测
request	调用 method/path	返回 `Response` 或抛结构化错误	pending / fulfilled / failed / aborted	HTTP failure、timeout、network、config、hook	幂等 retry 或业务降级	hooks、duration、requestId
SSE	订阅 topic/path	持续消费事件	connecting / open / reconnecting / closed / failed	断线、401、解析失败、重连耗尽	Last-Event-ID + reconnect	open/message/error/reconnect/close
RPC	调用 procedure	返回结果或 stream chunk	pending / streaming / fulfilled / failed / cancelled	transport、protocol、business、contract	query 可谨慎 retry；stream 默认不重放	procedure、metadata、retry、duration
socket	显式 connect	send/on 双向消息	connecting / open / reconnecting / closing / closed	网络、鉴权、协议、背压、乱序	reconnect、重新订阅、队列处理	connect/message/drain/reconnect/close

章节入口

手册入口：产品功能手册（规划 API）
HTTP 调用：Request
服务端事件：SSE
过程调用：RPC
长连接消息：Socket
配置：配置指南
错误恢复：错误与重试
VextJS：接入 VextJS

当前版本边界

commflow@0.0.2 当前只提供 manifest API。立即运行当前版本请看当前版本快速开始，查询导出字段请看 Manifest API。