spring-boot 整合 netty 不一样的玩法（下）(文末有彩蛋)

哈哈哈，很快又跟大家见面了，这次给大家带来的是期待已久的整合案例，好了废话少说，下面直接进入正题。

（上）、（中）、（下）番外，3篇博客中，已经跟大家介绍了整合案例的前置内容，如果不清楚的，请回去复习一下前面的内容。以免往下会迷路。

首先，pom 文件引入相关 Jar 包：

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-handler</artifactId>
</dependency>

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-transport</artifactId>
</dependency>

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-transport-classes-epoll</artifactId>
</dependency>

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-tcnative-boringssl-static</artifactId>
    <version>${netty-tcnative-boringssl-static.version}</version>
</dependency>

<dependency>
    <groupId>com.kevin.backend</groupId>
    <artifactId>netty-spring-boot-starter</artifactId>
    <version>${project.version}</version>
</dependency>

<dependency>
    <groupId>com.kevin.backend</groupId>
    <artifactId>protocol-binary</artifactId>
    <version>${project.version}</version>
</dependency>

<dependency>
    <groupId>com.kevin.backend</groupId>
    <artifactId>protocol-protobuf</artifactId>
    <version>${project.version}</version>
</dependency>

配置文件中 Netty 服务配置

这里配置两个 Netty 服务，监听两个端口 30000、31000，分别处理二进制协议和 Protobuf 协议。
示例已支持 SSL/TLS 单、双向认证（证书下示例 ca 目录下），Protobuf 协议额外提供 UDP 示例，可下载示例自行尝试，这里不再赘述。

netty:
  servers:
    - protocol: TCP
      name: binary
      port: 30000
      bossCount: 1
      workerCount: 2
      readerIdleTime: 180
      writerIdleTime: 180
      allIdleTime: 180
      ssl:
        enabled: false
        caCert: "ca/ca.crt"
        serverCert: "ca/server/server.crt"
        serverPrivateKey: "ca/server/server.pkcs8.key"
        sslProvider: OPENSSL_REFCNT
        protocols: "SSLv2Hello,TLSv1,TLSv1.1,TLSv1.2"
        clientAuth: REQUIRE
        sessionTimeout: 6000
    - protocol: TCP
      name: protobuf
      port: 31000
      bossCount: 1
      workerCount: 2
      readerIdleTime: 180
      writerIdleTime: 180
      allIdleTime: 180

处理粘包、拆包问题，定义解码器

固定长度粘包拆包基础类

public abstract class AbstractDecoder extends LengthFieldBasedFrameDecoder {

    public AbstractDecoder() {
        super(1024, 4, 1, 0, 0, true);
    }

}

解码器基础类

@Slf4j
public abstract class AbstractInboundHandler extends SimpleChannelInboundHandler<Object> {

    @Resource
    private ChannelGroupHelper channelGroupHelper;

    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        channelGroupHelper.add(ctx.channel());
        super.channelActive(ctx);
    }

    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {
        channelGroupHelper.unregister(ctx.channel());
        super.channelInactive(ctx);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        log.warn(">>>>>> 链接：{} 已断开，异常信息：{} >>>>>>", ctx.channel().id().asShortText(), cause.getMessage());
        channelGroupHelper.unregister(ctx.channel());
        super.exceptionCaught(ctx, cause);
    }

    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) {
        Channel channel = ctx.channel();
        if (evt instanceof IdleStateEvent) {
            IdleState state = ((IdleStateEvent) evt).state();
            if (state == IdleState.READER_IDLE) {
                log.warn(">>>>>> 空闲链接：{} 已断开 >>>>>>", ctx.channel().id().asShortText());
                channelGroupHelper.unregister(channel);
            }
        }
    }

}

TCP 二进制协议处理

@Component
@NettyHandler(name = "binary", order = 1)
public class BinaryDecoder extends AbstractDecoder {

}

@Slf4j
@Component
@ChannelHandler.Sharable
@NettyHandler(name = "binary", order = 2)
public class BinaryInboundHandler extends AbstractInboundHandler {

    @Resource
    private ObjectMapper objectMapper;

    @Override
    protected void channelRead0(ChannelHandlerContext channelHandlerContext, Object o) {
        ByteBuf bf = (ByteBuf) o;
        byte[] data = new byte[bf.readableBytes()];
        bf.readBytes(data);

        try {
            BasicMessage basicMessage = BinaryMessageUtil.deserializer(data);
            objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
            log.info("<<<<<< binaryInboundHandler 接收数据：{}", objectMapper.writeValueAsString(basicMessage));
        } catch (Exception e) {
            log.warn("hex : {}\nbyteArray : {}\nerror : {}", Arrays.toString(data), ByteBufUtil.hexDump(data), e.getMessage());
        }
    }

}

TCP Protobuf 协议处理

@Slf4j
@Component
@ChannelHandler.Sharable
@NettyHandler(name = "protobuf", order = 1)
public class ProtobufInboundHandler extends AbstractInboundHandler {

    @Override
    protected void channelRead0(ChannelHandlerContext channelHandlerContext, Object o) {
        ByteBuf bf = (ByteBuf) o;
        byte[] data = new byte[bf.readableBytes()];
        bf.readBytes(data);

        try {
            BasicMessage.Basic basicMessage = BasicMessage.Basic.parseFrom(data);
            log.info("<<<<<< protobufInboundHandler 接收数据：{}", JsonFormat.printer().print(basicMessage));
        } catch (Exception e) {
            log.warn("hex : {}\nbyteArray : {}\nerror : {}", Arrays.toString(data), ByteBufUtil.hexDump(data), e.getMessage());
        }
    }

}

UDP Protobuf 协议处理

@Slf4j
@Component
@ChannelHandler.Sharable
@NettyHandler(name = "protobuf", order = 1)
public class ProtobufDatagramInboundHandler extends AbstractInboundHandler {

    @Override
    protected void channelRead0(ChannelHandlerContext channelHandlerContext, Object o) {
        DatagramPacket datagramPacket = (DatagramPacket) o;
        ByteBuf bf = datagramPacket.content();
        byte[] data = new byte[bf.readableBytes()];
        bf.readBytes(data);

        try {
            BasicMessage.Basic basicMessage = BasicMessage.Basic.parseFrom(data);
            log.info("<<<<<< protobufInboundHandler 接收数据：{}", JsonFormat.printer().print(basicMessage));
        } catch (Exception e) {
            log.warn("hex : {}\nbyteArray : {}\nerror : {}", Arrays.toString(data), ByteBufUtil.hexDump(data), e.getMessage());
        }
    }

}

好了，到这里就大功告成了，启动服务，用 test 方法进行测试。

1.TCP 服务启动

2.TCP 客户端启动

3.UDP 服务端启动

4.UDP 客户端启动

是不是特别简单…哈哈哈，通过 DEMO 示例，相信大家应该能够举一反三了。

整合DEMO仓库地址