技術共有

Qt QWebSocket ネットワーク プログラミング

2024-07-12

한어Русский язык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 接続に基づいて構築されており、サーバーとクライアントは 1 つの接続を作成するだけでよく、接続は閉じられません。

  5. JavaScript、Java、C#、Python などの複数のプログラミング言語でクライアント側およびサーバー側のライブラリをサポートします。

一般的なアプリケーション シナリオ:

  1. チャット ルーム: 低遅延のリアルタイム会話をサポートします。

  2. オンライン ゲーム: ゲーム ステータスのリアルタイム同期を必要とする同期エンジン。

  3. 株価: リアルタイムの株価をクライアントにプッシュする必要がある株価ソフトウェア。

  4. ビデオ会議: 音声とビデオの低遅延リアルタイム通信が必要です。

  5. リアルタイムの共同編集: たとえば、オンライン コード エディターにはリアルタイムの同期が必要です。

QWebSocket は、Qt が提供する WebSocket 関数ライブラリです。これは Qt ネットワーク モジュール上に構築されており、RFC6455 標準の WebSocket プロトコルを実装しています。 QT+=websockets を Qmake ファイルに追加する必要があります

  1. QWebSocket はテキスト/バイナリ メッセージ形式のみをサポートし、他の拡張形式はサポートしません。他のカスタム プロトコルを追加する必要がある場合、開発者はアプリケーション層でそれを自分で処理する必要があります。

  2. 標準の http/https ポート 80/443 を使用した WebSocket サービスへのアクセスをサポートし、wss (暗号化 WebSocket) プロトコルもサポートします。そのため、既存の Web サーバーと簡単に対話できます。

  3. QT CP ソケット実装に基づいているため、プロキシ設定、SSL 構成など、すべての Qt ネットワーク機能を完全にサポートしています。これは、一部の低レベル C インターフェイスよりも使いやすいです。

  4. アクティブ接続モードとパッシブ接続モードの両方をサポートします。アクティブな接続は connectToHost() を通じて行われ、パッシブな接続はリスニング ポート accept() を通じて受け入れられます。どちらのモードも非常に便利です。

  5. QT GUI アプリケーションの場合、メッセージの受信とインターフェイスの更新を簡単に実行できるため、マルチスレッド プログラミングの複雑さが回避されます。たとえば、textMessageReceived() でインターフェイスを直接更新するだけです。

  6. QT5.10以降は非同期I/Oがサポートされ、以前と比べて若干パフォーマンスが向上しています。ネットワーク拡張のサポートも強化されています。

