feat: 本地化字符串和interface文件加载从单线程改为多线程

Author: textGamex

VModer.Core/Services/GameResource/Base/CommonResourcesService.cs

@@ -11,9 +11,10 @@ public abstract class CommonResourcesService<TType, TContent> : ResourcesService
     protected CommonResourcesService(
         string folderOrFileRelativePath,
         WatcherFilter filter,
-        PathType pathType = PathType.Folder
+        PathType pathType = PathType.Folder,
+        bool isAsyncLoading = false
     )
-        : base(folderOrFileRelativePath, filter, pathType) { }
+        : base(folderOrFileRelativePath, filter, pathType, isAsyncLoading) { }
 
     ///<inheritdoc />
     protected abstract override TContent? ParseFileToContent(Node rootNode);

VModer.Core/Services/GameResource/Base/ResourcesService.cs

@@ -1,3 +1,4 @@
+using System.Collections.Concurrent;
 using System.Diagnostics;
 using Microsoft.Extensions.DependencyInjection;
 using NLog;
@@ -12,7 +13,7 @@ public abstract partial class ResourcesService<TType, TContent, TParseResult> :
     /// <summary>
     /// key: 文件路径, value: 文件内资源内容
     /// </summary>
-    protected readonly Dictionary<string, TContent> Resources;
+    protected readonly IDictionary<string, TContent> Resources;
     protected readonly Logger Log;
 
     private readonly SettingsService _settingService;
@@ -25,7 +26,13 @@ public abstract partial class ResourcesService<TType, TContent, TParseResult> :
     /// <param name="folderOrFileRelativePath">文件夹或文件的相对路径</param>
     /// <param name="filter">过滤条件</param>
     /// <param name="pathType"><c>folderOrFileRelativePath</c>的类型</param>
