Netty实现WebSocket

作者: 沧海一粟谦 | 来源:发表于2018-08-13 12:43 被阅读1117次
    Saving Private Ryan

    Netty是由JBOSS提供的一款基于NIO的客户、服务器端编程的Java开源框架,用以快速开发高性能、高可靠性的网络服务器和客户端程序。

    BIO:同步阻塞IO

    服务端采用一个独立的Acceptor线程监听客户端的连接,当接收到客户端连接请求后,为每个客户端创建一个新的线程进行链路处理,处理完成后通过输出流返回给客户端,然后销毁线程。属于典型的一请求一应答通信模型,缺乏弹性伸缩能力。当客户端并发访问量增加后,服务端的线程数同步增加,由于线程是jvm非常宝贵的系统资源,线程数增加,系统的性能急剧下降,甚至会造成堆栈溢出,创建线程失败等问题。


    伪异步IO

    当有新的客户端接入的时候,将客户端socket封装成Task到线程池中处理。线程池可以设置消息队列的大小和最大线程数,因此它的资源占用是可控的。但是当有大量客户端接入的时候会造成线程池阻塞。


    NIO:同步非阻塞IO

    • 缓冲区Buffer:一块连续的内存块,是 NIO 数据读或写的中转地。
    • 通道Channel:数据的源头或者数据的目的地,用于向 buffer 提供数据或者读取 buffer 数据 ,buffer 对象的唯一接口。支持异步 I/O 。
    • 多路复用器Selector:具有选择就绪任务的能力。

    Buffer作为IO流中数据的缓冲区,而Channel则作为socket的IO流与Buffer的传输通道。客户端socket与服务端socket之间的IO传输不直接把数据交给CPU使用,而是先经过Channel通道把数据保存到Buffer,然后CPU直接从Buffer区读写数据,一次可以读写更多的内容。


    NIO是对BIO的改进,基于Reactor模型。NIO的最重要的地方是当一个连接创建后,不需要对应一个线程,这个连接会被注册到多路复用器上面,所以所有的连接只需要一个线程就可以搞定,当这个线程中的多路复用器进行轮询的时候,发现连接上有请求的话,才开启一个线程进行处理。

    AIO:异步阻塞IO

    AIO是对NIO的改进,是基于Proactor模型。与NIO不同,当进行读写操作时,只须直接调用API的read或write方法即可。这两种方法均为异步的,对于读操作而言,当有流可读取时,操作系统会将可读的流传入read方法的缓冲区,并通知应用程序;对于写操作而言,当操作系统将write方法传递的流写入完毕时,操作系统主动通知应用程序。较之NIO而言,AIO一方面简化了程序出的编写,流的读取和写入都由操作系统来代替完成;另一方面省去了NIO中程序要遍历事件通知队列(selector)的代价。Windows基于[IOCP(http://en.wikipedia.org/wiki/Input/output_completion_port)实现了AIO,Linux目前只有基于epoll实现的AIO。

    Java对BIO、NIO、AIO的支持:

    • BIO : 同步并阻塞,服务器实现模式为一个连接一个线程,即客户端有连接请求时服务器端就需要启动一个线程进行处理,如果这个连接不做任何事情会造成不必要的线程开销,当然可以通过线程池机制改善。

    • NIO : 同步非阻塞,服务器实现模式为一个请求一个线程,即客户端发送的连接请求都会注册到多路复用器上,多路复用器轮询到连接有I/O请求时才启动一个线程进行处理。

    • AIO(NIO.2) : 异步非阻塞,服务器实现模式为一个有效请求一个线程,客户端的I/O请求都是由OS先完成了再通知服务器应用去启动线程进行处理。

    BIO、NIO、AIO适用场景分析:

    • BIO方式适用于连接数目比较小且固定的架构,这种方式对服务器资源要求比较高,并发局限于应用中,JDK1.4以前的唯一选择,但程序直观简单易理解。

    • NIO方式适用于连接数目多且连接比较短(轻操作)的架构,比如聊天服务器,并发局限于应用中,编程比较复杂,JDK1.4开始支持。

    • AIO方式使用于连接数目多且连接比较长(重操作)的架构,比如相册服务器,充分调用OS参与并发操作,编程比较复杂,JDK7开始支持。

    WebSocket

    WebSocket是HTML5开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。在WebSocket API中,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。浏览器通过 JavaScript 向服务器发出建立 WebSocket 连接的请求,连接建立以后,客户端和服务器端就可以通过 TCP 连接直接交换数据。当你获取 Web Socket 连接后,你可以通过 send() 方法来向服务器发送数据,并通过 onmessage 事件来接收服务器返回的数据。

    当WebSocket的客户端与服务端通信以后,就不需要之前握手请求HTTP协议的参与了

    WebSocket的优点

    • 节省通信开销(HttpRequest中的head很长,占用带宽和资源)
    • 服务器可以主动传送数据给客户端
    • 实时通信
      因为HTTP 协议是一种无状态的、无连接的、单向的应用层协议。它采用了请求/响应模型。通信请求只能由客户端发起,服务端对请求做出应答处理。这种通信模型有一个弊端:HTTP 协议无法实现服务器主动向客户端发起消息。如果服务器有连续的状态变化,客户端要获知就非常麻烦。大多数 Web 应用程序将通过频繁的异步JavaScript和XML(AJAX)请求实现长轮询。轮询的效率低,非常浪费资源(因为必须不停连接,或者 HTTP 连接始终打开)。

    WebSocket的生命周期

    WebSocket端点生命周期的第一个事件是打开通知,它用来指示到WebSocket会话另一端的连接已经建立。一旦打开通知被WebSocket对话的两端都接收到,参与的任意WebSocket后续就可以发送消息了。在WebSocket对话期间,可能会出现一些消息传递的错误。接受消息的WebSocket端点本身就可能产生错误,或者WebSocket实现本身在某些情况下也会产生错误。要注意对错误的处理。不管在WebSocket对话的哪一端准备结束对话,他都可以初始化关闭事件。下面从Java组件的视角来看看其生命周期如何呈现。

    • 打开事件:@OnOpen 此事件发生在端点上建立新连接时并且在任何其他事件发生之前

    • 消息事件:@OnMessage 此事件接收WebSocket对话中另一端发送的消息。

    • 错误事件:@OnError 此事件在WebSocket连接或者端点发生错误时产生

    • 关闭事件:@OnClose 此事件表示WebSocket端点的连接目前部分地关闭,它可以由参与连接的任意一个端点发出

    Netty实现WebSocket

    import io.netty.channel.group.ChannelGroup;
    import io.netty.channel.group.DefaultChannelGroup;
    import io.netty.util.concurrent.GlobalEventExecutor;
    
    /**
     * 存储整个工程的全局配置
     */
    public class NettyConfig {
    
        //存储每一个客户端接入进来时的channel对象
        public static ChannelGroup group = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
    }
    
    import java.util.Date;
    import io.netty.buffer.ByteBuf;
    import io.netty.buffer.Unpooled;
    import io.netty.channel.ChannelFuture;
    import io.netty.channel.ChannelFutureListener;
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.SimpleChannelInboundHandler;
    import io.netty.handler.codec.http.DefaultFullHttpResponse;
    import io.netty.handler.codec.http.FullHttpRequest;
    import io.netty.handler.codec.http.HttpResponseStatus;
    import io.netty.handler.codec.http.HttpVersion;
    import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame;
    import io.netty.handler.codec.http.websocketx.PingWebSocketFrame;
    import io.netty.handler.codec.http.websocketx.PongWebSocketFrame;
    import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
    import io.netty.handler.codec.http.websocketx.WebSocketFrame;
    import io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker;
    import io.netty.handler.codec.http.websocketx.WebSocketServerHandshakerFactory;
    import io.netty.util.CharsetUtil;
    
    /**
     * 接收/处理/响应客户端websocket请求的核心业务处理类
     */
    public class MyWebSocketHandler extends SimpleChannelInboundHandler<Object> {
        
        private WebSocketServerHandshaker handshaker;
        private static final String WEB_SOCKET_URL = "ws://localhost:8888/websocket";
        //客户端与服务端创建连接的时候调用
        @Override
        public void channelActive(ChannelHandlerContext ctx) throws Exception {
            NettyConfig.group.add(ctx.channel());
            System.out.println("客户端与服务端连接开启...");
        }
    
        //客户端与服务端断开连接的时候调用
        @Override
        public void channelInactive(ChannelHandlerContext ctx) throws Exception {
            NettyConfig.group.remove(ctx.channel());
            System.out.println("客户端与服务端连接关闭...");
        }
    
        //服务端接收客户端发送过来的数据结束之后调用
        @Override
        public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
                ctx.flush();
        }
    
        //工程出现异常的时候调用
        @Override
        public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
            cause.printStackTrace();
            ctx.close();
        }
    
        //服务端处理客户端websocket请求的核心方法
        @Override
        protected void messageReceived(ChannelHandlerContext context, Object msg) throws Exception {
            //处理客户端向服务端发起http握手请求的业务
            if (msg instanceof FullHttpRequest) {
                handHttpRequest(context,  (FullHttpRequest)msg);
            }else if (msg instanceof WebSocketFrame) { //处理websocket连接业务
                handWebsocketFrame(context, (WebSocketFrame)msg);
            }
        }
        
        // 处理客户端与服务端之前的websocket业务
        private void handWebsocketFrame(ChannelHandlerContext ctx, WebSocketFrame frame){
            //判断是否是关闭websocket的指令
            if (frame instanceof CloseWebSocketFrame) {
                handshaker.close(ctx.channel(), (CloseWebSocketFrame)frame.retain());
            }
            //判断是否是ping消息
            if (frame instanceof PingWebSocketFrame) {
                ctx.channel().write(new PongWebSocketFrame(frame.content().retain()));
                return;
            }
            
            //判断是否是二进制消息,如果是二进制消息,抛出异常
            if( ! (frame instanceof TextWebSocketFrame) ){
                System.out.println("目前我们不支持二进制消息");
                throw new RuntimeException("【"+this.getClass().getName()+"】不支持消息");
            }
            //返回应答消息
            //获取客户端向服务端发送的消息
            String request = ((TextWebSocketFrame) frame).text();
            System.out.println("服务端收到客户端的消息====>>>" + request);
            TextWebSocketFrame tws = new TextWebSocketFrame(new Date().toString()                                                                               + ctx.channel().id()    + " ===>>> " + request);                                                                                                                                                            
            //服务端向每个连接上来的客户端群发消息
            NettyConfig.group.writeAndFlush(tws);
        }
        // 处理客户端向服务端发起http握手请求的业务
        private void handHttpRequest(ChannelHandlerContext ctx, FullHttpRequest req){
            if (!req.getDecoderResult().isSuccess() 
                    || ! ("websocket".equals(req.headers().get("Upgrade")))) {
                sendHttpResponse(ctx, req, 
                        new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.BAD_REQUEST));
                return;
            }
            WebSocketServerHandshakerFactory wsFactory = new WebSocketServerHandshakerFactory(
                    WEB_SOCKET_URL, null, false);
            handshaker = wsFactory.newHandshaker(req);
            if (handshaker == null) {
                WebSocketServerHandshakerFactory.sendUnsupportedWebSocketVersionResponse(ctx.channel());
            }else{
                handshaker.handshake(ctx.channel(), req);
            }
        }
        
        // 服务端向客户端响应消息
        private void sendHttpResponse(ChannelHandlerContext ctx, FullHttpRequest req,
                DefaultFullHttpResponse res){
            if (res.getStatus().code() != 200) {
                ByteBuf buf = Unpooled.copiedBuffer(res.getStatus().toString(), CharsetUtil.UTF_8);
                res.content().writeBytes(buf);
                buf.release();
            }
            //服务端向客户端发送数据
            ChannelFuture f = ctx.channel().writeAndFlush(res);
            if (res.getStatus().code() != 200) {
                f.addListener(ChannelFutureListener.CLOSE);
            }
        }
    }
    
    import io.netty.channel.ChannelInitializer;
    import io.netty.channel.socket.SocketChannel;
    import io.netty.handler.codec.http.HttpObjectAggregator;
    import io.netty.handler.codec.http.HttpServerCodec;
    import io.netty.handler.stream.ChunkedWriteHandler;
    
    /**
     * 初始化连接时候的各个组件
     */
    public class MyWebSocketChannelHandler extends ChannelInitializer<SocketChannel> {
    
        @Override
        protected void initChannel(SocketChannel e) throws Exception {
            e.pipeline().addLast("http-codec", new HttpServerCodec());
            e.pipeline().addLast("aggregator", new HttpObjectAggregator(65536));
            e.pipeline().addLast("http-chunked", new ChunkedWriteHandler());
            e.pipeline().addLast("handler", new MyWebSocketHandler());
        }
    }
    
    import io.netty.bootstrap.ServerBootstrap;
    import io.netty.channel.Channel;
    import io.netty.channel.EventLoopGroup;
    import io.netty.channel.nio.NioEventLoopGroup;
    import io.netty.channel.socket.nio.NioServerSocketChannel;
    
    /**
     * 程序的入口,负责启动应用
     */
    public class Main {
        public static void main(String[] args) {
            EventLoopGroup bossGroup = new NioEventLoopGroup();
            EventLoopGroup workGroup = new NioEventLoopGroup();
            try {
                ServerBootstrap b = new ServerBootstrap();
                b.group(bossGroup, workGroup);
                b.channel(NioServerSocketChannel.class);
                b.childHandler(new MyWebSocketChannelHandler());
                System.out.println("服务端开启等待客户端连接....");
                Channel ch = b.bind(8888).sync().channel();
                ch.closeFuture().sync();
                
            } catch (Exception e) {
                e.printStackTrace();
            }finally{
                //优雅的退出程序
                bossGroup.shutdownGracefully();
                workGroup.shutdownGracefully();
            }
        }
    }
    
    <html>
        <head>
            <meta http-equiv="Content-Type" content="text/html; charset = utf-8"/>
            <title>WebSocket客户端</title>
        <script type="text/javascript">
            var socket;
            if(!window.WebSocket){
                window.WebSocket = window.MozWebSocket;
            }
    
            if(window.WebSocket){
                socket = new WebSocket("ws://localhost:8888/websocket");
                socket.onmessage = function(event){
                    var ta = document.getElementById('responseContent');
                    ta.value += event.data + "\r\n";
                };
    
                socket.onopen = function(event){
                    var ta = document.getElementById('responseContent');
                    ta.value = "你当前的浏览器支持WebSocket,请进行后续操作\r\n";
                };
    
                socket.onclose = function(event){
                    var ta = document.getElementById('responseContent');
                    ta.value = "";
                    ta.value = "WebSocket连接已经关闭\r\n";
                };
            }else{
                alert("您的浏览器不支持WebSocket");
            }
    
    
            function send(message){
                if(!window.WebSocket){
                    return;
                }
                if(socket.readyState == WebSocket.OPEN){
                    socket.send(message);
                }else{
                    alert("WebSocket连接没有建立成功!!");
                }
            }
        </script>
        </head>
        <body>
            <form onSubmit="return false;">
                <input type = "text" name = "message" value = ""/>
                <br/><br/>
                <input type = "button" value = "发送WebSocket请求消息" onClick = "send(this.form.message.value)"/>
                <hr color="red"/>
                <h2>客户端接收到服务端返回的应答消息</h2>
                <textarea id = "responseContent" style = "width:1024px; height:300px"></textarea>
            </form>
        </body>
    </html>
    

    参考

    netty-all-5.0.0.Alpha1.jar
    WebSocket 详解教程
    SpringBoot 开发WebSocket

    相关文章

      网友评论

        本文标题:Netty实现WebSocket

        本文链接:https://www.haomeiwen.com/subject/desybftx.html