Qt QWebSocket网络编程

已于 2024-07-11 12:16:48 修改
阅读量1.1k 收藏 26
点赞数 16
文章标签： 网络
于 2024-07-11 12:16:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_50873490/article/details/140332606
版权

学习目标：Qt QWebSocket网络编程

学习前置环境

QT TCP多线程网络通信-CSDN博客

学习内容

WebSocket是一种通过单个TCP连接提供全双工通信信道的网络技术。2011年，IETF将WebSocket协议标准化为 RFC6455，QWebSocket可用于客户端应用程序和服务器应用程序。

它实现了浏览器与服务器全双工(full-duplex)通信,允许服务器主动发送信息到客户端。

主要特点:

  1. 与HTTP不同,WebSocket允许服务器主动发送数据给客户端,不需要客户端发起请求。

  2. 建立在TCP协议之上,服务器和客户端之间通过Ws(WebSocket)协议在单个端口上进行全双工通信。

  3. 支持以文本方式或者二进制方式传输数据。

  4. 协议建立在单个TCP连接上,服务器和客户端只需创建一个连接,且连接不会被关闭。

  5. 支持多种编程语言的客户端和服务器端库,如JavaScript,Java,C#,Python等。

常见应用场景:

  1. 聊天室:支持低延迟的实时对话。

  2. 在线game:需要实时同步游戏状态的同步引擎。

  3. 股票行情:需要推送即时行情给客户端的行情软件。

  4. 视频会议:需要语音和视频的低延迟实时通信。

  5. 实时协作编辑:如在线代码编辑器要求实时同步。

QWebSocket是Qt提供的WebSocket功能库。它建立在Qt网络模块之上,实现了RFC6455标准中的WebSocket协议。需要再Qmake文件中加入 QT+=websockets

  1. QWebSocket只支持Text/Binary两种消息格式,不支持其他扩展格式。如果需要补充其他自定义协议,需要开发者在应用层自己处理。

  2. 它支持使用标准的http/https端口80/443访问websocket服务,也支持wss(加密websocket)协议。所以可以很方便地与现有的web服务器交互。

  3. 由于它基于QT CP套接字实现,完全支持所有Qt网络功能,比如代理设置、SSL配置等。这一点相比一些底层的C接口更易用。

  4. 它同时支持主动和被动连接模式。主动连接通过connectToHost(),被动通过监听端口accept()接受新的链接。这两种模式都很方便。

  5. 对于QT GUI应用,可以很方便地进行消息接收与界面更新,避免了多线程编程的复杂性。比如直接在textMessageReceived()里更新界面就行了。

  6. QT5.10后支持了异步I/O,性能较以前有一点提升。对网延的支持也更好了。

QWebSocket常用成员函数


origin()
即 websocket=new QWebSocket("C1我是客户端",QWebSocketProtocol::VersionLatest,this);
websocket->origin()  -》 C1我是客户端

void connectToHost(const QUrl &url) - 用于连接到指定主机的websocket服务,这个函数是异步的。
void close() - 关闭与服务器的连接。
void textMessageReceived(const QString &message) - 收到文本消息时触发的信号,其参数就是收到的文本消息内容。
void binaryMessageReceived(const QByteArray &message) - 收到二进制消息时触发的信号,参数是原始二进制数据。
void error(QAbstractSocket::SocketError socketError) - 发生错误时触发的信号,参数是错误类型。
void stateChanged(QAbstractSocket::SocketState state) - 连接状态变化时触发,可以得知连接是否建立等。
void textMessageSent(qint64 numBytes) - 发送文本消息完成后触发,numBytes是字节数。
void bytesWritten(qint64 bytes) - 消息发送过程中的写入回调, bytes是一个部分发送出去的字节数。
void abort() - 主动断开连接。
bool waitForConnected(int msec = 30000) - 阻塞等待连接建立成功。

QString hostName() - 获取当前连接的主机名,常用于判断连接是否成功。
quint16 port() - 获取主机端口号。
bool openMode() - 判断当前是否为主动连接还是被动接受模式。
void writeTextMessage(const QString &text) - 发送文本消息,相比textMessage等更直观。
void writeMessage(const QByteArray &data) - 发送二进制数据。
qint64 bytesAvailable() - 查看接收缓存中可读取字节数。
qint64 readBufferSize() - 设置双向数据接收缓存大小。
void pauseIncomingPayload() - 暂停接收消息流。
void resumeIncomingPayload() - 恢复接收。
bool isValid() - 检查连接是否有效。

