C++文件操作详解，实用文件辅助类源码分享，建议收藏自用！

Posted 2021-07-07 CodeBowl

学习C++的小伙伴，应该会经常遇见对文件进行操作的需求，例如读写文件，作为一个使用频率较高的操作，我们每次重复地编写代码，就是浪费劳动力了，所以作者将自己常用的文件操作封装成了一个类，需要的小伙伴自取哦，喜欢的小伙伴刻个给博主一个关注嗷！
文末附源码，可直接使用。

使用的文件操作函数为C标准库<stdio.h>的函数。主要实现打开、关闭、刷新、读写文件；获得文件名、路径、大小；寻找文件起始和结束等操作。

文件操作

• 功能实现详解
• • 打开文件
  • • fopen参数说明
  • 关闭文件
  • 刷新文件
  • 读文件
  • • 读文件字符串
  • 写文件
  • 获得文件大小
  • 其他操作
• 源码
• 小结

功能实现详解

打开文件

对文件进行读写操作的第一步就是打开文件。

该函数使用说明
参数1：文件名
参数2：打开模式
返回值：BOOL类型，是否打开成功。

bool MyFile::Open(const char* szFilename, const char* mode)
{
    Close();//关闭文件，这里如果有上次打开的文件，先进行关闭
    pString = new char[LINE_LEN + 1];
    mFilename = new char[strlen(szFilename) + 1];  // char* mFilename;
    strcpy(mFilename, szFilename);
    pFile = fopen(mFilename, mode);//按照指定的模式打开指定文件
    return pFile == NULL ? 0 : 1;
}

我们这里使用fopen()函数打开文件。其功能是使用给定的模式 mode 打开 filename 所指向的文件。文件顺利打开后，指向该流的文件指针就会被返回。如果文件打开失败则返回NULL，并把错误代码存在 error 中。该函数位于C 标准库<stdio.h>中。

FILE *fopen(const char *filename, const char *mode);
参数
filename-- 这是 C 字符串，包含了要打开的文件名称。
mode-- 这是 C 字符串，包含了文件访问模式。
功能
使用给定的模式mode打开filename所指向的文件。

fopen参数说明

参数mode字符串包含了文件访问模式，欲打开的文件路径及文件名，参数 mode 字符串则代表着流形态。

关闭文件

该函数使用说明
无参数
无返回值

关闭文件很简单，如果文件名存在，因为我们之前new动态申请，所以需要先delete释放内存，并赋值为空。
文件指针FILE* pFile存在的话，就使用函数fclose()直接关闭，并赋值空。

void MyFile::Close()
{

    if(mFilename)
    {
	delete mFilename;
	mFilename = NULL;
    }
    if(pFile)
    {
        fclose(pFile);
        pFile = NULL;
    }
    if(pString)
    {
	delete pString;
	pString = NULL;
    }
}

刷新文件

该函数使用说明
无参数
无返回值

使用库函数fflush()。

fflush是一个在C语言标准输入输出库中的函数，功能是冲洗流中的信息，该函数通常用于处理磁盘文件。fflush()会强迫将缓冲区内的数据写回参数stream 指定的文件中。

void MyFile::Flush()
{
    if(pFile == NULL)
        return;
    fflush(pFile);
}

读文件

该函数使用说明
参数1：读取文件到缓存区pBuffer，需要提前申请
参数2：需要读取的长度
返回值：读取文件长度

ULONG MyFile::Read(void* pBuffer, int size)
{
    if(pBuffer == NULL || size == 0)
        return 0;
    if(pFile == NULL)
        return 0;
    return fread(pBuffer, 1, size, pFile);
}

主要函数fread( void * buffer , size_t size , size_t count , FILE * stream );

fread是一个函数，是计算机程序中从一个文件流中读数据，最多读取count个元素，每个元素size字节，如果调用成功返回实际读取到的元素个数，如果不成功返回 0。

参数即返回值说明：

参 数
　　buffer

　　用于接收数据的内存地址,大小至少是 size* count字节.

　　size

　　单个元素的大小，单位是字节

　　count

　　元素的个数,每个元素是size字节.

　　stream

　　输入流

返回值
　　实际读取的元素个数.如果返回值与 count不相同,则可能文件结尾或发生错误.

