配置模塊

来源:https://www.cnblogs.com/zjq1999/p/18218137
-Advertisement-
Play Games

概述 什麼是配置？chatGPT是這麼回答的： 配置項（Configuration Item）是一個廣泛使用的術語，尤其在軟體開發、系統管理和IT服務管理中。它通常指的是系統或應用程式中的一個可配置的元素，可以用來調整系統或應用的行為、性能或其他特性。配置項可以是軟體、硬體、文檔、資料庫、參數設置等 ...


概述

什麼是配置？chatGPT是這麼回答的：

配置項（Configuration Item）是一個廣泛使用的術語，尤其在軟體開發、系統管理和IT服務管理中。它通常指的是系統或應用程式中的一個可配置的元素，可以用來調整系統或應用的行為、性能或其他特性。配置項可以是軟體、硬體、文檔、資料庫、參數設置等。

配置項的用途

  • 定製化：通過調整配置項，可以讓同一軟體或系統在不同環境中運行時表現出不同的行為和特性。
  • 優化性能：通過修改配置參數，可以優化系統或應用程式的性能。
  • 提高安全性：配置安全參數和策略，增強系統或應用程式的安全性。
  • 簡化管理：通過集中管理和控制配置項，可以簡化系統或應用程式的管理和維護。

Sylar使用YAML作為配置文件。最簡單的配置文件方式還是 .ini 那種，選擇YAML是因為易讀易寫，同時能支持複雜的數據結構。這裡支持 STL 容器（vector, list, set, map 等等），支持自定義類型（但需要實現序列化和反序列化方法，也就是兩個仿函數）。YAML 語法快速簡單入門：https://www.runoob.com/w3cnote/yaml-intro.html

在配置模塊中主要有以下幾個類：

  • class ConfigVarBase：配置變數的基類
  • class ConfigVar：配置參數模板子類，保存對應類型的參數值，通過仿函數實現string和T類型之間的相互轉化
  • class Config：ConfigVar的管理類

最後將日誌模塊與配置模塊整合起來，當配置文件相應參數做出改變時，能夠通過回調函數改變相應的參數。

配置模塊實現了以下功能：

  • 支持yaml格式的配置文件解析
  • 使用模板完成基礎類型，複雜類型（vector、map、set等），自定義類型的序列化與反序列化
  • 利用回調機制，在載入配置時，完成配置的更新
  • 使用yaml-cpp庫，實現配置文件讀取
  • 約定大於配置

詳解

配置變數的基類 class ConfigVarBase

虛基類。包含配置名稱和配置描述兩個屬性。提供 toString() 和 fromString() 兩個純虛函數將參數值轉換成 YAML String 和從 YAML String 轉成參數的值。

// 名字
std::string m_name;
// 描述
std::string m_description;

virtual std::string toString() = 0; //轉化為string
virtual bool fromString(const std::string& val) = 0;    //從string轉化為相應類型
virtual std::string getTypeName() const = 0;    //獲得該類型的名稱
ConfigVarBase（構造函數 ）

std::transform被用於將字元串m_name中的字母字元轉換為小寫形式並覆蓋原來的字元串。所以不區分大小寫

ConfigVarBase(const std::string& name, const std::string &description = "")
        : m_name(name)
        , m_description(description)  {
        std::transform(m_name.begin(), m_name.end(), m_name.begin(), ::tolower);
    }

配置參數 class ConfigVar

/* 
 *  T 參數的具體類型
 *  FromStr 從std::string轉換成T類型的仿函數
 *  ToStr 從T轉換成std::string的仿函數
 *  std::string 為YAML格式的字元串
 */
template <class T, class FromStr = LexicalCast<std::string, T>
                , class ToStr = LexicalCast<T, std::string> >
