【C++】ReadFile概述，及实践使用时ReadFile的速率影响研究

`ReadFile` 函数概述

ReadFile 是 Windows API 函数，用于从文件或设备（如串口、硬盘等）中读取数据。它是同步和异步 I/O 操作的基础函数。

函数原型

BOOL ReadFile(
    _In_ HANDLE hFile,                          // 文件或设备句柄
    _Out_writes_bytes_to_opt_(nNumberOfBytesToRead, *lpNumberOfBytesRead) LPVOID lpBuffer, // 缓冲区
    _In_ DWORD nNumberOfBytesToRead,            // 预期读取的字节数
    _Out_opt_ LPDWORD lpNumberOfBytesRead,      // 实际读取的字节数，会根据_In_ DWORD返回给他
    _Inout_opt_ LPOVERLAPPED lpOverlapped       // 异步操作参数
);

参数详解

1. `HANDLE hFile`

含义：表示需要读取数据的目标。
- 可以是文件句柄（通过 CreateFile 打开）或设备句柄（如串口 COM1）。
- 例如，读取串口数据时，通过 CreateFile 获得串口句柄。

2. `LPVOID lpBuffer`

含义：指向缓冲区的指针，ReadFile 将读取的数据存储到该缓冲区中。
大小要求：缓冲区大小应至少等于 nNumberOfBytesToRead，以避免越界。
类型：LPVOID，可转换为任意指针类型（如 char*）。

3. `DWORD nNumberOfBytesToRead`

含义：预期读取的字节数，ReadFile 尝试从文件或设备读取该数量的数据。
注意：
- 如果设备中数据不足，ReadFile 可能返回成功，但实际读取的字节数会少于此值（存储在 lpNumberOfBytesRead 中）。

4. `LPDWORD lpNumberOfBytesRead`

含义：指向 DWORD 类型变量的指针，用于接收实际读取的字节数。
可选性：
- 如果为 nullptr，表示调用方不关心读取了多少字节（不推荐）。
返回值含义：
- 函数执行成功后，该变量存储实际读取的字节数。

5. `LPOVERLAPPED lpOverlapped`

含义：指向 OVERLAPPED 结构的指针，用于异步操作。
同步与异步：
- nullptr：表示同步操作，ReadFile 会阻塞，直到读取完成或超时。
- 非 nullptr：表示异步操作，ReadFile 会立即返回，读取操作会在后台完成。

返回值

BOOL 类型：
- TRUE：读取成功。
- FALSE：读取失败，调用 GetLastError 获取错误代码。
常见错误：
- ERROR_HANDLE_EOF：已到达文件末尾（EOF）。
- ERROR_IO_PENDING：对于异步操作，表示读取请求已提交但尚未完成。

函数用途

ReadFile 广泛用于以下场景：

文件读取：从文件系统中读取内容。
串口通信：读取串口（COM）数据，常用于嵌入式设备通信。
网络通信（通过设备接口）：读取基于设备接口的网络数据。
传感器数据读取：从硬件传感器中读取数据。

示例 1：从文件读取数据

从文件中读取内容并打印到控制台：

#include <windows.h>
#include <iostream>

int main() {
    // 打开文件
    HANDLE hFile = CreateFile(
        "example.txt",          // 文件路径
        GENERIC_READ,           // 读取权限
        0,                      // 共享模式
        NULL,                   // 安全属性
        OPEN_EXISTING,          // 打开已存在的文件
        FILE_ATTRIBUTE_NORMAL,  // 属性
        NULL                    // 模板文件句柄
    );

    if (hFile == INVALID_HANDLE_VALUE) {
        std::cerr << "无法打开文件，错误代码：" << GetLastError() << std::endl;
        return 1;
    }

    // 读取数据
    char buffer[128] = {0};  // 数据缓冲区
    DWORD bytesRead = 0;     // 实际读取的字节数

    if (ReadFile(hFile, buffer, sizeof(buffer) - 1, &bytesRead, NULL)) {
        std::cout << "成功读取 " << bytesRead << " 字节：" << std::endl;
        std::cout << buffer << std::endl;
    } else {
        std::cerr << "读取失败，错误代码：" << GetLastError() << std::endl;
    }

    // 关闭文件
    CloseHandle(hFile);
    return 0;
}

示例 2：串口数据读取

从串口（如 COM2）读取数据：

#include <windows.h>
#include <iostream>

