fgets函数详解

小记笔记

已于 2025-01-03 13:41:28 修改

阅读量1.8k

点赞数 13

分类专栏： C语言文章标签： c语言

于 2025-01-03 11:49:45 首次发布

本文链接：https://blog.csdn.net/weixin_43415263/article/details/144906854

版权

C语言专栏收录该内容

3 篇文章

订阅专栏

fgets函数是C语言标准库中的一个函数，用于从指定的文件流中读取一行字符，并将其存储在指定的字符数组中。它的原型在<stdio.h>头文件中定义，如下所示：

char *fgets(char *str, int n, FILE *stream);

参数

str：指向一个字符数组的指针，该数组用于存储从文件流中读取的字符串。数组的大小应该至少为n个字符，以容纳可能读取的字符和字符串结束符\0。
n：要读取的最大字符数（包括最后的空字符\0）。如果读取到的行超过了这个长度，那么fgets只会读取前n-1个字符，并在最后一个位置添加\0作为字符串的结束。
stream：指向一个FILE对象的指针，表示要从哪个文件流中读取数据。这通常是通过打开文件获得的，例如使用fopen函数。如果stream是stdin，那么fgets将从标准输入读取数据。

返回值

如果成功读取到数据，fgets返回str的指针。
如果在读取到任何字符之前就遇到了文件结束符（EOF）或发生了读取错误，fgets返回NULL。

注意事项

fgets会读取换行符\n，并将其存储在str中，除非行太长而无法完全读入。如果行被截断，那么str中不会包含换行符，但后续的读取操作会从下一行的开始处继续。
fgets会在读取的字符串末尾自动添加一个空字符\0，以确保str是一个以空字符结尾的字符串。
如果n的值为1，那么fgets将不会读取任何字符，只是检查文件结束符或错误，并相应地返回NULL或str。

示例代码

以下是一个使用fgets从标准输入读取一行文本的示例：

#include <stdio.h>

int main() {
    char buffer;

    printf("Please enter a line of text: ");
    if (fgets(buffer, sizeof(buffer), stdin) != NULL) {
        printf("You entered: %s", buffer);
    } else {
        printf("Error reading input or EOF reached.\n");
    }

    return 0;
}

在这个示例中，buffer是一个大小为100的字符数组，用于存储从标准输入读取的字符串。fgets函数被调用时，它会等待用户输入一行文本，并在用户按下回车键后读取该行文本（包括换行符，如果它存在且行没有太长）。然后，程序会打印出用户输入的文本。如果用户输入了超过99个字符（因为需要留一个位置给\0），那么只有前99个字符会被读取和打印。

fgets函数读取文件示例

以下是一个使用fgets函数从文件中读取文本的示例代码。这个示例将打开一个名为"example.txt"的文件，逐行读取其内容，并将每行打印到标准输出上。

#include <stdio.h>

#define MAX_LINE_LENGTH 1024

int main() {
    FILE *file;
    char line[MAX_LINE_LENGTH];

    // 打开文件，模式为"r"，表示只读
    file = fopen("example.txt", "r");
    if (file == NULL) {
        perror("Error opening file");
        return 1;
    }

    // 逐行读取文件内容
    while (fgets(line, MAX_LINE_LENGTH, file) != NULL) {
        // 打印读取到的行
        printf("%s", line);
    }

    // 关闭文件
    fclose(file);

    return 0;
}

在这个示例中：

我们定义了一个宏MAX_LINE_LENGTH，它表示每行可以读取的最大字符数（包括最后的空字符\0）。在这个例子中，我们将其设置为1024。
使用fopen函数以只读模式（"r"）打开名为"example.txt"的文件，并将文件指针赋值给file。如果文件打开失败，fopen将返回NULL，我们使用perror函数打印错误信息并退出程序。
使用while循环和fgets函数逐行读取文件内容。fgets将读取的行存储在line数组中，并在遇到换行符或达到MAX_LINE_LENGTH - 1个字符时停止读取（留一个位置给字符串结束符\0）。
在循环体内，我们使用printf函数打印读取到的行。
当文件读取完毕后，fgets将返回NULL，循环结束。我们使用fclose函数关闭文件。

请确保"example.txt"文件存在于你的程序运行目录中，或者提供文件的完整路径。如果文件不存在或无法访问，fopen将返回NULL，并且程序将打印错误信息。

fgets函数读取文件时需要注意什么？

使用fgets函数读取文件时，需要注意以下几点：

