C++的库应该更好用

 不要重复造轮子！一遍一遍我们说着这样的话。可是为什么C/C++的API那么难用（尤其windows下的）。每次我们都把时间浪费在了实现简单逻辑而不是实现领域模型上了，其实，我们根本没有足够好的轮子。抛砖引玉，一个在windows下文件及文件夹操作的封装。 C++没有理由不能像python一样易用，至少某些库可以更洁一些。

common.h:

#ifndef __COMMON #define __COMMON #include <string> using namespace std; #define sz(a) ((int)a.size()) typedef basic_string<TCHAR> tstring; #endif

file.h

#ifndef _OS_FILE #define _OS_FILE #include "common.h" #include "folder.h" namespace OS { class Folder; /** * this class is design for easy file copy/move/remove/rename, * it is more for string operation * can not retrieve easy to use file handler, */ class File { public: friend class Folder; File(const File& file); File(tstring fullPath);// or relative path void setFullPath(const tstring& fullPath); tstring getFullPath(); tstring getRelativePath(const tstring& base); tstring getSuffix(); tstring getName(); tstring getFullName(); long getFileSize(); OS::Folder getParentFolder(); bool isExist(); /** * create if not existed */ void create(); void remove(); void rename(const tstring& newName); void copy(const tstring& dest, bool overrideExisted = false); bool isCopying(); int getCopyDestSize(); int getCopyWholeSize(); protected: tstring fullPath; public: // copy status bool isCopy; BOOL isTryCancel; int copyDestSize; int copyWholeSize; }; /// end of File } /// end of namespace OS #endif

file.cpp

#include "stdafx.h" #include <cstdio> #include <algorithm> #include "file.h" #include "IOException.h" using namespace OS; namespace OS { File::File(const File& file) { this->fullPath = file.fullPath; } File::File(tstring path) { fullPath = path; } void File::setFullPath(const tstring& path) { fullPath = path; } tstring File::getFullPath() { return fullPath; } // todo: implement tstring File::getRelativePath(const tstring& base) { return _T(""); } tstring File::getSuffix() { tstring ret; int last = fullPath.size()-1; bool found = false; for (; last>=0; --last) { if (fullPath[last] == _T('.')) { found = true; break; } else if (fullPath[last] == _T('/') || fullPath[last] == _T('//')) { break; } else { ret.push_back(fullPath[last]); } } if (!found) ret = _T(""); std::reverse(ret.begin(), ret.end()); return ret; } tstring File::getName() { tstring fullName = getFullName(); tstring suffix = getSuffix(); return fullName.substr(0, fullName.size() - suffix.size()-1); } tstring File::getFullName() { tstring ret; int last = fullPath.size()-1; for (; last>=0; --last) { if (fullPath[last] == _T('/') || fullPath[last] == _T('//')) { break; } else { ret.push_back(fullPath[last]); } } reverse(ret.begin(), ret.end()); return ret; } long File::getFileSize() { long ret = -1; FILE* fGetSize = NULL; fGetSize = _tfopen(fullPath.c_str(), _T("rb")); if (fGetSize) { fseek(fGetSize, 0L, SEEK_END); ret =ftell(fGetSize); fclose(fGetSize); } return ret; } OS::Folder File::getParentFolder() { tstring fullName = getFullName(); Folder ret(fullPath.substr(0, fullPath.size() - fullName.size())); return ret; } bool File::isExist() { FILE* fp = NULL; fp = _tfopen(this->fullPath.c_str(), _T("r")); return fp != NULL; } /*may exsist a dir*/ void File::create() { // get Parent Folder OS::Folder parent = getParentFolder(); // create the folder if not exist if (!parent.isExist()) { try { parent.create(); } catch (...) { } } // create the file if possible FILE* fp = NULL; fp = _tfopen(fullPath.c_str(), "r"); if (fp == NULL) throw IOException(IOException::FILE_CANNOT_OPEN); } void File::remove() { int ret = ::_tremove(fullPath.c_str()); if (ret == -1) { throw IOException(IOException::FILE_CANNOT_CREATE); } } void File::rename(const tstring& newName) { int ret = ::_trename(getFullName().c_str(), newName.c_str()); if (ret == -1) { throw IOException(IOException::FILE_CANNOT_CREATE); } } DWORD CALLBACK copyProgress( LARGE_INTEGER TotalFileSize, // total file size, in bytes LARGE_INTEGER TotalBytesTransferred, // total number of bytes transferred LARGE_INTEGER StreamSize, // total number of bytes for this stream LARGE_INTEGER StreamBytesTransferred, // total number of bytes transferred for this stream DWORD dwStreamNumber, // the current stream DWORD dwCallbackReason, // reason for callback HANDLE hSourceFile, // handle to the source file HANDLE hDestinationFile, // handle to the destination file LPVOID lpData // passed by CopyFileEx ) { File* pThis = (File*)lpData; if (pThis) { pThis->copyDestSize = TotalBytesTransferred.LowPart; pThis->copyWholeSize = TotalFileSize.LowPart; } //Form1->ProgressBar1->Position = TotalBytesTransferred.LowPart /// TotalFileSize.LowPart * 100; return PROGRESS_CONTINUE; } void File::copy(const tstring& dest, bool overrideExisted) { this->isCopy = true; this->isTryCancel = FALSE; BOOL ret = TRUE; if (!overrideExisted) { if (!File(dest).isExist()) { ret = CopyFileEx(fullPath.c_str(), dest.c_str(), (LPPROGRESS_ROUTINE)copyProgress, this, (LPBOOL)&this->isTryCancel, COPY_FILE_FAIL_IF_EXISTS);// overide } } else { ret = CopyFileEx(fullPath.c_str(), dest.c_str(), (LPPROGRESS_ROUTINE)copyProgress, this, (LPBOOL)&this->isTryCancel, 0);// overide } this->isCopy = false; if (ret == FALSE) throw IOException(IOException::FILE_CANNOT_OPEN); } bool File::isCopying() { return this->isCopy; } int File::getCopyDestSize() { return this->copyDestSize; } int File::getCopyWholeSize() { return this->copyWholeSize; } }//end of namespace OS