另外,作为QT套接字,它还支持一些通用功能:
void setProxy() - 设置代理。
void encrypt() - 设置SSL安全连接。
void flush() - 强制输出缓存写出。
bool waitForBytesWritten() - 等待数据发送完毕。

 
void QWebSocket::sendTextMessage(const QString &message)  用于发送文本消息
使用这个函数发送文本消息主要有以下几点需要注意的地方:
1发送文本消息前请确保WebSocket连接已经建立。可以通过ReadyState判断连接状态。
2发送的消息内容必须是纯文本,不支持转义编码等更多格式。
3一条消息发送完毕后,会触发textMessageSent()信号通知。
4可以通过waitForBytesWritten()等待数据完全发送出去。
5发送数据顺序可能与收到响应顺序不一致,需要应用层自己处理序号等。
6若消息较大,建议使用write或send到套接字后flush,而不是sendTextMessage。
7跨平台考虑,消息内容编码最好使用QString而不是QByteArray。
8使用该函数发送的文本消息类型,服务端一般对应文本框接受。
9可以绑定消息发送断开连接的异常处理等。

sendTextMessage和writeTextMessage这两个函数都可以用来发送文本消息,但它们有一些区别:

  1. 函数定义不同:

  • sendTextMessage属于QWebSocket的成员函数;

  • writeTextMessage是QAbstractSocket的成员函数,QWebSocket继承于QAbstractSocket。

  1. 发送效率不同:

  • sendTextMessage内部会将消息先转成QByteArray,再通过write函数发送,多了一次转换;

  • writeTextMessage直接写入需要发送的QString,效率略高。

  1. 异步支持不同:

  • sendTextMessage是同步操作,发送完毕后再返回;

  • writeTextMessage支持异步调用,可以通过Lambda指定回调函数。

  1. 错误处理不同:

  • sendTextMessage不会返回错误信息,只能通过信号错误处理;

  • writeTextMessage可以获取返回的错误码判断发送情况。

  1. 使用场景不同:

  • sendTextMessage专注WebSocket,适合 WebSocket API 的调用方式;

  • writeTextMessage更通用,可用于其他QAbstractSocket子类。

总的来说:

  • sendTextMessage使用更简单,封装良好适合基本用法;

  • writeTextMessage效率略高,支持更多特性如异步和错误处理,适合性能或控制需求较高的场景。

实现项目

客户端与客户端私聊通信，客户端与服务端之间通信。

 核心代码

服务端

流程：创建QWebServer,绑定新连接回调，监听断开。

新连接回调：有新连接 加入集合，给新连接socket绑定离线和接收以及错误的回调。

发送消息按钮：对all和one进行分类处理，遍历set集合，使用sendTextMesg发送

