Qt之TCP通信

目录

一、TCP简介

二、TCP类

1.QTcpServer

2. QTcpSocket

三、TCP服务器

四、TCP客户端

五、获取本机网络信息

六、代码

1.TCP服务器

2.TCP客户端

一、TCP简介

TCP 协议（Transmission Control Protocol）全称是传输控制协议是一种面向连接的、可靠的、
基于字节流的传输层通信协议。TCP是大多数 Internet 协议（包括 HTTP 和 FTP）用于数据传输的低级网络协议。它是一种可靠的，面向流，面向连接的传输协议。它特别适合连续数据传输。

TCP 通信必须先建立 TCP 连接，通信端分为客户端和服务端。服务端通过监听某个端口来监听是否有客户端连接到来，如果有连接到来，则建立新的 socket 连接；客户端通过 ip 和port 连接服务端，当成功建立连接之后，就可进行数据的收发了。

需要注意的是，在 Qt 中把 socket 当成输入输出流来对待的，数据的收发是通过 read()和 write()来进行的，需要与常见的 send()与 recv()进行区分。

TCP 客户端与服务端通信示意图如下：

Qt 网络模块提供了编写 TCP / IP 客户端和服务器的类。它提供了较低级别的类，如代表低级网络概念的 QTcpSocket， QTcpServer 和 QUdpSocket，以及如 QNetworkRequest，QNetworkReply 和 QNetworkAccessManager 之类的高级类来执行使用应用层网络相关类和通用协议的网络操作。 它还提供了如QNetworkConfiguration， QNetworkConfigurationManager和QNetworkSession等类，实现承载管理。

二、TCP类

想要在程序中使用 Qt 网络模块，需要在 pro 项目配置文件添加network模块

QT   +=     network

#include <QtNetwork>  //在头文件中添加

使用 Qt 提供的类进行基于 TCP 的套接字通信需要用到两个类：

QTcpServer：服务器类，用于监听客户端连接以及和客户端建立连接。
QTcpSocket：通信的套接字类，客户端、服务器端都需要使用。 

1.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 的一个子对象，当 QTcpServer 对象析构的时候会自动析构这个子对象，当然也可自己手动析构，建议用完之后自己手动析构这个通信的 QTcpSocket 对象。

QTcpSocket *QTcpServer::nextPendingConnection();//获取客户端连接的套接字

阻塞等待客户端发起的连接请求，不推荐在单线程程序中使用，建议使用非阻塞方式处理新连接，即使用信号 newConnection() 。

bool QTcpServer::waitForNewConnection(int msec = 0, bool *timedOut = Q_NULLPTR);

msec：指定阻塞的最大时长，单位为毫秒（ms）
timeout：传出参数，如果操作超时 timeout 为 true，没有超时 timeout 为 false

 常用信号

① 当接受新连接导致错误时，将发射如下信号。socketError 参数描述了发生的错误相关的信息。

[signal] void QTcpServer::acceptError(QAbstractSocket::SocketError socketError);

②每次有新连接可用时都会发出 newConnection () 信号。 

[signal] void QTcpServer::newConnection(); 

2. QTcpSocket

QTcpSocket 是一个套接字通信类，不管是客户端还是服务器端都需要使用。在 Qt 中发送和接收数据也属于 IO 操作（网络 IO）。

常用API函数

①构造函数

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);

 一般给ip地址和端口号就可以了。

③接收数据

// 指定可接收的最大字节数 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 指向的内存中的数据，字符串以  作为结束标记
qint64 QIODevice::write(const char *data);
// 发送参数指定的字符串
qint64 QIODevice::write(const QByteArray &byteArray);

 常用信号

①在使用 QTcpSocket 进行套接字通信的过程中，如果该类对象发射出 readyRead() 信号，说明对端发送的数据达到了，之后就可以调用 read 函数接收数据了。

[signal] void QIODevice::readyRead();

②调用 connectToHost() 函数连接TCP服务器并成功建立连接之后发出 connected() 信号。

[signal] void QAbstractSocket::connected(); 

③在套接字断开连接时发出 disconnected() 信号。

[signal] void QAbstractSocket::disconnected(); 

三、TCP服务器

①创建套接字服务器 QTcpServer 对象

mServer = new QTcpServer(this);

②通过 QTcpServer 对象设置监听，即：QTcpServer::listen()

mServer->listen(QHostAddress::Any/*IP地址*/,端口号);

③基于 QTcpServer::newConnection() 信号检测是否有新的客户端连接

connect(mServer,&QTcpServer::newConnection,this,[&](){

        

});

当客户端连接上来时，会触发信号(newConnection),连接该信号和槽， 如果需要处理客户端发起的 TCP 连接，请使用 QTcpServer 类。调用 QTcpServer::listen() 设置服务器，并连接到 QTcpServer::newConnection() 信号，该信号对于每个连接的客户端发出一次。在对应的槽函数中，调用 QTcpServer::nextPendingConnection() 接受连接，并使用返回的QTcpSocket 与客户端进行通信。
 

