Обмен технологиями

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

Цели обучения: сетевое программирование Qt QWebSocket.

Предварительная среда обучения

Многопоточная сетевая связь QT TCP — блог CSDN

Учебный контент

WebSocket — это сетевая технология, обеспечивающая полнодуплексный канал связи через одно TCP-соединение. В 2011 году IETF стандартизировал протокол WebSocket как RFC6455, и QWebSocket можно использовать как в клиентских, так и в серверных приложениях.

Он реализует полнодуплексную связь между браузером и сервером, позволяя серверу заранее отправлять информацию клиенту.

Главная особенность:

1. В отличие от HTTP, WebSocket позволяет серверу активно отправлять данные клиенту, не требуя от клиента инициирования запроса.

2. Построенный на протоколе TCP, полнодуплексная связь между сервером и клиентом осуществляется по одному порту через протокол Ws (WebSocket).

3. Поддерживает передачу данных в текстовом или двоичном формате.

4. Протокол построен на одном TCP-соединении. Серверу и клиенту необходимо создать только одно соединение, и оно не будет закрыто.

5. Поддерживает клиентские и серверные библиотеки на нескольких языках программирования, таких как JavaScript, Java, C#, Python и т. д.

Распространенные сценарии применения:

1. Чат: поддерживает разговоры в реальном времени с малой задержкой.

2. Онлайн-игра: механизм синхронизации, требующий синхронизации статуса игры в реальном времени.

3. Котировки акций: программное обеспечение для котировок, которое должно передавать клиенту котировки в реальном времени.

4. Видеоконференции: требуется голосовая и видеосвязь с малой задержкой в ​​реальном времени.

5. Совместное редактирование в реальном времени. Например, онлайн-редактор кода требует синхронизации в реальном времени.

QWebSocket — это библиотека функций WebSocket, предоставляемая Qt. Он построен на сетевом модуле Qt и реализует протокол WebSocket стандарта RFC6455. Вам нужно добавить QT+=websockets в файл Qmake.

1. QWebSocket поддерживает только текстовые/двоичные форматы сообщений и не поддерживает другие расширенные форматы. Если необходимо добавить другие пользовательские протоколы, разработчикам придется сделать это самостоятельно на уровне приложения.

2. Он поддерживает доступ к службам веб-сокетов с использованием стандартных портов http/https 80/443, а также поддерживает протокол wss (зашифрованный веб-сокет). Поэтому он может легко взаимодействовать с существующими веб-серверами.

3. Поскольку он основан на реализации сокета QT CP, он полностью поддерживает все сетевые функции Qt, такие как настройки прокси, конфигурация SSL и т. д. Его проще использовать, чем некоторые низкоуровневые интерфейсы C.

4. Он поддерживает как активный, так и пассивный режимы подключения. Активные соединения осуществляются через метод ConnectToHost(), а пассивные соединения принимаются через порт прослушивания Accept(). Оба режима очень удобны.

5. Для приложений QT GUI можно легко выполнять прием сообщений и обновления интерфейса, избегая сложности многопоточного программирования. Например, просто обновите интерфейс непосредственно в textMessageReceived().

6. После QT5.10 поддерживается асинхронный ввод-вывод, а производительность немного улучшена по сравнению с предыдущей версией. Поддержка сетевых расширений также стала лучше.

Общие функции-члены 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, а затем отправляет его через функцию записи, что является еще одним преобразованием;

• writeTextMessage напрямую записывает QString, которую необходимо отправить, что немного более эффективно.

1. Поддержка асинхронности отличается:

• sendTextMessage является синхронной операцией и возвращается после завершения отправки;

• writeTextMessage поддерживает асинхронные вызовы, а функцию обратного вызова можно указать через Lambda.

1. Обработка ошибок отличается:

• sendTextMessage не будет возвращать информацию об ошибке и может обрабатываться только через ошибки сигнала;

• writeTextMessage может получить возвращенный код ошибки, чтобы определить ситуацию отправки.

1. Различные сценарии использования:

• sendTextMessage ориентирован на WebSocket и подходит для вызова API WebSocket;

• writeTextMessage является более общим и может использоваться с другими подклассами QAbstractSocket.

В общем:

• sendTextMessage проще в использовании, хорошо инкапсулирован и подходит для базового использования;

• writeTextMessage немного более эффективен, поддерживает больше функций, таких как асинхронная обработка и обработка ошибок, и подходит для сценариев с высокими требованиями к производительности или управлению.

Реализовать проект

Частное общение между клиентом и клиентом, общение между клиентом и сервером.

основной код

Сервер

Процесс: Создайте QWebServer, привяжите обратный вызов нового соединения и прослушайте разрыв соединения.

Обратный вызов нового соединения. Когда в коллекцию добавляется новое соединение, обратные вызовы в автономном режиме, а также обратные вызовы приема и ошибки привязываются к новому сокету соединения.

Кнопка «Отправить сообщение»: классифицировать все и одно, просмотреть коллекцию наборов и отправить с помощью 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();
}

клиент

Нажмите кнопку, чтобы реализовать процесс подключения веб-сокета: создайте веб-сокет, привяжите различные обратные вызовы и подключитесь через 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, предоставляет набор удобных API для разработки клиентов и серверов WebSocket.

Его основные преимущества:

1. Полностью объектно-ориентированный дизайн, API прост и удобен в использовании.

2. Высокая степень интеграции с другими сетевыми компонентами QT, такими как поддержка SSL/прокси.

3. Используя модель, управляемую событиями, разработчикам не нужно иметь дело с базовыми деталями, такими как многопоточность.

4. Естественно, интегрированные с приложениями Qt GUI, сообщения и обновления интерфейса можно вызывать напрямую.

5. Обеспечивает полную реализацию основных спецификаций WebSocket, которые можно использовать «из коробки» для облегчения разработки.

6. Производительность также хороша, особенно потому, что QT5.10 поддерживает асинхронный вызов ввода-вывода.

7. Для справки доступны богатые примеры и проекты с открытым исходным кодом, а входной барьер низок.

Некоторые моменты, на которые следует обратить внимание, включают в себя:

1. Некоторые расширенные форматы протоколов веб-сокетов не поддерживаются, и их необходимо реализовать самостоятельно.

2. Соответствие порядка отправки и получения сообщений необходимо контролировать самостоятельно.

3. Поддержка файловой и потоковой передачи больших данных недостаточно дружественна и проста.

4. Используемые базовые интеллектуальные указатели и механизмы управления памятью не могут быть изменены.

5. Поддержка новых стандартных функций C++ является относительно консервативной.

В целом, QWebSocket представляет собой очень хороший и продуманный выбор для большинства приложений WebSocket на основе TCP. Высокая эффективность разработки и мало ошибок. Также предпочтителен для приложений QT. Если есть требования более высокого уровня, можно рассмотреть другие базовые реализации. Но для большинства случаев QWebSocket достаточно хорош.

Наконец, прикрепите ссылку на исходный код
Если это было полезно для вас, пожалуйста, поставьте мне звезду

Демонстрация Qt: изучение процесса qt (gitee.com)