QWebSocketの共通メンバー関数

  1.  
  2. origin()
  3. 即 websocket=new QWebSocket("C1我是客户端",QWebSocketProtocol::VersionLatest,this);
  4. websocket->origin()  -》 C1我是客户端
  5.  
  6. void connectToHost(const QUrl &url) - 用于连接到指定主机的websocket服务,这个函数是异步的。
  7. void close() - 关闭与服务器的连接。
  8. void textMessageReceived(const QString &message) - 收到文本消息时触发的信号,其参数就是收到的文本消息内容。
  9. void binaryMessageReceived(const QByteArray &message) - 收到二进制消息时触发的信号,参数是原始二进制数据。
  10. void error(QAbstractSocket::SocketError socketError) - 发生错误时触发的信号,参数是错误类型。
  11. void stateChanged(QAbstractSocket::SocketState state) - 连接状态变化时触发,可以得知连接是否建立等。
  12. void textMessageSent(qint64 numBytes) - 发送文本消息完成后触发,numBytes是字节数。
  13. void bytesWritten(qint64 bytes) - 消息发送过程中的写入回调, bytes是一个部分发送出去的字节数。
  14. void abort() - 主动断开连接。
  15. bool waitForConnected(int msec = 30000) - 阻塞等待连接建立成功。
  17. QString hostName() - 获取当前连接的主机名,常用于判断连接是否成功。
  18. quint16 port() - 获取主机端口号。
  19. bool openMode() - 判断当前是否为主动连接还是被动接受模式。
  20. void writeTextMessage(const QString &text) - 发送文本消息,相比textMessage等更直观。
  21. void writeMessage(const QByteArray &data) - 发送二进制数据。
  22. qint64 bytesAvailable() - 查看接收缓存中可读取字节数。
  23. qint64 readBufferSize() - 设置双向数据接收缓存大小。
  24. void pauseIncomingPayload() - 暂停接收消息流。
  25. void resumeIncomingPayload() - 恢复接收。
  26. bool isValid() - 检查连接是否有效。
  28. 另外,作为QT套接字,它还支持一些通用功能:
  29. void setProxy() - 设置代理。
  30. void encrypt() - 设置SSL安全连接。
  31. void flush() - 强制输出缓存写出。
  32. bool waitForBytesWritten() - 等待数据发送完毕。
  34.  
  35. void QWebSocket::sendTextMessage(const QString &message)  用于发送文本消息
  36. 使用这个函数发送文本消息主要有以下几点需要注意的地方:
  37. 1发送文本消息前请确保WebSocket连接已经建立。可以通过ReadyState判断连接状态。
  38. 2发送的消息内容必须是纯文本,不支持转义编码等更多格式。
  39. 3一条消息发送完毕后,会触发textMessageSent()信号通知。
  40. 4可以通过waitForBytesWritten()等待数据完全发送出去。
  41. 5发送数据顺序可能与收到响应顺序不一致,需要应用层自己处理序号等。
  42. 6若消息较大,建议使用write或send到套接字后flush,而不是sendTextMessage。
  43. 7跨平台考虑,消息内容编码最好使用QString而不是QByteArray。
  44. 8使用该函数发送的文本消息类型,服务端一般对应文本框接受。
  45. 9可以绑定消息发送断开连接的异常处理等。

sendTextMessage 関数と writeTextMessage 関数はどちらもテキスト メッセージの送信に使用できますが、いくつかの違いがあります。

  1. 関数の定義が異なります。

  • sendTextMessage は QWebSocket のメンバー関数に属します。

  • writeTextMessage は QAbstractSocket のメンバー関数であり、QWebSocket は QAbstractSocket を継承します。

  1. 送信効率が異なります:

  • 内部的には、sendTextMessage はまずメッセージを QByteArray に変換し、次に write 関数を通じて送信します。これはもう 1 回の変換です。

  • writeTextMessage は、送信する必要がある QString を直接書き込みます。これは若干効率的です。

  1. 非同期サポートは異なります。

  • sendTextMessage は同期操作であり、送信が完了すると戻ります。

  • writeTextMessage は非同期呼び出しをサポートしており、コールバック関数は Lambda を通じて指定できます。

  1. エラー処理は異なります。

  • sendTextMessage はエラー情報を返さず、信号エラーを通じてのみ処理できます。

  • writeTextMessage は返されたエラー コードを取得して、送信状況を判断できます。

  1. さまざまな使用シナリオ:

  • sendTextMessage は WebSocket に焦点を当てており、WebSocket API の呼び出しに適しています。

  • writeTextMessage はより一般的で、他の QAbstractSocket サブクラスと一緒に使用できます。

一般的に：

  • sendTextMessage は使用が簡単で、適切にカプセル化されており、基本的な使用に適しています。

  • writeTextMessage は若干効率が高く、非同期やエラー処理などのより多くの機能をサポートしており、高いパフォーマンスや制御要件が必要なシナリオに適しています。

プロジェクトを実現する

クライアントとクライアント間のプライベート通信、クライアントとサーバー間の通信。

コアコード

サーバ

プロセス: QWebServer を作成し、新しい接続コールバックをバインドし、切断をリッスンします。

新しい接続コールバック: 新しい接続がコレクションに追加されると、オフライン コールバック、受信コールバック、およびエラー コールバックが新しい接続ソケットにバインドされます。