④在上面的槽函数中获取和客户端通信的套接字

//获取和客户端通信的套接字

mSocket = mServer->nextPendingConnection();

//获取客户端地址
QHostAddress c_addr = mSocket->peerAddress();

如果有新的客户端连接，调用 QTcpSocket *QTcpServer::nextPendingConnection() 得到通信的套接字对象。

QTcpSocket 使用必须先建立与远程主机和端口的 TCP 连接，然后才能开始任何数据传输。建立
连接后，即可通过 QTcpSocket::peerAddress() 和 QTcpSocket::peerPort() 获得对等方的 IP 地址和端口。对等方可以随时关闭连接，然后数据传输将立即停止

注意：这里对mSocket的操作是从客户端连接服务端得到的通过nextPendingConnection方式。

⑤使用通信的套接字对象 QTcpSocket 和客户端进行通信

发送： 通过QTcpSocket对象的write成员函数发送数据 

//获取发送的数据
QString str = ui->lineEdit->text();
//转换成QByteArray
QByteArray arr;
arr.append(str);
//发送
mSocket->write(arr);

接收： 收到数据会触发信号readyRead, 在连接的槽函数中调用QTcpSocket对象的read/readAll接收数据。

//连接readyRead信号和槽
QObject::connect(mSocket,&QTcpSocket::readyRead,this,[&]()

{
            //接收数据
            QByteArray arr = mSocket->readAll();
            //转换成字符串
            QString str(arr);
            //显示
            ui->textBrowser->insertPlainText("rcv:"+str+"n");
        });

四、TCP客户端

①创建通信的套接字类 QTcpSocket 对象

mSocket = new QTcpSocket(this);

②使用服务器端绑定的 IP 和端口连接服务器 QAbstractSocket::connectToHost()。

mSocket->connectToHost(ip,端口号);

③连接成功会触发connected信号

QObject::connect(mSocket,&QTcpSocket::connected,this,[&](){

         });

④使用 QTcpSocket 对象和服务器进行通信

发送： 通过QTcpSocket对象的write成员函数发送数据

//获取发送的数据

QString str = ui->lineEdit_send->text();

//转换成QByteArray QByteArray arr;

arr.append(str);

//发送 mSocket->write(arr);

接收： 收到数据会触发信号readyRead,在连接的槽函数中调用QTcpSocket对象的read/readAll接收数据。

//连接readyRead信号和槽

QObject::connect(mSocket,&QTcpSocket::readyRead,this,[&]()

{

        //接收数据

        QByteArray arr = mSocket->readAll();

        //转换成字符串

        QString str(arr);

        //显示

        ui->textBrowser->insertPlainText(rcv:+str+n);

});

 五、获取本机网络信息

在建立网络通信之前至少要得获取对方的 IP地址。 在网络应用中，经常需要用到本机的主机名、 IP 地址、 MAC 地址等网络信息，通常通在 Windows 通过调出命令行 cmd 窗口输入 ipconfig 或者在 Linux 系统中使用 ifconfig 命令就可以查看相关信息了。

Qt 提供了 QHostInfo 和 QNetworkInterface 类可以用于此类信息查询。

#include <QNetworkInterface>
#include <QHostInfo>

//通过 QHostInfo 的 localHostName 函数获取主机名称 
QString str = "主机名称： " + QHostInfo::localHostName() + "n";


//获取所有的网络接口，QNetworkInterface 类提供主机的 IP 地址和网络接口的列表
QList<QNetworkInterface> list = QNetworkInterface::allInterfaces();

//遍历 list
foreach (QNetworkInterface interface, list) 
{
    str+= "网卡设备:" + interface.name() + "n";
    str+= "MAC 地址:" + interface.hardwareAddress() + "n";


    //QNetworkAddressEntry 类存储 IP 地址子网掩码和广播地址
    QList<QNetworkAddressEntry> entryList= interface.addressEntries();
    //遍历 entryList
    foreach (QNetworkAddressEntry entry, entryList) 
    {
        //过滤 IPv6 地址，只留下 IPv4 
        if (entry.ip().protocol() ==QAbstractSocket::IPv4Protocol) 
        {
            str+= "IP 地址:" + entry.ip().toString() + "n";
            str+= "子网掩码:" + entry.netmask().toString() + "n";
            str+= "广播地址:" + entry.broadcast().toString() + "nn";
        }
    }
 }

六、代码

1.TCP服务器

头文件

#ifndef TCPSERVER_H
#define TCPSERVER_H

#include <QWidget>
#include <QtNetwork>

QT_BEGIN_NAMESPACE
namespace Ui { class TcpServer; }
QT_END_NAMESPACE

class TcpServer : public QWidget
{
    Q_OBJECT

public:
    TcpServer(QWidget *parent = nullptr);
    ~TcpServer();

private slots:
    void on_pushButton_start_clicked();

    void on_pushButton_send_clicked();

private:
    Ui::TcpServer *ui;
    //TCP服务器
    QTcpServer *mServer;
    QTcpSocket *mSocket;
};
#endif // TCPSERVER_H

