文件操作

1. 文件相关概念

1.1 文件的概念

一个文件通常就是磁盘上一段命名的存储区。但是对于操作系统来说，文件就会更复杂一些。例如，一个大文件可以存储在一些分散的区段中，或者还会包含一些操作系统可以确定其文件类型的附加数据，但是这些是操作系统，而不是我们程序员所要关心的事情。我们应该考虑如何在C程序中处理文件。

1.2 流的概念

流是一个动态的概念，可以将一个字节形象地比喻成一滴水，字节在设备、文件和程序之间的传输就是流，类似于水在管道中的传输，可以看出，流是对输入输出源的一种抽象，也是对传输信息的一种抽象。
C语言中，I/O操作可以简单地看作是从程序移进或移出字节，这种搬运的过程便称为流(stream)。程序只需要关心是否正确地输出了字节数据，以及是否正确地输入了要读取字节数据，特定I/O设备的细节对程序员是隐藏的。

1.2.1 文本流

文本流，也就是我们常说的以文本模式读取文件。文本流的有些特性在不同的系统中可能不同。其中之一就是文本行的最大长度。标准规定至少允许254个字符。另一个可能不同的特性是文本行的结束方式。例如在Windows系统中，文本文件约定以一个回车符和一个换行符结尾。但是在Linux下只使用一个换行符结尾。
标准C把文本定义为零个或者多个字符，后面跟一个表示结束的换行符\n.对于那些文本行的外在表现形式与这个定义不同的系统上，库函数负责外部形式和内部形式之间的翻译。例如，在Windows系统中，在输出时，文本的换行符被写成一对回车/换行符。在输入时，文本中的回车符被丢弃。这种不必考虑文本的外部形势而操纵文本的能力简化了可移植程序的创建。

1.2.2 二进制流

二进制流中的字节将完全根据程序编写它们的形式写入到文件中，而且完全根据它们从文件或设备读取的形式读入到程序中。它们并未做任何改变。这种类型的流适用于非文本数据，但是如果你不希望I/O函数修改文本文件的行末字符，也可以把它们用于文本文件。

c语言在处理这两种文件的时候并不区分，都看成是字符流，按字节进行处理。
我们程序中，经常看到的文本方式打开文件和二进制方式打开文件仅仅体现在换行符的处理上。
比如说，在widows下，文件的换行符是\r\n，而在Linux下换行符则是\n.
当对文件使用文本方式打开的时候，读写的windows文件中的换行符\r\n会被替换成\n读到内存中，当在windows下写入文件的时候，\n被替换成\r\n再写入文件。如果使用二进制方式打开文件，则不进行\r\n和\n之间的转换。 那么由于Linux下的换行符就是\n,所以文本文件方式和二进制方式无区别。

2. 文件的操作

2.1 文件流总览

标准库函数是的我们在C程序中执行与文件相关的I/O任务非常方便。下面是关于文件I/O的一般概况。

1. 程序为同时处于活动状态的每个文件声明一个指针变量，其类型为FILE*。这个指针指向这个FILE结构，当它处于活动状态时由流使用。
2. 流通过fopen()函数打开。为了打开一个流，我们必须指定需要访问的文件或设备以及他们的访问方式(读、写、或者读写)。fopen和操作系统验证文件或者设备是否存在并初始化FILE。
3. 根据需要对文件进行读写操作。
4. 最后调用fclose()函数关闭流。关闭一个流可以防止与它相关的文件被再次访问，保证任何存储于缓冲区中的数据被正确写入到文件中，并且释放FILE结构。

标准I/O更为简单，因为它们并不需要打开或者关闭。
I/O函数以三种基本的形式处理数据：单个字符、文本行和二进制数据。对于每种形式都有一组特定的函数对它们进行处理。

输入/输出函数家族

2.2 文件指针

文件是由操作系统管理的单元。当我们想操作一个文件的时候，让操作系统帮我们打开文件，操作系统把我们指定要打开文件的信息保存起来，并且返回给我们一个指针指向文件的信息。文件指针也可以理解为代指打开的文件。这个指针的类型为FILE类型。该类型定义在stdio.h头文件中。通过文件指针，我们就可以对文件进行各种操作。
对于每一个ANSI C程序，运行时系统必须提供至少三个流-标准输入(stdin)、标准输出(stdout)、标准错误(stderr)，它们都是一个指向FILE结构的指针。标准输入是缺省情况下的输入来源，标准输出时缺省情况下的输出设置。具体缺省值因编译器而异，通常标准输入为键盘设备、标准输出为终端或者屏幕。