メッセージ送信ボタン: すべてと 1 つを分類し、セットのコレクションを走査し、sendTextMesg を使用して送信します。

  1. #include "widget.h"
  2. #include "ui_widget.h"
  3. //这个是服务器端
  4. Widget::Widget(QWidget *parent)
  5.     : QWidget(parent)
  6.     , ui(new Ui::Widget)
  7. {
  8.     ui->setupUi(this);
  9.     /*
  10.      * mode
  11. NonSecureMode: 不安全模式,即不使用SSL/TLS进行通信。这是默认值。
  12. SecureMode: 安全模式,以SSL/TLS安全通信。客户端和服务端之间的连接将使用SSL握手建立安全通道。
  13. AutomaticallyAcceptServerCertificates: 自动接受服务器证书。在SecureMode下,客户端无法验证证书时,自动接受服务器发来的证书以建立连接。
  14. VerifyNone: 不验证证书。以SecureMode运行,但不会验证客户端和服务端使用的证书。
  15. */
  16.     webServer = new QWebSocketServer("testWebServer",QWebSocketServer::NonSecureMode,this);
  17.     QObject::connect(webServer,&QWebSocketServer::newConnection,this,&Widget::MyselfNewConnectCallBackSlot);
  18.  
  19.     webServer->listen(QHostAddress::Any,8888);
  20. }
  21. void Widget::MyselfNewConnectCallBackSlot(){//新连接回调
  22.  
  23.     if(webServer->hasPendingConnections()){
  24.         QWebSocket* websocket=webServer->nextPendingConnection();
  25.         ui->msgtext->append(websocket->origin()+"客户端已连接到服务器");
  26.         sockets<<websocket;
  27.  
  28.         QListWidgetItem * item =new QListWidgetItem;
  29.         item->setText(websocket->origin());
  30.         ui->clinetls->addItem(item);
  31.  
  32.  
  33.         //绑定离开
  34.         QObject::connect(websocket,&QWebSocket::disconnected,this,[websocket,this](){
  35.             ui->msgtext->append(websocket->origin()+"客户端断开服务器连接");
  36.             sockets.removeOne(websocket);
  37.             for(int i=0;i<ui->clinetls->count();i++)
  38.             {
  39.                 QListWidgetItem *item=ui->clinetls->item(i);
  40.  
  41.                 if(item->text()==websocket->origin())
  42.                 {
  43.                     ui->clinetls->removeItemWidget(item);
  44.                     delete item;
  45.                     break;
  46.                 }
  47.             }
  48.  
  49.             websocket->deleteLater();
  50.  
  51.         });
  52.  
  53.  
  54.         //接受消息回调
  55.         QObject::connect(websocket,&QWebSocket::textMessageReceived,this,[this](const QString &msg){
  56.             QJsonDocument doc =QJsonDocument::fromJson(msg.toLatin1().data());
  57.             if(doc.isNull()){
  58.                 QWebSocket* websocket =qobject_cast<QWebSocket*>(sender());//sender 触发信号的源头
  59.                 ui->msgtext->append("收到客户端消息["+websocket->origin()+"]--->"+msg);
  60.  
  61.             }else{
  62.                 //客户端之间的单发消息
  63.                 QJsonObject obj=doc.object();
  64.                 QString dst=doc["dst"].toString();
  65.                 for (auto& socket : sockets) {
  66.                     if(dst == socket->origin()){
  67.                         socket->sendTextMessage(msg);
  68.                     }
  69.                 }
  70.             }
  71.         });
  72.  
  73.  
  74.         QObject::connect(websocket,QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::error),
  75.                          this,[this](QAbstractSocket::SocketError error){
  76.             QWebSocket* web =qobject_cast<QWebSocket*>(sender());
  77.             ui->msgtext->append(web->origin()+"出错"+web->errorString());
  78.         });
  79.     }
  80.  
  81.  
  82.  
  83. }
  84. Widget::~Widget()
  85. {
  86.     delete ui;
  87.     for(auto socket:sockets)
  88.     {
  89.         socket->close();
  90.     }
  91.  
  92.     webServer->close();
  93. }
  94.  
  95.  
  96. void Widget::on_sendpb_clicked()
  97. {
  98.     QString send =ui->sendtext->toPlainText().trimmed();
  99.     if(send.isEmpty())return;
  100.     if(ui->allradio->isChecked()){
  101.         //群发
  102.         if(sockets.size()==0)return;
  103.         foreach(auto &socket,sockets){
  104.             socket->sendTextMessage(send);
  105.         }
  106.         ui->msgtext->append("服务器给所有连接发送："+send);
  107.     }else{ //私发  取客户端名称 找 发
  108.         if(!ui->clinetls->currentItem())return;
  109.         QString cname =ui->clinetls->currentItem()->text();
  110.  
  111.         for(auto &socket:sockets)
  112.         {
  113.             if(socket->origin()==cname)
  114.             {
  115.                 socket->sendTextMessage(send);
  116.                 ui->msgtext->append("服务端给["+socket->origin()+"]发送--->"+send);
  117.  
  118.                 break;
  119.             }
  120.         }
  121.     }
  122.  
  123.  
  124.     ui->sendtext->clear();
  125. }