class ConfigVar : public ConfigVarBase {};
  • 對於每種類型的配置，在對應的 ConfigVar 模板類實例化時都要提供其 FromStr 和 ToStr 兩個仿函數，用於實現該類型和 YAML 字元串的相互轉換。
  • 配置參數模板子類。繼承自 ConfigVarBase。
  • 保存對應類型 T 的參數值。
  • 根據不同的非內置基本類型 T，FromStr 和 ToStr 具有不同的模板偏特化實現。
  • 內含一個 std::map，存放配置變更的回調函數。
    提供 setValue() 和 getValue() 函數，其中在 setValue() 函數中，會調用 std::map 中存放的所有回調函數進行通知配置變更。
  • 關於回調函數，提供 addListener()、delListener()、getListener()、clearListener() 四個函數給外界使用。
    其中，FromStr和ToStr使用仿函數片特化的方式，實現不同類型T與string之間的相互轉化，例如vector與string之間的轉化，在轉化的過程中，字元串格式都是以YAML為標準。
//F from_type, T to_type
template<class F, class T>
class LexicalCast {
public:
    T operator() (const F &v) {
        return boost::lexical_cast<T>(v);
    }
};
​
// string To vector
// "[1, 2, 3]" ——> [1, 2, 3]
template<class T>
class LexicalCast<std::string, std::vector<T>> {
public:
    std::vector<T> operator() (const std::string& v) {
        YAML::Node node = YAML::Load(v);
        typename std::vector<T> vec;
        std::stringstream ss;
        for (size_t i = 0; i < node.size(); ++i) {
            ss.str("");
            ss << node[i];
            vec.push_back(LexicalCast<std::string, T>()(ss.str()));
        }
        return vec;
    }
};
​
// vector To string
// [1, 2, 3] ——> - 1
//               - 2
//               - 3             
template<class T>
class LexicalCast<std::vector<T>, std::string> {
public:
    std::string operator() (const std::vector<T>& v) {
        YAML::Node node;
        for (auto& i : v) {
            node.push_back(YAML::Load(LexicalCast<T, std::string>()(i)));
        }
        std::stringstream ss;
        ss << node;
        return ss.str();
    }
};

mumber（成員變數）

    // 參數值
    T m_val;
    // 變更回調函數組， uint64_t key(要求唯一，一般可以用hash)
    // typedef std::function<void(const T &old_value, const T &new_value)> on_change_cb;
    std::map<uint64_t, on_change_cb> m_cbs;
    // 讀寫鎖
    mutable RWMutexType m_mutex;

函數

// 構造函數
// 給配置名、描述、參數值賦值
ConfigVar(const std::string& name
        , const T& defult_val
        , const std::string& description = "")
    : ConfigVarBase(name, description)
    , m_val(defult_val) {
​
    }

// toString（從參數轉為string）
// 若成功，返迴轉化後的string，失敗打出日誌，異常以及值的類型
std::string toString() override {
    try{
        RWMutexType::ReadLock lock(m_mutex);
        return ToStr()(m_val);
    }
    catch (std::exception &e)
    {
        SYLAR_LOG_ERROR(SYLAR_LOG_ROOT()) << "ConfigVar::toString exception"
            << e.what() << "convert: " << typeid(m_val).name() << "to String";
    }
    return "";
}

// fromString（從string轉為值）
// 從YAML String轉為參數值，失敗打出日誌，異常以及值的類型
bool fromString(const std::string& val) override {
    try {
        setValue(FromStr()(val));
    }
    catch (std::exception &e)
    {
        SYLAR_LOG_ERROR(SYLAR_LOG_ROOT()) << "ConfigVar::fromString exception "
            << e.what() << " convert: String to " << typeid(m_val).name()
            << " - " << val;
    }
    return false;
}

// getValue（獲取）和setValue（設置參數）
// 獲取參數直接返回m_val，設置參數時，判斷v與m_val是否相同，若相同，直接返回，若不相同，則回調變更函數
// 獲取參數
const T getValue() const {
    RWMutexType::ReadLock lock(m_mutex);
    return m_val;
}
​
// 設置參數
void setValue(const T& v) {
    {
        RWMutexType::ReadLock lock(m_mutex);
        if (v == m_val) {
            return;
        }
        for (auto& i : m_cbs) {
            i.second(m_val, v);
        }
    }
    RWMutexType::WriteLock lock(m_mutex);
    m_val = v;
}