ANSI C并未规定FILE的成员，不同编译器可能有不同的定义。VS下FILE信息如下：

struct _iobuf { 
        char  *_ptr;         //文件输入的下一个位置 
        int   _cnt;          //剩余多少字符未被读取
        char  *_base;        //指基础位置(应该是文件的其始位置) 
        int   _flag;         //文件标志 
        int   _file;         //文件的有效性验证 
        int   _charbuf;      //检查缓冲区状况,如果无缓冲区则不读取 
        int   _bufsiz;       //文件的大小 
        char  *_tmpfname;    //临时文件名 
}; 
typedef struct _iobuf FILE;

2.3 文件缓冲区

2.3.1 文件缓冲区是什么

ANSI C标准采用“缓冲文件系统”处理数据文件 所谓缓冲文件系统是指系统自动地在内存区为程序中每一个正在使用的文件开辟一个文件缓冲区从内存向磁盘输出数据必须先送到内存中的缓冲区，装满缓冲区后才一起送到磁盘去 如果从磁盘向计算机读入数据，则一次从磁盘文件将一批数据输入到内存缓冲区(充满缓冲 区)，然后再从缓冲区逐个地将数据送到程序数据区(给程序变量) 。

2.3.2 文件缓冲区的作用

如我们从磁盘里取信息，我们先把读出的数据放在缓冲区，计算机再直接从缓冲区中取数据，等缓冲区的数据取完后再去磁盘中读取，这样就可以减少磁盘的读写次数，再加上计算机对缓冲区的操作大大快于对磁盘的操作，故应用缓冲区可大大提高计算机的运行速度。

2.4 文件打开关闭

2.4.1 文件打开(fopen)

文件的打开操作表示将给用户指定的文件在内存分配一个 FILE 结构区，并将该结构的指针返回给用户程序，以后用户程序就可用此FILE指针来实现对指定文件的存取操作了。当使用打开函数时，必须给出文件名、文件操作方式(读、写或读写)。

FILE * fopen(const char * filename, const char * mode);

功能：打开文件
参数：

• filename：需要打开的文件名，根据需要加上路径
• mode：打开文件的权限设置

返回值：

• 成功：文件指针
• 失败：NULL

打开方式：

示例代码：

void test(){
    FILE *fp = NULL;
    // "\\"这样的路径形式，只能在windows使用
    // "/"这样的路径形式，windows和linux平台下都可用，建议使用这种
    // 路径可以是相对路径，也可是绝对路径
    fp = fopen("../test", "w");
    //fp = fopen("..\\test", "w");
    if (fp == NULL) //返回空，说明打开失败
    {
        //perror()是标准出错打印函数，能打印调用库函数出错原因
        perror("open");
        return -1;
    }
}

应该检查fopen()的返回值!如何函数失败，它会返回一个NULL值。如果程序不检查错误，这个NULL指针就会传给后续的I/O函数。它们将对这个指针执行间接访问，并将失败.

2.4.2 文件关闭(fclose)

文件操作完成后，如果程序没有结束，必须要用fclose()函数进行关闭，这是因为对打开的文件进行写入时，若文件缓冲区的空间未被写入的内容填满，这些内容不会写到打开的文件中。只有对打开的文件进行关闭操作时，停留在文件缓冲区的内容才能写到该文件中去，从而使文件完整。再者一旦关闭了文件，该文件对应的FILE结构将被释放，从而使关闭的文件得到保护，因为这时对该文件的存取操作将不会进行。文件的关闭也意味着释放了该文件的缓冲区。

int fclose(FILE * stream);

功能：关闭先前fopen()打开的文件。此动作让缓冲区的数据写入文件中，并释放系统所提供的文件资源。
参数：

• stream：文件指针
• 返回值：

返回值：

• 成功：0
• 失败：-1

它表示该函数将关闭FILE指针对应的文件，并返回一个整数值。若成功地关闭了文件，则返回一个0值，否则返回一个非0值.

2.5 文件读写函数

1. 按照字符读写文件：fgetc(), fputc()
2. 按照行读写文件：fputs(), fgets()
3. 按照块读写文件：fread(), fwirte()
4. 按照格式化读写文件：fprintf(), fscanf()
5. 按照随机位置读写文件：fseek(), ftell(), rewind()

2.5.1 字符读写函数

