feat: 允许在配置文件中指定启动时检查文件行为

opti: 将部分代码拆分
opti: 对 Cluster 的部分操作添加了 IsEnabled 属性的检查
opti: 能够正确打印来自服务端的信息
actions: 移除“Debug”构建

Author: SALTWOOD

.github/workflows/dotnet.yml

@@ -14,7 +14,7 @@ jobs:
   build:
     strategy:
       matrix:
-        configuration: [Debug, Release]
+        configuration: [Release]
     runs-on: windows-latest
     steps:
       - name: Checkout

CSharp-OpenBMCLAPI/DefaultConfig.json5

@@ -1,4 +1,11 @@
 {
+  // 集群启动时的文件检查模式
+  // 0: None（不检查，不推荐）
+  // 1: Exists（检查文件是否存在）
+  // 2: SizeOnly（检查文件大小，推荐，默认）
+  // 3: Hash（完整计算哈希，时间长，推荐不常重启或是分片节点使用）
+  "startupCheckMode": 2,
+
   // 指示 token 应当在距离其失效前的多少毫秒进行刷新
   "refreshTokenTime": 1800000,
   // 指示应该将要服务的文件放在哪里（服务路径）

CSharp-OpenBMCLAPI/Modules/Cluster.cs

@@ -8,6 +8,7 @@
 using Microsoft.Extensions.Options;
 using SocketIOClient;
 using System.Diagnostics;
+using System.IO;
 using System.Net;
 using System.Runtime.InteropServices;
 using System.Security.Cryptography;
@@ -29,10 +30,11 @@ public class Cluster : RunnableBase
         private HttpClient client;
         public Guid guid;
         private SocketIOClient.SocketIO socket;
-        public bool IsEnabled { get; private set; }
+        public bool IsEnabled { get; set; }
         private Task? _keepAlive;
         protected IStorage storage;
         protected AccessCounter counter;
+        public CancellationTokenSource cancellationSrc = new CancellationTokenSource();
         //List<Task> tasks = new List<Task>();
 
         public Cluster(ClusterInfo info, TokenManager token) : base()
@@ -50,22 +52,28 @@ public Cluster(ClusterInfo info, TokenManager token) : base()
             this.storage = new FileStorage(SharedData.Config.clusterFileDirectory);
 
             this.counter = new();
+            InitializeSocket();
 
+            // 用来规避构造函数退出时巴拉巴拉的提示
+            if (this.socket == null)
+            {
+                throw new Exception("Impossible! \"socket\" field is still null.");
+            }
+        }
+
+        protected void InitializeSocket()
+        {
             this.socket = new(HttpRequest.client.BaseAddress?.ToString(), new SocketIOOptions()
             {
                 Transport = SocketIOClient.Transport.TransportProtocol.WebSocket,
                 Auth = new
                 {
-                    token = token.Token.token
+                    token = this.token.Token.token
                 }
             });
-
         }
 
-        private void HandleError(SocketIOResponse resp)
-        {
-            return;
-        }
+        public void HandleError(SocketIOResponse resp) => Utils.PrintResponseMessage(resp);
 
         protected override int Run(string[] args)
         {
@@ -95,15 +103,16 @@ protected async Task<int> AsyncRun()
 
             SharedData.Logger.LogInfo($"工作进程 {guid} 在 <{SharedData.Config.HOST}:{SharedData.Config.PORT}> 提供服务");
 
-            _keepAlive = Task.Run(() =>
+            _keepAlive = Task.Run(async () =>
             {
                 while (true)
                 {
-                    Thread.Sleep(25 * 1000);
+                    cancellationSrc.Token.ThrowIfCancellationRequested();
+                    await Task.Delay(25 * 1000);
                     // Disable().Wait();
-                    KeepAlive().Wait();
+                    await KeepAlive();
                 }
-            });
+            }, cancellationSrc.Token);
 
             _keepAlive.Wait();
 
@@ -161,7 +170,7 @@ public void Connect()
             this.socket.ConnectAsync().Wait();
 
             this.socket.On("error", error => HandleError(error));
-            this.socket.On("message", msg => PrintServerMessage(msg));
+            this.socket.On("message", msg => Utils.PrintResponseMessage(msg));
             this.socket.On("connect", (_) => SharedData.Logger.LogInfo("与主控连接成功"));
             this.socket.On("disconnect", (r) =>
             {
@@ -170,19 +179,16 @@ public void Connect()
             });
         }
 
