StreamFrame 2.7.1

<p align="center"> <img src="https://raw.githubusercontent.com/CSJ608/StreamFrame/main/docs/logo/icon-512.png" width="120" alt="StreamFrame logo" /> </p>

StreamFrame

English | 简体中文

通用 socket 通讯框架：把"帧边界判定"与"帧内数据编解码"插件化，适用于通过 socket 进行数据互换的场景（设备通讯、物流 WMS 对接等）。把场景间的共性（连接管理、重连、读写、粘包/半包、消息分发）收敛到框架核心，把差异性（framing、codec）抽象成可插拔的驱动。

为什么用它

安装

dotnet add package StreamFrame

XML 报文驱动（可选）：

dotnet add package StreamFrame.Protocols.Xml

快速上手

本库面向单连接设备对接。被动监听同时只服务一个客户端；AcceptFirstClientOnly = false 仅保持监听，不增加多客户端处理能力。以下为两个独立进程/角色的入门片段，ct 由宿主提供；部署前参考下方生产配置，并用 await using 释放连接。

一条连接 = 一个帧定界策略（framing）+ 一个编解码器（codec）+ 地址/端口/模式。framing 与 codec 均连接级固定，一条连接只流通一种消息类型、一种帧格式。

using System.Net;
using System.Xml.Linq;
using StreamFrame;
using StreamFrame.Protocols.Xml;

// 服务端（被动监听）
var server = new StreamConnection<XDocument>(
    new LengthPrefixFramer(),              // 4 字节大端长度头；也可用 StxEtxFramer
    new XmlDocumentCodec(),                // 换成自己的 ICodec<T> 即可支持自定义协议
    IPAddress.Any, 5100, isActive: false);
server.Start(ct);

await foreach (var doc in server.GetMessages(ct))
{
    var id = doc.Root?.Element("Id")?.Value;
    await server.SendAsync(XDocument.Parse($"<Reply><Echo>{id}</Echo></Reply>"), ct);
}

// 客户端（主动连接）
var client = new StreamConnection<XDocument>(
    new LengthPrefixFramer(),
    new XmlDocumentCodec(),
    IPAddress.Parse("127.0.0.1"), 5100, isActive: true);
client.Start(ct);
await client.SendAsync(XDocument.Parse("<Message><Id>1</Id></Message>"), ct);

概念

帧定界（IFramer）— 怎么从字节流里切出一帧

两种默认实现都支持流式单缓冲编码（可选，消除发送侧 memcpy）。想自定义帧格式时实现 IFramer 即可。

编解码（ICodec<T>）— 怎么解析/写入帧内数据

public interface ICodec<TMessage>
{
    TMessage Decode(in ReadOnlySequence<byte> frame, CancellationToken ct = default);
    void Encode(TMessage message, IBufferWriter<byte> writer, CancellationToken ct = default);
}

接新设备 = 写一个驱动：实现 ICodec<TMessage> + 定义业务消息类，选一个帧策略，其余全部复用。官方示例见 StreamFrame.Protocols.Xml。JSON 报文最简驱动（System.Text.Json，span 直写、AOT 安全）：

sealed class SystemTextJsonCodec : ICodec<JsonElement>
{
    public static readonly SystemTextJsonCodec Instance = new();

    public JsonElement Decode(in ReadOnlySequence<byte> frame, CancellationToken ct = default)
    {
        using var document = JsonDocument.Parse(frame.ToArray());
        return document.RootElement.Clone(); // Own data beyond document disposal.
    }

    public void Encode(JsonElement message, IBufferWriter<byte> writer, CancellationToken ct = default)
    {
        var raw = message.GetRawText(); // 序列化产物（已转义的非 ASCII 安全直写）
        var span = writer.GetSpan(Encoding.UTF8.GetMaxByteCount(raw.Length));
        writer.Advance(Encoding.UTF8.GetBytes(raw, span));
    }
}

连接（IStreamConnection<T>）— 传输层