1. fputc()

   int fputc(int ch, FILE * stream);

   功能：将ch转换为unsigned char后写入stream指定的文件中
   参数：

   • ch：需要写入文件的字符
   • stream：文件指针

返回值：

• 成功：成功写入文件的字符
• 失败：返回-1

1. fgetc()

   int fgetc(FILE * stream);

   功能：从stream指定的文件中读取一个字符
   参数：

   • stream：文件指针

返回值：

• 成功：返回读取到的字符
• 失败：-1

1. feof()

   int feof(FILE * stream);

   功能：检测是否读取到了文件结尾
   参数：

   • stream：文件指针

返回值：

• 非0值：已经到文件结尾
• 0：没有到文件结尾

示例代码：

void test(){
    //写文件
    FILE* fp_write= NULL;
    //写方式打开文件
    fp_write = fopen("./mydata.txt", "w+");
    if (fp_write == NULL){
        return;
    }
    char buf[] = "this is a test for pfutc!";
    for (int i = 0; i < strlen(buf);i++){
        fputc(buf[i], fp_write);
    }
    fclose(fp_write);
    //读文件
    FILE* fp_read = NULL;
    fp_read = fopen("./mydata.txt", "r");
    if (fp_read == NULL){
        return;
    }
#if 0
    //判断文件结尾 注意：多输出一个空格
    while (!feof(fp_read)){
        printf("%c",fgetc(fp_read));
    }
#else
    char ch;
    while ((ch = fgetc(fp_read)) != EOF){
        printf("%c", ch);
    }
#endif
}

将把流指针fp指向的文件中的一个字符读出，并赋给ch，当执行fgetc()函数时，若当时文件指针指到文件尾，即遇到文件结束标志EOF(其对应值为-1)，该函数返回一个 -1 给ch，在程序中常用检查该函数返回值是否为 -1 来判断是否已读到文件尾，从而决定是否继续。

2.5.2 行读写函数

1. fputs()

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

   功能：将str所指定的字符串写入到stream指定的文件中， 字符串结束符 ‘\0’ 不写入文件。
   参数：

   • str：字符串
   • stream：文件指针

返回值：

• 成功：0
• 失败：-1

1. fgets()

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

   功能：从stream指定的文件内读入字符，保存到str所指定的内存空间，直到出现换行字符、读到文件结尾 或是已读了size -1个字符为止，最后会自动加上字符’\0’作为字符串结束。
   参数：

   • str：字符串
   • size：指定最大读取字符串的长度（size -1）
   • stream：文件指针

返回值：

• 成功：成功读取的字符串
• 读到文件尾或出错： NULL

示例代码：

void test(){
    //写文件
    FILE* fp_write= NULL;
    //写方式打开文件
    fp_write = fopen("./mydata.txt", "w+");
    if (fp_write == NULL){
        perror("fopen:");
        return;
    }
    char* buf[] = {
        "01 this is a test for pfutc!\n",
        "02 this is a test for pfutc!\n",
        "03 this is a test for pfutc!\n",
        "04 this is a test for pfutc!\n",
    };
    for (int i = 0; i < 4; i ++){
        fputs(buf[i], fp_write);
    }
    fclose(fp_write);
    //读文件
    FILE* fp_read = NULL;
    fp_read = fopen("./mydata.txt", "r");
    if (fp_read == NULL){
        perror("fopen:");
        return;
    }
    //判断文件结尾
    while (!feof(fp_read)){
        char temp[1024] = { 0 };
        fgets(temp, 1024, fp_read);
        printf("%s",temp);
    }
    fclose(fp_read);
}

2.5.3 块读写函数

1. fwrite()

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

   功能：以数据块的方式给文件写入内容
   参数：

   • ptr：准备写入文件数据的地址
   • size： size_t为 unsigned int类型，此参数指定写入文件内容的块数据大小
   • nmemb：写入文件的块数，写入文件数据总大小为：size * nmemb
   • stream：已经打开的文件指针

返回值：

• 成功：实际成功写入文件数据的块数，此值和nmemb相等
• 失败：0

1. fread()

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

   功能：以数据块的方式从文件中读取内容
   参数：

   • ptr：存放读取出来数据的内存空间
   • size： size_t为 unsigned int类型，此参数指定读取文件内容的块数据大小
   • nmemb：读取文件的块数，读取文件数据总大小为：size * nmemb
   • stream：已经打开的文件指针

返回值：

• 成功：实际成功读取到内容的块数，如果此值比nmemb小，但大于0，说明读到文件的结尾。
• 失败：0

