Technologieaustausch

Qt QWebSocket-Netzwerkprogrammierung

2024-07-12

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

Lernziele: Qt QWebSocket Netzwerkprogrammierung

Lernende Vorumgebung

QT TCP Multithread-Netzwerkkommunikation – CSDN-Blog

Lerninhalte

WebSocket ist eine Netzwerktechnologie, die einen Vollduplex-Kommunikationskanal über eine einzige TCP-Verbindung bereitstellt. Im Jahr 2011 standardisierte die IETF das WebSocket-Protokoll als RFC6455, und QWebSocket kann sowohl in Clientanwendungen als auch in Serveranwendungen verwendet werden.

Es implementiert eine Vollduplex-Kommunikation zwischen dem Browser und dem Server, sodass der Server proaktiv Informationen an den Client senden kann.

Hauptmerkmal:

  1. Im Gegensatz zu HTTP ermöglicht WebSocket dem Server, aktiv Daten an den Client zu senden, ohne dass der Client eine Anfrage initiieren muss.

  2. Aufbauend auf dem TCP-Protokoll wird die Vollduplex-Kommunikation zwischen dem Server und dem Client über einen einzigen Port über das Ws-Protokoll (WebSocket) durchgeführt.

  3. Unterstützt die Datenübertragung im Text- oder Binärformat.

  4. Das Protokoll basiert auf einer einzigen TCP-Verbindung. Der Server und der Client müssen nur eine Verbindung herstellen, und die Verbindung wird nicht geschlossen.

  5. Unterstützt clientseitige und serverseitige Bibliotheken in mehreren Programmiersprachen wie JavaScript, Java, C#, Python usw.

Häufige Anwendungsszenarien:

  1. Chatroom: Unterstützt Echtzeitgespräche mit geringer Latenz.

  2. Online-Spiel: eine Synchronisierungs-Engine, die eine Echtzeit-Synchronisierung des Spielstatus erfordert.

  3. Aktienkurse: Angebotssoftware, die dem Kunden Kurse in Echtzeit übermitteln muss.

  4. Videokonferenzen: Echtzeitkommunikation von Sprache und Video mit geringer Latenz ist erforderlich.

  5. Kollaborative Bearbeitung in Echtzeit: Beispielsweise erfordert der Online-Code-Editor eine Synchronisierung in Echtzeit.

QWebSocket ist die von Qt bereitgestellte WebSocket-Funktionsbibliothek. Es basiert auf dem Qt-Netzwerkmodul und implementiert das WebSocket-Protokoll im RFC6455-Standard. Sie müssen QT+=websockets zur Qmake-Datei hinzufügen

  1. QWebSocket unterstützt nur Text-/Binärnachrichtenformate und keine anderen erweiterten Formate. Wenn andere benutzerdefinierte Protokolle hinzugefügt werden müssen, müssen Entwickler dies selbst auf der Anwendungsebene erledigen.

  2. Es unterstützt den Zugriff auf WebSocket-Dienste über die Standard-http/https-Ports 80/443 und unterstützt außerdem das WSS-Protokoll (Encrypted WebSocket). So kann es problemlos mit vorhandenen Webservern interagieren.

  3. Da es auf der QT-CP-Socket-Implementierung basiert, unterstützt es vollständig alle Qt-Netzwerkfunktionen, wie Proxy-Einstellungen, SSL-Konfiguration usw. Dies ist einfacher zu verwenden als einige Low-Level-C-Schnittstellen.

  4. Es unterstützt sowohl aktive als auch passive Verbindungsmodi. Aktive Verbindungen erfolgen über connectToHost() und passive Verbindungen werden über den Listening-Port Accept() akzeptiert. Beide Modi sind sehr praktisch.

  5. Für QT-GUI-Anwendungen können der Nachrichtenempfang und Schnittstellenaktualisierungen einfach durchgeführt werden, wodurch die Komplexität der Multithread-Programmierung vermieden wird. Aktualisieren Sie beispielsweise einfach die Schnittstelle direkt in textMessageReceived().

  6. Nach QT5.10 wird asynchrone E/A unterstützt und die Leistung ist im Vergleich zu zuvor leicht verbessert. Auch die Unterstützung für Netzwerkerweiterungen ist besser.

Allgemeine QWebSocket-Mitgliedsfunktionen

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

