netty与WebSocket协议

FullHttpRequest和WebSocketFrame是用于不同协议下处理网络请求的类。FullHttpRequest是 Netty 框架中的一个类,用于处理传统的 HTTP 请求。而WebSocketFrame则是用于处理 WebSocket 数据帧的各种类型。在实际应用中,通常需要转换 HTTP 请求到 WebSocket 握手,以及处理后续的 WebSocket 帧。

FullHttpRequest 和 WebSocketFrame 概述

FullHttpRequest

FullHttpRequest 是 Netty 中用于表示完整的 HTTP 请求的接口,继承了 HttpRequest 接口以及 FullHttpMessage。

它包含 HTTP 请求的所有部分,包括头部(Headers)、查询参数(Query Params)、主体(Body)等。

常用在 HTTP 服务端处理器中,用于处理客户端发来的请求。

WebSocketFrame

WebSocketFrame 是 Netty 中用于表示 WebSocket 数据帧的抽象类。

不同类型的 WebSocket 数据帧继承自 WebSocketFrame,包括但不限于 TextWebSocketFrame(文本帧)、BinaryWebSocketFrame(二进制帧)、PingWebSocketFrame、PongWebSocketFrame、CloseWebSocketFrame 等。

在 WebSocket 服务端处理器中,接收到的数据会以 WebSocketFrame 的子类形式出现。

生成 WebSocket 握手响应的示例代码

首先,我们需要处理 HTTP 握手请求,将其转换为 WebSocket 连接。这通常在 HTTP 服务器中进行,将 HTTP 请求转换为 WebSocket 握手响应。

import io.netty.buffer.ByteBuf;

import io.netty.buffer.Unpooled;

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.FullHttpResponse;

import io.netty.handler.codec.http.HttpHeaderNames;

import io.netty.handler.codec.http.HttpHeaderValues;

import io.netty.handler.codec.http.HttpHeaders;

import io.netty.handler.codec.http.HttpObject;

import io.netty.handler.codec.http.HttpResponseStatus;

import io.netty.handler.codec.http.HttpVersion;

import io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker;

import io.netty.handler.codec.http.websocketx.WebSocketServerHandshakerFactory;

import io.netty.handler.codec.http.websocketx.WebSocketFrame;

import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;

import io.netty.util.CharsetUtil;

public class WebSocketServerHandler extends SimpleChannelInboundHandler<HttpObject> {

    private WebSocketServerHandshaker handshaker;

    @Override

    protected void channelRead0(ChannelHandlerContext ctx, HttpObject msg) throws Exception {

        if (msg instanceof FullHttpRequest) {

            handleHttpRequest(ctx, (FullHttpRequest) msg);

        } else if (msg instanceof WebSocketFrame) {

            handleWebSocketFrame(ctx, (WebSocketFrame) msg);

        }

    }

    private void handleHttpRequest(ChannelHandlerContext ctx, FullHttpRequest req) {

        // 检查请求的解码结果

        if (!req.decoderResult().isSuccess() || !"websocket".equals(req.headers().get(HttpHeaderNames.UPGRADE))) {

            sendHttpResponse(ctx, req, new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.BAD_REQUEST));

            return;

        }

        // 建立 WebSocket 握手

        WebSocketServerHandshakerFactory wsFactory = new WebSocketServerHandshakerFactory(

                getWebSocketLocation(req), null, false);

        handshaker = wsFactory.newHandshaker(req);

        if (handshaker == null) {

            WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(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();

        ctx.channel().write(new TextWebSocketFrame(request + ", 欢迎使用Netty WebSocket服务,现在时刻:" + new java.util.Date().toString()));

    }


    private void sendHttpResponse(ChannelHandlerContext ctx, FullHttpRequest req, FullHttpResponse res) {

        // 返回应答给客户端

        if (res.status().code() != 200) {

            ByteBuf buf = Unpooled.copiedBuffer(res.status().toString(), CharsetUtil.UTF_8);

            res.content().writeBytes(buf);

            buf.release();

            HttpHeaders.setContentLength(res, res.content().readableBytes());

        }

        // 如果是非Keep-Alive,关闭连接

        ctx.channel().writeAndFlush(res).addListener(ChannelFutureListener.CLOSE);

    }

    private String getWebSocketLocation(FullHttpRequest req) {

        String location = req.headers().get(HttpHeaderNames.HOST) + "/websocket";

        if (WebSocketServer.SSL) {

            return "wss://" + location;

        } else {

            return "ws://" + location;

        }

    }

}

代码解释

处理 HTTP 请求

检查是否为 WebSocket 升级请求。如果不是,则返回一个 HTTP 400 错误响应。

使用 WebSocketServerHandshakerFactory 创建 WebSocket 握手处理器,并处理握手。

处理 WebSocket 帧

处理关闭帧(CloseWebSocketFrame):关闭连接。

处理 Ping 帧(PingWebSocketFrame):响应 Pong 帧。

处理文本帧(TextWebSocketFrame):处理并响应文本消息。此示例只支持处理文本消息,实际应用中可能需要处理二进制消息等。

辅助方法

sendHttpResponse:发送 HTTP 响应,必要时关闭连接。

getWebSocketLocation:获取 WebSocket 的 URL,处理 SSL 和非 SSL 情况。

总结

通过上述代码示例,你可以看到如何从 HTTP 请求处理 WebSocket 升级,并处理后续的 WebSocket 帧。FullHttpRequest和WebSocketFrame分别对应 HTTP 协议和 WebSocket 协议的数据处理,两者在 WebSocket 握手时结合使用。希望这对你有所帮助,如果有更多问题或需要进一步的帮助,请继续提问!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容