#include "widget.h"
#include "ui_widget.h"
//这个是服务器端
Widget::Widget(QWidget *parent)
    : QWidget(parent)
    , ui(new Ui::Widget)
{
    ui->setupUi(this);
    /*
     * mode
NonSecureMode: 不安全模式,即不使用SSL/TLS进行通信。这是默认值。
SecureMode: 安全模式,以SSL/TLS安全通信。客户端和服务端之间的连接将使用SSL握手建立安全通道。
AutomaticallyAcceptServerCertificates: 自动接受服务器证书。在SecureMode下,客户端无法验证证书时,自动接受服务器发来的证书以建立连接。
VerifyNone: 不验证证书。以SecureMode运行,但不会验证客户端和服务端使用的证书。
*/
    webServer = new QWebSocketServer("testWebServer",QWebSocketServer::NonSecureMode,this);
    QObject::connect(webServer,&QWebSocketServer::newConnection,this,&Widget::MyselfNewConnectCallBackSlot);

    webServer->listen(QHostAddress::Any,8888);
}
void Widget::MyselfNewConnectCallBackSlot(){//新连接回调

    if(webServer->hasPendingConnections()){
        QWebSocket* websocket=webServer->nextPendingConnection();
        ui->msgtext->append(websocket->origin()+"客户端已连接到服务器");
        sockets<<websocket;

        QListWidgetItem * item =new QListWidgetItem;
        item->setText(websocket->origin());
        ui->clinetls->addItem(item);


        //绑定离开
        QObject::connect(websocket,&QWebSocket::disconnected,this,[websocket,this](){
            ui->msgtext->append(websocket->origin()+"客户端断开服务器连接");
            sockets.removeOne(websocket);
            for(int i=0;i<ui->clinetls->count();i++)
            {
                QListWidgetItem *item=ui->clinetls->item(i);

                if(item->text()==websocket->origin())
                {
                    ui->clinetls->removeItemWidget(item);
                    delete item;
                    break;
                }
            }

            websocket->deleteLater();

        });


        //接受消息回调
        QObject::connect(websocket,&QWebSocket::textMessageReceived,this,[this](const QString &msg){
            QJsonDocument doc =QJsonDocument::fromJson(msg.toLatin1().data());
            if(doc.isNull()){
                QWebSocket* websocket =qobject_cast<QWebSocket*>(sender());//sender 触发信号的源头
                ui->msgtext->append("收到客户端消息["+websocket->origin()+"]--->"+msg);

            }else{
                //客户端之间的单发消息
                QJsonObject obj=doc.object();
                QString dst=doc["dst"].toString();
                for (auto& socket : sockets) {
                    if(dst == socket->origin()){
                        socket->sendTextMessage(msg);
                    }
                }
            }
        });


        QObject::connect(websocket,QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::error),
                         this,[this](QAbstractSocket::SocketError error){
            QWebSocket* web =qobject_cast<QWebSocket*>(sender());
            ui->msgtext->append(web->origin()+"出错"+web->errorString());
        });
    }



}
Widget::~Widget()
{
    delete ui;
    for(auto socket:sockets)
    {
        socket->close();
    }

    webServer->close();
}


void Widget::on_sendpb_clicked()
{
    QString send =ui->sendtext->toPlainText().trimmed();
    if(send.isEmpty())return;
    if(ui->allradio->isChecked()){
        //群发
        if(sockets.size()==0)return;
        foreach(auto &socket,sockets){
            socket->sendTextMessage(send);
        }
        ui->msgtext->append("服务器给所有连接发送："+send);
    }else{ //私发  取客户端名称 找 发
        if(!ui->clinetls->currentItem())return;
        QString cname =ui->clinetls->currentItem()->text();

        for(auto &socket:sockets)
        {
            if(socket->origin()==cname)
            {
                socket->sendTextMessage(send);
                ui->msgtext->append("服务端给["+socket->origin()+"]发送--->"+send);

                break;
            }
        }
    }


    ui->sendtext->clear();
}

客户端

点击按钮实现websocket连接流程：创建websocket,绑定各种回调，通过open(url)连接

发送消息按钮：对私发和服务器发进行分类，私发封装json格式，然后再发送。

#include "widget.h"
#include "ui_widget.h"
#include<QMessageBox>
Widget::Widget(QWidget *parent)
    : QWidget(parent)
    , ui(new Ui::Widget)
{
    ui->setupUi(this);

    websocket=nullptr;

}

Widget::~Widget()
{
    delete ui;
}


void Widget::on_sendpb_clicked()
{
    if(!websocket && !websocket->isValid())
            return;

    QString send=ui->sendtext->toPlainText().trimmed();
    if(send.isEmpty())return;


    QString cname =ui->onetextmsg->text().trimmed();
    if(cname.isEmpty()){ //发给服务器
        websocket->sendTextMessage(send);
        ui->msgtext->append("发送消息："+send);
    }else{
        //私聊发
        QJsonObject obj;
        obj["src"]=websocket->origin();
        obj["dst"]=cname;
        obj["msg"]=send;
        //将一个QJsonObject类型的obj转换成JSON字符串。 Compact参数指定格式化方式为紧凑格式(每个元素占一行)。紧凑格式输出结构清晰,容量小,适合传输和存储。
        QString str(QJsonDocument(obj).toJson(QJsonDocument::Compact));
        websocket->sendTextMessage(str);
    }
    ui->sendtext->clear();


}

