// Copyright (c) 2026 GeWuYou
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using GFramework.Core.Abstractions.Serializer;
using GFramework.Core.Abstractions.Storage;
using GFramework.Core.Extensions;
using GFramework.Core.Utility;
using GFramework.Game.Abstractions.Data;
using GFramework.Game.Abstractions.Data.Events;
namespace GFramework.Game.Data;
///
/// 使用单一文件存储所有设置数据的仓库实现。
///
///
/// 该仓库通过内存缓存聚合所有设置 section,并在公开的保存或删除操作发生时整文件回写。
/// 虽然底层不是“一项一个文件”,但它仍遵循 定义的统一契约:
/// 启用自动备份时,覆盖写入前会为整个统一文件创建单份备份;批量保存只发出批量事件,不重复发出单项保存事件。
///
public class UnifiedSettingsDataRepository(
IStorage? storage,
IRuntimeTypeSerializer? serializer,
DataRepositoryOptions? options = null,
string fileName = "settings.json")
: AbstractContextUtility, ISettingsDataRepository
{
private readonly SemaphoreSlim _lock = new(1, 1);
private readonly DataRepositoryOptions _options = options ?? new DataRepositoryOptions();
private readonly Dictionary _typeRegistry = new();
private UnifiedSettingsFile? _file;
private bool _loaded;
private IRuntimeTypeSerializer? _serializer = serializer;
private IStorage? _storage = storage;
private IStorage Storage =>
_storage ?? throw new InvalidOperationException("IStorage not initialized.");
private IRuntimeTypeSerializer Serializer =>
_serializer ?? throw new InvalidOperationException("ISerializer not initialized.");
private UnifiedSettingsFile File =>
_file ?? throw new InvalidOperationException("UnifiedSettingsFile not set.");
private string UnifiedKey => GetUnifiedKey();
// =========================
// IDataRepository
// =========================
///
/// 异步加载指定位置的数据
///
/// 数据类型,必须继承自IData接口
/// 数据位置信息
/// 加载的数据对象
public async Task LoadAsync(IDataLocation location)
where T : class, IData, new()
{
await EnsureLoadedAsync();
var key = location.Key;
var result = _file!.Sections.TryGetValue(key, out var raw) ? Serializer.Deserialize(raw) : new T();
if (_options.EnableEvents)
this.SendEvent(new DataLoadedEvent(result));
return result;
}
///
/// 异步保存数据到指定位置
///
/// 数据类型,必须继承自IData接口
/// 数据位置信息
/// 要保存的数据对象
/// 异步操作任务
public async Task SaveAsync(IDataLocation location, T data)
where T : class, IData
{
await EnsureLoadedAsync();
await MutateAndPersistAsync(file => file.Sections[location.Key] = Serializer.Serialize(data));
if (_options.EnableEvents)
{
this.SendEvent(new DataSavedEvent(data));
}
}
///
/// 检查指定位置的数据是否存在
///
/// 数据位置信息
/// 如果数据存在则返回true,否则返回false
public async Task ExistsAsync(IDataLocation location)
{
await EnsureLoadedAsync();
return File.Sections.ContainsKey(location.Key);
}
///
/// 删除指定位置的数据
///
/// 数据位置信息
/// 异步操作任务
public async Task DeleteAsync(IDataLocation location)
{
await EnsureLoadedAsync();
var removed = false;
await _lock.WaitAsync();
try
{
var currentFile = File;
var nextFile = CloneFile(currentFile);
removed = nextFile.Sections.Remove(location.Key);
if (!removed)
{
return;
}
await WriteUnifiedFileCoreAsync(currentFile, nextFile);
_file = nextFile;
}
finally
{
_lock.Release();
}
if (removed && _options.EnableEvents)
{
this.SendEvent(new DataDeletedEvent(location));
}
}
///
/// 批量保存多个数据项到存储
///
/// 包含数据位置和数据对象的枚举集合
/// 异步操作任务
public async Task SaveAllAsync(
IEnumerable<(IDataLocation location, IData data)> dataList)
{
await EnsureLoadedAsync();
var valueTuples = dataList.ToList();
await MutateAndPersistAsync(file =>
{
foreach (var (location, data) in valueTuples)
{
file.Sections[location.Key] = Serializer.Serialize(data);
}
});
if (_options.EnableEvents)
this.SendEvent(new DataBatchSavedEvent(valueTuples));
}
///
/// 加载所有存储的数据项
///
/// 包含所有数据项的字典,键为数据位置键,值为数据对象
public async Task> LoadAllAsync()
{
await EnsureLoadedAsync();
var result = new Dictionary();
foreach (var (key, raw) in File.Sections)
{
if (!_typeRegistry.TryGetValue(key, out var type))
continue;
var data = (IData)Serializer.Deserialize(raw, type);
result[key] = data;
}
return result;
}
///
/// 注册数据类型到类型注册表中
///
/// 数据位置信息,用于获取键值
/// 数据类型
public void RegisterDataType(IDataLocation location, Type type)
{
_typeRegistry[location.Key] = type;
}
///
/// 初始化
///
protected override void OnInit()
{
_storage ??= this.GetUtility()!;
_serializer ??= this.GetUtility()!;
}
// =========================
// Internals
// =========================
///
/// 确保数据已从存储中加载到缓存
///
private async Task EnsureLoadedAsync()
{
if (_loaded) return;
await _lock.WaitAsync();
try
{
if (_loaded) return;
var key = UnifiedKey;
_file = await Storage.ExistsAsync(key)
? await Storage.ReadAsync(key)
: new UnifiedSettingsFile { Version = 1 };
_loaded = true;
}
finally
{
_lock.Release();
}
}
///
/// 将缓存中的所有数据保存到统一文件
///
private async Task MutateAndPersistAsync(Action mutation)
{
await _lock.WaitAsync();
try
{
var currentFile = File;
var nextFile = CloneFile(currentFile);
// 先在副本上计算“下一份已提交状态”,只有底层持久化成功后才交换缓存,
// 这样即使备份或写入失败,也不会把未提交修改留在内存快照里。
mutation(nextFile);
await WriteUnifiedFileCoreAsync(currentFile, nextFile);
_file = nextFile;
}
finally
{
_lock.Release();
}
}
///
/// 将当前缓存快照写回底层存储,并在需要时创建整个文件的备份。
///
///
/// 该方法要求调用方已经持有 ,以保证“读取当前快照 -> 写入备份 -> 提交新快照”的原子提交顺序。
/// 只有在该方法成功返回后,调用方才应交换内存中的 引用。
///
/// 当前已提交的统一文件快照。
/// 即将提交的新统一文件快照。
private async Task WriteUnifiedFileCoreAsync(UnifiedSettingsFile currentFile, UnifiedSettingsFile nextFile)
{
if (_options.AutoBackup && await Storage.ExistsAsync(UnifiedKey))
{
var backupKey = $"{UnifiedKey}.backup";
await Storage.WriteAsync(backupKey, currentFile);
}
await Storage.WriteAsync(UnifiedKey, nextFile);
}
///
/// 复制当前统一文件快照,确保未提交修改不会污染内存中的已提交状态。
///
/// 要复制的统一文件快照。
/// 包含独立 section 字典的新快照。
private static UnifiedSettingsFile CloneFile(UnifiedSettingsFile source)
{
ArgumentNullException.ThrowIfNull(source);
return new UnifiedSettingsFile
{
Version = source.Version,
Sections = new Dictionary(source.Sections, source.Sections.Comparer)
};
}
///
/// 获取统一文件的存储键名。
///
/// 完整的存储键名。
protected virtual string GetUnifiedKey()
{
return string.IsNullOrEmpty(_options.BasePath) ? fileName : $"{_options.BasePath}/{fileName}";
}
}