-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.h
550 lines (500 loc) · 15 KB
/
config.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
/**
* @file config.h
* @brief 配置模块
* @author shawn
* @date 2024-05-22
*/
#ifndef __CORO_CONFIG_H__
#define __CORO_CONFIG_H__
#include <yaml-cpp/yaml.h>
#include <boost/lexical_cast.hpp>
#include <functional>
#include <list>
#include <map>
#include <memory>
#include <set>
#include <sstream>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
#include "mutex.h"
#include "util.h"
namespace coro {
/**
* @brief 配置变量的基类
*/
class ConfigVarBase {
public:
typedef std::shared_ptr<ConfigVarBase> ptr;
/**
* @brief 构造函数
* @param[in] name 配置参数名称[0-9a-z_.]
* @param[in] description 配置参数描述
*/
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);
}
/**
* @brief 析构函数
*/
virtual ~ConfigVarBase() {}
/**
* @brief 返回配置参数名称
*/
const std::string &getName() const { return m_name; }
/**
* @brief 返回配置参数的描述
*/
const std::string &getDescription() const { return m_description; }
/**
* @brief 转成字符串
*/
virtual std::string toString() = 0;
/**
* @brief 从字符串初始化值
*/
virtual bool fromString(const std::string &val) = 0;
/**
* @brief 返回配置参数值的类型名称
*/
virtual std::string getTypeName() const = 0;
protected:
/// 配置参数的名称
std::string m_name;
/// 配置参数的描述
std::string m_description;
};
/**
* @brief 类型转换模板类(F 源类型, T 目标类型)
*/
template <class F, class T>
class LexicalCast {
public:
/**
* @brief 类型转换
* @param[in] v 源类型值
* @return 返回v转换后的目标类型
* @exception 当类型不可转换时抛出异常
*/
T operator()(const F &v) { return boost::lexical_cast<T>(v); }
};
/**
* @brief 类型转换模板类片特化(YAML String 转换成 std::vector<T>)
*/
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;
}
};
/**
* @brief 类型转换模板类片特化(std::vector<T> 转换成 YAML String)
*/
template <class T>
class LexicalCast<std::vector<T>, std::string> {
public:
std::string operator()(const std::vector<T> &v) {
YAML::Node node(YAML::NodeType::Sequence);
for (auto &i : v) {
node.push_back(YAML::Load(LexicalCast<T, std::string>()(i)));
}
std::stringstream ss;
ss << node;
return ss.str();
}
};
/**
* @brief 类型转换模板类片特化(YAML String 转换成 std::list<T>)
*/
template <class T>
class LexicalCast<std::string, std::list<T>> {
public:
std::list<T> operator()(const std::string &v) {
YAML::Node node = YAML::Load(v);
typename std::list<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;
}
};
/**
* @brief 类型转换模板类片特化(std::list<T> 转换成 YAML String)
*/
template <class T>
class LexicalCast<std::list<T>, std::string> {
public:
std::string operator()(const std::list<T> &v) {
YAML::Node node(YAML::NodeType::Sequence);
for (auto &i : v) {
node.push_back(YAML::Load(LexicalCast<T, std::string>()(i)));
}
std::stringstream ss;
ss << node;
return ss.str();
}
};
/**
* @brief 类型转换模板类片特化(YAML String 转换成 std::set<T>)
*/
template <class T>
class LexicalCast<std::string, std::set<T>> {
public:
std::set<T> operator()(const std::string &v) {
YAML::Node node = YAML::Load(v);
typename std::set<T> vec;
std::stringstream ss;
for (size_t i = 0; i < node.size(); ++i) {
ss.str("");
ss << node[i];
vec.insert(LexicalCast<std::string, T>()(ss.str()));
}
return vec;
}
};
/**
* @brief 类型转换模板类片特化(std::set<T> 转换成 YAML String)
*/
template <class T>
class LexicalCast<std::set<T>, std::string> {
public:
std::string operator()(const std::set<T> &v) {
YAML::Node node(YAML::NodeType::Sequence);
for (auto &i : v) {
node.push_back(YAML::Load(LexicalCast<T, std::string>()(i)));
}
std::stringstream ss;
ss << node;
return ss.str();
}
};
/**
* @brief 类型转换模板类片特化(YAML String 转换成 std::unordered_set<T>)
*/
template <class T>
class LexicalCast<std::string, std::unordered_set<T>> {
public:
std::unordered_set<T> operator()(const std::string &v) {
YAML::Node node = YAML::Load(v);
typename std::unordered_set<T> vec;
std::stringstream ss;
for (size_t i = 0; i < node.size(); ++i) {
ss.str("");
ss << node[i];
vec.insert(LexicalCast<std::string, T>()(ss.str()));
}
return vec;
}
};
/**
* @brief 类型转换模板类片特化(std::unordered_set<T> 转换成 YAML String)
*/
template <class T>
class LexicalCast<std::unordered_set<T>, std::string> {
public:
std::string operator()(const std::unordered_set<T> &v) {
YAML::Node node(YAML::NodeType::Sequence);
for (auto &i : v) {
node.push_back(YAML::Load(LexicalCast<T, std::string>()(i)));
}
std::stringstream ss;
ss << node;
return ss.str();
}
};
/**
* @brief 类型转换模板类片特化(YAML String 转换成 std::map<std::string, T>)
*/
template <class T>
class LexicalCast<std::string, std::map<std::string, T>> {
public:
std::map<std::string, T> operator()(const std::string &v) {
YAML::Node node = YAML::Load(v);
typename std::map<std::string, T> vec;
std::stringstream ss;
for (auto it = node.begin(); it != node.end(); ++it) {
ss.str("");
ss << it->second;
vec.insert(std::make_pair(it->first.Scalar(),
LexicalCast<std::string, T>()(ss.str())));
}
return vec;
}
};
/**
* @brief 类型转换模板类片特化(std::map<std::string, T> 转换成 YAML String)
*/
template <class T>
class LexicalCast<std::map<std::string, T>, std::string> {
public:
std::string operator()(const std::map<std::string, T> &v) {
YAML::Node node(YAML::NodeType::Map);
for (auto &i : v) {
node[i.first] = YAML::Load(LexicalCast<T, std::string>()(i.second));
}
std::stringstream ss;
ss << node;
return ss.str();
}
};
/**
* @brief 类型转换模板类片特化(YAML String 转换成
* std::unordered_map<std::string, T>)
*/
template <class T>
class LexicalCast<std::string, std::unordered_map<std::string, T>> {
public:
std::unordered_map<std::string, T> operator()(const std::string &v) {
YAML::Node node = YAML::Load(v);
typename std::unordered_map<std::string, T> vec;
std::stringstream ss;
for (auto it = node.begin(); it != node.end(); ++it) {
ss.str("");
ss << it->second;
vec.insert(std::make_pair(it->first.Scalar(),
LexicalCast<std::string, T>()(ss.str())));
}
return vec;
}
};
/**
* @brief 类型转换模板类片特化(std::unordered_map<std::string, T> 转换成 YAML
* String)
*/
template <class T>
class LexicalCast<std::unordered_map<std::string, T>, std::string> {
public:
std::string operator()(const std::unordered_map<std::string, T> &v) {
YAML::Node node(YAML::NodeType::Map);
for (auto &i : v) {
node[i.first] = YAML::Load(LexicalCast<T, std::string>()(i.second));
}
std::stringstream ss;
ss << node;
return ss.str();
}
};
/**
* @brief 配置参数模板子类,保存对应类型的参数值
* @details 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 {
public:
typedef RWMutex RWMutexType;
typedef std::shared_ptr<ConfigVar> ptr;
typedef std::function<void(const T &old_value, const T &new_value)>
on_change_cb;
/**
* @brief 通过参数名,参数值,描述构造ConfigVar
* @param[in] name 参数名称有效字符为[0-9a-z_.]
* @param[in] default_value 参数的默认值
* @param[in] description 参数的描述
*/
ConfigVar(const std::string &name, const T &default_value,
const std::string &description = "")
: ConfigVarBase(name, description), m_val(default_value) {}
/**
* @brief 将参数值转换成YAML String
* @exception 当转换失败抛出异常
*/
std::string toString() override {
try {
// return boost::lexical_cast<std::string>(m_val);
RWMutexType::ReadLock lock(m_mutex);
return ToStr()(m_val);
} catch (std::exception &e) {
}
return "";
}
/**
* @brief 从YAML String 转成参数的值
* @exception 当转换失败抛出异常
*/
bool fromString(const std::string &val) override {
try {
setValue(FromStr()(val));
} catch (std::exception &e) {
}
return false;
}
/**
* @brief 获取当前参数的值
*/
const T getValue() {
RWMutexType::ReadLock lock(m_mutex);
return m_val;
}
/**
* @brief 设置当前参数的值
* @details 如果参数的值有发生变化,则通知对应的注册回调函数
*/
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;
}
/**
* @brief 返回参数值的类型名称(typeinfo)
*/
std::string getTypeName() const override { return TypeToName<T>(); }
/**
* @brief 添加变化回调函数
* @return 返回该回调函数对应的唯一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;
}
/**
* @brief 删除回调函数
* @param[in] key 回调函数的唯一id
*/
void delListener(uint64_t key) {
RWMutexType::WriteLock lock(m_mutex);
m_cbs.erase(key);
}
/**
* @brief 获取回调函数
* @param[in] key 回调函数的唯一id
* @return 如果存在返回对应的回调函数,否则返回nullptr
*/
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;
}
/**
* @brief 清理所有的回调函数
*/
void clearListener() {
RWMutexType::WriteLock lock(m_mutex);
m_cbs.clear();
}
private:
RWMutexType m_mutex;
T m_val;
// 变更回调函数组, uint64_t key,要求唯一,一般可以用hash
std::map<uint64_t, on_change_cb> m_cbs;
};
/**
* @brief ConfigVar的管理类
* @details 提供便捷的方法创建/访问ConfigVar
*/
class Config {
public:
typedef std::unordered_map<std::string, ConfigVarBase::ptr> ConfigVarMap;
typedef RWMutex RWMutexType;
/**
* @brief 获取/创建对应参数名的配置参数
* @param[in] name 配置参数名称
* @param[in] default_value 参数默认值
* @param[in] description 参数描述
* @details 获取参数名为name的配置参数,如果存在直接返回
* 如果不存在,创建参数配置并用default_value赋值
* @return 返回对应的配置参数,如果参数名存在但是类型不匹配则返回nullptr
* @exception 如果参数名包含非法字符[^0-9a-z_.] 抛出异常
* std::invalid_argument
*/
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()) {
auto tmp = std::dynamic_pointer_cast<ConfigVar<T>>(it->second);
if (tmp) {
return tmp;
} else {
return nullptr;
}
}
if (name.find_first_not_of("abcdefghikjlmnopqrstuvwxyz._012345678") !=
std::string::npos) {
throw std::invalid_argument(name);
}
typename ConfigVar<T>::ptr v(
new ConfigVar<T>(name, default_value, description));
GetDatas()[name] = v;
return v;
}
/**
* @brief 查找配置参数
* @param[in] name 配置参数名称
* @return 返回配置参数名为name的配置参数
*/
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);
}
/**
* @brief 使用YAML::Node初始化配置模块
*/
static void LoadFromYaml(const YAML::Node &root);
/**
* @brief 加载path文件夹里面的配置文件
*/
static void LoadFromConfDir(const std::string &path, bool force = false);
/**
* @brief 查找配置参数,返回配置参数的基类
* @param[in] name 配置参数名称
*/
static ConfigVarBase::ptr LookupBase(const std::string &name);
/**
* @brief 遍历配置模块里面所有配置项
* @param[in] cb 配置项回调函数
*/
static void Visit(std::function<void(ConfigVarBase::ptr)> cb);
private:
/**
* @brief 返回所有的配置项
*/
static ConfigVarMap &GetDatas() {
static ConfigVarMap s_datas;
return s_datas;
}
/**
* @brief 配置项的RWMutex
*/
static RWMutexType &GetMutex() {
static RWMutexType s_mutex;
return s_mutex;
}
};
} // namespace coro
#endif