源文件

#include "tcpserver.h"
#include "ui_tcpserver.h"
#include <QDebug>

TcpServer::TcpServer(QWidget *parent)
    : QWidget(parent)
    , ui(new Ui::TcpServer)
{
    ui->setupUi(this);
}

TcpServer::~TcpServer()
{
    delete ui;
}

//启动TCP服务器
void TcpServer::on_pushButton_start_clicked()
{
    //1.构造QTcpServer对象
    mServer = new QTcpServer(this);
    //2.连接客户端连接上来的信号
    QObject::connect(mServer,&QTcpServer::newConnection,this,[&](){
        //获取客户端连接上来的套接字
        mSocket = mServer->nextPendingConnection();
        //打印客户端的地址
        QHostAddress c_addr = mSocket->peerAddress();
        qDebug()<<c_addr.toString()<<"连接上来!";

        //使能发送输入框和按钮
        ui->lineEdit->setEnabled(true);
        ui->pushButton_send->setEnabled(true);

        //连接readyRead信号和槽
        QObject::connect(mSocket,&QTcpSocket::readyRead,this,[&](){
            //接收数据
            QByteArray arr = mSocket->readAll();
            //转换成字符串
            QString str(arr);
            //显示
            ui->textBrowser->insertPlainText("rcv:"+str+"n");
        });
    });

    //3.监听
    mServer->listen(QHostAddress::Any,ui->spinBox->value());

    //连接回车发送的信号和槽
    QObject::connect(ui->lineEdit,&QLineEdit::returnPressed,this,&TcpServer::on_pushButton_send_clicked);

    //禁止端口号和启动按钮
    ui->spinBox->setEnabled(false);
    ui->pushButton_start->setEnabled(false);
}

void TcpServer::on_pushButton_send_clicked()
{
    //获取发送的数据
    QString str = ui->lineEdit->text();
    //转换成QByteArray
    QByteArray arr;
    arr.append(str);

    //发送
    mSocket->write(arr);
    //显示发送的内容
    ui->textBrowser->insertPlainText("send:"+str+"n");
    //情况lineEdit
    ui->lineEdit->clear();
}

 ui界面

2.TCP客户端

头文件

#ifndef TCPCILENT_H
#define TCPCILENT_H

#include <QWidget>
#include <QtNetwork>

QT_BEGIN_NAMESPACE
namespace Ui { class TcpCilent; }
QT_END_NAMESPACE

class TcpCilent : public QWidget
{
    Q_OBJECT

public:
    TcpCilent(QWidget *parent = nullptr);
    ~TcpCilent();

private slots:
    void on_pushButton_start_clicked();

    void on_pushButton_send_clicked();

private:
    Ui::TcpCilent *ui;
    //TCP客户端
    QTcpSocket *mSocket;
};
#endif // TCPCILENT_H

 源文件

#include "tcpcilent.h"
#include "ui_tcpcilent.h"

TcpCilent::TcpCilent(QWidget *parent)
    : QWidget(parent)
    , ui(new Ui::TcpCilent)
{
    ui->setupUi(this);
}

TcpCilent::~TcpCilent()
{
    delete ui;
}

//连接服务器
void TcpCilent::on_pushButton_start_clicked()
{
    //1.创建QTcpSocket对象
    mSocket = new QTcpSocket(this);
    //2.连接连接成功的信号和槽
    QObject::connect(mSocket,&QTcpSocket::connected,this,[&](){
        //使能发送按钮和发送输入框
        ui->lineEdit_send->setEnabled(true);
        ui->pushButton_send->setEnabled(true);

        //禁止ip 端口号和连接按钮
        ui->lineEdit_ip->setEnabled(false);
        ui->spinBox->setEnabled(false);
        ui->pushButton_start->setEnabled(false);


        //连接readyRead信号和槽
        QObject::connect(mSocket,&QTcpSocket::readyRead,this,[&](){
            //接收数据
            QByteArray arr = mSocket->readAll();
            //转换成字符串
            QString str(arr);
            //显示
            ui->textBrowser->insertPlainText("rcv:"+str+"n");
        });
    });


    //3.连接服务器
    QString ip = ui->lineEdit_ip->text();
    quint16 port = ui->spinBox->value();
    mSocket->connectToHost(ip,port);

    //连接回车发送的信号和槽
    QObject::connect(ui->lineEdit_send,&QLineEdit::returnPressed,this,&TcpCilent::on_pushButton_send_clicked);
}

//发送
void TcpCilent::on_pushButton_send_clicked()
{
    //获取发送的数据
    QString str = ui->lineEdit_send->text();
    //转换成QByteArray
    QByteArray arr;
    arr.append(str);

    //发送
    mSocket->write(arr);
    //显示发送的内容
    ui->textBrowser->insertPlainText("send:"+str+"n");
    //情况lineEdit
    ui->lineEdit_send->clear();
}

 通信：