-    protected ResourcesService(string folderOrFileRelativePath, WatcherFilter filter, PathType pathType)
+    /// <param name="isAsyncLoading">是否多线程加载资源, 子类需要确保重写的方法是线程安全的</param>
+    protected ResourcesService(
+        string folderOrFileRelativePath,
+        WatcherFilter filter,
+        PathType pathType,
+        bool isAsyncLoading = false
+    )
     {
         _folderOrFileRelativePath = folderOrFileRelativePath;
         Log = LogManager.GetLogger(typeof(TType).FullName);
@@ -42,13 +49,23 @@ protected ResourcesService(string folderOrFileRelativePath, WatcherFilter filter
             : [gameResourcesPathService.GetFilePathPriorModByRelativePath(folderOrFileRelativePath)];
 
         // Resources 必须在使用 ParseFileAndAddToResources 之前初始化
-        Resources = new Dictionary<string, TContent>(filePaths.Length);
-
-        SortFilePath(filePaths);
+        if (isAsyncLoading)
+        {
+            Resources = new ConcurrentDictionary<string, TContent>();
+        }
+        else
+        {
+            Resources = new Dictionary<string, TContent>(filePaths.Length);
+        }
 
-        foreach (string filePath in filePaths)
+        if (isAsyncLoading)
         {
-            ParseFileAndAddToResources(filePath);
+            ParseFileAndAddToResourcesAsync(filePaths);
+        }
+        else
+        {
+            SortFilePath(filePaths);
+            ParseFileAndAddToResourcesSync(filePaths);
         }
 
         watcherService.Watch(
@@ -63,11 +80,29 @@ protected ResourcesService(string folderOrFileRelativePath, WatcherFilter filter
     }
 
     /// <summary>
-    /// 当需要对传入的文件路径顺序进行排序时, 重写此方法
+    /// 当需要对传入的文件路径顺序进行排序时, 重写此方法, 在多线程加载资源时不调用.
     /// </summary>
     /// <param name="filePathArray"></param>
     protected virtual void SortFilePath(string[] filePathArray) { }
 
+    private void ParseFileAndAddToResourcesAsync(string[] filePaths)
+    {
+        var tasks = new List<Task>();
+        foreach (string filePath in filePaths)
+        {
+            tasks.Add(Task.Run(() => ParseFileAndAddToResources(filePath)));
+        }
+        Task.WaitAll(tasks);
+    }
+
+    private void ParseFileAndAddToResourcesSync(string[] filePaths)
+    {
+        foreach (string filePath in filePaths)
+        {
+            ParseFileAndAddToResources(filePath);
+        }
+    }
+
     [Conditional("DEBUG")]
     private void LogItemsSum()
     {

VModer.Core/Services/GameResource/BuildingsService.cs

@@ -10,7 +10,7 @@ namespace VModer.Core.Services.GameResource;
 public sealed class BuildingsService
     : CommonResourcesService<BuildingsService, FrozenDictionary<string, BuildingInfo>>
 {
-    private Dictionary<string, FrozenDictionary<string, BuildingInfo>>.ValueCollection Buildings =>
+    private ICollection<FrozenDictionary<string, BuildingInfo>> Buildings =>
         Resources.Values;
     private const string BuildingsKeyword = "buildings";
 

VModer.Core/Services/GameResource/LeaderTraitsService.cs

@@ -14,7 +14,7 @@ public sealed class LeaderTraitsService()
         WatcherFilter.Text
     )
 {
-    private Dictionary<string, FrozenDictionary<string, LeaderTrait>>.ValueCollection Traits =>
+    private ICollection<FrozenDictionary<string, LeaderTrait>> Traits =>
         Resources.Values;
 
     public bool TryGetValue(string traitName, [NotNullWhen(true)] out LeaderTrait? trait)

VModer.Core/Services/GameResource/Localization/LocalizationService.cs

@@ -12,7 +12,7 @@ namespace VModer.Core.Services.GameResource.Localization;
 public sealed class LocalizationService
     : ResourcesService<LocalizationService, FrozenDictionary<string, string>, YAMLLocalisationParser.LocFile>
 {
-    private Dictionary<string, FrozenDictionary<string, string>>.ValueCollection Localisations =>
+    private ICollection<FrozenDictionary<string, string>> Localisations =>
         Resources.Values;
     private readonly LocalizationKeyMappingService _localizationKeyMapping;
 
@@ -24,7 +24,8 @@ public LocalizationService(LocalizationKeyMappingService localizationKeyMapping)
                 App.Services.GetRequiredService<SettingsService>().GameLanguage.ToGameLocalizationLanguage()
             ),
             WatcherFilter.LocalizationFiles,
-            PathType.Folder
+            PathType.Folder,
+            true
         )
     {
         _localizationKeyMapping = localizationKeyMapping;

VModer.Core/Services/GameResource/SpriteService.cs

@@ -15,9 +15,9 @@ public sealed class SpriteService
 {
     [Time("加载界面图片")]
     public SpriteService()
-        : base("interface", WatcherFilter.GfxFiles) { }
+        : base("interface", WatcherFilter.GfxFiles, PathType.Folder, true) { }
 
-    private Dictionary<string, FrozenDictionary<string, SpriteInfo>>.ValueCollection Sprites =>
+    private ICollection<FrozenDictionary<string, SpriteInfo>> Sprites =>
         Resources.Values;
 
     public bool TryGetSpriteInfo(string spriteTypeName, [NotNullWhen(true)] out SpriteInfo? info)

VModer.Core/Services/GameResource/TerrainService.cs

@@ -11,7 +11,7 @@ namespace VModer.Core.Services.GameResource;
 /// </summary>
 public sealed class TerrainService : CommonResourcesService<TerrainService, FrozenSet<string>>
 {
-    private Dictionary<string, FrozenSet<string>>.ValueCollection Terrains => Resources.Values;
+    private ICollection<FrozenSet<string>> Terrains => Resources.Values;
 
     /// <summary>
     /// 未在文件中定义的地形