[C笔记]文件操作

内存断电后其上数据不保留，需要在硬盘中以文件的形式长期存储数据。

文件的类别

放在硬盘上的可以长期保存的文件，按其功能分为程序文件与数据文件。

程序文件

如：源程序文件（后缀为.c）,目标文件（windows环境后缀为.obj）,可执行程序（windows环境后缀为.exe）。

数据文件(本文的讨论对象)

文件的内容不一定是程序，而是程序运行时读写的数据，比如程序运行需要从其中读取数据的文件，或者在其中输出内容的文件。
本文讨论的是数据文件。
之前的笔记中所处理数据的输入输出都是以终端为对象的，即，从终端的键盘输入数据，运行结果显示在显示器上。
有时会把信息输出到磁盘上，当需要的时候再从磁盘上把数据读取到内存中使用，这里处理的就是磁盘上的数据文件。

文件名

一个文件需要有唯一的文件标识，以便用户识别和引用。
windows下文件标识包含3部分：文件路径+文件名主干+文件后缀
例如： c:\code\test.txt
为了方便起见，文件标识常被称为文件名。

文件指针

缓冲文件系统中(参见本文 “文件缓冲区” 部分)，一个关键的概念是“文件类型指针”，简称“文件指针”。
每个被使用的文件都在内存中开辟了一个相应的文件信息区，用来存放文件的相关信息（如文件的名字，文件状态及文件当前的位置等）。这些信息保存在一个结构体变量中，该结构体类型由系统声明，命名为FILE。

例如，VS2013提供的<stdio.h>头文件中有以下的文件类型申明：

struct _iobuf {
	char *_ptr;
	int _cnt;
	char *_base;
	int _flag;
	int _file;
	int _charbuf;
	int _bufsiz;
	char *_tmpfname;
};
typedef struct _iobuf FILE;

不同的C编译器的FILE类型包含的内容不完全相同，但是大同小异。
每当打开一个文件，系统会根据文件的情况自动创建一个FILE结构的变量(又称文件信息区)，并填充其中的信息，使用者不必关心细节。
一般都是通过一个名为FILE的指针来维护这个FILE结构的变量，这样使用起来更方便。

可以创建一个FILE*的指针变量：

FILE* pf;//文件指针变量

定义的pf是一个指向FILE类型数据的指针变量。可以使pf指向某个文件的文件信息区（一个结构体变量）。通过该文件信息区中的信息就能访问该文件。也就是说，通过文件指针变量能够找到与它关联的文件。

文件的打开(fopen)和关闭(fclose)

文件在读写之前应先被打开，在使用结束之后应被关闭。
编写程序时，在打开文件的同时，会返回一个FILE*的指针变量指向该文件，以此建立指针和文件的关系。
ANSIC 规定使用fopen函数来打开文件，fclose来关闭文件：

//打开文件
FILE * fopen ( const char * filename, const char * mode );
//关闭文件
int fclose ( FILE * stream );

stream：这里认为是指向要关闭的文件的，之前由fopen返回的指针。
filename：路径-文件名，若不包含绝对路径则默认路径为项目所在的文件夹(相对路径)。
(双引号" “内表示路径的斜杠”\“应写成双斜杠”\\"以转义)
mode：打开文件的模式(使用方式)

打开失败时会返回空指针，应及时判断是否打开成功。
和free类似，使用fclose关闭文件后应及时将文件指针置空。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	//打开
	FILE* pf = fopen("data.txt", "r");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}
	//关闭
	fclose(pf);
	pf = NULL;
	
	return 0;
}

流

C语言的一个抽象概念，代码与流直接交互，流与外部设备直接交互，代码不与外部设备直接交互。
使用流的概念简化了程序员写代码时需要考虑的东西，将与外部设备交接的具体工作(底层细节)交给“流”处理。
C程序运行时默认打开三个流：标准输出流stdout、标准输入流stdin、标准错误流stderr。这三个流的类型都为 FILE* 。

文件的顺序读写(函数)

fputc

该函数每次调用会在目标写入一个字符，程序运行中对同目标多次调用该函数会依次顺序写入:
-字符写入流的内部位置指示器指示的位置，然后位置指示器自动前进一位。

声明：

int fputc ( int character, FILE * stream );

character：要输出的字符的ascii码值。
stream：指向输出流的指针，可以输出到文件，也可以输出到屏幕。
成功时，返回写入的字符。
如果发生写入错误，则返回EOF并设置错误指示符( ferror )。

