【云备份】文件操作实用工具类设计

文章目录

为什么要单独设计文件工具类？
整体实现
- Filesize ——文件大小
- - stat接口
- LastMTime ——最后一次修改时间
- LastATime —— 最后一次访问时间
- FileName —— 文件名称
- GetPostLen ——获取文件指定位置指定长度的数据
- GetContnet —— 读取文件数据
- SetContent ——向文件中写入数据
- Compress —— 压缩
- UnCompress —— 解压缩
- firesystem手册使用
- Exists—— 判断文件是否存在
- CreateDirectory ——创建目录
- ScanDirectory ——返回指定文件夹中所有的文件路径名称
整体代码
- util.hpp
- makefile
- cloud.cpp (测试代码)

为什么要单独设计文件工具类？

由于在客户端和服务器端中都涉及到文件的读写
所以要先设计封装文件操作类，当该类设计好后对文件的操作时就会变的简单化

功能：
1. Filesize 获取文件的大小
2. LastModTime 获取文件最后一次修改时间
3. LastAccessTime 获取文件最后一次访问时间
4. FileName 获取文件路径名中的文件名称
5. SetContent 向文件中写入数据
6. GetContnet 读取文件数据
7. GetPostLen 获取文件指定位置指定长度的数据
8. GetDirectory 返回指定文件夹中所有的文件路径名称
9. Exists 判断文件是否存在，若不存在则创建
10. CreateDirectory 创建目录
11. Compress 文件压缩
12. Uncompress 文件解压缩

整体实现

创建一个 util.hpp
在其内部创建一个 cloud 命名空间
在cloud中，创建一个FileUtil类
在私有权限中，设置一个 _filename 整体文件名称(可能包含文件路径)

Filesize ——文件大小

stat接口

stat 通过文件的路径名称访问文件，获取文件的状态属性信息，再放入到buf中
若返回小于0，则表示访问失败

stat结构体中包含的属性最主要的有
st_size(文件大小)
st_atime(文件最后一次访问时间)
st_mtime(文件最后一次修改时间)

若访问文件失败，则打印 get file size failed
若访问成功，则返回 stat类型结构体的 st_size 即可表示文件大小

LastMTime ——最后一次修改时间

同样使用stat函数，若返回值小于0则说明访问失败返回 get fire size faied
若访问成功，则返回 stat结构体的 st_mtime 即可表示文件最后一次修改时间

LastATime —— 最后一次访问时间

使用stat函数，若返回值小于0则说明访问失败返回 get fire size faied
若访问成功，则返回 stat结构体的 st_atime 即可表示文件最后一次访问时间

FileName —— 文件名称

路径之间都是以 / 来进行间隔的
所以只需找到最后一个 / ，从该/ 开始的下一个位置开始就是文件名的起始位置

string 中的 find_last_of()函数可以用来查找某个字符最后一次出现的位置

若没有找到 / ,则表示 filename 就为文件名称

若找到/ ，则从 /的下一个位置开始截断直到文件末尾，将子串整体作为文件名称返回

GetPostLen ——获取文件指定位置指定长度的数据

获取文件是要从文件中读取数据所以使用 ifstream 类型
ios::binary 表示二进制
所以以二进制的形式打开 _filename 文件
若打开文件失败，则打印 open file failed

若打开文件成功，还需判断下pos位置是否超过文件的整体大小
若超过文件整体大小，则返回 false

使用 seekg 跳转到文件pos位置
调整body的大小为文件大小len
将文件数据放入 body中
若读取出错，则返回false

GetContnet —— 读取文件数据

先通过FileSize 获取文件大小
再通过调用 GetPostLen 函数即可读取到整个文件的数据

SetContent ——向文件中写入数据

写入文件数据就为输入所以使用 ofstream 类型
使用二进制的方式打开文件 filename
打开失败，则返回false

将body数据写入到文件中
若写入失败，则返回false

Compress —— 压缩

将filename的文件内容全部读取到 body中
若读取失败，则返回 false

选择 LZIP 压缩格式，body作为文件内容，使用 pack 进行压缩，返回值就是压缩之后的数据

通过packname实例化一个新对象 fu
再将压缩的数据 packed 读取到文件中
若写入失败，则返回false
若写入成功，则返回true

