c# 深度解析:实现一个通用配置管理功能,打造高并发、可扩展的配置管理神器
文章目录
- 深入分析 ConfigManager<TKey, TValue> 类
- 1. 类设计概述
- 2. 核心成员分析
- 2.1 字段和属性
- 2.2 构造函数
- 3. 数据加载机制
- 4. CRUD 操作方法
- 4.1 添加数据
- 4.2 删除数据
- 4.3 更新数据
- 4.4 查询数据
- 4.5 清空数据
- 5. 数据持久化
- 6. 设计亮点
- 7. 使用示例
ConfigManager<TKey, TValue> 是一个泛型抽象类,用于管理键值对配置数据的加载、存储和操作。下面将从多个维度全面分析这个类的设计和实现。
public abstract class ConfigManager<TKey, TValue>
{private readonly ConcurrentDictionary<TKey, TValue> _datas;protected abstract string ModulePath { get; }private readonly string _path;public IReadOnlyDictionary<TKey, TValue> Datas => _datas;protected ConfigManager(){_path = $"{path1}/{path2}{ModulePath}";_datas = LoadData() ?? new ConcurrentDictionary<TKey, TValue>();}private ConcurrentDictionary<TKey, TValue> LoadData(){try{var loadedData = JsonHelper_S.GetData<Dictionary<TKey, TValue>>(_path);return loadedData != null? new ConcurrentDictionary<TKey, TValue>(loadedData): new ConcurrentDictionary<TKey, TValue>();}catch (Exception ex){Console.WriteLine($"Error loading config data: {ex.Message}");return new ConcurrentDictionary<TKey, TValue>();}}public void Add(TKey key, TValue value){if (_datas.TryAdd(key, value)){//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}}public bool Remove(TKey key){bool removed = _datas.TryRemove(key, out _);if (removed){//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}return removed;}public bool TryGetValue(TKey key, out TValue value){return _datas.TryGetValue(key, out value);}public void Update(TKey key, TValue value){_datas.AddOrUpdate(key, value, (k, oldValue) => value);//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}public void Clear(){_datas.Clear();//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}public void Save(){Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}
}
深入分析 ConfigManager<TKey, TValue> 类
ConfigManager<TKey, TValue>
是一个泛型抽象类,用于管理键值对配置数据的加载、存储和操作。下面我将从多个维度全面分析这个类的设计和实现。
1. 类设计概述
这是一个抽象基类,使用泛型参数 TKey
和 TValue
来支持不同类型的键值对配置。主要特点包括:
- 使用
ConcurrentDictionary
保证线程安全 - 抽象路径定义,由子类实现具体配置路径
- 提供基本的 CRUD 操作
- 自动持久化到 JSON 文件
- 错误处理和日志记录
2. 核心成员分析
2.1 字段和属性
private readonly ConcurrentDictionary<TKey, TValue> _datas;
protected abstract string ModulePath { get; }
private readonly string _path;
public IReadOnlyDictionary<TKey, TValue> Datas => _datas;
_datas
: 使用ConcurrentDictionary
存储配置数据,确保线程安全ModulePath
: 抽象属性,子类必须实现,定义配置文件的相对路径_path
: 完整的配置文件路径,由构造函数初始化Datas
: 只读属性,提供对配置数据的只读访问
2.2 构造函数
protected ConfigManager()
{_path = $"{path1}/{path2}{ModulePath}";_datas = LoadData() ?? new ConcurrentDictionary<TKey, TValue>();
}
- 构造完整路径:组合基础路径和模块路径
- 初始化数据:调用
LoadData()
方法加载现有配置,失败则创建空字典
3. 数据加载机制
private ConcurrentDictionary<TKey, TValue> LoadData()
{try{var loadedData = JsonHelper_S.GetData<Dictionary<TKey, TValue>>(_path);return loadedData != null? new ConcurrentDictionary<TKey, TValue>(loadedData): new ConcurrentDictionary<TKey, TValue>();}catch (Exception ex){Console.WriteLine($"Error loading config data: {ex.Message}");return new ConcurrentDictionary<TKey, TValue>();}
}
- 使用
JsonHelper_S.GetData
从 JSON 文件加载数据 - 错误处理:捕获异常并记录错误日志
- 回退机制:加载失败时返回空字典
4. CRUD 操作方法
4.1 添加数据
public void Add(TKey key, TValue value)
{if (_datas.TryAdd(key, value)){//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}
}
- 使用
TryAdd
确保线程安全 - 添加成功后注释了异步保存逻辑(可能是为了性能考虑)
4.2 删除数据
public bool Remove(TKey key)
{bool removed = _datas.TryRemove(key, out _);if (removed){//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));}return removed;
}
- 使用
TryRemove
安全删除 - 返回操作结果
- 删除成功后注释了异步保存
4.3 更新数据
public void Update(TKey key, TValue value)
{_datas.AddOrUpdate(key, value, (k, oldValue) => value);//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));
}
- 使用
AddOrUpdate
原子操作 - 确保更新操作的线程安全性
- 注释了异步保存
4.4 查询数据
public bool TryGetValue(TKey key, out TValue value)
{return _datas.TryGetValue(key, out value);
}
- 标准字典查询方法
- 使用
TryGetValue
模式避免异常
4.5 清空数据
public void Clear()
{_datas.Clear();//Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));
}
- 清空所有配置项
- 注释了异步保存
5. 数据持久化
public void Save()
{Task.Run(() => JsonHelper_S.SaveData(_datas.ToDictionary(kvp => kvp.Key, kvp => kvp.Value), _path));
}
- 显式保存方法
- 使用
Task.Run
异步执行保存操作 - 将
ConcurrentDictionary
转换为普通Dictionary
后保存
6. 设计亮点
- 线程安全:全程使用
ConcurrentDictionary
确保多线程环境下的安全性 - 抽象设计:通过抽象
ModulePath
属性支持不同模块的配置管理 - 错误处理:加载数据时有完善的错误处理和回退机制
- 惰性持久化:注释了自动保存,可能是为了避免频繁IO操作
- 只读接口:通过
IReadOnlyDictionary
暴露数据,防止外部修改
7. 使用示例
子类实现可能如下:
public class UserSettingsManager : ConfigManager<string, string>
{protected override string ModulePath => "/UserSettingsBase/UserSettingsConfigManagerIsLog";private static readonly Lazy<UserSettingsManager > _instance =new Lazy<UserSettingsManager >(() => new UserSettingsManager ());public static UserSettingsManager Instance => _instance.Value;private UserSettingsManager () : base() { }
}
使用示例:
var manager = new UserSettingsManager();
manager.Add("theme", "dark");
manager.Update("language", "en-US");
if(manager.TryGetValue("theme", out var theme))
{Console.WriteLine($"Current theme: {theme}");
}
manager.Save();