• 客户端/服务端双模式：isActive: true 主动连远端，false 被动监听；IPv4/IPv6 双栈（监听 IPAddress.Any 自动按双栈处理，IPv4 客户端地址归一显示为 IPv4）
• 自动重连：Connecting → Connected → Retry 状态机；可选指数退避（MaxRetryDelayMs，连续失败倍增封顶 + ±20% 抖动，连接成功自动复位）；GetMessages 是跨重连的稳定消息流——断线重连后已收消息不丢、枚举不中断
• 启动与停止：Start(ct) 的 ct 是连接的生命周期令牌——取消它会停止连接/重连并拆线（状态进入 Disconnected 终态，GetMessages 自然结束，之后需新建连接）；DisposeAsync 与之等效。停机后 SendAsync 抛 ChannelClosedException
• 等待连接就绪：await conn.WaitForConnectedAsync(ct)——已连接立即完成，未连接时等到下次连接成功（或调用方取消、生命周期取消/Dispose）；终态后的新等待也会取消，即使未传令牌，不用轮询状态
• 健壮性：帧内容解码失败、未完成帧超限/超时、发送失败、接收空闲超时都会判定会话失效并自动重建（不再产生"连接看似存活、消息静默消失"的假活）
• 活性探测（可选）：TCP KeepAlive 与接收空闲超时，兜底半开连接（对端断电/拔线）
• 事件：ConnectionChanged 状态变化、FrameError 帧层诊断、RawBytesReceived/Sent 原始字节（HEX 调试）
• 内置指标：System.Diagnostics.Metrics（Meter StreamFrame）——帧/字节收发计数、重连次数、会话时长、发送队列水位，详见下文"内置指标"
• 发送背压：有界发送队列，队列满时 SendAsync 自动等待；接收侧默认无上限缓冲，可用 ReceiveQueueCapacity 设上限——消费慢时解码暂停、TCP 背压自然传导到对端，防内存无限增长
• 会话感知收发（可选高级）：CurrentSessionId / SendInSessionAsync（整帧写入 socket 才完成、会话失效即失败、绝不跨会话重放）/ GetSessionMessages（消息带会话编号）——为有严格会话边界的协议（如 HSMS）准备，详见下文

缓冲所有权与并发约束

Decode 的 frame 仅在同步调用期间借用。返回消息及其嵌套字段必须独立拥有所需数据，不能返回 frame.First、切片或引用管线内存的 ReadOnlyMemory<byte>。管线随后推进/释放，业务可能跨 await 才消费。ReadOnlyMemory 不代表所有权转移；本接口没有转移管线池化内存所有权的机制。

Encode 必须在返回前完成写入，不得保留/释放 writer，也不得保留其缓冲供异步使用。发送队列存消息对象，入队后不要修改或归还底层数组：普通 SendAsync 成功只表示入队，编码可能还没开始。最简单的做法是发送独立数组且之后不再修改。

同一会话的发送 worker 只串行化自己的编码调用，不是整个 Codec 的锁：Encode 与 Decode 可并行；会话拆除最多等待 2 秒，旧解码任务（例如被接收背压阻塞）可与新会话解码重叠，阻塞的旧编码也不能假定已退出。使用调用局部状态或自行同步，避免阻塞同步方法。跨连接共享 Codec/Framer 实例前，由调用方确认其并发安全；每连接一个实例仍须满足收发和新旧会话约束。

IFramer 同样适用：不能留存输入序列；输出 payload 可借用输入，供连接紧接着同步调用 Codec。编码 writer 只能在本次调用内使用。IStreamingFramer.BeginFrame/EndFrame 之间可穿插其它调用，配对状态应放在传入 writer 中，不能依赖实例的“当前帧”字段。

完整可编译的 OwnedBytesCodec / OwnedMemoryCodec 对两种消息类型均返回 frame.ToArray()，包括单段输入；Encode 同步 writer.Write(message) 或 writer.Write(message.Span)。源文件直接纳入测试工程，在 net8.0/net10.0/net48 编译。OwnershipExampleTests 主动覆盖单段/多段输入，并用归还时填充 0xDD 的内存池运行真实 FrameDecoder，等管线释放后再异步消费，断言原始数据仍正确。

生产配置起点

完整 ProductionExample.RunAsync 展示有界收发、10 秒连接等待超时、异步消费、生命周期取消及 await using Dispose，直接参与三目标编译。以下参数假设负载最多 64 KiB，须按协议、峰值流量和处理时间调整；不改变库默认值：

var framer = new LengthPrefixFramer(64 * 1024);
var options = new StreamConnectionOptions
{
    SendQueueCapacity = 128,
    ReceiveQueueCapacity = 128, // 默认 0 为无界
    MaxIncompleteFrameBufferBytes = 64 * 1024 + 4, // 含长度头
    IncompleteFrameTimeoutMs = 5_000,
    ReceiveIdleTimeoutMs = 0, // 允许静默；有 5 秒心跳时可考虑 15_000
    TcpKeepAlive = true,
    KeepAliveTimeMs = 30_000,
    KeepAliveIntervalMs = 1_500, // 现代 .NET 向上取整为 2 秒（#62）
    AcceptFirstClientOnly = true,
};

