using GFramework.Core.Abstractions.Logging;
using GFramework.Core.Extensions;
using GFramework.Core.Logging;
using GFramework.Core.Model;
using GFramework.Game.Abstractions.Data;
using GFramework.Game.Abstractions.Setting;
using GFramework.Game.Setting.Events;
namespace GFramework.Game.Setting;
///
/// 设置模型:
/// - 管理 Settings Data 的生命周期(Load / Save / Reset / Migration)
/// - 编排 Settings Applicator 的 Apply 行为
///
public class SettingsModel(IDataLocationProvider? locationProvider, TRepository? repository)
: AbstractModel, ISettingsModel
where TRepository : class, ISettingsDataRepository
{
private static readonly ILogger Log =
LoggerFactoryResolver.Provider.CreateLogger(nameof(SettingsModel));
private readonly ConcurrentDictionary _applicators = new();
// =========================
// Fields
// =========================
private readonly ConcurrentDictionary _data = new();
private readonly ConcurrentDictionary> _migrationCache = new();
private readonly ConcurrentDictionary<(Type type, int from), ISettingsMigration> _migrations = new();
private volatile bool _initialized;
private IDataLocationProvider? _locationProvider = locationProvider;
private ISettingsDataRepository? _repository = repository;
private ISettingsDataRepository DataRepository =>
_repository ?? throw new InvalidOperationException("ISettingsDataRepository not initialized.");
private IDataLocationProvider LocationProvider =>
_locationProvider ?? throw new InvalidOperationException("IDataLocationProvider not initialized.");
///
/// 获取一个布尔值,指示当前对象是否已初始化。
///
/// 如果对象已初始化则返回 true,否则返回 false。
public bool IsInitialized => _initialized;
// =========================
// Data access
// =========================
///
/// 获取指定类型的设置数据实例(唯一实例)
///
/// 实现ISettingsData接口且具有无参构造函数的类型
/// 指定类型的设置数据实例
public T GetData() where T : class, ISettingsData, new()
{
// 使用_data字典获取或添加指定类型的实例,确保唯一性
return (T)_data.GetOrAdd(typeof(T), _ => new T());
}
///
/// 获取所有设置数据实例的集合
///
/// 包含所有ISettingsData实例的可枚举集合
public IEnumerable AllData()
{
// 返回_data字典中所有值的集合
return _data.Values;
}
// =========================
// Applicator
// =========================
///
/// 注册设置应用器
///
public ISettingsModel RegisterApplicator(T applicator)
where T : class, IResetApplyAbleSettings
{
_applicators[typeof(T)] = applicator;
_data[applicator.DataType] = applicator.Data;
return this;
}
///
/// 获取所有设置应用器的集合。
///
///
/// 返回一个包含所有设置应用器的可枚举集合。
///
public IEnumerable AllApplicators()
{
return _applicators.Values;
}
// =========================
// Migration
// =========================
///
/// 注册一个设置迁移对象,并将其与指定的设置类型和版本关联。
///
///
/// 要注册的设置迁移对象,需实现 ISettingsMigration 接口。
///
///
/// 返回当前 ISettingsModel 实例,支持链式调用。
///
public ISettingsModel RegisterMigration(ISettingsMigration migration)
{
_migrations[(migration.SettingsType, migration.FromVersion)] = migration;
return this;
}
// =========================
// Lifecycle
// =========================
///
/// 初始化设置模型:
/// - 加载所有已存在的 Settings Data
/// - 执行必要的迁移
///
public async Task InitializeAsync()
{
IDictionary allData;
try
{
allData = await DataRepository.LoadAllAsync();
}
catch (Exception ex)
{
Log.Error("Failed to load unified settings file.", ex);
return;
}
foreach (var data in _data.Values)
try
{
var type = data.GetType();
var location = LocationProvider.GetLocation(type);
if (!allData.TryGetValue(location.Key, out var raw))
continue;
if (raw is not ISettingsData loaded)
continue;
var migrated = MigrateIfNeeded(loaded);
// 回填(不替换实例)
data.LoadFrom(migrated);
}
catch (Exception ex)
{
Log.Error($"Failed to initialize settings data: {data.GetType().Name}", ex);
}
_initialized = true;
this.SendEvent(new SettingsInitializedEvent());
}
///
/// 将所有 Settings Data 持久化
///
public async Task SaveAllAsync()
{
foreach (var data in _data.Values)
try
{
var location = LocationProvider.GetLocation(data.GetType());
await DataRepository.SaveAsync(location, data);
}
catch (Exception ex)
{
Log.Error($"Failed to save settings data: {data.GetType().Name}", ex);
}
this.SendEvent(new SettingsSavedAllEvent());
}
///
/// 应用所有设置
///
public async Task ApplyAllAsync()
{
foreach (var applicator in _applicators)
try
{
await applicator.Value.Apply();
}
catch (Exception ex)
{
Log.Error($"Failed to apply settings: {applicator.GetType().Name}", ex);
}
this.SendEvent(new SettingsAppliedAllEvent());
}
///
/// 重置指定类型的可重置对象
///
/// 要重置的对象类型,必须是class类型,实现IResettable接口,并具有无参构造函数
public void Reset() where T : class, ISettingsData, new()
{
var data = GetData();
data.Reset();
this.SendEvent(new SettingsResetEvent(data));
}
///
/// 重置所有设置
///
public void ResetAll()
{
foreach (var data in _data.Values)
data.Reset();
foreach (var applicator in _applicators)
applicator.Value.Reset();
this.SendEvent(new SettingsResetAllEvent(_data.Values));
}
///
/// 获取指定类型的设置应用器
///
/// 要获取的设置应用器类型,必须继承自IResetApplyAbleSettings
/// 设置应用器实例,如果不存在则返回null
public T? GetApplicator() where T : class, IResetApplyAbleSettings
{
return _applicators.TryGetValue(typeof(T), out var app)
? (T)app
: null;
}
// =========================
// OnInitialize
// =========================
///
/// 初始化函数,在对象创建时调用。该函数负责初始化数据仓库和位置提供者,
/// 并注册所有已知数据类型到数据仓库中。
///
protected override void OnInit()
{
// 初始化数据仓库实例,如果尚未赋值则通过依赖注入获取
_repository ??= this.GetUtility()!;
// 初始化位置提供者实例,如果尚未赋值则通过依赖注入获取
_locationProvider ??= this.GetUtility()!;
// 遍历所有已知的数据类型,为其分配位置并注册到数据仓库中
foreach (var type in _data.Keys)
{
var location = _locationProvider.GetLocation(type);
DataRepository.RegisterDataType(location, type);
}
}
private ISettingsData MigrateIfNeeded(ISettingsData data)
{
if (data is not IVersionedData versioned)
return data;
var type = data.GetType();
var current = data;
if (!_migrationCache.TryGetValue(type, out var versionMap))
{
versionMap = _migrations
.Where(kv => kv.Key.type == type)
.ToDictionary(kv => kv.Key.from, kv => kv.Value);
_migrationCache[type] = versionMap;
}
while (versionMap.TryGetValue(versioned.Version, out var migration))
{
current = (ISettingsData)migration.Migrate(current);
versioned = current;
}
return current;
}
}