示例代码：

typedef struct _TEACHER{
    char name[64];
    int age;
}Teacher;
void test(){
    //写文件
    FILE* fp_write= NULL;
    //写方式打开文件
    fp_write = fopen("./mydata.txt", "wb");
    if (fp_write == NULL){
        perror("fopen:");
        return;
    }
    Teacher teachers[4] = {
        { "Obama", 33 },
        { "John", 28 },
        { "Edward", 45},
        { "Smith", 35}
    };
    for (int i = 0; i < 4; i ++){
        fwrite(&teachers[i],sizeof(Teacher),1, fp_write);
    }
    //关闭文件
    fclose(fp_write);
    //读文件
    FILE* fp_read = NULL;
    fp_read = fopen("./mydata.txt", "rb");
    if (fp_read == NULL){
        perror("fopen:");
        return;
    }
    Teacher temps[4];
    fread(&temps, sizeof(Teacher), 4, fp_read);
    for (int i = 0; i < 4;i++){
        printf("Name:%s Age:%d\n",temps[i].name,temps[i].age);
    }
    fclose(fp_read);
}

2.5.4 格式化读写函数

1. fprintf()

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

   功能：根据参数format字符串来转换并格式化数据，然后将结果输出到stream指定的文件中，指定出现字符串结束符 ‘\0’ 为止。
   参数：

   • stream：已经打开的文件
   • format：字符串格式，用法和printf()一样

返回值：

• 成功：实际写入文件的字符个数
• 失败：-1

1. fscanf()

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

   功能：从stream指定的文件读取字符串，并根据参数format字符串来转换并格式化数据。
   参数：

   • stream：已经打开的文件
   • format：字符串格式，用法和scanf()一样

返回值：

• 成功：实际从文件中读取的字符个数
• 失败： -1

注意：fscanf遇到空格和换行时结束。

示例代码：

void test(){
    //写文件
    FILE* fp_write= NULL;
    //写方式打开文件
    fp_write = fopen("./mydata.txt", "w");
    if (fp_write == NULL){
        perror("fopen:");
        return;
    }
    fprintf(fp_write,"hello world:%d!",10);
    //关闭文件
    fclose(fp_write);
    //读文件
    FILE* fp_read = NULL;
    fp_read = fopen("./mydata.txt", "rb");
    if (fp_read == NULL){
        perror("fopen:");
        return;
    }
    char temps[1024] = { 0 };
    while (!feof(fp_read)){
        fscanf(fp_read, "%s", temps);
        printf("%s", temps);
    }
    fclose(fp_read);
}

2.5.5 随机读写函数

1. fseek()

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

   功能：移动文件流（文件光标）的读写位置。
   参数：

   • stream：已经打开的文件指针
   • offset：根据whence来移动的位移数（偏移量），可以是正数，也可以负数，如果正数，则相对于whence往右移动，如果是负数，则相对于whence往左移动。如果向前移动的字节数超过了文件开头则出错返回，如果向后移动的字节数超过了 文件末尾，再次写入时将增大文件尺寸。
   • whence：其取值如下：
     • SEEK_SET：从文件开头移动offset个字节
     • SEEK_CUR：从当前位置移动offset个字节
     • SEEK_END：从文件末尾移动offset个字节

返回值：

• 成功：0
• 失败：-1

1. ftell()

   long ftell(FILE *stream);

   功能：获取文件流（文件光标）的读写位置。
   参数：

   • stream：已经打开的文件指针

返回值：

• 成功：当前文件流（文件光标）的读写位置
• 失败：-1