UnCompress —— 解压缩

将filename的文件内容全部读取到 body中
若读取失败，则返回 false

将body中的文件内容进行解压缩

通过filename实例化一个新对象 fu
再将解压缩的数据 unpacked 读取到文件中
若写入失败，则返回false
若写入成功，则返回true

firesystem手册使用

在C++17中支持的一个文件系统 filesystem 完成目录的遍历操作

点击查看：firesystem手册地址

打开文档后向下翻

找到 create_directory 创建目录(单层级)
create_directories 创建目录(多层级)

只需传入目录的路径名即可

exists 文件是否存在

将文件名传入即可

遍历目录的迭代器 directory_iterator

Exists—— 判断文件是否存在

fs作为文件系统的命名空间

调用 filesystem手册中的 exists 接口传入文件名即可达到判断文件是否存在的作用

CreateDirectory ——创建目录

如果不存在就创建，如果存在就不需要创建了
调用 filesystem手册中的 create_directories 接口传入目录的路径名即可达到创建目录的作用

ScanDirectory ——返回指定文件夹中所有的文件路径名称

需要先判断，在遍历的过程中，是否为文件，若不为文件，则不进行操作

借助firesystem手册中的 is_directory 作用为判断是否是一个目录

将文件名传入即可

迭代器的返回数据不是一个 string 类型
所以当要添加文件时不能直接向arry中添加 p

借助firesystem手册中的 path 类进行实例化一个path对象

想要返回文件的相对路径，所以借助path类中的 relative_path

最终为获取带有路径的文件名中的 string 对象

整体代码

util.hpp

#include<iostream>
#include<fstream>
#include<string>
#include<vector>
#include<sys/stat.h>
#include"bundle.h"
#include<experimental/filesystem>

namespace cloud
{
  namespace fs=std::experimental::filesystem;

 class FileUtil
 {
  private:
          std::string _filename;//文件名称
  public:
          FileUtil(const std::string &filename):_filename(filename)//构造函数 
          {}
 
          int64_t FileSize()//文件大小
          {
            struct stat st;
           if( stat(_filename.c_str(),&st)<0)
           {
              std::cout<<"get file size failed!\n";	
              return -1;
           }
           return st.st_size;           
          }

          time_t  LastMTime()//文件最后一次修改时间
          {
           struct stat st;
           if( stat(_filename.c_str(),&st)<0)
           {
              std::cout<<"get file size failed!\n";
              return -1;
           }  
           return st.st_mtime; 
          }
           
          time_t  LastATime()//文件最后一次访问时间
          {
           struct stat st;
           if( stat(_filename.c_str(),&st)<0)
           {
              std::cout<<"get file size failed!\n";
              return -1;
           }
           return st.st_atime;
          }

          std::string FileName()//文件名称
          {
            // ./abc/test.txt
            size_t pos=_filename.find_last_of("/");
            if(pos==std::string::npos)
            {
             return _filename;
            }
            return _filename.substr(pos+1);
          }
         bool GetPostLen(std:: string *body,size_t pos,size_t len)//获取文件数据
          {
             std::ifstream ifs;
             ifs.open(_filename,std::ios::binary);//以二进制方式打开文件
             if(ifs.is_open()==false)
             {
               std::cout<<"read file failed"<<std::endl;
               return false;
             }
             //打开成功，获取文件数据
             size_t fsize=this->FileSize();//获取文件大小
             if(pos+len>fsize)//若pos开始位置超过了文件大小
             {
               std::cout<<"get file len is error"<<std::endl;
               return false;
             }
             ifs.seekg(pos,std::ios::beg);//从文件起始位置偏移到pos位置处
             body->resize(len);
              ifs.read(&(*body)[0], len);//读取文件所有数据到 body中
 
             if(ifs.good()==false)//读取出错
             {
               std::cout<< "get file content fialed "<<std::endl;
               ifs.close();
               return false;
             }
             ifs.close();

              return true;
          }

          bool GetContent(std::string *body) //获取整体文件数据
          {
              size_t fsize=this->FileSize();//获取文件大小
              return GetPostLen(body,0,fsize);
          }                                       