void Widget::on_connect_clicked()
{

    if(websocket == nullptr){
        if(ui->server_addr->text().trimmed().isEmpty()){
            QMessageBox::critical(this,"错误","服务器名称不能为空，请重新检查!",QMessageBox::Yes);
            return;
        }
        //用于移除字符串开头和结尾处的空白字符。 输入: " test " trimmed()后的结果: "test"  VersionLatest使用最新的websocket协议版本。
        websocket=new QWebSocket(ui->client_name->text().trimmed(),QWebSocketProtocol::VersionLatest,this);

        //连接回调
        QObject::connect(websocket,&QWebSocket::connected,this,[this](){
            ui->msgtext->append("已经连接上"+websocket->peerAddress().toString());
            isConnecting=true;
            ui->connect->setText("断开服务器");
        });
        //断开回调
        QObject::connect(websocket,&QWebSocket::disconnected,this,[this](){
            ui->msgtext->append("已"+websocket->peerAddress().toString()+"断开连接");
            isConnecting=false;
            ui->connect->setText("连接服务器");
        });

        QObject::connect(websocket,QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::error)
                         ,this,[this](QAbstractSocket::SocketError){
            ui->msgtext->append(websocket->origin()+"出错"+websocket->errorString());

        });


        //接受消息回调 网上知名bug 当你连续发送 A:A*100 B:200时 接收方：A*100200 通过消息队列方式发送即可
        connect(websocket,&QWebSocket::textMessageReceived
                ,this,[this](const QString &msg){
            QJsonDocument jsd=QJsonDocument::fromJson(msg.toUtf8().data());

            if(jsd.isNull()) //解析失败 即没有 c1:c2 客户端与客户端私聊
            {
                ui->msgtext->append("收到消息:"+msg);
            }
            else
            {
                QJsonObject jsobj=jsd.object();
                ui->msgtext->append("收到来自"+jsobj["src"].toString()+"的消息:"+jsobj["msg"].toString());
            }
        },Qt::QueuedConnection);



    }

    if(isConnecting){ //连接是成功的
        websocket->close();
        websocket->deleteLater();
        websocket=nullptr;

    } else
    {
        websocket->open(QUrl(ui->server_addr->text().trimmed()));
    }
}

总结

总的来说,QWebSocket作为QT网络库中的一个组件,提供了一整套用于开发WebSocket客户端和服务端的便利API。

它的主要优点有:

  1. 完全面向对象的设计,API简单易用。

  2. 与QT网络其他组件高度集成,如SSL/代理支持都很好。

  3. 采用事件驱动模型,不需要开发者处理底层细节如多线程等。

  4. 和Qt GUI应用天然集成,消息与界面更新直接调用即可。

  5. 提供了WebSocket基础规范完整实现,开箱即用方便开发。

  6. 性能也不错,特别是QT5.10后支持了异步I/O调用方式。

  7. 丰富的示例和开源项目可供参考,入门门槛低。

而一些需要注意的点包括:

  1. 不支持一些扩展的websocket协议格式,需要自行实现。

  2. 消息发送和接收的顺序匹配需要自行控制。

  3. 文件与流式大数据传输支持不够友好直接。

  4. 无法改变底层使用的智能指针和内存管理机制。

  5. 对新的C++标准特性支持相对保守一些。

总体来说,对于大多数基于Tcp的WebSocket应用来说,QWebSocket提供了一个非常优秀而成熟的选择。开发效率高, bug少。对QT应用来说也是首选。如果有更高级别需求,可以考虑其他底层实现。但对绝大部分案例,QWebSocket已经足够好用了。

最后附上源代码链接
对您有帮助的话，帮忙点个star

Qt demo: 学习qt过程 (gitee.com)

