使用 Netty 实现基于 CS 架构的 WebSocket 功能

WebSocket 是 HTML5 的一种协议，它可以实现浏览器与服务器全双工通信。Websocket 是应用层第七层上的一个应用层协议，它必须依赖 HTTP 协议进行一次握手，握手成功后，数据就可以直接使用 TCP 通道传输，之后就与 HTTP 无关。简单地讲，开始握手需要借助 HTTP 请求完成，之后就会升级为 WebSocket 协议。

本篇开发一个基于 WebSocket 协议的长连接通信。 

采用 Netty 作为长连接的服务端，使用浏览器作为客户端，二者交互图如下。

package netty.websocket;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class MyNettyServerTest {
    public static void main(String[] args) {
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        try {
            // ServerBootstrap：服务端启动时的初始化操作
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            // 将 bossGroup 和 workerGroup 注册到服务端的 Channel上，并注册一个服务端的初始化器 NettyServerInitializer
            // 该初始化器中的 initChannel() 方法，会在连接被注册后立刻执行；最后将端口号绑定到 8888
            ChannelFuture channelFuture = serverBootstrap
                    .group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new MyNettyServerInitializer())
                    .bind(8888).sync();
            channelFuture.channel().closeFuture().sync();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }
}

package netty.websocket;

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;

public class MyNettyServerInitializer extends ChannelInitializer {
    protected void initChannel(SocketChannel sc) throws Exception {
        ChannelPipeline pipeline = sc.pipeline();
        pipeline.addLast("HttpServerCodec", new HttpServerCodec());
        
        pipeline.addLast("HttpObjectAggregator", new HttpObjectAggregator(4096));
        // 处理 websocket 的 netty 处理器，可以通过构造方法绑定 webSocket 的服务端地址
        pipeline.addLast("WebSocketServerProtocolHandler", new WebSocketServerProtocolHandler("/myWebSocket"));
        // 自定义处理器
        pipeline.addLast("MyNettyServerHandler", new MyNettyServerHandler());
    }
}

package netty.websocket;


import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;

// 泛型 TextWebSocketFrame：WebSocket 处理的处理文本类型
public class MyNettyServerHandler extends SimpleChannelInboundHandler {
    // 接收 WebSocket 客户端发送来的数据（Websocket以 fram e的形式传递数据）
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame frame) {
        System.out.println("Server收到消息：" + frame.text());
        // 向 WebSocket 客户端发送数据
        ctx.channel().writeAndFlush(new TextWebSocketFrame("helo client..."));
    }

    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        System.out.println("客户端加入：id=" + ctx.channel().id());
    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        System.out.println("客户端离开：id=" + ctx.channel().id());
    }
}

客户端加入：id=0ecbc18d

Server收到消息：hello，我是客户端

客户端离开：id=0ecbc18d