          bool Setcontent(const std::string &body)//写入文件数据
          { 
            std::ofstream  ofs;
            ofs.open(_filename,std::ios::binary);  //以二进制方式打开文件
            if(ofs.is_open()==false)//打开失败
            {
              std::cout<<"write open file failed"<<std::endl;
              return false;
            }
            ofs.write(&body[0], body.size());//将body数据写入到文件中
            if(ofs.good()==false)//写入失败
            {
               std::cout<<"write file content failed"<<std::endl;
               ofs.close();  
               return false;
            }
            
             ofs.close();
             return true;
          }

          bool compress(const std::string &packname) //压缩
          {
             //读取文件数据
              std::string body;
              if(this->GetContent(&body)==false)
              {
                std::cout<<"compress get file content failed"<<std::endl;
                return false;
              } 
             //对数据进行压缩
             std::string packed=bundle::pack(bundle::LZIP,body);
             

             //将压缩数据存储到压缩包文件中
              FileUtil fu(packname);
              if(fu.Setcontent(packed)==false)//写入数据失败
              {
                std::cout<<"compress write packed data failed"<<std::endl;
                return false;
              }
            return true;
          }

          bool UnCompress(const std::string &filename)//解压缩
          {
              //将当前压缩包数据读取出来
              std::string body;
               if(this->GetContent(&body)==false)//获取文件内容
              {
                std::cout<<"compress get file content failed"<<std::endl;
                return false;
              } 
                            
              //对压缩的数据进行解压缩
              std::string unpacked=bundle::unpack(body);

              //将解压缩的数据写入到新文件中
               FileUtil fu(filename);
              if(fu.Setcontent(unpacked)==false)//写入数据失败
              {
                std::cout<<"uncompress write packed data failed"<<std::endl;
                return false;
              }
              return true;
          }

          bool Exists()//判断文件是否存在
          {
             return fs::exists(_filename);
          }

          bool CreateDirectory()//创建目录
          {
            if(this->Exists())
            {
              return true;
            }
             return fs::create_directories(_filename);
          }
 
          bool ScanDirectory(std::vector<std::string> * arry)//浏览目录
          {
             for (auto & p : fs::directory_iterator(_filename))//遍历目录
             {
               if(fs::is_directory(p)==true)//检测遍历到的文件 是一个文件夹 就不进行操作
               {
                  continue;
               }
               //普通文件才进行操作
               //relative_path 表示带有路径的文件名
               arry->push_back(fs::path(p).relative_path().string());
             }
              return true;
          }
  };
}

makefile

cloud:cloud.cpp  util.hpp bundle.cpp
	g++ $^ -o $@ -lpthread  -lstdc++fs
.PHONY:clean
clean:
	rm -f cloud

cloud.cpp (测试代码)

  #include"util.hpp"
  

  void 	FileUtilTest(const std::string &filename)
  {
    /*
    1.
    cloud::FileUtil fu(filename);
    std::cout<<fu.FileSize() <<std::endl;
    std::cout<<fu.LastMTime()<<std::endl;
    std::cout<<fu.LastATime()<<std::endl;
    std::cout<<fu.FileName() <<std::endl;
     2.
     // 将 filename 文件内容 全部读取到 body中
     cloud::FileUtil fu(filename);
     std::string body;
     fu.GetContent(&body);//读取文件数据
     
     //再将body中的数据内容 读取到文件中
      cloud::FileUtil nfu("./hello.txt");
      nfu.Setcontent(body); //将body写入文件中
      return;
     
     3.
     //将packname数据进行压缩 再将其进行解压 放入 hello.txt中
     std::string packname=filename +".lz";
     cloud::FileUtil fu(filename);
     fu.compress( packname);//将压缩的数据放入packname中
     cloud::FileUtil pfu( packname);
     pfu.UnCompress("./hello.txt");//将packname中的数据放入 hello.txt中
     return;
     */

     cloud::FileUtil fu(filename);
     fu.CreateDirectory();//创建目录
     std::vector<std::string>arry;
     fu.ScanDirectory(&arry);//浏览目录
     for(auto &a: arry)
     {
      std::cout<<a<<std::endl;
     }
     return;
}  
 
  
  int main(int argc,char*argv[])
  {
    FileUtilTest(argv[1]); 
    return 0;
  }