クライアント

ボタンをクリックして WebSocket 接続プロセスを実装します。WebSocket を作成し、さまざまなコールバックをバインドし、open(url) を介して接続します。

メッセージ送信ボタン：プライベートメッセージとサーバーメッセージを分類し、プライベートメッセージをjson形式でカプセル化して送信します。

  1. #include "widget.h"
  2. #include "ui_widget.h"
  3. #include<QMessageBox>
  4. Widget::Widget(QWidget *parent)
  5.     : QWidget(parent)
  6.     , ui(new Ui::Widget)
  7. {
  8.     ui->setupUi(this);
  9.  
  10.     websocket=nullptr;
  11.  
  12. }
  13.  
  14. Widget::~Widget()
  15. {
  16.     delete ui;
  17. }
  18.  
  19.  
  20. void Widget::on_sendpb_clicked()
  21. {
  22.     if(!websocket && !websocket->isValid())
  23.             return;
  24.  
  25.     QString send=ui->sendtext->toPlainText().trimmed();
  26.     if(send.isEmpty())return;
  27.  
  28.  
  29.     QString cname =ui->onetextmsg->text().trimmed();
  30.     if(cname.isEmpty()){ //发给服务器
  31.         websocket->sendTextMessage(send);
  32.         ui->msgtext->append("发送消息："+send);
  33.     }else{
  34.         //私聊发
  35.         QJsonObject obj;
  36.         obj["src"]=websocket->origin();
  37.         obj["dst"]=cname;
  38.         obj["msg"]=send;
  39.         //将一个QJsonObject类型的obj转换成JSON字符串。 Compact参数指定格式化方式为紧凑格式(每个元素占一行)。紧凑格式输出结构清晰,容量小,适合传输和存储。
  40.         QString str(QJsonDocument(obj).toJson(QJsonDocument::Compact));
  41.         websocket->sendTextMessage(str);
  42.     }
  43.     ui->sendtext->clear();
  44.  
  45.  
  46. }
  47.  
  48. void Widget::on_connect_clicked()
  49. {
  50.  
  51.     if(websocket == nullptr){
  52.         if(ui->server_addr->text().trimmed().isEmpty()){
  53.             QMessageBox::critical(this,"错误","服务器名称不能为空，请重新检查!",QMessageBox::Yes);
  54.             return;
  55.         }
  56.         //用于移除字符串开头和结尾处的空白字符。 输入: " test " trimmed()后的结果: "test"  VersionLatest使用最新的websocket协议版本。
  57.         websocket=new QWebSocket(ui->client_name->text().trimmed(),QWebSocketProtocol::VersionLatest,this);
  58.  
  59.         //连接回调
  60.         QObject::connect(websocket,&QWebSocket::connected,this,[this](){
  61.             ui->msgtext->append("已经连接上"+websocket->peerAddress().toString());
  62.             isConnecting=true;
  63.             ui->connect->setText("断开服务器");
  64.         });
  65.         //断开回调
  66.         QObject::connect(websocket,&QWebSocket::disconnected,this,[this](){
  67.             ui->msgtext->append("已"+websocket->peerAddress().toString()+"断开连接");
  68.             isConnecting=false;
  69.             ui->connect->setText("连接服务器");
  70.         });
  71.  
  72.         QObject::connect(websocket,QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::error)
  73.                          ,this,[this](QAbstractSocket::SocketError){
  74.             ui->msgtext->append(websocket->origin()+"出错"+websocket->errorString());
  75.  
  76.         });
  77.  
  78.  
  79.         //接受消息回调 网上知名bug 当你连续发送 A:A*100 B:200时 接收方：A*100200 通过消息队列方式发送即可
  80.         connect(websocket,&QWebSocket::textMessageReceived
  81.                 ,this,[this](const QString &msg){
  82.             QJsonDocument jsd=QJsonDocument::fromJson(msg.toUtf8().data());
  83.  
  84.             if(jsd.isNull()) //解析失败 即没有 c1:c2 客户端与客户端私聊
  85.             {
  86.                 ui->msgtext->append("收到消息:"+msg);
  87.             }
  88.             else
  89.             {
  90.                 QJsonObject jsobj=jsd.object();
  91.                 ui->msgtext->append("收到来自"+jsobj["src"].toString()+"的消息:"+jsobj["msg"].toString());
  92.             }
  93.         },Qt::QueuedConnection);
  94.  
  95.  
  96.  
  97.     }
  98.  
  99.     if(isConnecting){ //连接是成功的
  100.         websocket->close();
  101.         websocket->deleteLater();
  102.         websocket=nullptr;
  103.  
  104.     } else
  105.     {
  106.         websocket->open(QUrl(ui->server_addr->text().trimmed()));
  107.     }
  108. }