1. rewind() ```c void rewind(FILE *stream);

功能：把文件流（文件光标）的读写位置移动到文件开头。<br />参数：
   - stream：已经打开的文件指针
返回值：
   - 无返回值
**示例代码：**
```c
typedef struct _TEACHER{
    char name[64];
    int age;
}Teacher;
void test(){
    //写文件
    FILE* fp_write = NULL;
    //写方式打开文件
    fp_write = fopen("./mydata.txt", "wb");
    if (fp_write == NULL){
        perror("fopen:");
        return;
    }
    Teacher teachers[4] = {
        { "Obama", 33 },
        { "John", 28 },
        { "Edward", 45 },
        { "Smith", 35 }
    };
    for (int i = 0; i < 4; i++){
        fwrite(&teachers[i], sizeof(Teacher), 1, fp_write);
    }
    //关闭文件
    fclose(fp_write);
    //读文件
    FILE* fp_read = NULL;
    fp_read = fopen("./mydata.txt", "rb");
    if (fp_read == NULL){
        perror("fopen:");
        return;
    }
    Teacher temp;
    //读取第三个数组
    fseek(fp_read , sizeof(Teacher) * 2 , SEEK_SET);
    fread(&temp, sizeof(Teacher), 1, fp_read);
    printf("Name:%s Age:%d\n",temp.name,temp.age);
    memset(&temp,0,sizeof(Teacher));
    fseek(fp_read, -(int)sizeof(Teacher), SEEK_END);
    fread(&temp, sizeof(Teacher), 1, fp_read);
    printf("Name:%s Age:%d\n", temp.name, temp.age);
    rewind(fp_read);
    fread(&temp, sizeof(Teacher), 1, fp_read);
    printf("Name:%s Age:%d\n", temp.name, temp.age);
    fclose(fp_read);
}

3. 文件读写案例

3.1 读写配置文件

配置文件格式如下：
正式的数据以‘:’冒号进行分割，冒号前为key起到索引作用，冒号后为value是实值。#开头的为注释，而不是正式数据

#英雄的Id
heroId:1
#英雄的姓名
heroName:德玛西亚
#英雄的攻击力
heroAtk:1000
#英雄的防御力
heroDef:500
#英雄的简介
heroInfo:前排坦克

示例代码：

struct ConfigInfo
{
    char key[64];
    char value[64];
};
//获取文件有效行数
int getFileLine(const char  * filePath)
{
    FILE * file = fopen(filePath, "r");
    char buf[1024] = {0};
    int lines = 0;
    while (fgets(buf,1024,file) != NULL)
    {
        if (isValidLine(buf))
        {
            lines++;
        }
        memset(buf, 0, 1024);
    }
    fclose(file);
    return lines;
}
//解析文件
void parseFile(const char  * filePath, int lines, struct ConfigInfo** configInfo)
{
    struct ConfigInfo * pConfig =  malloc(sizeof(struct ConfigInfo) * lines);
    if (pConfig == NULL)
    {
        return;
    }
    FILE * file = fopen(filePath, "r");
    char buf[1024] = { 0 };
    int index = 0;
    while (fgets(buf, 1024, file) != NULL)
    {
        if (isValidLine(buf))
        {
            //解析数据到struct ConfigInfo中
            memset(pConfig[index].key, 0, 64);
            memset(pConfig[index].value, 0, 64);
            char * pos = strchr(buf, ':');
            strncpy(pConfig[index].key, buf, pos - buf);
            // 从第二个单词开始截取字符串，并且不截取换行符
            strncpy(pConfig[index].value, pos + 1, strlen(pos + 1) - 1); 
            //printf("key = %s\n", pConfig[index].key);
            //printf("value = %s\n", pConfig[index].value);
            index++;
        }
        memset(buf, 0, 1024);
    }
    *configInfo = pConfig;
}
//获取指定的配置信息
char * getInfoByKey(char * key, struct ConfigInfo*configInfo ,int lines)
{
    for (int i = 0; i < lines;i++)
    {
        if (strcmp(key, configInfo[i].key) == 0)
        {
            return configInfo[i].value;
        }
    }
    return NULL;
}
//释放配置文件信息
void freeConfigInfo(struct ConfigInfo*configInfo)
{
    free(configInfo);
    configInfo = NULL;
}
//判断当前行是否为有效行
int isValidLine(char * buf)
{
    if (buf[0] == '0' || buf[0] == '\0' || strchr(buf,':') == NULL)
    {
        return 0;// 如果行无限 返回假
    }
    return 1;
}
int main(){
    char * filePath = "./config.txt";
    int lines = getFileLine(filePath);
    printf("文件有效行数为：%d\n", lines);
    struct ConfigInfo * config = NULL;
    parseFile(filePath, lines, &config);
    printf("heroId = %s\n", getInfoByKey("heroId", config, lines));
    printf("heroName: = %s\n", getInfoByKey("heroName", config, lines));
    printf("heroAtk = %s\n", getInfoByKey("heroAtk", config, lines));
    printf("heroDef: = %s\n", getInfoByKey("heroDef", config, lines));
    printf("heroInfo: = %s\n", getInfoByKey("heroInfo", config, lines));
    freeConfigInfo(config);
    config = NULL;
    system("pause");
    return EXIT_SUCCESS;
}