// addListener（添加變化回調函數）
// 返回該回調函數對應的唯一id，用於刪除回調函數
uint64_t addListener(on_change_cb cb) {
    static uint64_t s_fun_id = 0;
    RWMutexType::WriteLock lock(m_mutex);
    ++s_fun_id;
    m_cbs[s_fun_id] = cb;
​
    return s_fun_id;
}

// delListener（刪除回調函數）
void delListener(uint64_t key) {
    RWMutexType::WriteLock lock(m_mutex);
    m_cbs.erase(key);
}

// getListener（獲取回調函數）
on_change_cb getListener(uint64_t key) {
    RWMutexType::ReadLock lock(m_mutex);
    auto it = m_cbs.find(key);
    return it == m_cbs.end() ? nullptr : it->second;
}

// clearListener（清除回調函數）
void clearListener() {
    RWMutexType::WriteLock lock(m_mutex);
    m_cbs.clear();
}

ConfigVar管理類 Config

Config是ConfigVar的管理類，用來管理全部的ConfigVar全特化後的對象。他通過單例模式進行管理，整個服務進程只有一個對象。

沒有任何靜態成員變數，通過GetDatas函數內的靜態的map進行管理，以及用GetMutex函數內的靜態的鎖加解鎖。

Lookup函數用於創建或獲取對應參數名的配置參數。傳入三個參數，字元串形式的配置參數名稱，T類型的參數預設值，字元串形式的參數描述。首先判斷是否存在參數名稱的配置，若存在，則從map中取出這個配置項（ConfigVarBase類型的指針，指向了ConfigVar的某個全特化的類的對象）。並且通過dynamic_pointer_cast，轉換成ConfigVar類型的智能指針。若tmp為nullptr的話，說明map中存在著相同名字的配置項，但是map中配置項的參數類型和傳入的預設值的參數預設值不一樣，返回nullptr，否則就返回正確的配置參數。接著判斷參數名是否包含非法字元，存在就拋出一個異常。然後創建一個ConfigVar類型的指針指向的ConfigVar類型的對象，添加到map中。

還有一個重載的Lookup函數用於查找配置參數，傳入配置參數名稱，返回對應配置參數名稱的配置參數。若不存在或者類型錯誤的話，都會返回nullptr。

LoadFromYaml函數用於使用yaml初始化配置模塊，參數傳入一個yaml對象。函數內有名為ListAllMember的函數，採用類似遍歷二叉樹的方式遍歷。

LoadFromConfDir用於載入path文件夾裡面的配置文件。

LookupBase用於返回配置參數的基類（他跟上面的Lookup的區別是一個返回ConfigVar類型的指針，一個返回基類指針）。

Visit函數用於遍歷配置模塊裡面所有配置項，並且將配置項作為傳入函數的參數進行執行。

用法如下：

sylar::ConfigVar<int>::ptr g_int_value_config = sylar::Config::Lookup("system.port", (int)8080, "system port");
  				|
				|
			   \|/
SYLAR_LOG_INFO(SYLAR_LOG_ROOT()) << "before: " << g_int_value_config->getValue();
  				|
				|
			   \|/
YAML::Node root = YAML::LoadFile("/home/sylar/workspace/sylar/bin/conf/test.yml");
sylar::Config::LoadFromYaml(root);
				|
				|
			   \|/
SYLAR_LOG_INFO(SYLAR_LOG_ROOT()) << "after: " << g_int_value_config->getValue();

成員變數：

// typedef std::unordered_map<std::string, ConfigVarBase::ptr> ConfigVarMap;
// 返回所有的配置項
static ConfigVarMap& GetDatas() {
    static ConfigVarMap s_datas;
    return s_datas;
}
​
// 配置項的RWMutex
static RWMutexType& GetMutex() {
    static RWMutexType s_mutex;
    return s_mutex;
}

Lookup（獲取/創建對應參數名的配置參數）

