cocos2d-x开发: 一切应该从配置文件读取开始

想要做一款完整的游戏,应该从配置文件读取开始。cocos2d-x本身提供了UserDefault来操作xml格式的配置文件,准确的说配置这模块引擎开发者已经考虑到了.但是xml格式包含大量无关的格式信息,对于开发者直接使用编辑器操作也不是很友好.我期望的配置文件应该具备两个特点,第一：格式简单.这是我一贯的*nix风格的要求,我喜欢只管的#注释以及key-value的配置方式.可能唯一需要考虑的是这样简单的配置方式会不会因为业务扩展而显得功能不足.这一点是可以放心的,那些都是业务逻辑相关的,选择就会很多.至少现在不是应该考虑的范畴.第二:对开发者友好.什么叫做友好? 说白了,按照我的理解就是很容易可以定位配置信息的位置,容易修改,对编辑器依赖不高.我们随便用个notepad++/subl之类的文本编辑器就可以直接阅读和修改.

好了,基于上面的考虑,ini格式无疑是比较好的选择.我最终选用了ini格式作为配置文件首选.所以就写了一个c++类来解析和操作ini配置.代码如下:

#ifndef __xy_INICache_INCLUDE__
#define __xy_INICache_INCLUDE__
#include <map>
#include <vector>
#include <string>
namespace xy
{
    class INICache
    {
    public:
        INICache();
        virtual ~INICache();
        static INICache* createFromFile(const std::string& filePath);
        static INICache* createFromStream(const std::stringstream& sstream);
        bool loadFromFile(const std::string& filePath);
        bool loadFromStream(const std::stringstream& sstream);
        void flush(const std::string& filePath);
        std::string getFilePath() const { return this->M_filePath_; }
        bool isSectionExist(const std::string& section) const;
        bool deleteSection(const std::string& section);
        void getSectionNames(std::vector<std::string>& sectionVector);
        void setString(const std::string& section, const std::string& key, const std::string& value);
        std::string getString(const std::string& section, const std::string& key, const std::string& defaultValue);
        void setInteger(const std::string& section, const std::string& key, int value);
        int getInteger(const std::string& section, const std::string& key, int defaultValue);
        void setDouble(const std::string& section, const std::string& key, double value, int pre);
        double getDouble(const std::string& section, const std::string& key, double defaultValue);
        void setBoolean(const std::string& section, const std::string& key, bool value);
        bool getBoolean(const std::string& section, const std::string& key, bool defalutValue);
    protected:
        void trimString(std::string& buffer, const std::string& trim, bool isAll);
        void parseLine(const std::string& buffer);
        std::string parseSection(const std::string& buffer, const std::string& leftTag, const std::string& rightTag);
        bool stringToBoolean(const std::string& buffer, bool defaultValue);

        typedef std::map<std::string, std::string> KVtype;
        typedef std::map<std::string, KVtype>       SKVtype;

        std::string M_filePath_;        
        std::string M_currentSection_;  
        SKVtype        propsMap_;            
    };
}
#endif//__xy_INICache_INCLUDE__

实现部分的代码如下,如果需要看的,可以自行查看.

