Nettyx 项目名片

定位

设备接入

适合物联网设备、网关、采集器、工控设备、仪表、扫码枪等需要 TCP 或串口通信的项目。

私有协议

适合固定字段长度、保留位、数组字段、字符串字段、大小端转换等二进制协议处理。

Netty 工程化

保留 Netty 的灵活性，同时减少启动模板、Pipeline 样板代码和通用连接治理逻辑。

核心能力

超轻量封装

在 Netty 基础上提供薄封装和模板，不强迫业务切换到复杂框架模型。

多通信协议

覆盖 TCP、串口 Rxtx/Jsc、蓝牙等常见设备通信场景。

模板化启动

提供单通道、多通道、服务端、客户端等基础模板，减少重复启动代码。

编解码支持

内置字节数组、字符串、分隔符、首尾标识、转义、结构体等编解码能力。

结构体序列化

通过注解描述二进制协议字段，降低手写 byte array 解析成本。

函数式扩展

提供函数式接口、拦截器、心跳、超时处理、消息过滤等扩展点。

使用示例

TCP 服务端

少量代码启动服务

适合设备接入服务、协议验证服务，以及需要继续扩展 Pipeline 的 TCP 场景。

绑定端口
追加业务 Handler
收到消息后立即响应

TCP Server

ServerTemplate server = new ServerTemplate(8080) {
    @Override
    protected ChannelInitializer<NioSocketChannel> childChannelInitializer() {
        return ch -> ch.pipeline().addLast(new ChannelInboundHandlerAdapter() {
            @Override
            public void channelRead(ChannelHandlerContext ctx, Object msg) {
                byte[] body = "Hello\n".getBytes(StandardCharsets.UTF_8);
                ctx.writeAndFlush(Unpooled.wrappedBuffer(body));
            }
        });
    }
};

server.bind();

Struct 序列化

把协议字段写成模型

适合固定字段长度、保留位、数组字段和字符串字段的二进制协议。

字段布局可读
减少 offset 手写逻辑
对象和字节互转

Struct Serializer

@Struct
public class Login {
    @ToCharSequence(bufferLength = 32)
    private String username;

    @ToArray(10)
    private byte[] password;

    @Chunk(length = 8)
    private byte[] reserved;
}

Login login = StructSerializer.toStruct(buf, Login.class);
byte[] payload = StructSerializer.toBytes(login);

串口通信

像操作 Channel 一样操作串口

适合上位机、工控、仪表、扫码枪等串口设备对接。

配置串口地址
复用 Pipeline 模型
直接写入业务消息

Serial Port

SingleJscChannelTemplate serial =
        new SingleJscChannelTemplate("COM2") {
    @Override
    protected ChannelInitializer<JscChannel> channelInitializer() {
        return ch -> ch.pipeline().addLast(new StringCodec());
    }
};

serial.connect();
serial.writeAndFlush("Hello");