GFramework/GFramework.Game/setting/SettingsSystem.cs
GeWuYou 7d581f07ca feat(settings): 重构设置系统架构以支持数据仓库模式
- 为 ILoadableFrom 接口添加 XML 文档注释
- 重命名 UnifiedSettingsRepository 为 UnifiedSettingsDataRepository
- 将仓库基类从 IDataRepository 替换为更具体的 ISettingsDataRepository
- 为 UnifiedSettingsDataRepository 添加完整的 XML 文档注释
- 在 SettingsModel 中使用 ISettingsDataRepository 替代 IDataRepository
- 修改 SettingsModel 中的应用器存储结构从 ConcurrentBag 到 ConcurrentDictionary
- 添加 LoadAllAsync 方法以支持批量加载所有设置数据
- 优化 SettingsModel 初始化逻辑以使用批量加载提高性能
- 为 AudioSettings、GraphicsSettings 和 LocalizationSettings 添加 LoadFrom 实现
- 将设置数据版本属性改为私有只读以防止外部修改
- 更新 SettingsSystem 接口约束以匹配新的抽象层设计
- 添加 GetApplicator 泛型方法以支持获取特定类型的应用器
- 实现 Reset 泛型方法以支持重置指定类型的设置数据
- [release ci]
2026-01-30 21:16:31 +08:00

100 lines
3.0 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

using GFramework.Core.extensions;
using GFramework.Core.system;
using GFramework.Game.Abstractions.setting;
using GFramework.Game.setting.events;
namespace GFramework.Game.setting;
/// <summary>
/// 设置系统,负责管理和应用各种设置配置
/// </summary>
public class SettingsSystem : AbstractSystem, ISettingsSystem
{
private ISettingsModel _model = null!;
/// <summary>
/// 应用所有设置配置
/// </summary>
/// <returns>完成的任务</returns>
public async Task ApplyAll()
{
// 遍历所有设置应用器并尝试应用
foreach (var applicator in _model.AllApplicators()) await TryApplyAsync(applicator);
}
/// <summary>
/// 应用指定类型的设置配置
/// </summary>
/// <typeparam name="T">设置配置类型必须是类且实现IResetApplyAbleSettings接口</typeparam>
/// <returns>完成的任务</returns>
public Task Apply<T>() where T : class, IResetApplyAbleSettings
{
var applicator = _model.GetApplicator<T>();
return applicator != null
? TryApplyAsync(applicator)
: Task.CompletedTask;
}
/// <summary>
/// 保存所有设置数据到存储库
/// </summary>
/// <returns>完成的任务</returns>
public async Task SaveAll()
{
await _model.SaveAllAsync();
}
/// <summary>
/// 重置所有设置并应用更改
/// </summary>
/// <returns>异步任务</returns>
public async Task ResetAll()
{
_model.ResetAll();
await ApplyAll();
}
/// <summary>
/// 重置指定类型的设置并应用更改
/// </summary>
/// <typeparam name="T">设置类型必须实现IPersistentApplyAbleSettings接口且具有无参构造函数</typeparam>
/// <returns>异步任务</returns>
public async Task Reset<T>() where T : class, ISettingsData, IResetApplyAbleSettings, new()
{
_model.Reset<T>();
await Apply<T>();
}
/// <summary>
/// 初始化设置系统,获取设置模型实例
/// </summary>
protected override void OnInit()
{
_model = this.GetModel<ISettingsModel>()!;
}
/// <summary>
/// 尝试应用可应用的设置配置
/// </summary>
/// <param name="section">设置配置对象</param>
private async Task TryApplyAsync(ISettingsSection section)
{
if (section is not IApplyAbleSettings applyAbleSettings) return;
// 发送设置应用中事件
this.SendEvent(new SettingsApplyingEvent<ISettingsSection>(section));
try
{
await applyAbleSettings.Apply();
// 发送设置应用成功事件
this.SendEvent(new SettingsAppliedEvent<ISettingsSection>(section, true));
}
catch (Exception ex)
{
// 发送设置应用失败事件
this.SendEvent(new SettingsAppliedEvent<ISettingsSection>(section, false, ex));
}
}
}