Listener

Netty-Boot 自定义 ChannelConnectionListener

在基于 Netty 的应用程序中，监听客户端的连接和断开是非常重要的需求。Netty-Boot 提供了 ChannelConnectionListener 接口，开发者可以通过实现该接口，自定义处理客户端的连接和断开事件。本文将介绍如何在 Netty-Boot 中添加和使用自定义的 ChannelConnectionListener，并解释其工作原理。

原理说明

Netty 的 Channel 是抽象的连接，它可以代表客户端与服务器之间的一个连接。在 Netty 的生命周期中，Channel 可以经历不同的状态，例如连接建立、断开、数据传输等。

通过实现 ChannelConnectionListener，开发者可以监听连接的状态变化，捕捉客户端与服务器的连接和断开事件。这个接口提供了两个核心方法：

  1. handlerAdded(ChannelHandlerContext ctx)：当新的连接被建立时触发。
  2. handlerRemoved(ChannelHandlerContext ctx)：当连接被移除或断开时触发。

ChannelHandlerContext 是 Netty 提供的上下文对象，包含了与该连接相关的所有信息，例如 Channel 的状态、配置信息、传输的数据等。

工作流程

  1. 客户端连接：当客户端与服务器建立连接时，Netty 会调用 handlerAdded 方法，并传入与该连接相关的 ChannelHandlerContext 对象。此时，开发者可以在日志中记录连接的详细信息或执行其他操作。
  2. 客户端断开：当客户端断开连接或连接被移除时，Netty 会调用 handlerRemoved 方法。此时，同样可以记录断开连接的日志，或者进行资源清理等操作。

通过自定义 ChannelConnectionListener，开发者能够精确控制和监控客户端的连接状态。

实现自定义 ChannelConnectionListener

1. 创建自定义的 ChannelConnectionListener

package com.litongjava.netty.im.listener;

import com.litongjava.netty.boot.listener.ChannelConnectionListener;
import io.netty.channel.ChannelHandlerContext;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class MyChannelConnectionListener implements ChannelConnectionListener {

  @Override
  public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
    log.info("客户端连接建立: {}", ctx);
  }

  @Override
  public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
    log.info("客户端连接断开: {}", ctx);
  }
}

在这个示例中，我们创建了 MyChannelConnectionListener 类，并实现了 ChannelConnectionListener 接口。当客户端连接建立时，handlerAdded 方法会记录连接的上下文信息；当客户端断开时，handlerRemoved 方法会记录断开连接的上下文。

2. 在 Netty-Boot 中注册 ChannelConnectionListener

为了使自定义的 ChannelConnectionListener 生效，我们需要将其注册到 NettyBootServer 中：

import com.litongjava.netty.boot.server.NettyBootServer;
import com.litongjava.netty.im.listener.MyChannelConnectionListener;

public class NettyBootApplication {

  public static void main(String[] args) {
    // 初始化 NettyBootServer
    NettyBootServer nettyBootServer = NettyBootServer.me();

    // 创建并设置自定义的 ChannelConnectionListener
    ChannelConnectionListener myChannelConnectionListener = new MyChannelConnectionListener();
    nettyBootServer.setChannelConnectionListener(myChannelConnectionListener);

    // 启动服务器
    nettyBootServer.start();
  }
}

在这段代码中，我们首先获取 NettyBootServer 实例，然后创建 MyChannelConnectionListener 实例，并将其通过 setChannelConnectionListener() 方法注册到服务器中。最后，调用 start() 方法启动服务器。

3. 连接和断开日志示例

当客户端与服务器建立连接或断开连接时，日志中会记录相关的信息，例如：

2024-10-02 10:22:42.225 [nioEventLoopGroup-5-3] INFO  c.l.n.i.l.MyChannelConnectionListener.handlerAdded:13 - 客户端连接建立: ChannelHandlerContext(DefaultNettyHandlerAdapter#0, [id: 0x22311fff, L:/0:0:0:0:0:0:0:1:80 - R:/0:0:0:0:0:0:0:1:2161])
2024-10-02 10:22:45.181 [nioEventLoopGroup-5-3] INFO  c.l.n.i.l.MyChannelConnectionListener.handlerRemoved:18 - 客户端连接断开: ChannelHandlerContext(DefaultNettyHandlerAdapter#0, [id: 0x22311fff, L:/0:0:0:0:0:0:0:1:80 ! R:/0:0:0:0:0:0:0:1:2161])

此日志显示了客户端的连接建立和断开的时间及其相关的 ChannelHandlerContext 信息。

总结

通过 ChannelConnectionListener，我们可以在 Netty-Boot 中方便地捕捉客户端的连接和断开事件。这对于监控客户端连接状态、记录日志、处理资源清理等操作非常有用。

本文展示了如何实现自定义的 ChannelConnectionListener，并将其集成到 Netty-Boot 中。通过这种方式，开发者可以灵活地处理客户端的连接和断开事件，并对连接的生命周期进行有效的管理。