template<class T>
static typename ConfigVar<T>::ptr Lookup(const std::string& name
        , const T& default_value, const std::string& description = "") {
        RWMutexType::WriteLock lock(GetMutex());
        auto it = GetDatas().find(name);
        // 找到了
        if (it != GetDatas().end()) {
            // 將ConfigVarBase轉換為ConfigVar
            auto tmp = std::dynamic_pointer_cast<ConfigVar<T>>(it->second);
            // 若轉換成功，顯示顯示成功
            if (tmp) {
                SYLAR_LOG_INFO(SYLAR_LOG_ROOT()) << "Lookup name = " << name << " exists";
                return tmp;
            }   else {
                SYLAR_LOG_ERROR(SYLAR_LOG_ROOT()) << "Lookup name = " << name << " exitst but type not "
                                                  << typeid(T).name() << ", real_type = " << it->second->getTypeName()
                                                  << " " << it->second->toString();
                return nullptr;
            }
        }
    
        // 用於在當前字元串中查找第一個不屬於指定字元集合的字元，並返回該字元位置的索引。如果沒有找到任何字元，則返回 std::string::npos。
        // name不全在 "abcdefghigklmnopqrstuvwxyz._012345678" 中 
        // name中有非法字元，拋出異常
        if (name.find_first_not_of("abcdefghigklmnopqrstuvwxyz._012345678")
                != std::string::npos) {
            SYLAR_LOG_ERROR(SYLAR_LOG_ROOT()) << "Lookup name invalid" << name;
            throw std::invalid_argument(name);
        }
        
        // 若沒有，則創建一個新的ConfigVar
        // typename：用於告訴編譯器 ConfigVar<T>::ptr 是一個類型而不是成員變數。
        typename ConfigVar<T>::ptr v(new ConfigVar<T>(name, default_value, description));
        GetDatas()[name] = v;
        return v;
}

Lookup（查找配置參數）

template<class T>
static typename ConfigVar<T>::ptr Lookup(const std::string& name) {
        RWMutexType::ReadLock lock(GetMutex());
        auto it = GetDatas().find(name);
        if (it == GetDatas().end()) {
            return nullptr;
        }
        return std::dynamic_pointer_cast<ConfigVar<T>>(it->second);
}

LookupBase（查找配置參數,返回配置參數的基類）

ConfigVarBase::ptr Config::LookupBase(const std::string& name) {
    RWMutexType::ReadLock lock(GetMutex());
    auto it = GetDatas().find(name);
    return it == GetDatas().end() ? nullptr : it->second;
}

LoadFromYaml（使用YAML::Node初始化配置模塊）

// 遞歸方式，遍歷YAML格式的配置文件中的所有成員，將每個節點的名稱和值存在list中
static void ListAllMember(const std::string& prefix,
                          const YAML::Node& node,
                          std::list<std::pair<std::string, const YAML::Node> >& output) {
    // prefix字元不合法
    if (prefix.find_first_not_of("abcdefghigklmnopqrstuvwxyz._012345678") 
            != std::string::npos) {
        SYLAR_LOG_INFO(SYLAR_LOG_ROOT()) << "Config invalid name: " << prefix << " ! " << node;
        return;
    }
    output.push_back(std::make_pair(prefix, node));
    // 若解析的是map
    if (node.IsMap()) {
        for (auto it = node.begin();
                 it != node.end(); ++it) {
            // 若首碼為空,說明為頂層，prefix為key的值，否則為子層，prefix為父層加上當前層。it->second為當前node
            ListAllMember(prefix.empty() ? it->first.Scalar() : prefix + "." + it->first.Scalar(), it->second, output);
        }
    }
}
​
void Config::LoadFromYaml(const YAML::Node& root) {
    // 將root中的所有節點信息保存到all_nodes中
    std::list<std::pair<std::string, const YAML::Node> > all_nodes;
    ListAllMember("", root, all_nodes);
    
    // 遍歷list
    for(auto &i : all_nodes) {
        std::string &key = i.first;
        if (key.empty()) {
            continue;
        }
        
        // 無視大小寫
        std::transform(key.begin(), key.end(), key.begin(), ::tolower);
        // 查找名為key的配置參數
        ConfigVarBase::ptr var = LookupBase(key);
        // 若找到
        if (var) {
            // 若為純量，則調用fromString(會調用setValue設值)
            if (i.second.IsScalar()) {
                var->fromString(i.second.Scalar());
            // 否則為數組，將其轉換為字元串
            } else {
                std::stringstream ss;
                ss << i.second;
                var->fromString(ss.str());
            }
        }
    }
}