#include "INICache.h"
#include <fstream>
#include <sstream>
namespace xy
{
    INICache::INICache()
    {
    }
    INICache::~INICache()
    {
        if(!this->propsMap_.empty()) { this->propsMap_.clear(); }
    }
    INICache* INICache::createFromFile(const std::string& filePath)
    {
        INICache* pINICache = new INICache;
        if(!pINICache->loadFromFile(filePath))
        {
            delete pINICache;
            return NULL;
        }
        return pINICache;
    }
    bool INICache::loadFromFile(const std::string& filePath)
    {
        std::ifstream fin(filePath.c_str());
        if(!fin.is_open()) { return false; }
        
        std::string lineBuffer;
        while(!fin.eof())
        {
            std::getline(fin, lineBuffer);
            this->trimString(lineBuffer, std::string(" "), true);
            this->parseLine(lineBuffer);
        }
        fin.close();
        this->M_filePath_ = filePath;
        return true;
    }
    INICache* INICache::createFromStream(const std::stringstream& sstream)
    {
        INICache* pINICache = new INICache;
        if(!pINICache->loadFromStream(sstream))
        {
            delete pINICache;
            return NULL;
        }
        return pINICache;
    }
    bool INICache::loadFromStream(const std::stringstream& sstream)
    {
        std::string lineBuffer;
        std::istringstream isstream(sstream.str());
        while(!isstream.eof())
        {
            std::getline(isstream, lineBuffer);
            this->trimString(lineBuffer, std::string(" "), true);
            this->parseLine(lineBuffer);
        }
        return true;
    }
    void INICache::flush(const std::string& filePath)
    {
        std::ofstream fout(filePath.c_str());
        if(!fout.is_open()) { return; }
        std::string buffer;
        SKVtype::iterator skv_iter;
        KVtype::iterator  kv_iter;
        for(skv_iter = this->propsMap_.begin(); skv_iter != this->propsMap_.end(); ++skv_iter)
        {
            fout << std::endl;
            fout << std::string("[") << skv_iter->first << std::string("]") << std::endl;
            for(kv_iter = skv_iter->second.begin(); kv_iter != skv_iter->second.end(); ++kv_iter)
            {
                fout << kv_iter->first << std::string("=") << kv_iter->second << std::endl;
            }
        }
        fout.close();
    }
    bool INICache::isSectionExist(const std::string& section) const
    {  return (this->propsMap_.find(section) != this->propsMap_.end()); }
    bool INICache::deleteSection(const std::string& section)
    {
        if(!section.empty()) { return false; }
        SKVtype::iterator skv_iter = this->propsMap_.find(section);
        if(skv_iter != this->propsMap_.end())
        {
            this->propsMap_.erase(skv_iter);
            return true;
        }
        return false;
    }
    void INICache::getSectionNames(std::vector<std::string>& sectionVector)
    {
        if(!sectionVector.empty()) { sectionVector.clear(); }
        SKVtype::iterator skv_iter = this->propsMap_.begin();
        for(; skv_iter != this->propsMap_.end(); ++skv_iter)
        { sectionVector.push_back(skv_iter->first); }
    }
    void INICache::setString(const std::string& section, const std::string& key, const std::string& value)
    {
        if(!section.empty() && !key.empty())
        { this->propsMap_[section][key] = value; }
    }
    std::string INICache::getString(const std::string& section, const std::string& key, const std::string& defaultValue)
    {
        if(!section.empty() && !key.empty())
        {
            SKVtype::iterator skv_iter = this->propsMap_.find(section);
            if(skv_iter != this->propsMap_.end())
            {
                KVtype::iterator kv_iter = skv_iter->second.find(key);
                if(kv_iter != skv_iter->second.end())
                { return kv_iter->second; }
            }
        }
        return defaultValue;
    }
    void INICache::setInteger(const std::string& section, const std::string& key, int value)
    {
        std::stringstream sstream;
        sstream << value;
        this->setString(section, key, sstream.str());
    }
    int INICache::getInteger(const std::string& section, const std::string& key, int defaultValue)
    {
        std::string tmp = this->getString(section, key, std::string(""));
        std::stringstream sstream;
        sstream << tmp;
        sstream >> defaultValue;
        return defaultValue;
    }
    void INICache::setDouble(const std::string& section, const std::string& key, double value, int pre)
    {
        std::stringstream sstream;
        if(pre) { sstream.precision(pre); }
        sstream << value;
        this->setString(section, key, sstream.str());
    }
    double INICache::getDouble(const std::string& section, const std::string& key, double defaultValue)
    {
        std::string tmp = this->getString(section, key, std::string(""));
        std::stringstream sstream;
        if(!tmp.empty())
        {
            sstream << tmp;
            sstream >> defaultValue;
        }
        return defaultValue;
    }
    void INICache::setBoolean(const std::string& section, const std::string& key, bool value)
    { this->setInteger(section, key, value ? 1:0); }
    bool INICache::getBoolean(const std::string& section, const std::string& key, bool defaultValue)
    {
        std::string tmp = this->getString(section, key, std::string(""));
        if(!tmp.empty()) { return this->stringToBoolean(tmp, defaultValue); }
        return defaultValue;
    }
    void INICache::trimString(std::string& buffer, const std::string& trim, bool isAll)
    {
        if(buffer.empty()) { return; }
        while(buffer.find(trim) == 0)
        {
            buffer.erase(0, trim.length());
            if(!isAll) { break; }
        }
        while(!buffer.empty() && (buffer.rfind(trim) == (buffer.length() - trim.length())))
        {
            buffer.erase(buffer.length() - trim.length(), trim.length());
            if(!isAll) { break; }
        }
    }
    void INICache::parseLine(const std::string& buffer)
    {
        if(buffer.empty()) { return; }
        switch (buffer[0])
        {
        case '#':
        case '%':
            return;
        case '[':
            {
                std::string section = this->parseSection(buffer, std::string("["), std::string("]"));
                this->trimString(section, std::string(" "), true);
                if(!section.empty()) { this->M_currentSection_ = section; }
            }
            return;
        default:
            {
                if(buffer.find(std::string("=")) != std::string::npos && !this->M_currentSection_.empty())
                {
                    std::string key = this->parseSection(buffer, std::string(""), std::string("="));
                    this->trimString(key, std::string(" "), true);
                    std::string value = this->parseSection(buffer, std::string("="), std::string(""));
                    this->trimString(value, std::string(" "), true);
                    if(!key.empty()) { this->propsMap_[this->M_currentSection_][key] = value; }
                }
            }
            return;
        }
    }
    std::string INICache::parseSection(const std::string& buffer, const std::string& leftTag, const std::string& rightTag)
    {
        std::string ret;
        if(!buffer.empty())
        {
            std::string::size_type pos_begin = 0, pos_end = 0;
            if(!leftTag.empty())
            {
                pos_begin = buffer.find(leftTag);
                if(pos_begin == std::string::npos) { return ret; }
                pos_begin += leftTag.size();
            } else { pos_begin = 0; }
            if(!rightTag.empty())
            {
                pos_end = buffer.find(rightTag, pos_begin);
                if(pos_end == std::string::npos) { return ret; }
                ret = buffer.substr(pos_begin, pos_end - pos_begin);
            } else { ret = buffer.substr(pos_begin, std::string::npos); }
        }
        return ret;
    }
    bool INICache::stringToBoolean(const std::string& buffer, bool defaultValue)
    {
        if(buffer.empty()) { return defaultValue; }
        std::stringstream sstream;
        sstream << buffer;
        int tmp = 0;
        sstream >> tmp;
        return (buffer.compare(std::string("true"))==0 || tmp > 0);
    }
}

 这里主要是说一下我做的这些接口的思路. 读取涉及到的get/set这些方法,是基本需求.提供了两个读取Ini buffer的方法,一个是loadFromFile(const std::string& filePath),这个接口主要是应对客户端从本地读取配置文件信息,而loadFromStream(const std::stringstream& sstream)接口则是作为预留,从buffer直接读取Ini配置,为什么会做这样一个接口的预留呢? 可以一起看一下getSectionNames这个接口方法,返回的是key值的集合.

