ChannelInitializer

自定义 ChannelInitializer

Netty-Boot 提供了灵活的扩展机制，允许开发者根据具体需求自定义 ChannelInitializer，以定制 Netty 的管道（Pipeline）配置。通过自定义 ChannelInitializer，您可以添加或修改处理器（Handlers），实现特定的业务逻辑处理。

以下将介绍如何创建并使用自定义的 ChannelInitializer 来配置 Netty 的管道。

1. 创建自定义 ChannelInitializer

首先，创建一个自定义的 ChannelInitializer 类，用于配置 Netty 的管道。在本示例中，我们将创建一个名为 MyChannelInitializer 的类，并添加多个处理器，包括 HTTP 编解码器、WebSocket 协议处理器以及自定义的业务处理器 ChatHandler。

package com.netty.initializer;

import com.netty.handler.ChatHandler;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;
import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.HttpServerCodec;
import io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler;
import io.netty.handler.stream.ChunkedWriteHandler;

/**
 * 自定义的 ChannelInitializer，用于配置 Netty 的 ChannelPipeline。
 */
public class MyChannelInitializer extends ChannelInitializer<SocketChannel> {

    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();

        // 添加 HTTP 编解码器，因为 WebSocket 基于 HTTP 协议
        pipeline.addLast(new HttpServerCodec());

        // 支持对大数据流的异步传输
        pipeline.addLast(new ChunkedWriteHandler());

        // 聚合 HTTP 消息为 FullHttpRequest 或 FullHttpResponse
        pipeline.addLast(new HttpObjectAggregator(1024 * 64));

        // WebSocket 协议处理器，指定 WebSocket 的端点路径
        pipeline.addLast(new WebSocketServerProtocolHandler("/nettyServer"));

        // 添加自定义的业务处理器
        pipeline.addLast(new ChatHandler());
    }
}

说明：

• HttpServerCodec：HTTP 编解码器，用于处理 HTTP 请求和响应。
• ChunkedWriteHandler：支持对大数据流的异步传输，适用于处理文件传输等场景。
• HttpObjectAggregator：将多个 HTTP 消息聚合为一个完整的 FullHttpRequest 或 FullHttpResponse，简化消息处理。
• WebSocketServerProtocolHandler：处理 WebSocket 协议的握手、升级以及控制帧（如 Ping、Pong、Close）。
• ChatHandler：自定义的业务处理器，用于处理 WebSocket 消息。

2. 配置 NettyServerConfig

接下来，创建一个配置类 NettyServerConfig，用于初始化和启动 Netty 服务器，并应用自定义的 ChannelInitializer。

package com.config;

import com.litongjava.netty.boot.server.DefaultNettyServerBootstrap;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.utils.environment.EnvUtils;
import com.netty.initializer.MyChannelInitializer;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.socket.SocketChannel;

/**
 * Netty 服务器配置类，负责初始化和启动 Netty 服务器。
 */
public class NettyServerConfig {

    /**
     * 初始化 Netty 上下文，应用自定义的 ChannelInitializer。
     */
    public void nettyContext() {
        // 实例化自定义的 ChannelInitializer
        ChannelInitializer<SocketChannel> myChannelInitializer = new MyChannelInitializer();

        // 获取当前时间，用于记录启动时间
        long startTime = System.currentTimeMillis();

        // 从环境变量或配置文件中获取服务器端口
        Integer port = EnvUtils.getInt("netty.server.port");

        // 创建 Netty 服务器引导类，并应用自定义的 ChannelInitializer
        DefaultNettyServerBootstrap nettyServerBootstrap = new DefaultNettyServerBootstrap(port, myChannelInitializer);

        // 启动 Netty 服务器
        nettyServerBootstrap.start(startTime);

        // 注册销毁方法，确保应用关闭时正确关闭 Netty 服务器
        TioBootServer.me().addDestroyMethod(nettyServerBootstrap::close);
    }
}

说明：

• DefaultNettyServerBootstrap：Netty-Boot 提供的默认服务器引导类，用于简化 Netty 服务器的启动和配置。
• EnvUtils.getInt("netty.server.port")：从环境变量或配置文件中获取服务器端口号，确保端口配置的灵活性。
• TioBootServer.me().addDestroyMethod(nettyServerBootstrap::close)：注册销毁方法，确保在应用关闭时，Netty 服务器能够优雅地关闭，释放资源。