　　从ferror和feof获取错误信息或检测是否到达文件结尾.

读文件字符串

首先确认文件是否为空，然后判断参数长度是否大于行长；然后使用fgets()读取字符串。

fgets，是C语言中从文件中获取字符串函数。从文件结构体指针stream中读取数据，每次读取一行。读取的数据保存在buf指向的字符数组中，每次最多读取bufsize-1个字符（第bufsize个字符赋’\\0’），如果文件中的该行，不足bufsize个字符，则读完该行就结束。函数成功将返回buf，失败或读到文件结尾返回NULL。因此我们不能直接通过fgets的返回值来判断函数是否是出错而终止的，应该借助feof函数或者ferror函数来判断。

bool MyFile::ReadString(char* szBuffer, int size)
{
    if(szBuffer == NULL || size == 0 || pFile == NULL)
        return false;
    int len = size > LINE_LEN ? LINE_LEN : size;
    if(!fgets(szBuffer, len, pFile))
	return false;
    if('\\n' == szBuffer[strlen(szBuffer)-1])
	{
	    szBuffer[strlen(szBuffer)-1] = '\\0';
	}
    return true;
}

写文件

该函数使用说明
参数1：要写入文件的缓冲区
参数2：写入长度

void MyFile::Write(const void* pBuffer, int nCount)
{
    if(pBuffer == NULL || nCount == 0 || pFile == NULL)
        return;
    fwrite(pBuffer, 1, nCount, pFile);
}

主要实现函数fwrite()。

fwrite() 是 C 语言标准库中的一个文件处理函数，功能是向指定的文件中写入若干数据块，如成功执行则返回实际写入的数据块数目。该函数以二进制形式对文件进行操作，不局限于文本文件。

参数及使用说明

参数说明
ptr-- 这是指向要被写入的元素数组的指针。
size-- 这是要被写入的每个元素的大小，以字节为单位。
nmemb-- 这是元素的个数，每个元素的大小为 size 字节。
stream-- 这是指向 FILE 对象的指针，该 FILE 对象指定了一个输出流。


使用说明
size_t fwrite(const void* buffer, size_t size, size_t count, FILE* stream);

返回值：返回实际写入的数据块数目
（1）buffer：是一个指针，对fwrite来说，是要获取数据的地址；
（2）size：要写入内容的单字节数；
（3）count:要进行写入size字节的数据项的个数；
（4）stream:目标文件指针；
（5）返回实际写入的数据项个数count。

说明：写入到文件的哪里？ 这个与文件的打开模式有关，如果是w+，则是从file pointer指向的地址开始写，替换掉之后的内容，文件的长度可以不变，stream的位置移动count个数；如果是a+，则从文件的末尾开始添加，文件长度加大。
fseek对此函数有作用，但是fwrite函数写到用户空间缓冲区，并未同步到文件中，所以修改后要将内存与文件同步可以用fflush（FILE *fp）函数同步。[3]

获得文件大小

可以看到主要实现依靠乐俩个自实现函数，文件头和文件尾。

ULONG MyFile::GetFileSize()
{
    SeekToBegin();
    return SeekToEnd();
}

文件头：

void MyFile::SeekToBegin()
{
    if(pFile == NULL)
        return;
    fseek(pFile, 0L, SEEK_SET);
}

文件尾：

ULONG xFile::SeekToEnd()
{
    if(pFile == NULL)
        return 0;
    ULONG curpos = ftell(pFile);
    fseek(pFile, 0L, SEEK_END);
    return ftell(pFile) - curpos;
}

其他操作

ULONG MyFile::GetPosition() const 
{
    if(pFile == NULL)
        return 0;
    return ftell(pFile);
}
char* MyFile::GetFileName() const
{
    return mFilename;
}

char* MyFile::GetFileFmt() const
{
    if(mFilename == NULL)
        return NULL;
    char* ptr = strrchr(mFilename, '.');
    return ptr + 1;
}

源码

头文件·

#ifndef XFILE_H_INCLUDED
#define XFILE_H_INCLUDED
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
typedef unsigned long ULONG;
const int LINE_LEN = 1024;

class xFile
{
public:
    xFile();
    xFile(const char* szFilename, const char* mode);
    virtual ~xFile();