‌文件打开和错误检查‌：
- 在调用fgets之前，确保文件已经成功打开。使用fopen函数打开文件，并检查其返回值是否为NULL。如果是NULL，表示文件打开失败，可能是文件不存在或没有读取权限。
‌缓冲区大小‌：
- fgets函数需要指定一个缓冲区来存储读取的字符串。确保缓冲区的大小足够大，以容纳可能的最长行以及字符串结束符\0。如果缓冲区太小，可能会导致数据被截断。
‌换行符处理‌：
- fgets会将换行符（如果有的话）也读取到字符串中。如果需要去除换行符，可以在读取后进行处理。
‌文件结束和错误处理‌：
- fgets在读取到文件末尾或发生错误时会返回NULL。因此，每次调用fgets后都应该检查其返回值。如果是NULL，可以使用feof和ferror函数来判断是到达了文件末尾还是发生了错误。
‌多次调用‌：
- 由于fgets每次调用只能读取一行数据，如果文件包含多行，需要在一个循环中多次调用fgets来读取整个文件。
‌文件关闭‌：
- 在完成文件读取后，使用fclose函数关闭文件。这是一个好习惯，可以释放文件相关的资源。
‌编码和字符集‌：
- 如果文件使用特定的编码或字符集（如UTF-8），需要确保程序正确处理这些编码和字符集。在某些情况下，可能需要额外的库或函数来处理多字节字符。
‌跨平台兼容性‌：
- 在不同的操作系统和文件系统中，文件路径和权限可能会有所不同。确保代码在不同的环境下都能正确运行。
‌安全性‌：
- 虽然fgets比gets更安全，因为它允许指定读取的最大字符数，但还是要确保不会将读取的数据写入到比预期小的缓冲区中，以防止缓冲区溢出。
‌性能考虑‌：
- 对于非常大的文件，fgets可能不是最高效的读取方式。在这种情况下，可能需要考虑使用fread或其他更高效的I/O函数。

fgets函数与scanf的区别

fgets函数和scanf函数在C语言中都是用于从标准输入或其他文件流中读取数据的函数，但它们之间存在一些重要的区别。以下是它们之间的主要区别：

‌安全性‌：
- fgets函数是安全的，因为它允许你指定要读取的最大字符数。这可以防止缓冲区溢出，因为即使输入的数据超过了你预期的长度，fgets也只会读取指定数量的字符，并在字符串末尾添加空字符\0。
- scanf函数在读取字符串时不太安全，因为它不会自动检查目标缓冲区的大小。如果输入的字符串长度超过了指定的缓冲区大小，scanf可能会继续写入内存，导致缓冲区溢出，从而引发安全问题或程序崩溃。
‌换行符处理‌：
- fgets会读取换行符并将其存储在字符串中（如果行没有太长而被截断）。这意味着，如果你想要处理输入的行，包括换行符，你需要手动去除它。
- scanf在遇到空格、制表符或换行符时会停止读取字符串。它不会将换行符存储在字符串中，但换行符仍然会留在输入缓冲区中，可能会影响后续的输入操作。
‌格式控制‌：
- scanf是一个格式化输入函数，它允许你根据指定的格式从输入中读取数据。这提供了很大的灵活性，但也增加了复杂性，因为你需要确保输入的数据与格式字符串匹配。
- fgets则更简单直接，它只读取一行文本，直到遇到换行符或达到指定的最大字符数。它不提供格式化输入的功能。
‌返回值‌：
- fgets返回一个指向存储了读取数据的字符数组的指针，如果读取失败（如到达文件末尾或发生错误），则返回NULL。
- scanf返回成功读取的数据项数。如果没有成功读取任何项，返回0；如果在读取过程中遇到文件结束或错误，返回EOF。
‌用途‌：
- fgets通常用于需要读取整行文本的情况，特别是当你不确定输入的长度时。它非常适合处理用户输入或读取文件。
- scanf则更适合需要读取特定格式数据的情况，比如整数、浮点数或特定格式的字符串。它提供了更多的灵活性，但也需要更多的注意来确保输入的正确性和安全性。

综上所述，fgets和scanf各有优缺点，选择使用哪个函数取决于你的具体需求和场景。如果你需要读取整行文本并确保安全性，fgets通常是更好的选择。如果你需要读取特定格式的数据，并且能够确保输入的正确性和安全性，scanf可能更合适。然而，在使用scanf时，你需要特别注意缓冲区溢出和输入格式匹配的问题。