例1-输出到文件：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "w");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	fputc('0', pf);
	fputc('v', pf);
	fputc('0', pf);

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

例2-标准输出(到屏幕)-等于putchar函数的效果：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "w");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	fputc('0', stdout);
	fputc('v', stdout);
	fputc('0', stdout);

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

fgetc

该函数每次调用会从目标读取一个字符，程序运行中对同目标多次调用该函数会依次顺序读取:
-从流中获取字符，返回指定流的内部文件位置指示符当前指向的字符，然后内部文件位置指示器前进到下一个字符。

声明：

int fgetc ( FILE * stream );

stream：指向输入流的指针。

成功时，返回读取的字符的ascii码值（提升为int）。
返回类型为int，以适应表示失败的特殊值EOF：
-如果位置指示符位于文件末尾，则该函数返回EOF并设置流的eof 指示符（feof）。
-如果发生其他一些读取错误，该函数也会返回EOF，但会设置其错误指示符( ferror )。

例1-从文件输入：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "r");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	int ch = 1;
	while (ch!=EOF){
		ch = fgetc(pf);
		printf("%c\n", ch);
	}
	
	fclose(pf);
	pf = NULL;
	return 0;
}

被读取文件与输出结果：

例2-标准输入(从键盘)-等于getchar函数的效果：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	int ch = 1;
	while (ch!=EOF){
		ch = fgetc(stdin);
		printf("%c\n", ch);
	}
	return 0;
}

输入与输出结果：

fputs

将字符串写入流。

声明：

int fputs ( const char * str, FILE * stream );

str：带有要写入流的内容的C字符串。
stream：指向标识输出流的FILE对象的指针。

成功时，返回一个非负值。
出错时，该函数返回EOF并设置错误指示符( ferror )。

该函数从指定的地址(str)开始复制，直到到达终止空字符 (‘\0’)，此终止空字符不会复制到流中。
请注意，fputs与puts的不同不仅在于可以指定目标流，而且fputs不会写入额外的字符，而puts会自动在末尾附加一个换行符。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "w");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	fputs("不会自", pf);
	fputs("动换行", pf);

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

fgets

从指定的流读取一行，并把它存储在字符串内。程序运行中每次调用都会从指定数组的起始位置开始写入，会覆盖数组中之前的内容。若对同一文件连续多次调用，会从上一次读取到的位置向后读取直到遇到’\0’。

声明：

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

str：指向用于存储要读取的字符串的字符数组的指针。
num：要复制到str的最大字符数(包括’\0’),一般取str所指数组的尺寸：指定n个时，函数会在拷贝n-1个字符到目标数组后，在第n个字符的位置上放置’\0’。
stream：指向标识了要从中读取字符的流的指针。

成功时，函数返回str。
如果在尝试读取字符时遇到文件结尾，则设置eof指示符(feof)。
如果在读到字符前遇到文件结尾，则返回空指针(并且str的内容保持不变)。
如果发生读取错误，则设置错误指示符(ferror)并返回空指针(但str指向的内容可能已更改)。

该函数从流中读取字符并将它们作为C字符串存储到str中，直到 ( num -1) 个字符被读取或到达换行符或文件结尾，以先发生者为准。
换行符使fgets停止读取，但它被函数视为有效字符并包含在复制到str的字符串中。在复制到str的字符之后会自动附加一个终止空字符’\0’。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "r");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	int a = 4, b = 4;
	char arr[20] = { 0 };
	fgets(arr, a, pf);
	printf("%s\n", arr);
	fgets(arr, b, pf);
	printf("%s\n", arr);

	fclose(pf);
	pf = NULL;
	return 0;
}

当a=b=4 或a=4，b=6：

当a=b=3：

当a=6，b=4：

当a=3，b=6：

fwrite

将指定数组中的内容以二进制形式(注意不是文本形式)写入流。

声明：

size_t fwrite ( const void * ptr, size_t size, size_t count, FILE * stream );

ptr：指向要将其中内容写入流的内存块的指针，转换为const void*。
size：要写入的每个元素的大小（以字节为单位）。
count：元素的数量，每个元素的大小为size字节。
stream：指向指定输出流的FILE对象的指针。

返回成功写入的元素总数。
如果此数字与count参数不同，则写入错误会阻止函数完成。在这种情况下，将为流设置错误指示符( ferror ) 。 如果size或count为零，则该函数返回零，并且错误指示符保持不变。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