    virtual bool Open(const char* szFilename, const char* mode);
    virtual ULONG Read(void* pBuffer, int size);
    virtual bool ReadString(char* szBuffer, int size);
    virtual char* ReadString();
    virtual void Write(const void* pBuffer, int nCount);

    ULONG SeekToEnd();
    void SeekToBegin();
    virtual ULONG Seek(ULONG offset, int nFrom);
    virtual ULONG GetFileSize();
    virtual ULONG GetPosition() const;
    virtual char* GetFileName() const;
    virtual char* GetFileFmt() const;
    virtual void Flush();
    virtual void Close();
private:
    char* mFilename;
    char *pString;
    FILE* pFile;
};

#endif /*XFILE_H_INCLUDED*/

cpp文件

#include "xFile.h"

xFile::xFile()
{
    mFilename = NULL;
    pFile = NULL;
    pString = NULL;
}
xFile::~xFile()
{
    Close();
}


xFile::xFile(const char* szFilename, const char* mode)
{
    mFilename = NULL;
    pFile == NULL;
    pString = new char[LINE_LEN + 1];
    mFilename = new char[strlen(szFilename) + 1];
    strcpy(mFilename, szFilename);
    pFile = fopen(mFilename, mode);
}

bool xFile::Open(const char* szFilename, const char* mode)
{
    Close();
    pString = new char[LINE_LEN + 1];
    mFilename = new char[strlen(szFilename) + 1];
    strcpy(mFilename, szFilename);
    pFile = fopen(mFilename, mode);
    return pFile == NULL ? 0 : 1;
}
void xFile::Close()
{

    if(mFilename)
    {
	delete mFilename;
	mFilename = NULL;
    }
    if(pFile)
    {
        fclose(pFile);
        pFile = NULL;
    }
    if(pString)
    {
	delete pString;
	pString = NULL;
    }
}

ULONG xFile::Read(void* pBuffer, int size)
{
    if(pBuffer == NULL || size == 0)
        return 0;
    if(pFile == NULL)
        return 0;
    return fread(pBuffer, 1, size, pFile);
}
bool xFile::ReadString(char* szBuffer, int size)
{
    if(szBuffer == NULL || size == 0 || pFile == NULL)
        return false;
    int len = size > LINE_LEN ? LINE_LEN : size;
    if(!fgets(szBuffer, len, pFile))
	return false;
    if('\\n' == szBuffer[strlen(szBuffer)-1])
	{
	    szBuffer[strlen(szBuffer)-1] = '\\0';
	}
    return true;
}
void xFile::Write(const void* pBuffer, int nCount)
{
    if(pBuffer == NULL || nCount == 0 || pFile == NULL)
        return;
    fwrite(pBuffer, 1, nCount, pFile);
}

ULONG xFile::SeekToEnd()
{
    if(pFile == NULL)
        return 0;
    ULONG curpos = ftell(pFile);
    fseek(pFile, 0L, SEEK_END);
    return ftell(pFile) - curpos;
}

void xFile::SeekToBegin()
{
    if(pFile == NULL)
        return;
    fseek(pFile, 0L, SEEK_SET);
}
ULONG xFile::Seek(ULONG offset, int nFrom)
{
    if(pFile == NULL)
        return 0;
    return fseek(pFile, offset, nFrom);
}
ULONG xFile::GetFileSize()
{
    SeekToBegin();
    return SeekToEnd();
}

ULONG xFile::GetPosition() const 
{
    if(pFile == NULL)
        return 0;
    return ftell(pFile);
}
char* xFile::GetFileName() const
{
    return mFilename;
}

char* xFile::GetFileFmt() const
{
    if(mFilename == NULL)
        return NULL;
    char* ptr = strrchr(mFilename, '.');
    return ptr + 1;
}
void xFile::Flush()
{
    if(pFile == NULL)
        return;
    fflush(pFile);
}
char* xFile::ReadString()
{
	if(!ReadString(pString, LINE_LEN))
		return NULL;
	return pString;	
}

小结

本文总结了常用的文件操作，并使用c标准库函数实现，可以满足平常的使用需求，适合学生和初学者来使用，大大提升开发效率。

闲来无事，算上一卦