Galosys.Foundation.DotNetty 26.9.14.1

Galosys.Foundation.DotNetty

成熟度: 🔴 实验性 — 依赖 preview 版本，API 可能变更

⚠️ 本模块依赖 preview/不稳定版本包，API 可能随时变更。

基于 DotNetty 的高性能 TCP RPC 服务器模块，提供低延迟的网络通信能力。

简介

DotNetty 是 Netty 的 .NET 移植版本，是一个高性能的异步事件驱动网络编程框架。Galosys.Foundation.DotNetty 模块封装了 DotNetty 的核心功能，提供简洁的 API 用于快速构建 TCP 服务器，支持自定义编解码器、会话管理和消息路由等特性。

特性

• 高性能 TCP 服务器：基于 NIO/Libuv 两种模式
• 自定义消息协议：内置 Packet 编解码，支持请求/响应类型
• 会话管理：SessionManager 维护客户端连接状态
• 灵活的编解码器：支持自定义 IPacketCodec 实现
• 多线程事件循环：充分利用多核处理器
• 服务标记：通过 NettyServiceAttribute 标记服务接口

安装

dotnet add package Galosys.Foundation.DotNetty

配置

在 appsettings.json 中配置 DotNetty 服务器端口：

{
  "DotNetty": {
    "Port": 3000
  }
}

使用示例

定义服务接口

[NettyService("MyService")]
public interface IMyService
{
    Task<string> SayHelloAsync(string name);
}

实现 TCP 服务器

using DotNetty.Transport.Bootstrapping;
using DotNetty.Transport.Channels.Sockets;

public class MyNettyServer : NettyServer
{
    protected override void AddHandlers(ISocketChannel channel)
    {
        channel.Pipeline
            .AddLast(new PacketDecoder())
            .AddLast(new PacketEncoder())
            .AddLast(new SessionManager())
            .AddLast(new MyServerHandler());
    }
}

服务注册与启动

// 注册 Netty 服务器
services.AddNettyServer<MyNettyServer>();

// 在后台服务中启动
public class MyHostService : BackgroundService
{
    private readonly INettyServer _server;

    public MyHostService(INettyServer server)
    {
        _server = server;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        await _server.StartAsync();
    }
}

使用消息包

// 构建请求包
var request = Packet.Builder()
    .SessionId(sessionId)
    .Type(0) // 0 = 请求
    .Level(1)
    .Body(new { Name = "Alice" })
    .Build();

// 处理响应包
var response = Packet.Builder()
    .SessionId(sessionId)
    .Type(1) // 1 = 响应
    .Level(1)
    .Body(new { Message = "Hello, Alice!" })
    .Build();

自定义编解码器

public class CustomCodec : IPacketCodec
{
    public T Decode<T>(byte[] bytes)
    {
        // 自定义解码逻辑
        return JsonSerializer.Deserialize<T>(Encoding.UTF8.GetString(bytes));
    }

    public byte[] Encode<T>(T payload)
    {
        // 自定义编码逻辑
        return Encoding.UTF8.GetBytes(JsonSerializer.Serialize(payload));
    }
}

核心类

消息包结构

public class Packet
{
    public PacketHeader Header { get; set; }
    public object Body { get; set; }
}

public class PacketHeader
{
    public uint Crc = 0xabef0101;      // 校验码
    public byte Type { get; set; }      // 0=请求, 1=响应
    public byte Level { get; set; }     // 级别
    public long SessionId { get; set; } // 会话ID
    public int Length { get; set; }     // 消息体长度
}

依赖

• DotNetty.Transport (>= 0.7.5)
• DotNetty.Codecs (>= 0.7.5)
• DotNetty.Common (>= 0.7.5)
• Galosys.Foundation.Core
• Microsoft.Extensions.Options

相关文档

• DotNetty 官方文档
• Netty 官方文档
• DotNetty传输层分析