StreamFrame 1.2.0

StreamFrame

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

为什么用它

安装

dotnet add package StreamFrame

XML 报文驱动（可选）：

dotnet add package StreamFrame.Protocols.Xml

快速上手

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

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

// 服务端（被动监听）
var server = new StreamConnection<XDocument>(
    new LengthPrefixFrameCodec(),          // 4 字节大端长度头；也可用 StxEtxFrameCodec
    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 LengthPrefixFrameCodec(),
    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);

概念

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

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

编解码（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。

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

• 客户端/服务端双模式：isActive: true 主动连远端，false 被动监听
• 自动重连：Connecting → Connected → Retry 状态机；GetMessages 是跨重连的稳定消息流——断线重连后已收消息不丢、枚举不中断
• 健壮性：帧内容解码失败、未完成帧超限、发送失败、接收空闲超时都会判定会话失效并自动重建（不再产生"连接看似存活、消息静默消失"的假活）
• 活性探测（可选）：TCP KeepAlive 与接收空闲超时，兜底半开连接（对端断电/拔线）
• 事件：ConnectionChanged 状态变化、FrameError 帧层诊断、RawBytesReceived/Sent 原始字节（HEX 调试）
• 发送背压：有界发送队列，队列满时 SendAsync 自动等待

诊断与调试

FrameError — 帧层诊断事件

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

client.FrameError += (_, e) =>
{
    // e.Kind: DecodeFailed（帧完整但内容解析失败）
    //         DiscardedByResync（被定界器当作噪声丢弃的字节）
    //         IncompleteFrameOverflow（未完成帧缓冲超限）
    // e.Bytes: 已拷贝，可安全长期留存
    // e.Exception: DecodeFailed 时的原始异常
    Console.WriteLine($"[{e.Kind}] {Convert.ToHexString(e.Bytes.Span)} {e.Exception?.Message}");
};

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

RawBytesReceived / RawBytesSent — 原始字节流

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

未完成帧防护

对端声明一个超长帧却永远不补齐（或 STX/ETX 流中只有 STX 没有闭合），会无限占用缓冲。MaxIncompleteFrameBufferBytes（默认 = 帧上限 + 4KB）给"等不齐的半帧"设了硬上限，超限即断线并通过 FrameError 上报。

活性探测建议

生产环境建议开启 TcpKeepAlive = true；有周期性报文的协议可再加 ReceiveIdleTimeoutMs（如心跳周期的 3 倍），双保险兜底半开连接。

依赖

• System.IO.Pipelines
• System.Threading.Channels

测试与示例

dotnet build StreamFrame.slnx
dotnet test
dotnet run --project samples/StreamFrame.Demo

项目结构

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

许可

MIT