QT中基于TCP的网络通信
- QTcpServer
- 公共成员函数
- 信号
- QTcpSocket
- 公共成员函数
- 信号
- 通信流程
- 服务器端
- 通信流程
- 代码
- 客户端
- 通信流程
- 代码
使用Qt提供的类进行基于TCP的套接字通信需要用到两个类:
QTcpServer:服务器类,用于监听客户端连接以及和客户端建立连接。
QTcpSocket:通信的套接字类,客户端、服务器端都需要使用。
这两个套接字通信类都属于网络模块network。
QTcpServer
QTcpServer类 用于监听客户端连接以及和客户端建立连接,在使用之前先介绍一下这个类提供的一些常用API函数
公共成员函数
构造函数
QTcpServer::QTcpServer(QObject *parent = Q_NULLPTR);
给监听的套接字设置监听
bool QTcpServer::listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0);
// 判断当前对象是否在监听, 是返回true,没有监听返回false
bool QTcpServer::isListening() const;
// 如果当前对象正在监听返回监听的服务器地址信息, 否则返回 QHostAddress::Null
QHostAddress QTcpServer::serverAddress() const;
// 如果服务器正在侦听连接,则返回服务器的端口; 否则返回0
quint16 QTcpServer::serverPort() const
参数:
address:通过类QHostAddress可以封装IPv4、IPv6格式的IP地址,QHostAddress::Any表示自动绑定
port:如果指定为0表示随机绑定一个可用端口。
返回值:绑定成功返回true,失败返回false
QTcpSocket *QTcpServer::nextPendingConnection();
得到和客户端建立连接之后用于通信的QTcpSocket套接字对象,它是QTcpServer的一个子对象,当QTcpServer对象析构的时候会自动析构这个子对象,当然也可自己手动析构,建议用完之后自己手动析构这个通信的QTcpSocket对象。
bool QTcpServer::waitForNewConnection(int msec = 0, bool *timedOut = Q_NULLPTR);
阻塞等待客户端发起的连接请求,不推荐在单线程程序中使用,建议使用非阻塞方式处理新连接,即使用信号 newConnection() 。
参数:
msec:指定阻塞的最大时长,单位为毫秒(ms)
timeout:传出参数,如果操作超时timeout为true,没有超时timeout为false
信号
当接受新连接导致错误时,将发射如下信号。socketError参数描述了发生的错误相关的信息。
[signal] void QTcpServer::acceptError(QAbstractSocket::SocketError socketError);
每次有新连接可用时都会发出 newConnection() 信号。
[signal] void QTcpServer::newConnection();
QTcpSocket
QTcpSocket是一个套接字通信类,不管是客户端还是服务器端都需要使用。在Qt中发送和接收数据也属于IO操作(网络IO),先来看一下这个类的继承关系:
公共成员函数
构造函数
QTcpSocket::QTcpSocket(QObject *parent = Q_NULLPTR);
连接服务器,需要指定服务器端绑定的IP和端口信息。
[virtual] void QAbstractSocket::connectToHost(const QString &hostName, quint16 port, OpenMode openMode = ReadWrite, NetworkLayerProtocol protocol = AnyIPProtocol);
[virtual] void QAbstractSocket::connectToHost(const QHostAddress &address, quint16 port, OpenMode openMode = ReadWrite);
在Qt中不管调用读操作函数接收数据,还是调用写函数发送数据,操作的对象都是本地的由Qt框架维护的一块内存。因此,调用了发送函数数据不一定会马上被发送到网络中,调用了接收函数也不是直接从网络中接收数据,关于底层的相关操作是不需要使用者来维护的。
接收数据
// 指定可接收的最大字节数 maxSize 的数据到指针 data 指向的内存中
qint64 QIODevice::read(char *data, qint64 maxSize);
// 指定可接收的最大字节数 maxSize,返回接收的字符串
QByteArray QIODevice::read(qint64 maxSize);
// 将当前可用操作数据全部读出,通过返回值返回读出的字符串
QByteArray QIODevice::readAll();
发送数据
// 发送指针 data 指向的内存中的 maxSize 个字节的数据
qint64 QIODevice::write(const char *data, qint64 maxSize);
// 发送指针 data 指向的内存中的数据,字符串以 \0 作为结束标记
qint64 QIODevice::write(const char *data);
// 发送参数指定的字符串
qint64 QIODevice::write(const QByteArray &byteArray);
信号
在使用QTcpSocket进行套接字通信的过程中,如果该类对象发射出readyRead()信号,说明对端发送的数据达到了,之后就可以调用 read 函数接收数据了。
[signal] void QIODevice::readyRead();
调用connectToHost()函数并成功建立连接之后发出connected()信号。
[signal] void QAbstractSocket::connected();
在套接字断开连接时发出disconnected()信号。
[signal] void QAbstractSocket::disconnected();
通信流程
服务器端
通信流程
- 创建套接字服务器QTcpServer对象
- 通过QTcpServer对象设置监听,即:QTcpServer::listen()
- 基于QTcpServer::newConnection()信号检测是否有新的客户端连接
- 如果有新的客户端连接调用QTcpSocket
- *QTcpServer::nextPendingConnection()得到通信的套接字对象
- 使用通信的套接字对象QTcpSocket和客户端进行通信
代码
服务器端的窗口界面如下图所示:
QtServer.pro文件
mainwindow.h文件
#ifndef MAINWINDOW_H
#define MAINWINDOW_H
#include <QMainWindow>
#include <QTcpServer>
#include <QTcpSocket>
#include <QLabel>
QT_BEGIN_NAMESPACE
namespace Ui { class MainWindow; }
QT_END_NAMESPACE
class MainWindow : public QMainWindow
{
Q_OBJECT
public:
MainWindow(QWidget *parent = nullptr);
~MainWindow();
private slots:
void on_setListen_clicked();
void on_sendMsg_clicked();
private:
Ui::MainWindow *ui;
QTcpServer* m_s;
QTcpSocket* m_tcp;
QLabel* m_status;
};
#endif // MAINWINDOW_H
main.cpp文件
#include "mainwindow.h"
#include <QApplication>
int main(int argc, char *argv[])
{
QApplication a(argc, argv);
MainWindow w;
w.show();
return a.exec();
}
mainwindow.cpp文件
#include "mainwindow.h"
#include "ui_mainwindow.h"
MainWindow::MainWindow(QWidget *parent)
: QMainWindow(parent)
, ui(new Ui::MainWindow)
{
ui->setupUi(this);
ui->port->setText("8000"); //先设置一个端口号
setWindowTitle("服务器");
//创建监听的服务器对象
m_s = new QTcpServer(this); //指定父对象,不需要再去管内存的释放
//等待客户端链接,连接上会发送一个信号newConnection
connect(m_s,&QTcpServer::newConnection,this,[=](){
m_tcp = m_s->nextPendingConnection(); //得到可供通讯的套接字对象
m_status->setPixmap(QPixmap(":/connect.png").scaled(20,20)); //更改链接状态
//检测是否可以接收数据
connect(m_tcp,&QTcpSocket::readyRead,this,[=]()
{
QByteArray data = m_tcp->readAll(); //全部读出来
ui->record->append("客户端say: " + data); //显示在历史记录框中
});
//对端断开链接时会,TcpSocket会发送一个disconnect信号
connect(m_tcp,&QTcpSocket::disconnected,this,[=]()
{
m_tcp->close(); //关闭套接字
m_tcp->deleteLater(); //释放m_tcp
m_status->setPixmap(QPixmap(":/disconnect.png").scaled(20,20)); //更改链接状态
});
});
//状态栏
m_status = new QLabel;
//给标签设置图片
m_status->setPixmap(QPixmap(":/disconnect.png").scaled(20,20)); //scaled设置图片大小
//将标签设置到状态栏中
ui->statusbar->addWidget(new QLabel("连接状态: "));
ui->statusbar->addWidget(m_status);
}
MainWindow::~MainWindow()
{
delete ui;
}
void MainWindow::on_setListen_clicked()
{
unsigned short port = ui->port->text().toUShort();
m_s->listen(QHostAddress::Any,port); //开始监听
ui->setListen->setDisabled(true); //监听之后设置为不可用状态
}
void MainWindow::on_sendMsg_clicked()
{
QString msg = ui->msg->toPlainText(); //以纯文本的方式把数据读出来
m_tcp->write(msg.toUtf8());
ui->record->append("服务器say: " + msg); //显示在历史记录框中
}
mainwindow.ui文件
客户端
通信流程
- 创建通信的套接字类QTcpSocket对象
- 使用服务器端绑定的IP和端口连接服务器QAbstractSocket::connectToHost()
- 使用QTcpSocket对象和服务器进行通信
代码
客户端的窗口界面如下图所示:
QtClient.pro文件
mainwindow.h文件
#ifndef MAINWINDOW_H
#define MAINWINDOW_H
#include <QMainWindow>
#include <QTcpSocket>
#include <QLabel>
QT_BEGIN_NAMESPACE
namespace Ui { class MainWindow; }
QT_END_NAMESPACE
class MainWindow : public QMainWindow
{
Q_OBJECT
public:
MainWindow(QWidget *parent = nullptr);
~MainWindow();
private slots:
void on_sendMsg_clicked();
void on_connect_clicked();
void on_disconnect_clicked();
private:
Ui::MainWindow *ui;
QTcpSocket* m_tcp;
QLabel* m_status;
};
#endif // MAINWINDOW_H
main.cpp文件
#include "mainwindow.h"
#include <QApplication>
int main(int argc, char *argv[])
{
QApplication a(argc, argv);
MainWindow w;
w.show();
return a.exec();
}
mainwindow.cpp文件
#include "mainwindow.h"
#include "ui_mainwindow.h"
#include <QHostAddress>
MainWindow::MainWindow(QWidget *parent)
: QMainWindow(parent)
, ui(new Ui::MainWindow)
{
ui->setupUi(this);
ui->port->setText("8000"); //先设置一个端口号
ui->ip->setText("127.0.0.1"); //设置本地循环ip
setWindowTitle("客户端");
ui->disconnect->setDisabled(true);//断开连接按钮不可用
//创建监听的服务器对象
m_tcp = new QTcpSocket(this); //指定父对象,不需要再去管内存的释放
//检测是否可以接受数据 当 m_tcp 发送给出readyRead信号,就说明有信号到达了
connect(m_tcp,&QTcpSocket::readyRead,this,[=]()
{
QByteArray data = m_tcp->readAll(); //全部读出来
ui->record->append("服务器say: " + data); //显示在历史记录框中
});
//对端断开链接时会,TcpSocket会发送一个disconnect信号
connect(m_tcp,&QTcpSocket::disconnected,this,[=]()
{
m_tcp->close(); //关闭套接字
//m_tcp->deleteLater(); // 指定了父对象,不需要手动释放 m_tcp
m_status->setPixmap(QPixmap(":/disconnect.png").scaled(20,20)); //更改链接状态
ui->record->append("服务器已经和客户端断开了连接...");
ui->connect->setDisabled(false); //连接按钮可用
ui->disconnect->setEnabled(false); //断开连接按钮不可用
});
//当 m_tcp 发送一个 connected 信号后,就说明已经连接上服务器
connect(m_tcp,&QTcpSocket::connected,this,[=]()
{
m_status->setPixmap(QPixmap(":/connect.png").scaled(20,20)); //scaled设置图片大小
ui->record->append("已经成功连接到了服务器...");
ui->connect->setDisabled(true); //连接按钮不可用
ui->disconnect->setEnabled(true); //断开连接按钮可用
});
//状态栏
m_status = new QLabel;
//给标签设置图片
m_status->setPixmap(QPixmap(":/disconnect.png").scaled(20,20)); //scaled设置图片大小
//将标签设置到状态栏中
ui->statusbar->addWidget(new QLabel("连接状态: "));
ui->statusbar->addWidget(m_status);
}
MainWindow::~MainWindow()
{
delete ui;
}
void MainWindow::on_sendMsg_clicked()
{
QString msg = ui->msg->toPlainText(); //以纯文本的方式把数据读出来
m_tcp->write(msg.toUtf8());
ui->record->append("客户端say: " + msg); //显示在历史记录框中
}
void MainWindow::on_connect_clicked()
{
QString ip = ui->ip->text();
unsigned short port = ui->port->text().toUShort();
m_tcp->connectToHost(QHostAddress(ip),port);
}
void MainWindow::on_disconnect_clicked()
{
m_tcp->close();
ui->connect->setDisabled(false);
ui->disconnect->setEnabled(false);
}
mainwindow.ui文件