struct S{
	int n;
	double d;
	char name[10];
};

int main() {
	struct S s = { 114514,3.14,"abcdefg" };

	FILE* pf = fopen("data.txt", "wb");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	fwrite(&s,sizeof(s),1,pf);

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

以文本格式无法正常阅读，因为是以二进制形式写入的，可以用fread读取：

fread

将来自流的内容以二进制形式(注意不是文本形式)写入指定数组中。

声明：

size_t fread ( void * ptr, size_t size, size_t count, FILE * stream );

ptr：指向大小至少为(sizecount)字节的，用于存放来自流的内容的内存块的指针，转换为void。
size：要读取的每个元素的大小（以字节为单位）。
count：元素的数量，每个元素的大小为size字节。
stream：指向指定输入流的FILE对象的指针。

返回成功读取的元素总数。
如果此数字与count参数不同，则说明发生读取错误或读取时到达文件末尾。在这两种情况下，都设置了正确的指示符，可以分别使用ferror和feof进行检查。
如果size或count为零，则函数返回零，并且流状态和ptr指向的内容都保持不变。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

struct S{
	int n;
	double d;
	char name[10];
};

int main() {
	struct S s = { 0 };

	FILE* pf = fopen("data.txt", "rb");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	fread(&s,sizeof(s),1,pf);
	printf("%d %lf %s\n", s.n, s.d, s.name);

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

fprintf & fscanf

与printf的主要区别是多了一个stream参数,可以打印流。
将format指向 的 C 字符串写入流。如果format包含格式说明符（以%开头的子序列），则format后面的附加参数将被格式化并插入到结果字符串中，替换它们各自的说明符。

声明：

int fprintf ( FILE * stream, const char * format, ... );

stream：指向标识了输出流的FILE对象的指针，也就是需要打印的流的指针。
format：包含要写入流的文本的 C 字符串。
-它可以包含嵌入的 format 标签，format 标签可被随后的附加参数中指定的值替换，并按需求进行格式化。
-format 标签属性是 %[flags][width][.precision][length]specifier

fscanf与之类似，此处略。

常考点：对比以下函数

scanf：从标准输入(键盘)读取格式化的数据
fscanf：从任意输入流(包括标准输入)读取格式化的数据
sscanf：将存放在内存块中的字符串转换成格式化的数据，并输出到流中

printf：输出格式化的数据到标准输出(屏幕)
fprintf：输出格式化的数据到任意输出流(包括标准输出)
sprintf：将流中格式化的数据转化为对应的字符串，并输出到存放字符串的内存块(字符数组)中

文件的随机读写

fseek

将与流关联的位置指示器设置为新位置。

声明：

int fseek ( FILE * stream, long int offset, int origin );

stream：指向标识流的FILE对象的指针。
offset：
-二进制文件：从origin偏移的字节数。
-文本文件：零或ftell返回的值。
origin：用作偏移参考的位置，
它由中定义的以下常量之一指定，专门用作此函数的参数：

*允许库实现无意义地支持SEEK_END（因此，使用它的代码没有真正的标准可移植性）。

如果成功，该函数返回零。
否则，它返回非零值。
如果发生读取或写入错误，则会设置错误指示符( ferror )。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "r");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	int ch = fgetc(pf);
	printf("%c\n", ch);

	fseek(pf, 4, SEEK_SET);
	ch = fgetc(pf); //fgetc调用后，内部文件位置指示器前进到下一个字符
	printf("%c\n", ch);

	fseek(pf, -4, SEEK_CUR);//之前位置指示器到了f，因此当前位置-4会是b
	ch = fgetc(pf);
	printf("%c\n", ch);

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

ftell

获取文件指针相对于起始位置的偏移量

声明：

long int ftell ( FILE * stream );

stream：指向标识流的FILE对象的指针。

成功时，返回位置指示器的当前值。
失败时，返回-1L（注意是长整型），并将errno设置为系统特定的正值。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "r");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	printf("%ld\n", ftell(pf));

	fseek(pf, 4, SEEK_SET);
	printf("%ld\n", ftell(pf));

	int ch = fgetc(pf); //fgetc调用后，内部文件位置指示器前进到下一个字符
	printf("%c\n", ch);

	printf("%ld\n", ftell(pf));
	

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

rewind

将与流关联的位置指示符设置为文件的开头(复位)。
成功调用此函数后，与流关联的文件结尾和错误内部指示符将被清除，并且先前调用ungetc对该流的所有影响都将被删除。

