mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-22 19:03:29 +08:00
7d581f07ca
- 为 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]
104 lines
3.2 KiB
C#
104 lines
3.2 KiB
C#
using GFramework.Core.Abstractions.model;
|
||
|
||
namespace GFramework.Game.Abstractions.setting;
|
||
|
||
/// <summary>
|
||
/// 设置模型接口：
|
||
/// - 管理 Settings Data 的生命周期
|
||
/// - 管理并编排 Settings Applicator
|
||
/// - 管理 Settings Migration
|
||
/// </summary>
|
||
public interface ISettingsModel : IModel
|
||
{
|
||
// =========================
|
||
// Data
|
||
// =========================
|
||
|
||
/// <summary>
|
||
/// 获取指定类型的设置数据（唯一实例）
|
||
/// </summary>
|
||
/// <typeparam name="T">设置数据类型，必须继承自ISettingsData并具有无参构造函数</typeparam>
|
||
/// <returns>指定类型的设置数据实例</returns>
|
||
T GetData<T>() where T : class, ISettingsData, new();
|
||
|
||
/// <summary>
|
||
/// 获取所有已创建的设置数据
|
||
/// </summary>
|
||
/// <returns>所有已创建的设置数据集合</returns>
|
||
IEnumerable<ISettingsData> AllData();
|
||
|
||
|
||
// =========================
|
||
// Applicator
|
||
// =========================
|
||
|
||
/// <summary>
|
||
/// 注册设置应用器
|
||
/// </summary>
|
||
/// <typeparam name="T">设置数据类型，必须实现ISettingsData接口且具有无参构造函数</typeparam>
|
||
/// <param name="applicator">要注册的设置应用器</param>
|
||
/// <returns>当前设置模型实例，支持链式调用</returns>
|
||
ISettingsModel RegisterApplicator<T>(IResetApplyAbleSettings applicator) where T : class, ISettingsData, new();
|
||
|
||
|
||
/// <summary>
|
||
/// 获取指定类型的设置应用器
|
||
/// </summary>
|
||
/// <typeparam name="T">要获取的设置应用器类型，必须继承自IResetApplyAbleSettings</typeparam>
|
||
/// <returns>设置应用器实例，如果不存在则返回null</returns>
|
||
T? GetApplicator<T>() where T : class, IResetApplyAbleSettings;
|
||
|
||
|
||
/// <summary>
|
||
/// 获取所有设置应用器
|
||
/// </summary>
|
||
/// <returns>所有设置应用器的集合</returns>
|
||
IEnumerable<IResetApplyAbleSettings> AllApplicators();
|
||
|
||
|
||
// =========================
|
||
// Migration
|
||
// =========================
|
||
|
||
/// <summary>
|
||
/// 注册设置迁移器
|
||
/// </summary>
|
||
/// <param name="migration">要注册的设置迁移器</param>
|
||
/// <returns>当前设置模型实例，支持链式调用</returns>
|
||
ISettingsModel RegisterMigration(ISettingsMigration migration);
|
||
|
||
|
||
// =========================
|
||
// Lifecycle
|
||
// =========================
|
||
|
||
/// <summary>
|
||
/// 初始化所有设置数据（加载 + 迁移）
|
||
/// </summary>
|
||
/// <returns>异步操作任务</returns>
|
||
Task InitializeAsync();
|
||
|
||
/// <summary>
|
||
/// 保存所有设置数据
|
||
/// </summary>
|
||
/// <returns>异步操作任务</returns>
|
||
Task SaveAllAsync();
|
||
|
||
/// <summary>
|
||
/// 应用所有设置
|
||
/// </summary>
|
||
/// <returns>异步操作任务</returns>
|
||
Task ApplyAllAsync();
|
||
|
||
/// <summary>
|
||
/// 重置指定类型的设置
|
||
/// </summary>
|
||
/// <typeparam name="T">要重置的设置类型，必须实现IResettable接口并具有无参构造函数</typeparam>
|
||
void Reset<T>() where T : class, ISettingsData, new();
|
||
|
||
|
||
/// <summary>
|
||
/// 重置所有设置数据与应用器
|
||
/// </summary>
|
||
void ResetAll();
|
||
} |