容量按消息数而非字节预算：128 条 × 64 KiB 约为每队列 8 MiB 负载，还需计算对象开销、编码/管线/socket 缓冲、处理中消息、等待入队的生产者及旧会话残留工作。解码对象也可能比线上负载大。限制生产者并发并逐条 await SendAsync，避免无限创建等待任务；有界队列不是进程内存硬上限。

慢消费者使接收通道写入等待，解码暂停，背压经管线和 TCP 逐步传向对端。半帧字节限制只检查未消费半帧，不是完整消息或总内存预算；通道堵塞期间半帧超时不计时，字节检查也要等解码循环继续才能执行。接收空闲超时适合周期流量；允许静默时保留 0，并按帧传输时限选择半帧超时。KeepAlive 参数为正毫秒，现代 .NET 向上取整为秒，netstandard2.0 IOControl 保留毫秒。

WaitForConnectedAsync 的调用方超时只取消本次等待；生命周期取消/Dispose 停止连接，终态后的新等待也取消，即使未传令牌（#65）。普通 SendAsync 不保证 socket 写出或远端确认，未出队条目可跨会话续发，已出队失败不能视为已交付（#67）；可靠业务交付需要协议 ACK、重试和去重。会话绑定发送成功也只表示整帧交给本机 socket。

会话感知收发（高级）

对允许消息重放的一般业务，SendAsync（入队即完成、断线后由新会话续发）+ GetMessages（跨重连稳定流）就够了。部分协议有严格的会话边界——重连后必须重新握手、旧会话消息禁止重放、协议计时器要从"整帧实际写出"起算（HSMS 的 Select/T3/T6/T8 即是）。为此提供可选能力接口 ISessionAwareStreamConnection<TMessage>（StreamConnection<TMessage> 已实现；依赖接口抽象的上层用 is 探测）：

if (connection is ISessionAwareStreamConnection<MyMessage> sessionAware)
{
    long id = sessionAware.CurrentSessionId;          // 每次 TCP 会话建立时分配，单调递增不复用；无会话时为 0

    // 整帧全部写入本机 socket 后才完成；会话在写出前终止 → SessionExpiredException，消息绝不重放
    await sessionAware.SendInSessionAsync(id, message, ct);

    // 接收视图：每条消息携带它所属的会话编号（旧会话解码任务迟到投递的消息带旧编号）
    await foreach (var m in sessionAware.GetSessionMessages(ct))
        Handle(m.SessionId, m.Message);
}

语义要点：

• 编号的线性化：ConnectionChanged 回调与 WaitForConnectedAsync 完成时读 CurrentSessionId 必得有效值（分配先于 Connected 对外发布）；状态离开 Connected（Retry/Disconnected）可见时已归零。
• "写完"的定义：整帧字节已交给本机 socket（内核缓冲），不含对端 ACK——应用层可得的最好信号。任务失败时远端处理结果视为未知（可能已收到部分/全部字节），由上层协议的事务关联、幂等或恢复流程兜底。
• 调用方取消的提交点：发送 worker 认领条目之前取消 → 任务取消且消息不再发送；认领之后（帧已开始写出）取消对结果无副作用——取消单条消息不会撕裂帧、不会杀死连接。
• 与 SendAsync 的关系：两类发送共享同一条 FIFO（按入队顺序串行化）；普通 SendAsync 的跨会话续发行为不变。会话绑定发送在任何失败路径下都不转移到新会话。
• 两个接收 API 不是广播：GetMessages 与 GetSessionMessages 是同一通道的两个竞争消费视图，同时枚举会互相分流——请二选一使用。

诊断与调试

FrameError — 帧层诊断事件

对端发来坏数据时，FrameError 事件把出问题的字节和原因直接交给上层，不用再拿 HEX 流人工对齐：

client.FrameError += (_, e) =>
{
    // e.Kind: DecodeFailed（帧完整但内容解析失败）
    //         DiscardedByResync（被定界器当作噪声丢弃的字节）
    //         IncompleteFrameOverflow（未完成帧缓冲超限）
    //         IncompleteFrameTimeout（未完成帧超时：半帧迟迟收不齐）
    // e.Bytes: 已拷贝，可安全长期留存
    // e.Exception: DecodeFailed 时的原始异常
    // e.SessionId: 检测到错误的解码器所属会话编号（与 CurrentSessionId/
    //              SessionMessage.SessionId 同一编号空间；重连后迟到的
    //              旧会话事件仍带旧编号，不会被改写成当前会话）
    // e.ObservedByteCount / e.IsTruncated: 原始观测字节数与快照是否截断。
    //              timeout/overflow 快照有 8KB 上限，Bytes 更长时只是前缀；
    //              IsTruncated == true 时 ObservedByteCount 才是真实规模
    Console.WriteLine($"[session {e.SessionId}] [{e.Kind}] {Convert.ToHexString(e.Bytes.Span)}" +
        (e.IsTruncated ? $"（前 {e.Bytes.Length}/{e.ObservedByteCount} 字节）" : "") +
        $" {e.Exception?.Message}");
};