int main() {
    // 打开串口
    HANDLE hSerial = CreateFile(
        "COM2",                // 串口名称
        GENERIC_READ,          // 读取权限
        0,                     // 共享模式
        NULL,                  // 安全属性
        OPEN_EXISTING,         // 打开已存在的设备
        0,                     // 属性
        NULL                   // 模板文件句柄
    );

    if (hSerial == INVALID_HANDLE_VALUE) {
        std::cerr << "无法打开串口，错误代码：" << GetLastError() << std::endl;
        return 1;
    }

    // 设置串口参数（波特率、数据位等）
    DCB dcb = {0};//Device Control Block
    dcb.DCBlength = sizeof(DCB);
    GetCommState(hSerial, &dcb);
    dcb.BaudRate = CBR_9600;
    dcb.ByteSize = 8;
    dcb.Parity = NOPARITY;
    dcb.StopBits = ONESTOPBIT;
    SetCommState(hSerial, &dcb);

    // 读取数据
    char buffer[128] = {0};
    DWORD bytesRead = 0;

    if (ReadFile(hSerial, buffer, sizeof(buffer) - 1, &bytesRead, NULL)) {
        std::cout << "成功读取 " << bytesRead << " 字节：" << std::endl;
        for (DWORD i = 0; i < bytesRead; ++i) {
            std::cout << "0x" << std::hex << static_cast<int>(buffer[i]) << " ";
        }
        std::cout << std::endl;
    } else {
        std::cerr << "读取失败，错误代码：" << GetLastError() << std::endl;
    }

    // 关闭串口
    CloseHandle(hSerial);
    return 0;
}

异步模式的应用

如果需要非阻塞读取，可以使用 OVERLAPPED 结构：

OVERLAPPED overlapped = {0};
overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);

BOOL result = ReadFile(hFile, buffer, sizeof(buffer), &bytesRead, &overlapped);
if (!result && GetLastError() == ERROR_IO_PENDING) {
    // 等待异步操作完成
    WaitForSingleObject(overlapped.hEvent, INFINITE);
    GetOverlappedResult(hFile, &overlapped, &bytesRead, FALSE);
}

总结

`ReadFile` 的作用

从文件或设备读取数据，支持同步和异步模式。

典型应用

文件操作：读取文本或二进制文件。
串口通信：读取嵌入式设备数据。
网络设备：读取基于接口的网络数据。

优点

支持异步 I/O，提高程序性能。
适用于广泛的文件和设备操作场景。

注意事项

缓冲区大小要足够大以避免数据截断。
在串口和异步模式中，需额外配置超时和事件处理机制。

补充 1 关于DBC

DCB dcb = {0}; 是一个用于初始化并配置串口通信参数的结构体。在 Windows API 中，DCB（Device Control Block）结构用于描述串口通信的控制设置，例如波特率、数据位、停止位、校验位等。

DCB 结构的定义

typedef struct _DCB {
    DWORD DCBlength;       // 结构体的大小（字节）
    DWORD BaudRate;        // 波特率（如 9600、115200）
    DWORD fBinary: 1;      // 是否使用二进制模式
    DWORD fParity: 1;      // 是否启用校验位
    DWORD fOutxCtsFlow: 1; // 是否启用 CTS 流控制
    DWORD fOutxDsrFlow: 1; // 是否启用 DSR 流控制
    DWORD fDtrControl: 2;  // DTR 控制流设置
    DWORD fDsrSensitivity: 1; // DSR 灵敏度
    DWORD fTXContinueOnXoff: 1; // 接收 XOFF 后是否继续传输
    DWORD fOutX: 1;        // 是否启用 XON/XOFF 流控制（输出）
    DWORD fInX: 1;         // 是否启用 XON/XOFF 流控制（输入）
    DWORD fErrorChar: 1;   // 是否替换错误字符
    DWORD fNull: 1;        // 是否丢弃 NULL 字节
    DWORD fRtsControl: 2;  // RTS 控制流设置
    DWORD fAbortOnError: 1;// 是否在错误时中止读/写操作
    DWORD fDummy2: 17;     // 保留位
    WORD wReserved;        // 保留字段
    WORD XonLim;           // XON 限制
    WORD XoffLim;          // XOFF 限制
    BYTE ByteSize;         // 每个字节的数据位数（4-8 位）
    BYTE Parity;           // 校验类型（无、奇、偶、标记、空）
    BYTE StopBits;         // 停止位（1、1.5 或 2 位）
    char XonChar;          // XON 字符
    char XoffChar;         // XOFF 字符
    char ErrorChar;        // 替换错误的字符
    char EofChar;          // 文件结束符
    char EvtChar;          // 事件字符
    WORD wReserved1;       // 保留字段
} DCB, *LPDCB;