3. 集成自定义 ChannelInitializer

为了使自定义的 ChannelInitializer 生效，需要在应用的启动类中配置 NettyServerConfig。假设您的启动类为 NettyHelloApp，可以按照以下方式进行配置：

package com.litongjava.study.netty.boot;

import com.config.NettyServerConfig;
import com.litongjava.annotation.AComponentScan;
import com.litongjava.netty.boot.NettyApplication;

/**
 * 应用启动类，负责启动 Netty-Boot 应用。
 */
@AComponentScan
public class NettyHelloApp {
    public static void main(String[] args) {
        // 加载配置
        EnvUtils.load()
        // 配置并启动自定义的 Netty 服务器
        NettyServerConfig nettyServerConfig = new NettyServerConfig();
        nettyServerConfig.nettyContext();
    }
}

说明：

• 在启动类中实例化并调用 NettyServerConfig 的 nettyContext 方法，确保自定义的 ChannelInitializer 被应用于 Netty 服务器。

4. 示例 ChatHandler 实现

以下是一个简单的 ChatHandler 示例，用于处理 WebSocket 消息：

package com.netty.handler;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
import lombok.extern.slf4j.Slf4j;

/**
 * 自定义的 ChatHandler，用于处理 WebSocket 消息。
 */
@Slf4j
public class ChatHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
        String received = msg.text();
        log.info("收到消息: {}", received);

        // 处理消息，例如广播给所有连接的客户端
        ctx.channel().writeAndFlush(new TextWebSocketFrame("服务器回复: " + received));
    }

    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        log.info("新连接加入: {}", ctx.channel());
    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        log.info("连接移除: {}", ctx.channel());
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        log.error("处理消息时发生异常: ", cause);
        ctx.close();
    }
}

说明：

• channelRead0：接收并处理来自客户端的文本消息，并将回复发送回客户端。
• handlerAdded 和 handlerRemoved：记录连接的添加和移除事件，便于监控和调试。
• exceptionCaught：处理异常情况，记录错误日志并关闭连接，确保服务器的稳定性。

5. 启动和测试自定义 ChannelInitializer

完成上述配置后，您可以按照以下步骤启动和测试自定义的 ChannelInitializer 配置。

1. 构建项目

确保已安装 Maven 和 JDK 1.8 或更高版本。

在项目根目录下运行以下命令以构建项目：

mvn clean install

2. 运行应用

使用以下命令启动应用程序：

mvn spring-boot:run -Pdevelopment

此命令将使用 development 配置文件启动应用，并根据 app.properties 中的配置在指定端口（默认 443 或自定义端口）上运行。

3. 测试 WebSocket 接口

您可以使用 WebSocket 客户端工具 或 WebSocket UI 来测试自定义的 WebSocket 接口。

连接到 /nettyServer 路由

1. 打开 WebSocket 客户端工具。

2. 输入连接地址：

   wss://localhost/im/nettyServer
   

3. 连接后，发送一条消息，例如：

   Hello Netty-Boot WebSocket!
   

4. 预期响应：

   服务器回复: Hello Netty-Boot WebSocket!
   

注意：

• 如果您使用的是自签名证书，请确保客户端允许不受信任的证书，或在生产环境中使用受信任的 SSL 证书。
• 确保防火墙或安全组允许所使用的端口（如 443）的入站连接。

7. 常见问题

1. 自定义 ChannelInitializer 未生效

解决方案：

• 确保 NettyServerConfig 已正确配置并在应用启动时调用。
• 检查 ChannelInitializer 类路径是否正确，并确保其被正确扫描和加载。
• 查看启动日志，确认 Netty 服务器是否使用了自定义的 ChannelInitializer。

2. WebSocket 连接失败

解决方案：

• 确认服务器已启动，并监听正确的端口和路径。
• 检查 SSL 证书配置是否正确，确保客户端能够信任服务器的证书。
• 确认防火墙或网络配置允许 WebSocket 连接。

3. SSL 证书相关错误

解决方案：

• 确认 app.properties 中的 SSL 配置项（如证书路径、私钥路径、密码）是否正确。
• 确保私钥格式为 PKCS#8，公钥证书为 PEM 格式的 X.509 证书链文件。
• 使用 openssl 工具验证证书和私钥的有效性。