기술나눔

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 연결을 기반으로 구축되었습니다. 서버와 클라이언트는 하나의 연결만 생성하면 되며 연결이 닫히지 않습니다.

  5. JavaScript, Java, C#, Python 등과 같은 여러 프로그래밍 언어로 클라이언트 측 및 서버 측 라이브러리를 지원합니다.

일반적인 애플리케이션 시나리오:

  1. 채팅방: 지연 시간이 짧은 실시간 대화를 지원합니다.

  2. 온라인 게임: 게임 상태의 실시간 동기화가 필요한 동기화 엔진입니다.

  3. 주식 시세: 실시간 시세를 클라이언트에 푸시해야 하는 시세 소프트웨어입니다.

  4. 화상 회의: 지연 시간이 짧은 음성 및 영상의 실시간 통신이 필요합니다.

  5. 실시간 공동 편집: 예를 들어 온라인 코드 편집기에는 실시간 동기화가 필요합니다.

QWebSocket은 Qt에서 제공하는 WebSocket 함수 라이브러리입니다. 이는 Qt 네트워크 모듈을 기반으로 구축되었으며 RFC6455 표준에서 WebSocket 프로토콜을 구현합니다. Qmake 파일에 QT+=websockets를 추가해야 합니다.

  1. QWebSocket은 텍스트/이진 메시지 형식만 지원하며 다른 확장 형식은 지원하지 않습니다. 다른 사용자 정의 프로토콜을 추가해야 하는 경우 개발자는 애플리케이션 계층에서 이를 직접 처리해야 합니다.

  2. 표준 http/https 포트 80/443을 사용하여 웹소켓 서비스에 대한 액세스를 지원하고 wss(암호화된 웹소켓) 프로토콜도 지원합니다. 따라서 기존 웹 서버와 쉽게 상호 작용할 수 있습니다.

  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로 변환한 다음 한 번 더 변환하는 쓰기 기능을 통해 보냅니다.

  • writeTextMessage는 전송해야 하는 QString을 직접 작성하므로 약간 더 효율적입니다.

  1. 비동기 지원은 다릅니다.

  • sendTextMessage는 동기 작업이며 전송이 완료된 후 반환됩니다.

  • writeTextMessage는 비동기 호출을 지원하며 콜백 함수는 Lambda를 통해 지정할 수 있습니다.

  1. 오류 처리가 다릅니다.

  • sendTextMessage는 오류 정보를 반환하지 않으며 신호 오류를 통해서만 처리될 수 있습니다.

  • writeTextMessage는 반환된 오류 코드를 가져와 전송 상황을 확인할 수 있습니다.

  1. 다양한 사용 시나리오:

  • sendTextMessage는 WebSocket에 중점을 두고 있으며 WebSocket API를 호출하는 데 적합합니다.

  • writeTextMessage는 더 일반적이며 다른 QAbstractSocket 하위 클래스와 함께 사용할 수 있습니다.

일반적으로:

  • sendTextMessage는 사용이 더 간단하고 잘 캡슐화되어 있으며 기본 사용에 적합합니다.

  • writeTextMessage는 약간 더 효율적이고 비동기 및 오류 처리와 같은 더 많은 기능을 지원하며 고성능 또는 제어 요구 사항이 있는 시나리오에 적합합니다.

프로젝트를 실현하다

클라이언트와 클라이언트 간의 비공개 통신, 클라이언트와 서버 간의 통신.

핵심 코드

섬기는 사람

프로세스: QWebServer를 생성하고, 새로운 연결 콜백을 바인딩하고, 연결 끊김을 수신합니다.

새 연결 콜백: 새 연결이 컬렉션에 추가되면 오프라인, 수신 및 오류 콜백이 새 연결 소켓에 바인딩됩니다.

메시지 보내기 버튼: 모두와 하나로 분류하고, 설정된 컬렉션을 순회하고, 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. }

요약하다

일반적으로 QT 네트워크 라이브러리의 구성 요소인 QWebSocket은 WebSocket 클라이언트 및 서버 개발을 위한 편리한 API 세트를 제공합니다.

주요 장점은 다음과 같습니다.

  1. 완전한 객체 지향 설계로 API는 간단하고 사용하기 쉽습니다.

  2. SSL/프록시 지원과 같은 다른 QT 네트워크 구성 요소와 고도로 통합됩니다.

  3. 이벤트 중심 모델을 사용하면 개발자는 멀티스레딩과 같은 기본 세부 사항을 처리할 필요가 없습니다.

  4. Qt GUI 애플리케이션과 자연스럽게 통합되어 메시지 및 인터페이스 업데이트를 직접 호출할 수 있습니다.

  5. 개발을 용이하게 하기 위해 즉시 사용할 수 있는 WebSocket 기본 사양의 완전한 구현을 제공합니다.

  6. 특히 QT5.10이 비동기 I/O 호출을 지원하므로 성능도 좋습니다.

  7. 풍부한 예제와 오픈소스 프로젝트를 참고할 수 있으며 진입 장벽이 낮습니다.

참고할 사항은 다음과 같습니다.

  1. 일부 확장된 웹소켓 프로토콜 형식은 지원되지 않으며 직접 구현해야 합니다.

  2. 메시지 전송 및 수신 순서 매칭은 사용자가 직접 제어해야 합니다.

  3. 파일 및 스트리밍 빅데이터 전송 지원은 친절하지도 간단하지도 않습니다.

  4. 사용되는 기본 스마트 포인터 및 메모리 관리 메커니즘은 변경할 수 없습니다.

  5. 새로운 C++ 표준 기능에 대한 지원은 상대적으로 보수적입니다.

전반적으로 QWebSocket은 대부분의 Tcp 기반 WebSocket 애플리케이션에 대해 매우 훌륭하고 성숙한 선택을 제공합니다. 개발 효율성이 높고 버그가 거의 없습니다. QT 애플리케이션에도 선호됩니다. 더 높은 수준의 요구 사항이 있는 경우 다른 기본 구현을 고려할 수 있습니다. 그러나 대부분의 경우 QWebSocket이면 충분합니다.

마지막으로 소스코드 링크를 첨부해주세요
도움이 되셨다면 별점 부탁드려요

Qt 데모: Qt 프로세스 학습(gitee.com)

개인 프로필

그는 30년 이상 기술 연구에 전념해 왔으며, java, linux, javascript, php, css 등 다양한 언어에 능숙하며, 오픈 소스 분야에서 많은 공헌을 했습니다. 나중에 참조할 수 있도록 기술 개발의 일부 문제를 공유하는 개발자 문서 스테이션입니다.

내 연락처 정보

우편