帧内容解码失败的策略由 StreamConnectionOptions.DecodeErrorPolicy 决定：

RawBytesReceived / RawBytesSent — 原始字节流

socket 层全量输出（含被丢弃的噪声字节），发送侧按实际写出的分片回调（部分发送失败时已上线字节也可见）。内存契约：回调参数是内部缓冲的切片，仅在回调同步执行期间有效，需要留存必须自行拷贝；回调抛异常会被隔离，不影响会话。

未完成帧防护

对端声明一个超长帧却永远不补齐（或 STX/ETX 流中只有 STX 没有闭合），会无限占用缓冲。两条互补的防线：

• MaxIncompleteFrameBufferBytes（默认 = 帧上限 + 4KB）——字节上限：半帧超过即断线，防内存攻击；
• IncompleteFrameTimeoutMs（默认 0 = 关闭）——时间上限：半帧开始后连续这么久收不到后续字节即断线，FrameError 上报 IncompleteFrameTimeout 并携带受 8KB 上限保护的缓冲快照。

未完成帧超时只计"帧已开头、迟迟收不齐"的时间：缓冲为空的静默连接不计时（收到字节即重置，整帧切尽后归零）。它与 ReceiveIdleTimeoutMs（见下节）互补——后者在完全没流量时也计时，适合有周期报文的协议；对允许长时间空闲、但半帧卡死必须判死的协议（如 HSMS T8），用未完成帧超时。注意其作用域是"等待网络后续字节"期间：若设置了 ReceiveQueueCapacity 且消费端完全停滞，解码循环阻塞在消息通道写入上，此期间不计时（内存防线仍由 MaxIncompleteFrameBufferBytes 兜底）。

内置指标（Metrics）

连接自带 System.Diagnostics.Metrics 指标（Meter 名 StreamFrame，标签 endpoint），零外部依赖——生产部署用 MeterListener 或 OpenTelemetry 订阅即可观测，不订阅则开销为每次记录纳秒级：

// 最简订阅（示例）：OTel 的 MeterProvider.AddMeter("StreamFrame") 一行即可接入完整体系
using var listener = new MeterListener { InstrumentPublished = (i, l) => l.EnableMeasurementEvents(i) };
listener.SetMeasurementEventCallback<long>((instrument, value, _, _) => { /* 上报 */ });
listener.Start();

netstandard2.0 目标经 System.Diagnostics.DiagnosticSource 包提供同款 API（netfx 运行时可用）。

日志（可选）

构造连接时传入 ILogger，内部事件（连接重试、会话故障、用户回调异常等）输出到日志，生产环境不再静默：

var conn = new StreamConnection<XDocument>(..., logger: loggerFactory.CreateLogger("StreamFrame"));

不传则无日志输出（零依赖可用）。

活性探测与心跳范式

KeepAlive 默认关闭。开启后，KeepAliveTimeMs / KeepAliveIntervalMs 必须为正毫秒值，默认 30000 / 5000。现代 .NET 的 Socket 选项使用整秒，向上取整（1ms → 1s，1500ms → 2s，默认 → 30s / 5s）；netstandard2.0 的 SIO_KEEPALIVE_VALS 分支保留毫秒粒度。

生产环境建议开启 TcpKeepAlive = true；应用层心跳配合 ReceiveIdleTimeoutMs（取心跳周期的 3 倍，容忍偶尔丢 1-2 次）是更强的组合——框架不内置心跳（消息形态由协议决定），范式如下，完整可运行示例见 demo 场景 4：

var options = new StreamConnectionOptions { ReceiveIdleTimeoutMs = 1500 };

// 一侧周期发心跳；另一侧收到任何消息回 PONG（双向都有字节即可重置双方空闲计时）
_ = Task.Run(async () =>
{
    while (!cts.IsCancellationRequested)
    {
        await client.SendAsync("PING", cts.Token);
        await Task.Delay(TimeSpan.FromMilliseconds(500), cts.Token); // 周期 ≈ 超时的 1/3
    }
});

