2 Commits
Author SHA1 Message Date
cneicy 67d6814c4b feat: update Godot integration and coordinated package dependencies
Publish UPM package / publish (push) Successful in 2s
Publish NuGet packages / publish (push) Successful in 4m2s
2026-11-06 19:13:16 +08:00
cneicy cdb682f484 perf(save): encode detached snapshots and expose phase timings
Publish UPM package / publish (push) Successful in 2s
Publish NuGet packages / publish (push) Successful in 2m31s
2026-09-29 10:14:43 +08:00
13 changed files with 581 additions and 59 deletions

No files matched your search

+12
View File
@@ -2,6 +2,18 @@
本文件记录 `ShrinkDataSaver` 在当前工作区中的包内变更。 本文件记录 `ShrinkDataSaver` 在当前工作区中的包内变更。
## [2.5.0] - 2026-11-06
### Added
- `LocalStorageProvider` 新增 `LocalStorageCommitStrategy`;`RenameOnly` 通过宿主注入的覆盖移动委托提交,适用于不支持原子替换的沙箱文件系统。
- `ShrinkDataSaverPlatform.Initialize(IStorageProvider, ...)` 与两套 `ShrinkDataSaverRuntimeConfig.Storage` 支持宿主注入存储实现。
### Changed
- `RenameOnly` 保留 `.bak1` / `.bak2` 两级备份,并在读取或下一次写入前从备份恢复中断的提交;孤立临时文件不会被当成完整存档。
- `DeleteAsync` 会同时清理主文件、两级备份和临时文件。
## [2.2.2] - 2026-08-28 ## [2.2.2] - 2026-08-28
### Changed ### Changed
+2 -1
View File
@@ -15,6 +15,7 @@ public sealed class ShrinkDataSaverRuntimeConfig
public int MaxSlots { get; set; } = 3; public int MaxSlots { get; set; } = 3;
public float SettingsWriteDebounceSeconds { get; set; } = 0.35f; public float SettingsWriteDebounceSeconds { get; set; } = 0.35f;
public bool DontDestroyOnLoadDriver { get; set; } public bool DontDestroyOnLoadDriver { get; set; }
public IStorageProvider? Storage { get; set; }
} }
public static class ShrinkDataSaverRuntime public static class ShrinkDataSaverRuntime
@@ -29,7 +30,7 @@ public static class ShrinkDataSaverRuntime
? ShrinkRuntimeServices.Paths.PersistentDataPath ? ShrinkRuntimeServices.Paths.PersistentDataPath
: config.RootPath!; : config.RootPath!;
Directory.CreateDirectory(root); Directory.CreateDirectory(root);
var storage = new LocalStorageProvider(root); var storage = config.Storage ?? new LocalStorageProvider(root);
ShrinkDataSaverPlatform.SettingsWriteDebounceSeconds = config.SettingsWriteDebounceSeconds; ShrinkDataSaverPlatform.SettingsWriteDebounceSeconds = config.SettingsWriteDebounceSeconds;
ShrinkDataSaverPlatform.MaxSlots = config.MaxSlots; ShrinkDataSaverPlatform.MaxSlots = config.MaxSlots;
ShrinkSettings.Initialize(storage, Path.Combine(root, config.SettingsFileName)); ShrinkSettings.Initialize(storage, Path.Combine(root, config.SettingsFileName));
+2 -2
View File
@@ -5,7 +5,7 @@
<AssemblyName>ShrinkDataSaver.Runtime</AssemblyName> <AssemblyName>ShrinkDataSaver.Runtime</AssemblyName>
<RootNamespace>ShrinkDataSaver</RootNamespace> <RootNamespace>ShrinkDataSaver</RootNamespace>
<PackageId>ShrinkSDK.DataSaver</PackageId> <PackageId>ShrinkSDK.DataSaver</PackageId>
<Version>2.3.0</Version> <Version>2.5.0</Version>
<Description>ShrinkSDK engine-neutral versioned save and settings runtime.</Description> <Description>ShrinkSDK engine-neutral versioned save and settings runtime.</Description>
<ShrinkCodeGenEnabled>false</ShrinkCodeGenEnabled> <ShrinkCodeGenEnabled>false</ShrinkCodeGenEnabled>
<Nullable>disable</Nullable> <Nullable>disable</Nullable>
@@ -24,6 +24,6 @@
<Compile Include="..\Runtime\ShrinkSettings.cs" /> <Compile Include="..\Runtime\ShrinkSettings.cs" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" /> <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="UniTask" Version="2.5.10" /> <PackageReference Include="UniTask" Version="2.5.10" />
<PackageReference Include="ShrinkSDK.Runtime.Abstractions" Version="0.1.0" /> <PackageReference Include="ShrinkSDK.Runtime.Abstractions" Version="0.2.0" />
</ItemGroup> </ItemGroup>
</Project> </Project>
+22 -1
View File
@@ -19,6 +19,7 @@ Godot 和普通 .NET 项目安装 `ShrinkSDK.DataSaver`;可打包源码位于
| ⚙️ **Settings 系统** | 独立于存档的键值对设置,防抖写入,本地持久化 | | ⚙️ **Settings 系统** | 独立于存档的键值对设置,防抖写入,本地持久化 |
| 🧷 **最近游玩槽位** | 自动记录最近一次成功进入的槽位,可用于“继续游戏” | | 🧷 **最近游玩槽位** | 自动记录最近一次成功进入的槽位,可用于“继续游戏” |
| 🛠️ **双副本备份** | 主文件原子替换,自动保留 `.bak1` / `.bak2` 双副本轮换 | | 🛠️ **双副本备份** | 主文件原子替换,自动保留 `.bak1` / `.bak2` 双副本轮换 |
| 📦 **可注入存储** | 宿主可传入自定义 `IStorageProvider`,或选择 `RenameOnly` 提交策略 |
| ☁️ **云存档兼容** | 每槽单文件 `.sav`,模块级 `EnableCloudSync` 开关 | | ☁️ **云存档兼容** | 每槽单文件 `.sav`,模块级 `EnableCloudSync` 开关 |
| 🔗 **EventBus 集成** | 可选接入 ShrinkEventBus,所有事件自动桥接到事件总线 | | 🔗 **EventBus 集成** | 可选接入 ShrinkEventBus,所有事件自动桥接到事件总线 |
| 🖥️ **Editor 工具** | 中文可视化调试窗口,实时查看/操作设置与存档 | | 🖥️ **Editor 工具** | 中文可视化调试窗口,实时查看/操作设置与存档 |
@@ -75,6 +76,16 @@ Bootstrap 会自动 `DontDestroyOnLoad`,并在应用退出 / 移动端切后
- 如果项目接入了 `ShrinkApp`,则可由宿主统一调用 `ShrinkDataSaverRuntime.Initialize(...)` - 如果项目接入了 `ShrinkApp`,则可由宿主统一调用 `ShrinkDataSaverRuntime.Initialize(...)`
- 宿主已接管时,旧 bootstrap 会自动幂等退出,不重复初始化 - 宿主已接管时,旧 bootstrap 会自动幂等退出,不重复初始化
Godot 或其他 .NET 8 宿主可以注入自己的存储实现,并显式提供覆盖重命名操作。共享 netstandard2.1 库不绑定平台原生 API;缺少该操作时 `RenameOnly` 构造会失败。Godot 也可直接使用 `ShrinkGodotStorage.CreateRenameOnly(rootPath)`:
```csharp
var storage = new LocalStorageProvider(rootPath, LocalStorageCommitStrategy.RenameOnly,
(source, destination) => File.Move(source, destination, overwrite: true));
ShrinkDataSaverPlatform.Initialize(storage, rootPath);
```
`ShrinkDataSaverRuntimeConfig.Storage`(Unity 与 .NET 两套运行时配置均提供)和 `ShrinkDataSaverAppModuleConfig` 也支持传入自定义存储。`RenameOnly` 适合不支持原子替换的沙箱文件系统;它仍保留 `.bak1` / `.bak2`,并会在读取或下一次写入前恢复中断的提交。
### 第三步:注册存档模块 ### 第三步:注册存档模块
```csharp ```csharp
@@ -529,7 +540,7 @@ await ShrinkSave.LoadSlotAsync(slotIndex, key);
- **模块注册顺序无关**:`SaveSlotAsync` 序列化所有已注册模块,`LoadSlotAsync` 分发到对应模块,缺失的模块会跳过但不会导致加载失败。 - **模块注册顺序无关**:`SaveSlotAsync` 序列化所有已注册模块,`LoadSlotAsync` 分发到对应模块,缺失的模块会跳过但不会导致加载失败。
- **宿主接管兼容**:如果项目接入了 `ShrinkApp`,推荐通过 `ShrinkDataSaver.Integration.App` 让宿主统一初始化,而不是继续依赖场景 bootstrap。 - **宿主接管兼容**:如果项目接入了 `ShrinkApp`,推荐通过 `ShrinkDataSaver.Integration.App` 让宿主统一初始化,而不是继续依赖场景 bootstrap。
- **写入原子性**:`LocalStorageProvider` 先异步写入 `.tmp` 临时文件,再通过原子替换提交主文件,并自动轮换 `.bak1` / `.bak2` 两份备份。 - **写入原子性**:`LocalStorageProvider` 先异步写入 `.tmp` 临时文件,再按 `FileReplace` 或 `RenameOnly` 策略提交主文件,并自动轮换 `.bak1` / `.bak2` 两份备份。
- **读取恢复**:`ShrinkSave` 与 `ShrinkSettings` 读取主文件失败时,会自动回退到 `.bak1`、`.bak2`,并在成功后修复主文件。 - **读取恢复**:`ShrinkSave` 与 `ShrinkSettings` 读取主文件失败时,会自动回退到 `.bak1`、`.bak2`,并在成功后修复主文件。
- **Settings 防抖**:`Set()` 调用后不立刻写磁盘,在 300ms(可配置)内连续调用只触发一次写入。退出时强制跳过防抖直接写入。 - **Settings 防抖**:`Set()` 调用后不立刻写磁盘,在 300ms(可配置)内连续调用只触发一次写入。退出时强制跳过防抖直接写入。
- **加密密钥管理**:框架不存储密钥。密钥丢失则对应存档无法解密,建议在 UI 层给玩家明确提示。 - **加密密钥管理**:框架不存储密钥。密钥丢失则对应存档无法解密,建议在 UI 层给玩家明确提示。
@@ -542,3 +553,13 @@ await ShrinkSave.LoadSlotAsync(slotIndex, key);
## 📄 License ## 📄 License
[MIT](LICENSE) [MIT](LICENSE)
## 可复用能力
<!-- shrink:capabilities -->
Capability: 模块化存档、槽位、设置、迁移、加密和损坏备份恢复
Aliases: 存储 存档 保存 读档 设置 持久化 save
Limits: 模块负责采集一致状态;后台不得读取 Unity 对象;不会自动保存任意游戏字段
Extension: 存档模块注册、序列化器、迁移链与平台路径服务
Evidence: [ShrinkSave](Runtime/ShrinkSave.cs); [ShrinkDataSaverRuntime](DotNet~/Runtime/ShrinkDataSaverRuntime.cs)
<!-- /shrink:capabilities -->
+156 -37
View File
@@ -8,6 +8,12 @@ using Cysharp.Threading.Tasks;
namespace ShrinkDataSaver namespace ShrinkDataSaver
{ {
public enum LocalStorageCommitStrategy
{
FileReplace = 0,
RenameOnly = 1
}
public class LocalStorageProvider : IStorageProvider public class LocalStorageProvider : IStorageProvider
{ {
private const string BackupPrimarySuffix = ".bak1"; private const string BackupPrimarySuffix = ".bak1";
@@ -18,16 +24,37 @@ namespace ShrinkDataSaver
new(StringComparer.OrdinalIgnoreCase); new(StringComparer.OrdinalIgnoreCase);
private readonly string _rootPath; private readonly string _rootPath;
private readonly LocalStorageCommitStrategy _commitStrategy;
private readonly Action<string, string> _overwriteMove;
public LocalStorageProvider(string rootPath = null) public LocalStorageProvider(string rootPath = null)
: this(rootPath, LocalStorageCommitStrategy.FileReplace)
{ {
}
public LocalStorageProvider(string rootPath, LocalStorageCommitStrategy commitStrategy)
: this(rootPath, commitStrategy, null)
{
}
public LocalStorageProvider(string rootPath, LocalStorageCommitStrategy commitStrategy,
Action<string, string> overwriteMove)
{
if (!Enum.IsDefined(typeof(LocalStorageCommitStrategy), commitStrategy))
throw new ArgumentOutOfRangeException(nameof(commitStrategy));
if (commitStrategy == LocalStorageCommitStrategy.RenameOnly && overwriteMove == null)
throw new ArgumentException("RenameOnly requires an overwrite-rename implementation.", nameof(overwriteMove));
_overwriteMove = overwriteMove;
_rootPath = rootPath ?? ShrinkDataSaverPlatform.Paths?.PersistentDataPath _rootPath = rootPath ?? ShrinkDataSaverPlatform.Paths?.PersistentDataPath
#if UNITY_5_3_OR_NEWER #if UNITY_5_3_OR_NEWER
?? UnityEngine.Application.persistentDataPath ?? UnityEngine.Application.persistentDataPath
#endif #endif
?? throw new InvalidOperationException("ShrinkDataSaver persistent path is not configured."); ?? throw new InvalidOperationException("ShrinkDataSaver persistent path is not configured.");
_commitStrategy = commitStrategy;
} }
public LocalStorageCommitStrategy CommitStrategy => _commitStrategy;
private string Resolve(string path) => private string Resolve(string path) =>
Path.IsPathRooted(path) ? path : Path.Combine(_rootPath, path); Path.IsPathRooted(path) ? path : Path.Combine(_rootPath, path);
@@ -40,48 +67,26 @@ namespace ShrinkDataSaver
await Task.Run(() => Directory.CreateDirectory(dir), ct); await Task.Run(() => Directory.CreateDirectory(dir), ct);
} }
var tempPath = fullPath + TempWriteSuffix;
var backupPath = fullPath + BackupPrimarySuffix;
var secondaryBackupPath = fullPath + BackupSecondarySuffix;
var pathLock = GetPathLock(fullPath); var pathLock = GetPathLock(fullPath);
await pathLock.WaitAsync(ct); await pathLock.WaitAsync(ct);
try try
{
await Task.Run(() => RecoverInterruptedWrite(fullPath), CancellationToken.None);
ct.ThrowIfCancellationRequested();
var tempPath = fullPath + TempWriteSuffix;
try
{ {
await WriteFileBytesAsync(tempPath, data, ct); await WriteFileBytesAsync(tempPath, data, ct);
await Task.Run(() => ct.ThrowIfCancellationRequested();
{ await Task.Run(() => Commit(tempPath, fullPath), CancellationToken.None);
if (File.Exists(fullPath))
{
if (File.Exists(secondaryBackupPath))
{
File.Delete(secondaryBackupPath);
}
if (File.Exists(backupPath))
{
File.Move(backupPath, secondaryBackupPath);
}
File.Replace(tempPath, fullPath, backupPath, true);
}
else
{
File.Move(tempPath, fullPath);
}
}, ct);
} }
catch catch
{ {
await Task.Run(() => await Task.Run(() => TryDelete(tempPath), CancellationToken.None);
{
if (File.Exists(tempPath))
{
File.Delete(tempPath);
}
}, CancellationToken.None);
throw; throw;
} }
}
finally finally
{ {
pathLock.Release(); pathLock.Release();
@@ -95,6 +100,7 @@ namespace ShrinkDataSaver
await pathLock.WaitAsync(ct); await pathLock.WaitAsync(ct);
try try
{ {
await Task.Run(() => RecoverInterruptedWrite(fullPath), CancellationToken.None);
if (!File.Exists(fullPath)) if (!File.Exists(fullPath))
{ {
throw new FileNotFoundException($"ShrinkDataSaver: file not found: {fullPath}"); throw new FileNotFoundException($"ShrinkDataSaver: file not found: {fullPath}");
@@ -108,8 +114,23 @@ namespace ShrinkDataSaver
} }
} }
public UniTask<bool> ExistsAsync(string path, CancellationToken ct = default) => public async UniTask<bool> ExistsAsync(string path, CancellationToken ct = default) =>
Task.Run(() => File.Exists(Resolve(path)), ct).AsUniTask(); await ExistsCoreAsync(Resolve(path), ct);
private async UniTask<bool> ExistsCoreAsync(string fullPath, CancellationToken ct)
{
var pathLock = GetPathLock(fullPath);
await pathLock.WaitAsync(ct);
try
{
await Task.Run(() => RecoverInterruptedWrite(fullPath), CancellationToken.None);
return File.Exists(fullPath);
}
finally
{
pathLock.Release();
}
}
public async UniTask DeleteAsync(string path, CancellationToken ct = default) public async UniTask DeleteAsync(string path, CancellationToken ct = default)
{ {
@@ -120,10 +141,10 @@ namespace ShrinkDataSaver
{ {
await Task.Run(() => await Task.Run(() =>
{ {
if (File.Exists(fullPath)) File.Delete(fullPath + TempWriteSuffix);
{ File.Delete(fullPath + BackupPrimarySuffix);
File.Delete(fullPath + BackupSecondarySuffix);
File.Delete(fullPath); File.Delete(fullPath);
}
}, ct); }, ct);
} }
finally finally
@@ -148,6 +169,104 @@ namespace ShrinkDataSaver
}, ct); }, ct);
} }
private void Commit(string tempPath, string fullPath)
{
if (_commitStrategy == LocalStorageCommitStrategy.RenameOnly)
CommitRenameOnly(tempPath, fullPath);
else
CommitFileReplace(tempPath, fullPath);
}
private static void CommitFileReplace(string tempPath, string fullPath)
{
var backupPath = fullPath + BackupPrimarySuffix;
var secondaryBackupPath = fullPath + BackupSecondarySuffix;
if (!File.Exists(fullPath))
{
File.Move(tempPath, fullPath);
return;
}
if (File.Exists(secondaryBackupPath))
{
File.Delete(secondaryBackupPath);
}
if (File.Exists(backupPath))
{
File.Move(backupPath, secondaryBackupPath);
}
File.Replace(tempPath, fullPath, backupPath, true);
}
private void CommitRenameOnly(string tempPath, string fullPath)
{
var backupPath = fullPath + BackupPrimarySuffix;
var secondaryBackupPath = fullPath + BackupSecondarySuffix;
if (File.Exists(fullPath))
{
if (File.Exists(backupPath))
{
if (File.Exists(secondaryBackupPath))
{
File.Delete(secondaryBackupPath);
}
MoveFileReplacing(backupPath, secondaryBackupPath);
}
MoveFileReplacing(fullPath, backupPath);
}
MoveFileReplacing(tempPath, fullPath);
}
private void RecoverInterruptedWrite(string fullPath)
{
if (_commitStrategy != LocalStorageCommitStrategy.RenameOnly)
return;
var tempPath = fullPath + TempWriteSuffix;
var primaryBackupPath = fullPath + BackupPrimarySuffix;
var secondaryBackupPath = fullPath + BackupSecondarySuffix;
if (!File.Exists(fullPath))
{
if (File.Exists(primaryBackupPath))
{
MoveFileReplacing(primaryBackupPath, fullPath);
}
else if (File.Exists(secondaryBackupPath))
{
MoveFileReplacing(secondaryBackupPath, fullPath);
}
}
if (File.Exists(tempPath))
{
TryDelete(tempPath);
}
}
private void MoveFileReplacing(string source, string destination) => _overwriteMove(source, destination);
private static void TryDelete(string path)
{
try
{
if (File.Exists(path))
{
File.Delete(path);
}
}
catch (IOException)
{
}
catch (UnauthorizedAccessException)
{
}
}
private static SemaphoreSlim GetPathLock(string fullPath) private static SemaphoreSlim GetPathLock(string fullPath)
{ {
return PathLocks.GetOrAdd(fullPath, _ => new SemaphoreSlim(1, 1)); return PathLocks.GetOrAdd(fullPath, _ => new SemaphoreSlim(1, 1));
+13
View File
@@ -59,8 +59,21 @@ namespace ShrinkDataSaver
} }
public sealed class SavePhaseTimings
{
public double CaptureMilliseconds { get; internal set; }
public double EncodeMilliseconds { get; internal set; }
public double EncryptMilliseconds { get; internal set; }
public double WriteMilliseconds { get; internal set; }
public long EncodedBytes { get; internal set; }
}
public class SaveOptions public class SaveOptions
{ {
/// <summary>Only the detached JToken snapshot is encoded off-thread; module capture stays on the caller thread.</summary>
public bool EncodeInBackground = false;
public bool CollectTimings = false;
public SavePhaseTimings LastTimings { get; internal set; }
public string SlotName = "New Save"; public string SlotName = "New Save";
public bool CaptureScreenshot = false; public bool CaptureScreenshot = false;
#if UNITY_5_3_OR_NEWER #if UNITY_5_3_OR_NEWER
+22 -2
View File
@@ -33,8 +33,28 @@ namespace ShrinkDataSaver
if (string.IsNullOrWhiteSpace(rootPath)) if (string.IsNullOrWhiteSpace(rootPath))
throw new InvalidOperationException("ShrinkDataSaver platform paths are not configured."); throw new InvalidOperationException("ShrinkDataSaver platform paths are not configured.");
var storage = new LocalStorageProvider(rootPath); var storage = new LocalStorageProvider(rootPath);
ShrinkSettings.Initialize(storage, System.IO.Path.Combine(rootPath, settingsFileName)); Initialize(storage, rootPath, saveFileExtension, settingsFileName, currentSaveVersion);
ShrinkSave.Initialize(storage, System.IO.Path.Combine(rootPath, "saves"), saveFileExtension, currentSaveVersion); }
public static void Initialize(IStorageProvider storage, string? rootPath = null,
string saveFileExtension = ".json", string settingsFileName = "settings.json",
int currentSaveVersion = 1)
{
if (storage == null)
throw new ArgumentNullException(nameof(storage));
rootPath ??= Paths?.PersistentDataPath;
#if UNITY_5_3_OR_NEWER
rootPath ??= UnityEngine.Application.persistentDataPath;
#endif
var settingsPath = string.IsNullOrWhiteSpace(rootPath)
? settingsFileName
: System.IO.Path.Combine(rootPath, settingsFileName);
var savesDir = string.IsNullOrWhiteSpace(rootPath)
? "saves"
: System.IO.Path.Combine(rootPath, "saves");
ShrinkSettings.Initialize(storage, settingsPath);
ShrinkSave.Initialize(storage, savesDir, saveFileExtension, currentSaveVersion);
} }
internal static double TimeSeconds internal static double TimeSeconds
+2 -1
View File
@@ -11,6 +11,7 @@ namespace ShrinkDataSaver
public ShrinkDataSaverSettings? SettingsOverride { get; set; } public ShrinkDataSaverSettings? SettingsOverride { get; set; }
public int CurrentSaveVersion { get; set; } = 1; public int CurrentSaveVersion { get; set; } = 1;
public bool DontDestroyOnLoadDriver { get; set; } = true; public bool DontDestroyOnLoadDriver { get; set; } = true;
public IStorageProvider? Storage { get; set; }
} }
public static class ShrinkDataSaverRuntime public static class ShrinkDataSaverRuntime
@@ -36,7 +37,7 @@ namespace ShrinkDataSaver
var savesDir = Path.Combine(rootPath, "saves"); var savesDir = Path.Combine(rootPath, "saves");
var settingsPath = Path.Combine(rootPath, cfg.settingsFileName); var settingsPath = Path.Combine(rootPath, cfg.settingsFileName);
var storage = new LocalStorageProvider(rootPath); var storage = config.Storage ?? new LocalStorageProvider(rootPath);
ShrinkDataSaverPlatform.SettingsWriteDebounceSeconds = cfg.settingsWriteDebounceSeconds; ShrinkDataSaverPlatform.SettingsWriteDebounceSeconds = cfg.settingsWriteDebounceSeconds;
ShrinkDataSaverPlatform.MaxSlots = cfg.maxSlots; ShrinkDataSaverPlatform.MaxSlots = cfg.maxSlots;
+36 -13
View File
@@ -1,6 +1,8 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using System.Diagnostics;
using System.Threading.Tasks;
using System.Threading; using System.Threading;
using Cysharp.Threading.Tasks; using Cysharp.Threading.Tasks;
using Newtonsoft.Json.Linq; using Newtonsoft.Json.Linq;
@@ -183,6 +185,14 @@ namespace ShrinkDataSaver
{ {
options ??= new SaveOptions(); options ??= new SaveOptions();
ValidateSlotIndex(slotIndex); ValidateSlotIndex(slotIndex);
ct.ThrowIfCancellationRequested();
var timings = options.CollectTimings ? new SavePhaseTimings() : null;
options.LastTimings = timings;
var captureStarted = Stopwatch.GetTimestamp();
var encrypt = options.Encrypt;
var encryptionKey = options.EncryptionKey;
var encodeInBackground = options.EncodeInBackground;
var storage = _storage;
var timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(); var timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds();
OnSaveStarted?.Invoke(new SaveStartedEventArgs { SlotIndex = slotIndex, Timestamp = timestamp }); OnSaveStarted?.Invoke(new SaveStartedEventArgs { SlotIndex = slotIndex, Timestamp = timestamp });
@@ -198,7 +208,7 @@ namespace ShrinkDataSaver
SaveVersion = _currentSaveVersion, SaveVersion = _currentSaveVersion,
LastModified = timestamp, LastModified = timestamp,
PlaytimeSeconds = GetCurrentPlaytime(), PlaytimeSeconds = GetCurrentPlaytime(),
IsEncrypted = options.Encrypt IsEncrypted = encrypt
} }
}; };
@@ -233,24 +243,35 @@ namespace ShrinkDataSaver
} }
} }
if (options.Encrypt) if (timings != null) timings.CaptureMilliseconds = PhaseElapsed(captureStarted);
ct.ThrowIfCancellationRequested();
// Modules have been materialized as private JSON tokens; the worker never touches providers or engine objects.
byte[] Encode()
{ {
if (string.IsNullOrEmpty(options.EncryptionKey)) ct.ThrowIfCancellationRequested();
var stage = Stopwatch.GetTimestamp();
if (encrypt)
{ {
throw new ArgumentException("EncryptionKey missing."); if (string.IsNullOrEmpty(encryptionKey)) throw new ArgumentException("EncryptionKey missing.");
}
var modulesBytes = DataSerializer.Serialize(modulesDict); var modulesBytes = DataSerializer.Serialize(modulesDict);
var encryptedBytes = SaveEncryptor.Encrypt(modulesBytes, options.EncryptionKey); if (timings != null) timings.EncodeMilliseconds += PhaseElapsed(stage);
stage = Stopwatch.GetTimestamp();
var encryptedBytes = SaveEncryptor.Encrypt(modulesBytes, encryptionKey);
if (timings != null) timings.EncryptMilliseconds = PhaseElapsed(stage);
packet.EncryptedModules = Convert.ToBase64String(encryptedBytes); packet.EncryptedModules = Convert.ToBase64String(encryptedBytes);
} }
else else packet.Modules = modulesDict;
{ ct.ThrowIfCancellationRequested();
packet.Modules = modulesDict; stage = Stopwatch.GetTimestamp();
var bytes = DataSerializer.Serialize(packet);
if (timings != null) { timings.EncodeMilliseconds += PhaseElapsed(stage); timings.EncodedBytes = bytes.Length; }
return bytes;
} }
var finalBytes = encodeInBackground ? await Task.Run(Encode, ct) : Encode();
var finalBytes = DataSerializer.Serialize(packet); ct.ThrowIfCancellationRequested();
await _storage.WriteAsync(SlotPath(slotIndex), finalBytes, ct); var writeStarted = Stopwatch.GetTimestamp();
await storage.WriteAsync(SlotPath(slotIndex), finalBytes, ct);
if (timings != null) timings.WriteMilliseconds = PhaseElapsed(writeStarted);
OnSaveCompleted?.Invoke(new SaveCompletedEventArgs OnSaveCompleted?.Invoke(new SaveCompletedEventArgs
{ {
@@ -271,6 +292,8 @@ namespace ShrinkDataSaver
} }
} }
private static double PhaseElapsed(long started) => (Stopwatch.GetTimestamp() - started) * 1000d / Stopwatch.Frequency;
public static async UniTask LoadSlotAsync(int slotIndex, string decryptionKey = null, CancellationToken ct = default) public static async UniTask LoadSlotAsync(int slotIndex, string decryptionKey = null, CancellationToken ct = default)
{ {
var timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(); var timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds();
+239
View File
@@ -0,0 +1,239 @@
using System;
using System.Collections;
using System.IO;
using System.Text;
using System.Threading.Tasks;
using Cysharp.Threading.Tasks;
using NUnit.Framework;
using UnityEngine.TestTools;
namespace ShrinkDataSaver.Tests
{
[TestFixture]
public class LocalStorageProviderStrategyTests
{
private string _rootPath;
[SetUp]
public void SetUp()
{
_rootPath = Path.Combine(Path.GetTempPath(), $"ShrinkDataSaverStrategyTests_{Guid.NewGuid():N}");
Directory.CreateDirectory(_rootPath);
}
[TearDown]
public void TearDown()
{
if (Directory.Exists(_rootPath))
{
Directory.Delete(_rootPath, true);
}
}
[Test]
public void DefaultConstructor_UsesFileReplace()
{
Assert.AreEqual(LocalStorageCommitStrategy.FileReplace,
new LocalStorageProvider(_rootPath).CommitStrategy);
}
[UnityTest]
public IEnumerator RenameOnly_RotatesTwoBackups() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
await WriteAsync(provider, "three");
Assert.AreEqual("three", await ReadAsync(provider, "save.dat"));
Assert.AreEqual("two", await ReadAsync(provider, "save.dat.bak1"));
Assert.AreEqual("one", await ReadAsync(provider, "save.dat.bak2"));
});
[UnityTest]
public IEnumerator RenameOnly_RecoversPrimaryFromBak1_WhenPrimaryMissing() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
var primary = Path.Combine(_rootPath, "save.dat");
var primaryBackup = primary + ".bak1";
File.Delete(primaryBackup);
File.Move(primary, primaryBackup);
Assert.IsTrue(await provider.ExistsAsync("save.dat"));
Assert.AreEqual("two", await ReadAsync(provider, "save.dat"));
Assert.IsTrue(File.Exists(primary));
Assert.IsFalse(File.Exists(primaryBackup));
});
[UnityTest]
public IEnumerator RenameOnly_RecoversPrimaryFromBak2_WhenBak1Missing() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
await WriteAsync(provider, "three");
var primary = Path.Combine(_rootPath, "save.dat");
File.Delete(primary);
File.Delete(primary + ".bak1");
Assert.AreEqual("one", await ReadAsync(provider, "save.dat"));
});
[UnityTest]
public IEnumerator RenameOnly_DeletesStaleTempBeforeWrite() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
var primary = Path.Combine(_rootPath, "save.dat");
File.WriteAllText(primary + ".tmp", "stale", Encoding.UTF8);
await WriteAsync(provider, "two");
Assert.IsFalse(File.Exists(primary + ".tmp"));
Assert.AreEqual("two", await ReadAsync(provider, "save.dat"));
});
[UnityTest]
public IEnumerator RenameOnly_PreservesSecondGeneration_WhenBak1Missing() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
await WriteAsync(provider, "three");
var primary = Path.Combine(_rootPath, "save.dat");
File.Delete(primary + ".bak1");
await WriteAsync(provider, "four");
Assert.AreEqual("four", await ReadAsync(provider, "save.dat"));
Assert.AreEqual("three", await ReadAsync(provider, "save.dat.bak1"));
Assert.AreEqual("one", await ReadAsync(provider, "save.dat.bak2"));
});
[UnityTest]
public IEnumerator RenameOnly_DoesNotPromoteOrphanTemp() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
var primary = Path.Combine(_rootPath, "save.dat");
File.WriteAllText(primary + ".tmp", "partial", new UTF8Encoding(false));
Assert.IsFalse(await provider.ExistsAsync("save.dat"));
Assert.IsFalse(File.Exists(primary));
Assert.IsFalse(File.Exists(primary + ".tmp"));
var readFailed = false;
try
{
await ReadAsync(provider, "save.dat");
}
catch (FileNotFoundException)
{
readFailed = true;
}
Assert.IsTrue(readFailed);
});
[UnityTest]
public IEnumerator RenameOnly_PrefersBackupOverPartialTemp() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
var primary = Path.Combine(_rootPath, "save.dat");
File.Delete(primary);
File.WriteAllText(primary + ".tmp", "partial", new UTF8Encoding(false));
Assert.IsTrue(await provider.ExistsAsync("save.dat"));
Assert.AreEqual("one", await ReadAsync(provider, "save.dat"));
Assert.IsFalse(File.Exists(primary + ".tmp"));
});
[UnityTest]
public IEnumerator FileReplace_DoesNotApplyRenameOnlyRecovery() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
var primary = Path.Combine(_rootPath, "save.dat");
File.Delete(primary);
File.WriteAllText(primary + ".tmp", "partial", new UTF8Encoding(false));
Assert.IsFalse(await provider.ExistsAsync("save.dat"));
Assert.IsTrue(File.Exists(primary + ".bak1"));
Assert.IsTrue(File.Exists(primary + ".tmp"));
var readFailed = false;
try
{
await ReadAsync(provider, "save.dat");
}
catch (FileNotFoundException)
{
readFailed = true;
}
Assert.IsTrue(readFailed);
});
[UnityTest]
public IEnumerator DeleteAsync_RemovesBackupsAndTemp() => UniTask.ToCoroutine(async () =>
{
var provider = new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly, TestMove);
await WriteAsync(provider, "one");
await WriteAsync(provider, "two");
var primary = Path.Combine(_rootPath, "save.dat");
File.WriteAllText(primary + ".tmp", "stale", Encoding.UTF8);
await provider.DeleteAsync("save.dat");
Assert.IsFalse(File.Exists(primary));
Assert.IsFalse(File.Exists(primary + ".bak1"));
Assert.IsFalse(File.Exists(primary + ".bak2"));
Assert.IsFalse(File.Exists(primary + ".tmp"));
});
[UnityTest]
public IEnumerator PlatformInitialize_UsesInjectedStorage() => UniTask.ToCoroutine(async () =>
{
var storage = new MockStorageProvider();
ShrinkSettings.ResetForTesting();
ShrinkDataSaverPlatform.Initialize(storage, "runtime-root");
ShrinkSettings.Set("injected", 7);
await ShrinkSettings.SaveAsync();
Assert.IsTrue(await storage.ExistsAsync("runtime-root/settings.json"));
var bytes = await storage.ReadAsync("runtime-root/settings.json");
StringAssert.Contains("\"injected\"", Encoding.UTF8.GetString(bytes));
});
// Tests the shared rotation contract; Godot integration tests exercise actual overwrite rename.
private static void TestMove(string source, string destination)
{
if (File.Exists(destination)) File.Delete(destination);
File.Move(source, destination);
}
[Test]
public void RenameOnly_RequiresOverwriteCapability() => Assert.Throws<ArgumentException>(() =>
new LocalStorageProvider(_rootPath, LocalStorageCommitStrategy.RenameOnly));
private static async UniTask WriteAsync(IStorageProvider provider, string value)
{
await provider.WriteAsync("save.dat", Encoding.UTF8.GetBytes(value));
}
private static async UniTask<string> ReadAsync(IStorageProvider provider, string path)
{
var bytes = await provider.ReadAsync(path);
return Encoding.UTF8.GetString(bytes);
}
}
}
@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: f087803def7c483eab1449e4f5dce096
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:
+62
View File
@@ -1,5 +1,7 @@
using System.Collections; using System.Collections;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO;
using System.Threading;
using Cysharp.Threading.Tasks; using Cysharp.Threading.Tasks;
using NUnit.Framework; using NUnit.Framework;
using UnityEngine; using UnityEngine;
@@ -199,6 +201,48 @@ namespace ShrinkDataSaver.Tests
CollectionAssert.AreEqual(backupBytes, repairedPrimary); CollectionAssert.AreEqual(backupBytes, repairedPrimary);
}); });
[UnityTest]
public IEnumerator LoadAsync_FallsBackToSecondaryBackup_WhenPrimaryAndFirstBackupCorrupted() =>
UniTask.ToCoroutine(async () =>
{
ShrinkSettings.Set("lang", "zh_cn");
await ShrinkSettings.SaveAsync();
var backupBytes = await _storage.ReadAsync("settings.json");
await _storage.WriteAsync("settings.json.bak2", backupBytes);
await _storage.WriteAsync("settings.json.bak1", System.Text.Encoding.UTF8.GetBytes("{ broken"));
await _storage.WriteAsync("settings.json", System.Text.Encoding.UTF8.GetBytes("{ broken"));
ShrinkSettings.ResetForTesting();
ShrinkSettings.Initialize(_storage, "settings.json");
await ShrinkSettings.LoadAsync();
Assert.AreEqual("zh_cn", ShrinkSettings.Get<string>("lang"));
var repairedPrimary = await _storage.ReadAsync("settings.json");
CollectionAssert.AreEqual(backupBytes, repairedPrimary);
});
[UnityTest]
public IEnumerator SaveAsync_PropagatesStorageFailure() => UniTask.ToCoroutine(async () =>
{
ShrinkSettings.ResetForTesting();
ShrinkSettings.Initialize(new FailingStorageProvider(), "settings.json");
ShrinkSettings.Set("lang", "zh_cn");
var failed = false;
try
{
await ShrinkSettings.SaveAsync();
}
catch (IOException)
{
failed = true;
}
Assert.IsTrue(failed);
});
// ── Overwrite ── // ── Overwrite ──
[Test] [Test]
@@ -208,5 +252,23 @@ namespace ShrinkDataSaver.Tests
ShrinkSettings.Set("key", "second"); ShrinkSettings.Set("key", "second");
Assert.AreEqual("second", ShrinkSettings.Get<string>("key")); Assert.AreEqual("second", ShrinkSettings.Get<string>("key"));
} }
private sealed class FailingStorageProvider : IStorageProvider
{
public UniTask WriteAsync(string path, byte[] data, CancellationToken ct = default) =>
throw new IOException("write failed");
public UniTask<byte[]> ReadAsync(string path, CancellationToken ct = default) =>
throw new FileNotFoundException(path);
public UniTask<bool> ExistsAsync(string path, CancellationToken ct = default) =>
UniTask.FromResult(false);
public UniTask DeleteAsync(string path, CancellationToken ct = default) =>
UniTask.CompletedTask;
public UniTask<string[]> ListAsync(string prefix = "", CancellationToken ct = default) =>
UniTask.FromResult(System.Array.Empty<string>());
}
} }
} }
+2 -2
View File
@@ -1,6 +1,6 @@
{ {
"name": "com.cneicy.shrink-datasaver", "name": "com.cneicy.shrink-datasaver",
"version": "2.3.0", "version": "2.5.0",
"displayName": "ShrinkDataSaver", "displayName": "ShrinkDataSaver",
"description": "模块化 Unity 存档与设置管理系统,支持多槽位、链式版本迁移、AES-256 加密、关键模块保护、跨模块查询与事件驱动架构。", "description": "模块化 Unity 存档与设置管理系统,支持多槽位、链式版本迁移、AES-256 加密、关键模块保护、跨模块查询与事件驱动架构。",
"unity": "2022.3", "unity": "2022.3",
@@ -12,7 +12,7 @@
"com.cysharp.unitask": "2.5.0", "com.cysharp.unitask": "2.5.0",
"com.unity.modules.imageconversion": "1.0.0", "com.unity.modules.imageconversion": "1.0.0",
"com.unity.modules.screencapture": "1.0.0", "com.unity.modules.screencapture": "1.0.0",
"com.cneicy.shrink-runtime-abstractions": "0.1.0" "com.cneicy.shrink-runtime-abstractions": "0.2.0"
}, },
"keywords": [ "keywords": [
"save", "save",