我是这样考虑的,c++这部分的接口尽量的简单,实现基本的功能,尽量避开业务逻辑的操作.要什么,我就提供基本接口,除非是在lua那边实现效率不高,或者是复杂,才会考虑提供完整的功能.因为紧接着下面会做更新模块的功能,这部分至少会依赖读取配置中一条关于资源版本的信息.而从远程Http服务器下载资源的时候也还是需要做很多版本的检测处理,如果是增量更新的话,需要按照版本的先后顺序依次下载.这就是要对key值进行按照需求排序. 本来在c++这部分做很简单的,我只要用std::sort函数,提供一个compare函数就好了。可是这部分是和具体的更新业务逻辑关联的,所以我不应该在c++这部分实现,所以就只是提供给你获取集合的方法.然后自己去处理.

绑定这部分就没什么好说的了. getSectionNames loadFromStream createFromStream这三个函数接口需要skip掉,结合前面的更新需求,需要的话,另外绑定接口,传入lua callback,在C++这边调用getSectionNames接口就好了,具体细节在后面写到更新的时候自然就会写出来了.我写了一个测试:

 ---------------------------------------------------------------------
 -- @Author        小岩
 -- @Created on  2014-12-26 21:29
 -- @Brief        INI解析测试
 ---------------------------------------------------------------------
 INICacheTestCase = class("INICacheTestCase", TestsCase)
 -----------------------------------------------------------
 -- 测试解析INI文件
 function INICacheTestCase:run()
     local iniCache = xy.INICache:createFromFile("src/Tests/INICache/INICache_conf.ini")
     if iniCache == nil then
         Logger.Error(" cannot get local conf file! ")
     end
     Logger.Info("load file succ!")
     Logger.Info("%s", iniCache:getString("Section", "Key", "Failed"))
     Logger.Info("%d", iniCache:getInteger("Section", "Integer", "-1"))
     Logger.Info("%f", iniCache:getDouble("Section", "Double", "-1"))
     local boolean = iniCache:getBoolean("Section", "Boolean", false)
     if boolean == true then
         Logger.Info("%s", "boolean == true")
     else
         Logger.Info("%s", "boolean == false")
     end
 end
 ---------------------------------------------------------------------
 -- End Of Lua File
 ---------------------------------------------------------------------

需要注意的问题是,INICache读取文件后,将配置文件信息一直都是保存在map中的,所以不要在不同的地方对同一份配置文件做多次读取操作,这样的话,将配置再次持久化到设备的时候,配置信息就会错掉.所以最好是提供配置的单例操作方式.