Visit（遍歷配置模塊裡面所有配置項）

void Config::Visit(std::function<void(ConfigVarBase::ptr)> cb) {
    RWMutexType::ReadLock lock(GetMutex());
    ConfigVarMap& m = GetDatas();
    for (auto it = m.begin();
         it != m.end(); ++it) {
        cb(it->second);
    }
}

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 升鮮寶供應鏈管理系統重構版發佈（技術點：Java8、mysql8.0 uniapp、vue、android、web 框架： Vue3+Spring Boot3) ,界面功能（三 ）
    升鮮寶供應鏈管理系統重構版發佈（技術點：Java8、mysql8.0 uniapp、vue、android、web 框架： Vue3+Spring Boot3) ,界面功能(三) 主要功能要點： 許可權管理（組織機構、用戶管理、角色管理、崗位管理） 系統設置（菜單管理、參數管理、數據字典、定時任務、文 ...
  • 【日記】終於鼓起勇氣買了吹風機！（356 字）
    正文 好忙。今天比昨天還要忙，水都沒喝幾口。嗯，好像只喝了兩口。 今天補了一份印鑒卡，銷了一個戶，變了一個戶，弄了一大堆資料找人簽字，還順帶要解決一個押品的歷史遺留問題。 中午睡得好香，都不想起床。 終於鼓起勇氣，買下了米家的吹風機！降了整整 8 塊錢。69 塊錢拿下。 劉海變得很長了，有點想買發箍 ...
  • K8S POD控制器：從基礎到高級實戰技巧
    本文深入探討了Kubernetes POD控制器的基礎知識、配置示例、最佳實踐，並通過一個電子商務公司的案例分析，展示瞭如何在複雜的生產環境中應用POD控制器，以優化雲服務架構。 關註【TechLeadCloud】，分享互聯網架構、雲服務技術的全維度知識。作者擁有10+年互聯網服務架構、AI產品研發 ...
  • 【xhs爬蟲軟體】用Python開發的小紅書關鍵詞搜索批量採集工具
    目錄一、背景介紹1.1 爬取目標1.2 演示視頻1.3 軟體說明二、代碼講解2.1 爬蟲採集模塊2.2 軟體界面模塊2.3 日誌模塊三、轉載聲明 一、背景介紹 1.1 爬取目標 用python開發的爬蟲採集軟體，可自動按關鍵詞抓取小紅書筆記數據。 為什麼有了源碼還開發界面軟體呢？方便不懂編程代碼的小 ...
  • Nginx R31 doc-15-Live Activity Monitoring 實時活動監控
    前言 大家好，我是老馬。很高興遇到你。 我們為 java 開發者實現了 java 版本的 nginx https://github.com/houbb/nginx4j 如果你想知道 servlet 如何處理的，可以參考我的另一個項目： 手寫從零實現簡易版 tomcat minicat 手寫 ngin ...
  • Design OOP use C
    Design OOP use C 使用c語言實現面向對象特性 以底層思維來理解面向對象。我所理解的oop：為不同的數據元提供穩定的處理邏輯框架，同時提供覆寫的可能，支持不同數據元個性化定製有限的邏輯； 多態特性： 基類實現一組通用處理邏輯介面，子類通過改變特定介面的執行邏輯實現將子類與個性化操作綁定 ...
  • SpringBoot3.2更新聲明！
    1 從 Spring Boot 3.1 升級 1.1 參數名稱發現 Spring Boot 3.2 使用的 Spring Framework 版本不再嘗試通過解析位元組碼來推斷參數名稱。如果您在依賴註入或屬性綁定時遇到問題,請務必檢查您是否在編譯時使用了 -parameters 選項。有關更多詳細信息 ...
  • SpringBoot升級到3.2.0報錯Invalid value type for attribute ‘factoryBeanObjectType‘: java.lang.String
    1 現象 SpringBoot由3.1.0升級為3.2.0時報的錯： 直接debug進入該行，看到報錯的bean信息： 看到是MyBatis出問題。 2 處理 MyBatis 先想到mybatis-spring版本較低導致。 大家應該都用的MyBatisPlus，其實可暫緩升級3.2，等待一段時間， ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類