c++ 解析yaml檔案

peng發表於2020-12-15
C++YAML

一直用c++操作ini做配置檔案，想換成yaml，在全球最大的同性交友網站github上搜尋，看有沒有開源的庫，功夫不負有心人，找到了yaml-cpp，試著解析了一個yaml檔案，給個滿分。分享一下如何使用他。
先git clone git@github.com:jbeder/yaml-cpp.git下，進行build四件套，把他編譯成靜態庫

mkdir build
cd build
cmake ..
make

執行完後，會得到libyaml-cpp.a。
新建一個專案，結構大致如下

yaml_demo
  |__ include
         |__yaml-cpp 標頭檔案夾
  |__ lib 
         |__yaml-cpp 庫資料夾
  |__ main.cpp

把標頭檔案和庫拷貝到相應的資料夾內。
配置CMakeLists.txt把標頭檔案和靜態庫加到專案裡，這樣在編譯和連結時才能通過

project(yaml_demo)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) # 二進位制檔案的輸出目錄
link_directories(${PROJECT_SOURCE_DIR}/lib/yaml-cpp)
add_executable(${PROJECT_NAME} main.cpp)
target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
target_link_libraries(${PROJECT_NAME} yaml-cpp.a)

對yaml-cpp的配置就完成了。看一下我的config檔案

api: aaaaa
v: 1
label:
  app: hello
  image: abc
containers:
  - name: abc
    age: 18
  - name: 222
    age: 12

其中api和v是比較簡單的鍵值，我們可以直接讀取他們的值

    std::cout << "api: " << config["api"].as<std::string>() << std::endl;
    std::cout << "v: " << config["v"].as<int>() << std::endl;

label是一個map，containers是一個列表，這就要特殊處理一下，yaml-cpp有自己的轉換模板

template <typename T>
struct convert;

在進行轉換的時候他會判斷有沒有實現 decode方法

struct as_if<T, void> {
  explicit as_if(const Node& node_) : node(node_) {}
  const Node& node;

  T operator()() const {
    if (!node.m_pNode)
      throw TypedBadConversion<T>(node.Mark());

    T t;
    if (convert<T>::decode(node, t))
      return t;
    throw TypedBadConversion<T>(node.Mark());
  }
};

Node是yaml-cpp的核心，我們的配置的所有操作都從這個類中進行。
我們只要具體化自定義的struct就可以使用了

struct label {
    std::string app;
    std::string image;
};

namespace YAML {
    template<>
    struct convert<label> {
        static Node encode(const label &rhs) {
            Node node;
            node.push_back(rhs.app);
            node.push_back(rhs.image);
            return node;
        }

        static bool decode(const Node &node, label &rhs) {
            std::cout << node.Type() << std::endl;
            rhs.app = node["app"].as<std::string>();
            rhs.image = node["image"].as<std::string>();
            return true;
        }
    };
}

encode 方法是把我們自定義的struct轉換成yaml-cpp的Node，
轉換時可以這樣

if (config["label"]) {
    label l = config["label"].as<label>();
    std::cout << "app: " << l.app << " image: " << l.image << std::endl;
}

container也是一樣的具體化

struct container {
    std::string name;
    int age;
};

namespace YAML {
    template<>
    struct convert<container> {
        static Node encode(const container &rhs) {
            Node node;
            node.push_back(rhs.name);
            node.push_back(rhs.age);
            return node;
        }

        static bool decode(const Node &node, container &rhs) {
            rhs.name = node["name"].as<std::string>();
            rhs.age = node["age"].as<int>();
            return true;
        }
    };
}

完整程式碼如下：

#include <string>
#include <iostream>
#include <yaml-cpp/yaml.h>
#include <yaml-cpp/node/parse.h>

struct container {
    std::string name;
    int age;
};

namespace YAML {
    template<>
    struct convert<container> {
        static Node encode(const container &rhs) {
            Node node;
            node.push_back(rhs.name);
            node.push_back(rhs.age);
            return node;
        }

        static bool decode(const Node &node, container &rhs) {
            rhs.name = node["name"].as<std::string>();
            rhs.age = node["age"].as<int>();
            return true;
        }
    };
}

struct label {
    std::string app;
    std::string image;
};

namespace YAML {
    template<>
    struct convert<label> {
        static Node encode(const label &rhs) {
            Node node;
            node.push_back(rhs.app);
            node.push_back(rhs.image);
            return node;
        }

        static bool decode(const Node &node, label &rhs) {
            std::cout << node.Type() << std::endl;
            rhs.app = node["app"].as<std::string>();
            rhs.image = node["image"].as<std::string>();
            return true;
        }
    };
}

int main(int argc, char **argv) {
    std::string config_path = "./config.yaml";
    std::cout << config_path << std::endl;
    YAML::Node config = YAML::LoadFile(config_path);

    std::cout << "api: " << config["api"].as<std::string>() << std::endl;
    std::cout << "v: " << config["v"].as<int>() << std::endl;

    if (config["label"]) {
        label l = config["label"].as<label>();
        std::cout << "app: " << l.app << " image: " << l.image << std::endl;
    }

    if (config["containers"]) {
        std::vector<container> vi = config["containers"].as<std::vector<container>>();

        for (std::vector<container>::iterator it = vi.begin(); it != vi.end(); ++it) {
            std::cout << "vector: name: " << it->name << " age: " << it->age << std::endl;
        }
    }

    return 0;
}

相關文章