-        private static void PrintServerMessage(SocketIOResponse msg)
-        {
-            SharedData.Logger.LogInfo(msg);
-        }
-
         public async Task Enable()
         {
-            await socket.EmitAsync("enable",
+            if (!this.socket.Connected || !this.IsEnabled)
+                await socket.EmitAsync("enable",
                 (SocketIOResponse resp) =>
                 {
-                    SharedData.Logger.LogInfo(resp);
+                    Utils.PrintResponseMessage(resp);
                     // Debugger.Break();
                     SharedData.Logger.LogInfo($"启用成功");
+                    this.IsEnabled = true;
                 },
                 new
                 {
@@ -201,22 +207,25 @@ await socket.EmitAsync("enable",
 
         public async Task Disable()
         {
-            await socket.EmitAsync("disable",
+            if (this.IsEnabled)
+                await socket.EmitAsync("disable",
                 (SocketIOResponse resp) =>
                 {
-                    SharedData.Logger.LogInfo(resp);
+                    Utils.PrintResponseMessage(resp);
                     SharedData.Logger.LogInfo($"禁用成功");
+                    this.IsEnabled = false;
                 });
         }
 
         public async Task KeepAlive()
         {
+            if (!this.IsEnabled) return;
             string time = DateTime.Now.ToStandardTimeString();
             // socket.Connected.Dump();
             await socket.EmitAsync("keep-alive",
                 (SocketIOResponse resp) =>
                 {
-                    SharedData.Logger.LogInfo(resp);
+                    Utils.PrintResponseMessage(resp);
                     SharedData.Logger.LogInfo($"保活成功 at {time}，served {Utils.GetLength(this.counter.bytes)}({this.counter.bytes} bytes)/{this.counter.hits} hits");
                     this.counter.Reset();
                 },
@@ -234,27 +243,27 @@ public async Task GetConfiguration()
             var content = await resp.Content.ReadAsStringAsync();
         }
 
+
         protected async Task CheckFiles()
         {
-            SharedData.Logger.LogInfo("开始检查文件");
-            var resp = await client.GetAsync("openbmclapi/files");
-            byte[] buffer = await resp.Content.ReadAsByteArrayAsync();
-            var decompressor = new Decompressor();
-            var data = decompressor.Unwrap(buffer).ToArray();
-            buffer = data;
+            const string avroString = @"{""type"": ""array"",""items"": {""type"": ""record"",""name"": ""fileinfo"",""fields"": [{""name"": ""path"", ""type"": ""string""},{""name"": ""hash"", ""type"": ""string""},{""name"": ""size"", ""type"": ""long""}]}}";
 
-            string avroString = @"{""type"": ""array"",""items"": {""type"": ""record"",""name"": ""fileinfo"",""fields"": [{""name"": ""path"", ""type"": ""string""},{""name"": ""hash"", ""type"": ""string""},{""name"": ""size"", ""type"": ""long""}]}}";
+            var resp = await this.client.GetAsync("openbmclapi/files");
+            byte[] bytes = await resp.Content.ReadAsByteArrayAsync();
+            var decompressor = new Decompressor();
+            bytes = decompressor.Unwrap(bytes).ToArray();
 
             Schema schema = Schema.Parse(avroString);
-
-            Avro.IO.Decoder decoder = new BinaryDecoder(new MemoryStream(buffer));
+            var decoder = new BinaryDecoder(new MemoryStream(bytes));
 
             object[] files = new GenericDatumReader<object[]>(schema, schema).Read(null!, decoder);
 
             object countLock = new();
             int count = 0;
 
-            Parallel.ForEach(files, (obj) =>
+            SharedData.Logger.LogDebug($"文件检查策略：{SharedData.Config.startupCheckMode}");
+
+            Parallel.ForEach(files, async (obj) =>
             //foreach (var obj in files)
             {
                 GenericRecord? record = obj as GenericRecord;
@@ -270,44 +279,56 @@ protected async Task CheckFiles()
 
                     if (long.TryParse(t.ToString().ThrowIfNull(), out size))
                     {
-                        DownloadFile(path, hash).Wait();
+                        await DownloadFile(hash, path);
                         lock (countLock)
                         {
                             count++;
                         }
+                        VerifyFile(hash, size, SharedData.Config.startupCheckMode);
                         SharedData.Logger.LogInfoNoNewLine($"\r{count}/{files.Length}");
                     }
                 }
             });
-            SharedData.Logger.LogInfo("\n文件校验完毕");
         }
 
-        private async Task DownloadFile(string path, string hash, bool fullcheck = true)
+        protected bool VerifyFile(string hash, long size, FileVerificationMode mode)
+        {
+            string path = Path.Combine(SharedData.Config.cacheDirectory, Utils.HashToFileName(hash));
+
+            switch (mode)
+            {
+                case FileVerificationMode.None:
+                    return true;
+                case FileVerificationMode.Exists:
+                    return File.Exists(path);
+                case FileVerificationMode.SizeOnly:
+                    if (!VerifyFile(hash, size, FileVerificationMode.Exists)) return false;
+                    FileInfo fileInfo = new FileInfo(path);
+                    return fileInfo.Length == size;
+                case FileVerificationMode.Hash:
+                    if (!VerifyFile(hash, size, FileVerificationMode.SizeOnly)) return false;
+                    var file = File.ReadAllBytes(path);
+                    return Utils.ValidateFile(file, hash);
+                default:
+                    return true;
+            }
+        }
+
+        private async Task DownloadFile(string hash, string path)
         {
             string filePath = Path.Combine(SharedData.Config.cacheDirectory, Utils.HashToFileName(hash));
-            if (!File.Exists(filePath))
+            if (File.Exists(filePath))
             {
-                var resp = await HttpRequest.client.GetAsync($"openbmclapi/download/{hash}");
-                using (var file = File.Create(Path.Combine(SharedData.Config.cacheDirectory, Utils.HashToFileName(hash))))
-                {
-                    file.Write(await resp.Content.ReadAsByteArrayAsync());
-                }
-                SharedData.Logger.LogInfo($"文件 {path} 下载完毕");
+                return;
             }
-            else
+
+            var resp = await this.client.GetAsync($"openbmclapi/download/{hash}");
+
+            using (var file = File.Create(filePath))
             {
-                if (fullcheck)
-                {
-                    var file = File.ReadAllBytes(filePath);
-                    bool valid = Utils.ValidateFile(file, hash, out string realHash);
-                    if (!valid)
-                    {
-                        SharedData.Logger.LogInfo($"文件 {path} 损坏（期望哈希值为 {hash}，实际为 {realHash}）");
-                        File.Delete(filePath);
-                        await DownloadFile(path, hash);
-                    }
-                }
+                file.Write(await resp.Content.ReadAsByteArrayAsync());
             }
+            SharedData.Logger.LogInfo($"文件 {path} 下载成功");
         }
 
         public async Task RequestCertification()

CSharp-OpenBMCLAPI/Modules/Config.cs

@@ -5,6 +5,13 @@ namespace CSharpOpenBMCLAPI.Modules
 {
     public class Config
     {
+        // 集群启动时的文件检查模式
+        // 0: None（不检查，不推荐）
+        // 1: Exists（检查文件是否存在）
+        // 2: SizeOnly（检查文件大小，推荐，默认）
+        // 3: Hash（完整计算哈希，时间长，推荐不常重启或是分片节点使用）
+        public FileVerificationMode startupCheckMode;
+
         // 指示 token 应当在距离其失效前的多少毫秒进行刷新
         public int refreshTokenTime;
         // 指示应该将要服务的文件放在哪里（服务路径）
@@ -29,6 +36,8 @@ public class Config
 
         public Config()
         {
+            this.startupCheckMode = FileVerificationMode.SizeOnly;
+
             this.refreshTokenTime = 1800000;
             this.clusterFileDirectory = "./";
             this.clusterVersion = "1.9.8";

CSharp-OpenBMCLAPI/Modules/FileVerificationMode.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CSharpOpenBMCLAPI.Modules
+{
+    public enum FileVerificationMode
+    {
+        None,
+        Exists,
+        SizeOnly,
+        Hash
+    }
+}

CSharp-OpenBMCLAPI/Modules/Utils.cs

@@ -1,9 +1,11 @@
 using CSharpOpenBMCLAPI.Modules.Storage;
+using SocketIOClient;
 using System.Diagnostics;
 using System.Runtime.InteropServices;
 using System.Security.Cryptography;
 using System.Security.Principal;
 using System.Text;
+using System.Text.Json;
 using TeraIO.Runnable;
 using WindowsFirewallHelper;
 using static System.Net.Mime.MediaTypeNames;
@@ -12,8 +14,40 @@ namespace CSharpOpenBMCLAPI.Modules
 {
     public static class Utils
     {
+        public static void PrintResponseMessage(SocketIOResponse resp)
+        {
+            JsonElement element = resp.GetValue<JsonElement>();
+            PrintJsonElement(element);
+        }
+
+        public static void PrintJsonElement(JsonElement element)
+        {
+            if (element.ValueKind == JsonValueKind.Null) return;
+            switch (element.ValueKind)
+            {
+                case JsonValueKind.String:
+                case JsonValueKind.Number:
+                case JsonValueKind.Object:
+                    SharedData.Logger.LogInfo(element);
+                    break;
+                case JsonValueKind.Array:
+                    foreach (var i in element.EnumerateArray())
+                    {
+                        PrintJsonElement(i);
+                    }
+                    break;
+                default:
+                    break;
+
+            }
+        }
+
         public static async Task ExitCluster(Cluster cluster)
         {
+            cluster.cancellationSrc.Cancel();
+            cluster.IsEnabled = true;
+            await cluster.KeepAlive();
+            Thread.Sleep(1000);
             await cluster.Disable();
             cluster.Stop();
         }