对端"猝死"（断电/拔线，无 FIN/RST）时静默超限 → 会话判定死亡 → 自动重连；对端不可达时重连持续失败，状态停留在 Connecting/Retry。

两种接收超时的取舍：ReceiveIdleTimeoutMs 要求连接必须有周期流量——协议有心跳/周期上报时用它（还能兜底半开连接）；协议允许长时间静默（只在有帧进行中才该有流量）时改用 IncompleteFrameTimeoutMs，静默不算故障、半帧卡死才判死。

性能

基准覆盖同机 TCP 回环上的单向传输与逐条往返，包含两种 Framer、64B/1KB/64KB，以及字节数组和两种字符串编码。两侧执行相同的编码、定界、物化及完整内容校验；单向在接收完成后计时结束，往返等待每条回显。复现命令、原始结果及限制见 基准说明。

直接 TCP 对照仍省略队列、Pipe 与通用流重组，因此差值不能精确代表“框架自身开销”。旧的“快于裸 TCP”“大报文 3–4 倍”“字节负载仅多 20–30%”来自不匹配的工作量，已撤回。单机单次采样不代表普遍性能优势。

流式编码省去负载缓冲到帧缓冲的一次整体复制；Codec、Socket、缓冲扩容与消息物化仍会复制或分配，不是端到端零拷贝。XML、帧路径、指标和会话功能有独立基准，应按实际业务分别测量。

大报文指南（≥64KB）

64KB 级消息应分别检查 Codec 中间数组、消息物化与传输成本（测量口径见 bench/README.md）。三条建议：

1. codec 用 span 直写重载——Encoding.GetBytes(ReadOnlySpan<char>, IBufferWriter<byte>) 不产生中间数组（旧写法每条多一次全尺寸分配 + 拷贝）：

   // 推荐：零中间数组
   public void Encode(string message, IBufferWriter<byte> writer, CancellationToken ct)
       => Encoding.UTF8.GetBytes(message.AsSpan(), writer);
   // 不推荐：writer.Write(Encoding.UTF8.GetBytes(message));  // 每条一次全尺寸 byte[]
   

2. 消息类型选 byte[] / ReadOnlyMemory<byte>：本基准的 ASCII string 负载会生成约 2× 负载大小的 UTF-16 字符数据；字节消息也需要拥有独立数据的 codec，不能将其等同零拷贝或零分配；

3. 保持默认的流式编码开启（UseStreamingEncode），发送缓冲会按上一帧大小自适应起租（封顶 1MB）。

支持框架

netstandard2.0 资产经 net48 全量测试套件（真实 TCP 回环）验证；TCP KeepAlive 参数在 .NET Framework 上通过 SIO_KEEPALIVE_VALS 设置。CI 在 Ubuntu（net8/net10）与 Windows（net48/net8/net10）双平台运行全部测试。

Demo 和 NativeAOT 示例使用 .NET 10。库保留 net8 兼容资产，但 .NET 8 的安全支持于 2026-11-10 结束，实际宿主应及时迁移；资产兼容不能替代受支持的运行时。SDK 基线、锁定恢复、无内置 TLS/认证的部署边界，以及覆盖率工具的已知内嵌组件风险见 安全维护说明。

依赖

• System.IO.Pipelines
• System.Threading.Channels
• Microsoft.Extensions.Logging.Abstractions（仅日志抽象，不引入具体日志框架）

测试与示例

dotnet build StreamFrame.slnx
dotnet test
dotnet run --project samples/StreamFrame.Demo          # 五场景端到端 demo
dotnet run -c Release --project bench/StreamFrame.Benchmarks   # 性能基准（先按 bench/README.md 筛选）
dotnet test -f net10.0 -p:EnableCoverage=true --collect:"XPlat Code Coverage"  # 隔离覆盖率工具，已知风险见安全维护说明

NativeAOT 验证

CI 的非必需 aot 检查分别验证 NativeAOT 发布/裁剪分析 与 linux-x64 原生产物运行：真实 TCP 回环校验两条会话绑定发送、一条普通发送和消息内容，并用受控故障验证非零退出。发布成功不等于运行通过。命令、期限、故障模式及 #55 未来传输扩展边界见 AotSmoke 说明。

项目结构

src/StreamFrame/                  # 核心库（无业务依赖）
src/StreamFrame.Protocols.Xml/    # XML 报文驱动（示例 codec）
test/StreamFrame.Tests/           # xUnit 单测
samples/StreamFrame.Demo/         # 控制台端到端 demo
bench/StreamFrame.Benchmarks/     # 性能基准

许可

MIT