要約する

一般に、QWebSocket は、QT ネットワーク ライブラリのコンポーネントとして、WebSocket クライアントおよびサーバーを開発するための便利な API セットを提供します。

その主な利点は次のとおりです。

  1. 完全なオブジェクト指向設計で、API はシンプルで使いやすいです。

  2. SSL/プロキシのサポートなど、他の QT ネットワーク コンポーネントと高度に統合されています。

  3. イベント駆動型モデルを使用すると、開発者はマルチスレッドなどの基礎となる詳細に対処する必要がありません。

  4. Qt GUI アプリケーションと自然に統合されており、メッセージやインターフェイスの更新を直接呼び出すことができます。

  5. WebSocket の基本仕様の完全な実装を提供します。これは、開発を容易にするためにすぐに使用できます。

  6. 特に QT5.10 が非同期 I/O 呼び出しをサポートしているため、パフォーマンスも良好です。

  7. 豊富なサンプルとオープンソース プロジェクトが参照可能であり、参入障壁は低いです。

注意すべき点は次のとおりです。

  1. 一部の拡張 WebSocket プロトコル形式はサポートされていないため、自分で実装する必要があります。

  2. メッセージ送受信の順序合わせは自分で制御する必要があります。

  3. ファイルおよびストリーミングのビッグ データ転送のサポートは、十分にフレンドリーで簡単ではありません。

  4. 使用される基礎となるスマート ポインターとメモリ管理メカニズムは変更できません。

  5. 新しい C++ 標準機能のサポートは比較的保守的です。

全体として、QWebSocket は、ほとんどの Tcp ベースの WebSocket アプリケーションにとって非常に優れた成熟した選択肢を提供します。開発効率が高く、バグが少ない。 QT アプリケーションにも推奨されます。より高いレベルの要件がある場合は、他の基礎となる実装を検討できます。ただし、ほとんどの場合、QWebSocket で十分です。

最後にソースコードのリンクを添付します
お役に立てましたら、星をお願いします

Qt デモ: Qt プロセスの学習 (gitee.com)

個人プロフィール

彼は 30 年以上テクノロジーの研究に専念しており、java、linux、javascript、php、css などのさまざまな言語に堪能であり、オープンソース分野で多くの貢献を行っています。将来の参考のために技術開発におけるいくつかの問題を共有する開発者ドキュメント ステーション。

私の連絡先情報

郵便