声明：

void rewind ( FILE * stream );

stream：指向标识流的FILE对象的指针。

例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

int main() {
	FILE* pf = fopen("data.txt", "r");
	if (pf == NULL) {
		perror("fopen");
		return -1;
	}

	printf("%ld\n", ftell(pf));

	fseek(pf, 4, SEEK_SET);
	printf("%ld\n", ftell(pf));

	rewind(pf);
	printf("%ld\n", ftell(pf));
	

	fclose(pf);
	pf = NULL;
	return 0;
}

结果：

文件读取结束的判定

根据函数的返回值判断是否遇到文件末尾：
文本文件读取是否结束，判断返回值是否为 EOF，或者 NULL：
-fgetc：判断是否为 EOF .
-fgets：判断返回值是否为 NULL .
二进制文件的读取结束判断：判断返回值是否小于实际要读的个数。
-fread：判断返回值是否小于实际要读的个数。

feof

测试给定的流的文件结束标识符。
注意：
在文件读取过程中，不能用feof函数的返回值直接判断文件是否结束（常见误区）。
feof的作用是：当函数读取文件结束返回EOF时，判断是读取失败结束，还是遇到文件尾结束。

声明：

int feof ( FILE * stream );

stream：指向标识流的FILE对象的指针。

如果设置了与流关联的文件结束指示符 ，则返回非零值。
否则，返回零。

文本文件例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>
#include <stdlib.h>

int main()
{
	int c; // 为便于处理EOF而使用int类型声明字符变量
	FILE* fp = fopen("data.txt", "r");
	if (!fp) {
		perror("fopen");
		return EXIT_FAILURE;
	}
	//fgetc读取失败时或遇到文件末尾时，都会返回EOF
	while ((c = fgetc(fp)) != EOF) {
		putchar(c);
	}
	//判断结束原因
	if (ferror(fp))
		puts("I/O error when reading");
	else if (feof(fp))
		puts("End of file reached successfully");
	fclose(fp);

	return 0;
}

二进制文件例：

#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>

#define SIZE 5 

int main(){
	double a[SIZE] = { 1.,2.,3.,4.,5. };
	FILE* fp = fopen("test.bin", "wb");
	fwrite(a, sizeof * a, SIZE, fp); //写double的数组
	fclose(fp);

	double b[SIZE];
	fp = fopen("test.bin", "rb");
	size_t ret_code = fread(b, sizeof * b, SIZE, fp); //读double的数组
	if (ret_code == SIZE) {
		puts("Array read successfully, contents: ");
		for (int n = 0; n < SIZE; ++n) printf("%f ", b[n]);
		putchar('\n');
	}
	else { //错误处理
		if (feof(fp))
			printf("Error reading test.bin: unexpected end of file\n");
		else if (ferror(fp)) {
			perror("Error reading test.bin");
		}
	}
	fclose(fp);
	fp = NULL;

	return 0;
}

文件缓冲区

-ANSIC 标准采用“缓冲文件系统”处理的数据文件的。
-缓冲文件系统是指系统自动地在内存中为程序中每一个正在使用的文件开辟一块“文件缓冲区”。
-从内存向磁盘输出数据会先送到内存中的缓冲区，装满缓冲区后才一起送到磁盘上。
-如果从磁盘向计算机读入数据，则从磁盘文件中读取数据输入到内存缓冲区（充满缓冲区），然后再从缓冲区逐个地将数据送到程序数据区（程序变量等）。
-缓冲区的大小根据C编译系统决定的。

因为有缓冲区的存在，C语言在操作文件时，需要刷新缓冲区或者在文件操作结束的时候关闭文件，如果不做，可能导致读写文件的问题。

例：

//VS2022 WIN10环境测试
#define _CRT_SECURE_NO_WARNINGS 1
#include <stdio.h>
#include <windows.h>

int main(){
	FILE* pf = fopen("test.txt", "w");
	fputs("abcdef", pf);//将代码放在输出缓冲区
	printf("睡眠5秒-已写数据，此时test.txt中没有内容\n");
	Sleep(5000);
	printf("刷新缓冲区\n");
	fflush(pf);//刷新缓冲区时，才将输出缓冲区的数据写到文件(磁盘)
	printf("再睡眠5秒-此时，再次打开test.txt文件，文件有内容了\n");
	Sleep(5000);
	fclose(pf);//fclose在关闭文件时也会刷新缓冲区
	pf = NULL;
	return 0;
}