Sowohl die Funktionen sendTextMessage als auch writeTextMessage können zum Senden von Textnachrichten verwendet werden, es gibt jedoch einige Unterschiede:

  1. Die Funktionsdefinition ist unterschiedlich:
  • sendTextMessage gehört zur Mitgliedsfunktion von QWebSocket;

  • writeTextMessage ist eine Mitgliedsfunktion von QAbstractSocket und QWebSocket erbt von QAbstractSocket.

  1. Die Sendeeffizienz ist anders:
  • Intern konvertiert sendTextMessage die Nachricht zunächst in QByteArray und sendet sie dann über die Schreibfunktion, was eine weitere Konvertierung darstellt.

  • writeTextMessage schreibt den zu sendenden QString direkt, was etwas effizienter ist.

  1. Die Async-Unterstützung ist anders:
  • sendTextMessage ist eine synchrone Operation und wird nach Abschluss des Sendens zurückgegeben.

  • writeTextMessage unterstützt asynchrone Aufrufe und die Rückruffunktion kann über Lambda angegeben werden.

  1. Die Fehlerbehandlung ist unterschiedlich:
  • sendTextMessage gibt keine Fehlerinformationen zurück und kann nur durch Signalfehler behandelt werden;

  • writeTextMessage kann den zurückgegebenen Fehlercode abrufen, um die Sendesituation zu bestimmen.

  1. Verschiedene Nutzungsszenarien:
  • sendTextMessage konzentriert sich auf WebSocket und eignet sich zum Aufrufen der WebSocket-API.

  • writeTextMessage ist allgemeiner und kann mit anderen QAbstractSocket-Unterklassen verwendet werden.

Allgemein:

  • sendTextMessage ist einfacher zu verwenden, gut gekapselt und für den einfachen Gebrauch geeignet;

  • writeTextMessage ist etwas effizienter, unterstützt mehr Funktionen wie Asynchronität und Fehlerbehandlung und eignet sich für Szenarien mit hohen Leistungs- oder Kontrollanforderungen.

Realisieren Sie das Projekt

Private Kommunikation zwischen Client und Client, Kommunikation zwischen Client und Server.

Kerncode

Server

Prozess: QWebServer erstellen, neuen Verbindungsrückruf binden und auf Trennung warten.

Rückruf für neue Verbindung: Wenn der Sammlung eine neue Verbindung hinzugefügt wird, werden Offline- sowie Empfangs- und Fehlerrückrufe an den neuen Verbindungssocket gebunden.

Schaltfläche „Nachricht senden“: Alle und eins klassifizieren, die festgelegte Sammlung durchlaufen und mit sendTextMesg senden

  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. webServer->listen(QHostAddress::Any,8888);
  19. }
  20. void Widget::MyselfNewConnectCallBackSlot(){//新连接回调
  21. if(webServer->hasPendingConnections()){
  22. QWebSocket* websocket=webServer->nextPendingConnection();
  23. ui->msgtext->append(websocket->origin()+"客户端已连接到服务器");
  24. sockets<<websocket;
  25. QListWidgetItem * item =new QListWidgetItem;
  26. item->setText(websocket->origin());
  27. ui->clinetls->addItem(item);
  28. //绑定离开
  29. QObject::connect(websocket,&QWebSocket::disconnected,this,[websocket,this](){
  30. ui->msgtext->append(websocket->origin()+"客户端断开服务器连接");
  31. sockets.removeOne(websocket);
  32. for(int i=0;i<ui->clinetls->count();i++)
  33. {
  34. QListWidgetItem *item=ui->clinetls->item(i);
  35. if(item->text()==websocket->origin())
  36. {
  37. ui->clinetls->removeItemWidget(item);
  38. delete item;
  39. break;
  40. }
  41. }
  42. websocket->deleteLater();
  43. });
  44. //接受消息回调
  45. QObject::connect(websocket,&QWebSocket::textMessageReceived,this,[this](const QString &msg){
  46. QJsonDocument doc =QJsonDocument::fromJson(msg.toLatin1().data());
  47. if(doc.isNull()){
  48. QWebSocket* websocket =qobject_cast<QWebSocket*>(sender());//sender 触发信号的源头
  49. ui->msgtext->append("收到客户端消息["+websocket->origin()+"]--->"+msg);
  50. }else{
  51. //客户端之间的单发消息
  52. QJsonObject obj=doc.object();
  53. QString dst=doc["dst"].toString();
  54. for (auto& socket : sockets) {
  55. if(dst == socket->origin()){
  56. socket->sendTextMessage(msg);
  57. }
  58. }
  59. }
  60. });
  61. QObject::connect(websocket,QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::error),
  62. this,[this](QAbstractSocket::SocketError error){
  63. QWebSocket* web =qobject_cast<QWebSocket*>(sender());
  64. ui->msgtext->append(web->origin()+"出错"+web->errorString());
  65. });
  66. }
  67. }
  68. Widget::~Widget()
  69. {
  70. delete ui;
  71. for(auto socket:sockets)
  72. {
  73. socket->close();
  74. }
  75. webServer->close();
  76. }
  77. void Widget::on_sendpb_clicked()
  78. {
  79. QString send =ui->sendtext->toPlainText().trimmed();
  80. if(send.isEmpty())return;
  81. if(ui->allradio->isChecked()){
  82. //群发
  83. if(sockets.size()==0)return;
  84. foreach(auto &socket,sockets){
  85. socket->sendTextMessage(send);
  86. }
  87. ui->msgtext->append("服务器给所有连接发送:"+send);
  88. }else{ //私发 取客户端名称 找 发
  89. if(!ui->clinetls->currentItem())return;
  90. QString cname =ui->clinetls->currentItem()->text();
  91. for(auto &socket:sockets)
  92. {
  93. if(socket->origin()==cname)
  94. {
  95. socket->sendTextMessage(send);
  96. ui->msgtext->append("服务端给["+socket->origin()+"]发送--->"+send);
  97. break;
  98. }
  99. }
  100. }
  101. ui->sendtext->clear();
  102. }

