C++實現讀寫ini配置文件的示例代碼
1.概述
配置文件的讀取是每個程序必備的功能,配置文件的格式多種多樣,例如:ini格式、json格式、xml格式等。其中屬ini格式最為簡單,且應用廣泛。
2.ini格式語法
- 註釋內容采用“#”或者“;”開頭。
- 配置是由一系列的section組成,每個section就是一個關聯的配置塊,section使用[]包含起來。
- 每個section下配置的是具體的配置項,每個配置項是使用“=”分隔的key-value對。
下面讓我們來看一個簡單的示例,假設我們有一個配置文件demo.cfg,它的內容如下所示。
[server]
ip = 127.0.0.1
port = 8088
上面的配置內容中,有一個server的配置節,在這個配置節裡有兩個配置項,它們分別是ip和port,ip的值為127.0.0.1,port的值為8088。
3.配置讀取
知道瞭ini格式語法之後,就可以根據語法規則來讀取配置文件內容瞭,春哥這裡實現瞭一個非常精簡易用的版本,源代碼文件config.hpp的內容如下。
#pragma once #include <fstream> #include <functional> #include <string> #include <unordered_map> namespace Config { class Ini { public: void Dump(std::function<void(const std::string&, const std::string&, const std::string&)> deal) { auto iter = cfg_.begin(); while (iter != cfg_.end()) { auto kv_iter = iter->second.begin(); while (kv_iter != iter->second.end()) { deal(iter->first, kv_iter->first, kv_iter->second); ++kv_iter; } ++iter; } } bool Load(std::string file_name) { if (file_name == "") return false; std::ifstream in; std::string line; in.open(file_name.c_str()); if (not in.is_open()) return false; while (getline(in, line)) { std::string section, key, value; if (not parseLine(line, section, key, value)) { continue; } setSectionKeyValue(section, key, value); } return true; } void GetStrValue(const std::string& section, const std::string& key, std::string& value, std::string default_value) { value = default_value; if (cfg_.find(section) == cfg_.end()) { return; } if (cfg_[section].find(key) == cfg_[section].end()) { return; } value = cfg_[section][key]; } void GetIntValue(const std::string& section, const std::string& key, int64_t& value, int64_t default_value) { value = default_value; if (cfg_.find(section) == cfg_.end()) { return; } if (cfg_[section].find(key) == cfg_[section].end()) { return; } value = atol(cfg_[section][key].c_str()); } private: void ltrim(std::string& str) { if (str.empty()) return; size_t len = 0; char* temp = (char*)str.c_str(); while (*temp && isblank(*temp)) { ++len; ++temp; } if (len > 0) str.erase(0, len); } void rtrim(std::string& str) { if (str.empty()) return; size_t len = str.length(); size_t pos = len; while (pos > 0) { if (not isblank(str[pos - 1])) { break; } --pos; } if (pos != len) str.erase(pos); } void trim(std::string& str) { ltrim(str); rtrim(str); } void setSectionKeyValue(std::string& section, std::string& key, std::string& value) { if (cfg_.find(section) == cfg_.end()) { std::unordered_map<std::string, std::string> kv_map; cfg_[section] = kv_map; } if (key != "" && value != "") cfg_[section][key] = value; } bool parseLine(std::string& line, std::string& section, std::string& key, std::string& value) { static std::string cur_section = ""; std::string nodes[2] = {"#", ";"}; //去掉註釋的內容 for (int i = 0; i < 2; ++i) { std::string::size_type pos = line.find(nodes[i]); if (pos != std::string::npos) line.erase(pos); } trim(line); if (line == "") return false; if (line[0] == '[' && line[line.size() - 1] == ']') { section = line.substr(1, line.size() - 2); trim(section); cur_section = section; return false; } if (cur_section == "") return false; bool is_key = true; for (size_t i = 0; i < line.size(); ++i) { if (line[i] == '=') { is_key = false; continue; } if (is_key) { key += line[i]; } else { value += line[i]; } } section = cur_section; trim(key); trim(value); return true; } private: std::unordered_map<std::string, std::unordered_map<std::string, std::string>> cfg_; }; // ini格式配置文件的讀取 } // namespace Config
Config命名空間下實現瞭Ini配置讀取類。Load函數用於加載配置文件內容,GetStrValue函數和GetIntValue函數用於獲取配置項值並支持設置默認值,Dump函數用於遍歷配置文件的內容。由於在解析過程中需要刪除字符串中的前導和後導空白符,因此我們還實現瞭trim函數用於刪除前導和後導空白符。
這裡重點講解一下Load函數的邏輯:每次從配置文件中讀取一行,然後先去掉註釋的內容,接著再判斷剩餘的內容是一個section頭配置,還是section下的key-value配置,再走不同的解析分支。
4.demo示例
以上面配置文件demo.cfg內容的讀取為例,示例代碼如下。
#include <iostream> #include "config.hpp" int main(int argc, char *argv[]) { Config::Ini ini; ini.Load("./demo.cfg"); ini.Dump([](const std::string §ion, const std::string &key, const std::string value) { std::cout << "section[" << section << "],key[" << key << "]->value[" << value << "]" << std::endl; }); return 0; }
5.自動生成讀取代碼
如果這次分享的內容到上面demo示例之後就進入尾聲的話,那麼春哥就太過於標題黨瞭。假設我們的程序有幾十項配置內容,如果每一項采用GetIntValue函數或者GetStrValue函數來讀取,那麼編碼工作量還是不小的,並且也容易出錯,那麼怎麼做到提效呢?
其實提效方案並不難想到,我們可以自動生成讀取配置項的代碼,並生成具體業務配置讀取類。下面我們舉一個例子,假設我們有一個配置文件mysvr.cfg,它的內容如下。
[server]
ip = 127.0.0.1
port = 8080[pool]
conn_pool_size = 100
我們手動編寫瞭業務配置讀取類代碼文件MySvrCfg.hpp,它的內容如下。
#include <string> #include "config.hpp" class MysvrCfg { public: bool Load(std::string file_name) { Config::Ini ini; if (not ini.Load(file_name)) { return false; } ini.GetIntValue("pool", "conn_pool_size", conn_pool_size_, 0); ini.GetIntValue("server", "port", port_, 0); ini.GetStrValue("server", "ip", ip_, ""); return true; } int64_t conn_pool_size() { return conn_pool_size_; } int64_t port() { return port_; } std::string ip() { return ip_; } public: int64_t conn_pool_size_; int64_t port_; std::string ip_; };
我們可以發現上面的代碼完全可以自動生成。「我們先讀取配置的內容,然後使用配置文件的內容作為元數據驅動生成這個MySvrCfg.hpp的內容」。
自動生成業務配置讀取類的腳手架工具代碼文件configtool.cpp,它的內容如下。
#include <iostream> #include <regex> #include <string> #include "MysvrCfg.hpp" using namespace std; int genCfgReadFile(Config::Ini &ini, string file_name) { string prefix = ""; for (size_t i = 0; i < file_name.size(); i++) { if (file_name[i] == '.') break; if (prefix == "") { prefix = toupper(file_name[i]); } else { prefix += file_name[i]; } } string class_name = prefix + "Cfg"; string output_file_name = prefix + "Cfg.hpp"; ofstream out; out.open(output_file_name); if (not out.is_open()) { cout << "open " << output_file_name << " failed." << endl; return -1; } string cfg_read_content; string class_func_content; string class_member_content; ini.Dump([&cfg_read_content, &class_func_content, &class_member_content](const string §ion, const string &key, const string &value) { regex integer_regex("[+-]?[0-9]+"); if (regex_match(value, integer_regex)) { // 整數 cfg_read_content += " ini.GetIntValue("" + section + "", "" + key + "", " + key + "_, 0);\n"; class_func_content += " int64_t " + key + "() { return " + key + "_; }\n"; class_member_content += " int64_t " + key + "_;\n"; } else { cfg_read_content += " ini.GetStrValue("" + section + "", "" + key + "", " + key + "_, "");\n"; class_func_content += " std::string " + key + "() { return " + key + "_; }\n"; class_member_content += " std::string " + key + "_;\n"; } }); // string content = R"(#include <string> #include "config.hpp" class )" + class_name + R"( { public: bool Load(std::string file_name) { Config::Ini ini; if (not ini.Load(file_name)) { return false; } )" + cfg_read_content + R"( return true; } )" + class_func_content + R"( public: )" + class_member_content + "};"; out << content; return 0; } int readDemoCfg() { MysvrCfg cfg; cout << "usage: configtool cfg_file_name" << endl; cout << "read demo cfg mysvr.cfg" << endl; cfg.Load("./mysvr.cfg"); cout << "ip = " << cfg.ip() << endl; cout << "port = " << cfg.port() << endl; cout << "conn_pool_size = " << cfg.conn_pool_size() << endl; return 0; } int main(int argc, char *argv[]) { if (argc == 1) { return readDemoCfg(); } if (argc != 2) { cout << "usage: configtool mysvr.cfg" << endl; return -1; } Config::Ini ini; string file_name = argv[1]; if (not ini.Load(file_name)) { cout << "load " << file_name << " failed." << endl; return -1; } return genCfgReadFile(ini, file_name); }
在configtool腳手架工具中,「我們先使用Config::Ini類對象讀取瞭配置文件的內容,然後遍歷配置文件的內容,生成業務配置讀取類中動態變化的代碼內容,最後使用模版生成最終的代碼」。
腳手架工具configtool的使用也非常簡單,直接把配置文件名作為命令行參數傳入即可,如果執行configtool時不攜帶任何參數則會使用生成的類MysvrCfg來讀取上面的配置文件mysvr.cfg的內容。
到此這篇關於C++實現讀寫ini配置文件的示例代碼的文章就介紹到這瞭,更多相關C++讀寫ini配置文件內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!