Netty四、websocket 协议

曾经终败给现在 2022-08-28 11:39 265阅读 0赞

# 1. Websocket协议 #

WebSocket是HTML5开始提供的一种浏览器与服务器间进行全双工通信的网络技术，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道，两者就可以直接互相传送数据了。WebSocket基于TCP 双向全双工进行消息传递，在同一时刻，既可以发送消息，也可以接收消息，相比HTTP 的半双工协议，性能得到很大提升。其特点是

> 1.  单一的TCP连接，采用全双工模式通信：
> 2.  对代理、防火墙和路由器透明；
> 3.  对代理、防火墙和路由器透明；
> 4.  无安全开销：
> 5.  通过“ping/pong”帧保持链路激活：
> 6.  服务器可以主动传递消息给客户端，不再需要客户端轮询。

## 1.1. HTTP协议的弊端 ##

1.  HTTP协议为半双工协议。半双工协议指数据可以在客户端和服务端两个方向上 传输，但是不能同时传输。它意味着在同一时刻，只有一个方向上的数据传送。
2.  HTTP消息冗长而繁琐。HTTP消息包含消息头、消息体、换行符等，通常情况 下采用文本方式传输，相比于其他的二进制通信协议，冗长而繁琐；
3.  针对服务器推送的黑客攻击。例如长时间轮询。现在，很多网站为了实现消息推送，所用的技术都是轮询。轮询是在特定的的时间间 隔（如每1秒），由浏览器对服务器发出HTTP request,然后由服务器返回最新的数据给 客户端浏览器。这种传统的模式具有很明显的缺点，即浏览器需要不断地向服务器发出请 求，然而HTTP request的Header是非常冗长的，里面包含的可用数据比例可能非常低， 这会占用很多的带宽和服务器资源。

## 1.1.2 Websocket链接建立 ##

1.  为了建立一个WebSocket连接，客户端浏览器先要向服务器发起1个HTTP请求， 这个清求和通常的HTTP请求不同，包含了一些附加头信息，其中附加头信息" Upgrade: WebSocket"表明这是 个申请协议升级的HTTP请求。
2.  双方可以通过这个连接通道自由地传递信息，并旦这个连接会持续存在直到客尸端或者服务 器端的某一方主动关闭连接。
3.  握手成功之后，服务端和客户端就可以通过“messages"的方式进行通信了，一个消 息由一个或者多个帧组成，WebSocket的消息并不一定对应一个特定网结层的帧，它可以 被分割成多个帧或者被合并。

## 1.1.2 Websocket链接关闭 ##

1.  为关闭WebSocket连接，客户端和服务端需要通过一个安全的方法关闭底层TCP连 接以及TLS会话。如果合适，丢弃任何可能己经接收的字节，必要时（比如受到攻击）可 以通过任何可用的手段关闭连接。
2.  当服务器被指示关闭WebSocket连接时，它应该立即发起一个TCP Close操作：客户 端应该等待服务器的TCP Close。
3.  WebSocket的握手关闭消息带有一个状态码和一个可选的关闭原因，它必须按照协议 要求发送一个Close控制帧，当对端接收到关闭控制帧指令时，需要主动关闭WebSocket 连接。

# 2. Netty 编写Websocket服务器 #

public class WebSocketServerHandler extends SimpleChannelInboundHandler<Object> {
        
        private static final Logger logger = Logger.getLogger(WebSocketServerHandler.class.getName());
    
        private WebSocketServerHandshaker handshaker;
    
    
        @Override
        public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        
            ctx.flush();
        }
    
        private void handleHttpRequest(ChannelHandlerContext ctx, FullHttpRequest req) throws Exception {
        
            // 如果HTTP解码失败，返回HHTP异常
            if (!req.getDecoderResult().isSuccess() || (!"websocket".equals(req.headers().get("Upgrade")))) {
        
                sendHttpResponse(ctx, req, new DefaultFullHttpResponse(HTTP_1_1, BAD_REQUEST));
                return;
            }
    
            // 创建握手处理类 WebSocketServer Handshaker.通过它构造握手响应消息返冋给客户端，同时将WebSocket相关的编码和解 码类动态添加到					ChannelPipeline中，用于WebSocket消息的编解码
            WebSocketServerHandshakerFactory wsFactory = new WebSocketServerHandshakerFactory(
                    "ws://localhost:8080/websocket", null, false);
            handshaker = wsFactory.newHandshaker(req);
            if (handshaker == null) {
        
                WebSocketServerHandshakerFactory.sendUnsupportedWebSocketVersionResponse(ctx.channel());
            } else {
        
                handshaker.handshake(ctx.channel(), req);
            }
        }
    
        private void handleWebSocketFrame(ChannelHandlerContext ctx,
                                          WebSocketFrame frame) {
        
    
            // 判断是否是关闭链路的指令
            if (frame instanceof CloseWebSocketFrame) {
        
                handshaker.close(ctx.channel(),
                        (CloseWebSocketFrame) frame.retain());
                return;
            }
    
            // 判断是否是Ping消息
            if (frame instanceof PingWebSocketFrame) {
        
                ctx.channel().write(new PongWebSocketFrame(frame.content().retain()));
                return;
            }
    
            // 本例程仅支持文本消息，不支持二进制消息
            if (!(frame instanceof TextWebSocketFrame)) {
        
                throw new UnsupportedOperationException(String.format(
                        "%s frame types not supported", frame.getClass().getName()));
            }
    
            // 返回应答消息
            String request = ((TextWebSocketFrame) frame).text();
            if (logger.isLoggable(Level.FINE)) {
        
                logger.fine(String.format("%s received %s", ctx.channel(), request));
            }
            ctx.channel().write(new TextWebSocketFrame(request + " , 欢迎使用Netty WebSocket服务，现在时刻：" +
                    new java.util.Date().toString()));
        }
    
    
        private static void sendHttpResponse(ChannelHandlerContext ctx,
                                             FullHttpRequest req, FullHttpResponse res) {
        
            // 返回应答给客户端
            if (res.getStatus().code() != 200) {
        
                ByteBuf buf = Unpooled.copiedBuffer(res.getStatus().toString(),
                        CharsetUtil.UTF_8);
                res.content().writeBytes(buf);
                buf.release();
                setContentLength(res, res.content().readableBytes());
            }
    
            // 如果是非Keep-Alive，关闭连接
            ChannelFuture f = ctx.channel().writeAndFlush(res);
            if (!isKeepAlive(req) || res.getStatus().code() != 200) {
        
                f.addListener(ChannelFutureListener.CLOSE);
            }
        }
    
        @Override
        public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
                throws Exception {
        
            cause.printStackTrace();
            ctx.close();
        }
    
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
        
            // 第一次握手请求消息由HTTP协议承载，所以它是一个HTTP消息处理WebSocket握手请求
            if (msg instanceof FullHttpRequest) {
        
                handleHttpRequest(ctx, (FullHttpRequest) msg);
            }
            
            // WebSocket接入
            else if (msg instanceof WebSocketFrame) {
        
                handleWebSocketFrame(ctx, (WebSocketFrame) msg);
            }
        }
    }

# 3. xmind #

![请添加图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Li25oOz5Y-L_size_20_color_FFFFFF_t_70_g_se_x_16]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Li25oOz5Y-L_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/c272e0e1a782494d95c54a95f0282072.png