folder.h

#ifndef _OS_FOLDER #define _OS_FOLDER #include <vector> #include "common.h" #include "file.h" namespace OS { class File; using namespace OS; class Folder { public: Folder(const Folder& file); Folder(tstring fullPath); void setFullPath(const tstring& fullPath); tstring getFullPath(); tstring getRelativePath(const tstring& base); tstring getName(); bool hasParent(); Folder getParentFolder(); vector<File> getFiles(const tstring& findOption = _T("")); vector<Folder> getFolders(const tstring& findOption = _T("")); bool isExist(); bool operator == (const Folder& rhs); void create(); void remove(); void copy(tstring& dest); bool isCopying(); int getCopyTotal(); int getCopyCur(); // share by both copy and remove File* getCurrentFile(); bool isRemoving(); int getRemoveTotal(); int getRemoveCur(); protected: tstring fullPath; public: // copy status bool isCopy; int copyTotal; int copyCur; // share by both copy and remove File* currentFile; // remove status bool isRemove; int removeTotal; int removeCur; }; } #endif

folder.cpp

#include "stdafx.h" #include <algorithm> #include <assert.h> #include <windows.h> #include <shlwapi.h> #include <direct.h> #include "folder.h" #include "IOException.h" using namespace OS; //#undef __Folder_FWD_DEFINED__ // ShlDisp.h, System file's macro vector<tstring> splitPath(const tstring& s) { vector<tstring> ret; tstring t; for (int i = 0; i < sz(s); ++i) { if (s[i] == '/' || s[i] == '//') { if (!t.empty()) ret.push_back(t); t=_T(""); } else { t.push_back(s[i]); } } if (!t.empty()) ret.push_back(t); return ret; } template<class T> void concate(vector<T>& a, vector<T>& b) { a.insert(a.end(), b.begin(), b.end()); } namespace OS { Folder::Folder(const Folder& f) { this->fullPath = f.fullPath; } Folder::Folder(tstring path) { fullPath = path; } void Folder::setFullPath(const tstring& path) { fullPath = path; } tstring Folder::getFullPath() { return fullPath; } // todo: implementation tstring Folder::getRelativePath(const tstring& base) { tstring ret; return ret; } tstring Folder::getName() { tstring ret; for (int i = sz(fullPath)-1; i >= 0; --i) { if (fullPath[i] == _T('//') || fullPath[i] == _T('/') ) { if (ret.size() != 0) { break; } } else { ret.push_back(fullPath[i]); } } reverse(ret.begin(), ret.end()); return ret; } bool Folder::hasParent() { Folder p = getParentFolder(); return p.fullPath.size() != 0; } Folder Folder::getParentFolder() { int len = sz(fullPath) - sz(getName()); if (_T('//') == (*fullPath.rbegin()) || _T('/') == (*fullPath.rbegin())) len--; return Folder(fullPath.substr(0,len)); } vector<File> Folder::getFiles(const tstring& findOption) { vector<File> files; //vector<Folder> folders = getFolder(); WIN32_FIND_DATA wfd; tstring path = fullPath; tstring wildCard; if ((*path.rbegin()) != _T('/') && (*path.rbegin()) != _T('//') ) { path += (_T("/")); wildCard = path + _T("*"); } HANDLE hFind=FindFirstFile(wildCard.c_str(),&wfd); if (hFind!=INVALID_HANDLE_VALUE) { BOOL bFind = TRUE; while (bFind) { if(wfd.cFileName[0] != '.') // . .. { tstring tmp = path + wfd.cFileName; if (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) { Folder f(tmp); concate(files, f.getFiles()); } else { //SetFileAttributes(tmp.c_str(),FILE_ATTRIBUTE_NORMAL); files.push_back(File(tmp)); //Ret = Ret && DeleteFile(Tmp.c_str()); } } bFind = FindNextFile(hFind,&wfd); } FindClose(hFind); } // get all the return files; } vector<Folder> Folder::getFolders(const tstring& findOption) { vector<Folder> folders; //vector<Folder> folders = getFolder(); //folders.push_back(*this); WIN32_FIND_DATA wfd; tstring path = fullPath; tstring wildCard; if ((*path.rbegin()) != _T('/') && (*path.rbegin()) != _T('//') ) { path += (_T("/")); wildCard = path + _T("*"); } HANDLE hFind=FindFirstFile(wildCard.c_str(),&wfd); if (hFind!=INVALID_HANDLE_VALUE) { BOOL bFind = TRUE; while (bFind) { if(wfd.cFileName[0] != '.') // . .. { tstring tmp = path + wfd.cFileName; if (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) { Folder f(tmp); folders.push_back(f); concate(folders, f.getFolders()); } } bFind = FindNextFile(hFind,&wfd); } FindClose(hFind); } // get all the return folders; } bool Folder::isExist() { return ::PathIsDirectory(fullPath.c_str()) ? true : false; } bool Folder::operator == (const Folder& rhs) { return this->fullPath == rhs.fullPath; } void Folder::create() { // test if the parent folder exist Folder f = *this; while (!f.isExist()) { if (f.hasParent()) { f = f.getParentFolder(); } else { throw IOException(IOException::FOLDER_CANNOT_CREATE); } } // from the folder create to the dest folder tstring suffix = fullPath.substr(f.fullPath.size(), fullPath.size() - f.fullPath.size()); vector<tstring> paths = splitPath(suffix); for (int i = 0; i < sz(paths); ++i) { TCHAR last = f.fullPath[f.fullPath.size()-1]; if ( last != _T('//') && last != _T('/')) f.fullPath += _T('/'); f.fullPath += paths[i]; int ret = _tmkdir(f.fullPath.c_str()); if (ret == -1) throw IOException(IOException::FOLDER_CANNOT_CREATE); } } void Folder::remove() { // remove all the files and folders, record the progress vector<File> files = getFiles(); vector<Folder> folders = getFolders(); isRemove = true; removeTotal = sz(files); removeCur = 0; for (int i = 0; i < sz(files); ++i) { files[i].remove(); currentFile = &files[i]; removeCur = i+1; SetFileAttributes(files[i].getFullPath().c_str(),FILE_ATTRIBUTE_NORMAL); DeleteFile(files[i].getFullPath().c_str()); } for (int i = 0; i < sz(folders); ++i) { RemoveDirectory(folders[i].fullPath.c_str()); } RemoveDirectory(fullPath.c_str()); currentFile = 0; isRemove = false; } /** * the dest is the folder contain source's subfolder */ void Folder::copy(tstring& dest) { vector<File> files = getFiles(); vector<Folder> folders = getFolders();// preorder assert(dest.size() > 0); if ((*dest.rbegin()) == _T('/') || (*dest.rbegin()) == _T('//') ) { dest.resize(dest.size() -1); } isCopy = true; copyTotal = sz(files); copyCur = 0; //CreateDirectory(dest.c_str(), FALSE); for (int i = 0; i < sz(folders); ++i) { int len = sz(folders[i].fullPath) - sz(fullPath); tstring append = folders[i].fullPath.substr(fullPath.size(), len); if (append[0] != _T('/') && append[0] != _T('//') ) append = _T("/") + append; Folder fd((dest+append).c_str()); fd.create(); // CopyDirectory(folders[i].fullPath.c_str(), dest + append); // CopyFile(dest.c_str(), FALSE); } for (int i = 0; i < sz(files); ++i) { int len = sz(files[i].fullPath) - sz(fullPath); tstring append = files[i].fullPath.substr(fullPath.size(), len); currentFile = &files[i]; copyCur = i+1; if (append[0] != _T('/') && append[0] != _T('//') ) append = _T("/") + append; files[i].copy(dest + append); } currentFile = 0; isCopy = false; } bool Folder::isCopying() { return isCopy; } int Folder::getCopyTotal() { return copyTotal; } int Folder::getCopyCur() { return copyCur; } File* Folder::getCurrentFile() { return currentFile; } bool Folder::isRemoving() { return isRemove; } int Folder::getRemoveTotal() { return removeTotal; } int Folder::getRemoveCur() { return removeCur; } }// end of OS