Klient

Klicken Sie auf die Schaltfläche, um den WebSocket-Verbindungsprozess zu implementieren: WebSocket erstellen, verschiedene Rückrufe binden und über open(URL) eine Verbindung herstellen.

Schaltfläche „Nachricht senden“: Private Nachrichten und Servernachrichten klassifizieren, private Nachrichten im JSON-Format kapseln und dann senden.

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

Zusammenfassen

Im Allgemeinen stellt QWebSocket als Komponente der QT-Netzwerkbibliothek eine Reihe praktischer APIs für die Entwicklung von WebSocket-Clients und -Servern bereit.

Seine Hauptvorteile sind:

  1. Vollständig objektorientiertes Design, API ist einfach und benutzerfreundlich.

  2. Hochgradig integriert mit anderen QT-Netzwerkkomponenten, wie z. B. SSL/Proxy-Unterstützung.

  3. Mithilfe eines ereignisgesteuerten Modells müssen sich Entwickler nicht mit zugrunde liegenden Details wie Multithreading befassen.

  4. Natürlich in Qt-GUI-Anwendungen integriert, können Nachrichten und Schnittstellenaktualisierungen direkt aufgerufen werden.

  5. Bietet eine vollständige Implementierung der WebSocket-Basisspezifikationen, die sofort verwendet werden können, um die Entwicklung zu erleichtern.

  6. Auch die Performance ist gut, insbesondere da QT5.10 asynchrone I/O-Aufrufe unterstützt.

  7. Umfangreiche Beispiele und Open-Source-Projekte stehen als Referenz zur Verfügung und die Eintrittsbarriere ist niedrig.

Zu den zu beachtenden Punkten gehören:

  1. Einige erweiterte Websocket-Protokollformate werden nicht unterstützt und müssen selbst implementiert werden.

  2. Die Reihenfolge des Sendens und Empfangens von Nachrichten muss von Ihnen selbst gesteuert werden.

  3. Die Unterstützung der Datei- und Streaming-Big-Data-Übertragung ist nicht freundlich und unkompliziert genug.

  4. Die zugrunde liegenden intelligenten Zeiger und verwendeten Speicherverwaltungsmechanismen können nicht geändert werden.

  5. Die Unterstützung für neue C++-Standardfunktionen ist relativ konservativ.

Insgesamt bietet QWebSocket eine sehr gute und ausgereifte Wahl für die meisten Tcp-basierten WebSocket-Anwendungen. Hohe Entwicklungseffizienz und wenige Fehler. Auch für QT-Anwendungen bevorzugt. Bei übergeordneten Anforderungen können andere zugrunde liegende Implementierungen in Betracht gezogen werden. Aber für die meisten Fälle ist QWebSocket gut genug.

Hängen Sie abschließend den Quellcode-Link an
Wenn es für Sie hilfreich ist, geben Sie mir bitte einen Stern

Qt-Demo: QT-Prozess lernen (gitee.com)