C++工业级软件架构设计之文件路径管理

通常来说,我们要为一个应用程序提供各种资源,比如配置文件、作为插件的动态链接库文件、样式表文件等。为了保证有一个清晰明了的应用程序目录结构,我们需要把这些文件在目录中有效组织。

Root
   |--- Application.exe
   |--- Plugins
         |--- plugin1.dll
         |--- plugin2.dll
   |--- Config
         |--- AppConfig.ini
         |--- AnotherConfig.ini
   |--- Resources
         |--- Images
         |--- Icons
         |--- StyleSheet

应用程序在初始化过程中,需要读取配置文件来进行初始化, 比如恢复上次关闭时的UI状态。 这个动作一般发生在程序最开始。 如果应用程序使用 Qt 框架开发,这个过程一般发生在 QApplication对象被构造之前。

int main(int argc, char** argv)
{
    Configuration::get().init();    

    QApplication app(argc, argv);

    return app.exec();
}

为了读取配置文件,我们需要先获得应用程序此时的路径信息, 再确定配置文件存放的位置。因为这个过程早于QApplication的构造,所以不能使用QCoreApplication::applicationFilePath()之类的API来获取。 所以我们需要自己组织数据结构,来进行这项工作。

首先,需要设计一个单例类Configuration,在这个类中保存所有需要用到的路径。这个对象的生命周期需要明确指出,因为要确保配置信息是最先被初始化的。

class Configuration
{
    using Self = Configuration;
public:
    void init()
    {
        // 初始化路径变量
        Self::initializeDirs();
        // TODO: 初始化配置信息
        
    }
    static Configuration& get() 
    {
        return *getPtr();
    }

    static Configuration* getPtr()
    {
        static Configuration g_configuration;
        return &g_configuration;
    }

private:
    Configuration()=default;
    ~Configuration()=default;

private:
    void initializeDirs()
    {
        // TODO: 初始化所有 Path 
    }
};

我们在经典的Singleton模式上增加一个init()Api, 这是把初始化语义从构造函数中分离出来。 因为经典的Singleton模式中,对象的初始化是在第一次调用get()时进行的。 程序规模变大后,代码中到处充斥着get(),便很难确定对象是何时初始化的。
在我们的程序中,如果你想确定configuration对象的初始化时间, 在项目中直接搜索Configuration::get().init();即可。

我同时使用了一个using增强了语义,你一看到代码,就知道initializeDirs()这个函数,是Configuration类的成员函数。这在多级继承中非常有效,我会专门开一贴来讲这个做法带来的好处。

假设我们的程序需要读取配置文件, 配置文件存放在./Config目录下。为了读取文件,我们需要修改当前的类。代码如下

#include <Windows.h>
#include <pathcch.h>
class Configuration
{
   ...
private:
    void initializeDirs()
    {
        int ret = 0;

        // 获取应用程序目录
        ret = ::GetModuleFileName(NULL, EXE_DIR, MAX_PATH);
        if (ret != 0)
        {
            ::OutputDebugString(TEXT("Fail to get .exe file path.");
            return;
        }
        
        // 去掉.exe后缀
        ret = ::PathCchRemoveFileSpec(EXE_DIR, MAX_PATH);
        if (ret != 0)
        {
            ::OutputDebugString(TEXT("Fail to get .exe file directory.");
            return;
        }
        
        // 初始化 配置文件目录 和 Style Sheet 目录
        ::swprintf(INI_DIR, TEXT(%s\\Config\\), EXE_DIR);
        ::swprintf(RESOURCE_DIR, TEXT(%s\\Resource\\StyleSheet\\), EXE_DIR);
    }
    
    const TCHAR* exeDir() const           { return EXE_DIR;      }
    const TCHAR* iniDir() const           { return INI_DIR;      }
    const TCHAR* resourceDir() const      { return RESOURCE_DIR; }

private:
    static const TCHAR EXE_DIR[MAX_PATH];
    static const TCHAR INI_DIR[MAX_PATH];
    static const TCHAR RESOURCE_DIR[MAX_PATH];
};

注意, 为了使用PathCchRemoveFileSpec这个Api,需要在静态链接选项里引入pathcch.lib

这里使用了C语言和Windows Api,简洁高效快速。为了保证这三个变量是只读的,我们只开放出读取Getter, 也没有提供Setter。

接下来我们开始读取文件。在init()函数中新增一个函数调用。

class Configuration
{
    // ...
public:
    void init()
    {
        // 初始化路径变量
        Self::initializeDirs();
        // 初始化配置信息
        Self::initializeConfiguration();
    }
private:
    void initializeConfiguration()
    {
        TCHAR pathBuf[MAX_PATH] = {0};
        const TCHAR* dir= iniDir();
        ::swprintf(pathBuf, TEXT("%sAppConfig.ini"), dir);

        // 读取配置文件
        // ::getPrivateProfileString(..., pathBuf);
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,699评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,124评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,127评论 0 358
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,342评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,356评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,057评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,654评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,572评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,095评论 1 318
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,205评论 3 339
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,343评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,015评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,704评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,196评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,320评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,690评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,348评论 2 358

推荐阅读更多精彩内容