写的一个通用的库，其中getRelativePath还未实现，觉得暂时只能实现同一盘符下的相对路径，还没找到统一的方法。

其它的都是很常见的操作，删除啊，复制啊很方便，要在复制过程中显示进度条也很容易。

最后还有个IOException.h

#ifndef __IOEXCEPTION #define __IOEXCEPTION #include <exception> #include <string> using namespace std; class IOException : public exception { public: IOException(const string& s) : exception(s.c_str()) { } public: static string FILE_CANNOT_CHANGENAME; static string FILE_CANNOT_OPEN; static string FILE_CANNOT_CREATE; static string FOLDER_CANNOT_CREATE; // static string FOLDER_NOT_EXIST; // static string FILE_CANNOT_OPEN; }; #endif // .cpp string IOException::FILE_CANNOT_CHANGENAME = "File cannot change name!"; string IOException::FILE_CANNOT_OPEN = "File cannot be opened!"; string IOException::FILE_CANNOT_CREATE = "File cannot be created!"; string IOException::FOLDER_CANNOT_CREATE = "Folder cannot be created!";

 

还有什么是你能做的？我觉得下面几个都是突破口：

  1. Unit test, regexp: 这两个一个可以用cppunit，一个可以用boost库，都不错，真的不需要造轮子了。
  2. Http Related, SMTP Related(attach files) FTP：http可以做的事还很多，能轻易地用http模拟表单提交吗？能提交文件表单吗？支持SSL吗？如果不行，这些应该是网络库必须的啊（可以试着对curllib做一个封装），smtp和ftp应该都有类似的方向。
  3. Process Related(Module Related)：进程间共享数据，windows API参数多，维护起来麻烦，想想我们要干什么：找到叫某名字的共享空间，向其中写入或读出数据，有锁来保证读写，仅这些而已。 如果做的比较好，是不是连序列化也要一起做？这个要好好想想了。
  4. Thread Related：线程池，简单创建线程，这些都有文章可做
  5. OS version：有了vista之后，windows就更乱了，不同版本下的行为差得多，所以，要注意了。
  6. xml parser: 必须的。

 

嗯，实现这些类库代码并不多，因为大多数都是对库或系统api的封装。但是，一旦有了这些轮子，你就可以全心全力的关注你的业务逻辑，领域模型了。