C9程序猿
关注
  • 16
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
Qt Websocket通讯实例，自己封装了一个websocket通讯的类。
08-10
基于Qt的Websocket通讯实例。经实测可用，使用时把地址改成自己需要通讯的地址即可，能与服务端收发文本，图片，文件，需要自己制定协议。
Qt 网络编程 QWebSocketServer和QWebSocket 客户端和网络端 demo
08-14
Qt 网络编程 QWebSocketServer和QWebSocket 客户端和网络端 demo 欢迎下载，内部代码有解析，点击按钮，可以很容易了解原理和逻辑。
WebSocket与java通讯
qq_32587949的博客
10-18 396
1、编写目的         传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便。HTML5中支持WebSocket，其底层通讯协...
QWebSocket客户端
仗剑天涯
06-15 1718
Qt使用websocket需要在pro文件里面添加websockets QT += websockets 在头文件里面添加include声明 #include <QtWebSockets> .h文件实现 class Widget : public QWidget { Q_OBJECT public: explicit Widget(QW...
Qt之WebSockets
weixin_34087503的博客
09-18 947
简述 WebSocket 是一个基于 Web 的协议，旨在使 client 应用程序和远程主机之间进行双向通信。如果最初的握手成功，则两个实体可以来回发送数据。WebSocket 是通过用更少的网络延迟和最小数据交换来努力获取实时数据的应用程序解决方案。 简述 优点 工作原理 使用方式 典型用例 Qt WebSockets ...
qt websocket 通讯实现消息发送接收
路过的熊的博客
09-09 1758
qt websocket 通讯实现消息发送接收
【QT】Qt中Websocket的使用
最新发布
weixin_62370184的博客
08-07 1300
也就是说使用listen函数监听连接请求，一旦有新的客户端连接，就可以触发。
【QT教程】QT6 WebSocket QT网络编程
QT界面开发界面美化
05-18 1297
WebSocket技术背景WebSocket技术背景WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议。它允许服务端主动发送信息给客户端，是实现推送（Push）技术的一种非常流行的解决方案。在传统的HTTP通信中，客户端发起请求，服务端响应请求，这样的交互是单向的，且完全由客户端控制。
qt开发环境和依赖包，支持大多数的qt开发
06-04
QT库提供了丰富的API，支持多种编程语言，尤其是C++，同时也支持Qt Quick（QML）进行声明式编程。这个压缩包文件包含了QT开发所需的重要组件和依赖，确保开发者能够在大多数情况下顺利进行QT项目的开发。 首先，让...
Qt实现websocket通信
02-04
在Qt中实现WebSocket通信，主要涉及Qt的网络模块和QWebSocket类。首先，你需要在服务器端创建一个QWebSocketServer对象来监听特定端口，这个对象会处理连接请求和接收来自客户端的消息。以下是一个简单的创建...
Qt web socket
04-21
Qt web socket
QtWebsocket:websocket 主动消息推送 qt通信示例
05-14
QtWebsocket 服务端请安装php，打上swoole扩展使用
QT高级编程.pdf
12-03
Qt提供了丰富的网络通信类，如QNetworkAccessManager和QWebSocket，简化了HTTP请求、WebSocket连接等操作。对于数据库集成，Qt的SQL模块支持多种关系型数据库，包括MySQL、SQLite和PostgreSQL等，通过QSqlQuery和...
Qt实现WebSocket客户端和服务端通信
05-18
Qt是一个跨平台的C++开发框架，它提供了一系列丰富的库，包括对网络编程的支持。在Qt中，我们可以使用`QWebSocket`类来实现WebSocket的客户端和服务器端通信。`QWebSocket`是Qt网络模块的一部分，它为WebSocket协议...
Qt6 QML Book/网络设置/Web Sockets
aggs1990的专栏
01-31 645
Web Sockets The WebSockets module provides an implementation of the WebSockets protocol for WebSockets clients and servers. It mirrors the Qt CPP module. It allows sending a string and binary messages using a full duplex communication channel. A WebSocket
【QT开发】WebSocket通信QWebSocket类详解及实战应用
科技改变人类，技术成就未来
07-13 1670
QWebSocket是Qt提供的一个功能强大且灵活的WebSocket通信类，通过本篇文章的学习，你应该对QWebSocket有了全面的理解，能够在自己的项目中正确使用它。QWebSocket在用户界面中帮助你实现实时数据传输和消息推送，实现交互式和响应式的实时通信，有助于创建用户友好和高效的实时通信应用场景。
【QT教程】QT6 WebSocket编程
QT界面开发界面美化
04-07 2222
WebSocket概述WebSocket概述WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议。它允许服务端主动发送信息给客户端，是实现推送（Push）技术的一种非常流行的解决方案。WebSocket的特点持久的连接与传统的HTTP连接不同，WebSocket连接一旦建立，就可以持续开放，直到任意一方关闭连接。这种持久的连接大大减少了建立和关闭连接的次数，减少了延迟，提高了通信效率。服务器主动推送。
Qt websocket
weixin_30883271的博客
02-15 275
1.pro 添加 QT += websockets #ifndef MYWEBSOCKETSERVER_H #define MYWEBSOCKETSERVER_H #include <QObject> #include <QtWebSockets/QWebSocket> #include <QtWebSockets/QWebSocketSe...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值