Add custom async file trace listener and improve disposal

JusterZhu · JusterZhu · commit 2917dab2a183 · 2025-08-28T17:08:55.000+08:00
Introduces TextTraceListener for asynchronous file logging, replacing TextWriterTraceListener in GeneralTracer. Ensures proper disposal of trace listeners in upgrade and strategy flows. Also removes unnecessary PublishAot properties and comments out Patch/BackUp options in client and upgrader programs for better configuration flexibility.
diff --git a/src/c#/GeneralUpdate.Bowl/GeneralUpdate.Bowl.csproj b/src/c#/GeneralUpdate.Bowl/GeneralUpdate.Bowl.csproj
@@ -85,6 +85,7 @@
         <Compile Include="..\GeneralUpdate.Common\Shared\Object\VersionOSS.cs" Link="Common\VersionOSS.cs" />
         <Compile Include="..\GeneralUpdate.Common\Shared\Service\VersionService.cs" Link="Common\VersionService.cs" />
         <Compile Include="..\GeneralUpdate.Common\Shared\Trace\GeneralTracer.cs" Link="Common\GeneralTracer.cs" />
+        <Compile Include="..\GeneralUpdate.Common\Shared\Trace\TextTraceListener.cs" Link="Common\TextTraceListener.cs" />
         <Compile Include="..\GeneralUpdate.Common\Shared\Trace\WindowsOutputDebugListener.cs" Link="Common\WindowsOutputDebugListener.cs" />
     </ItemGroup>
 
diff --git a/src/c#/GeneralUpdate.Client/GeneralUpdate.Client.csproj b/src/c#/GeneralUpdate.Client/GeneralUpdate.Client.csproj
@@ -6,7 +6,6 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <LangVersion>default</LangVersion>
-    <PublishAot>true</PublishAot>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/c#/GeneralUpdate.Client/Program.cs b/src/c#/GeneralUpdate.Client/Program.cs
@@ -51,8 +51,8 @@ static async Task Main(string[] args)
                     .SetConfig(configinfo)
                     .Option(UpdateOption.DownloadTimeOut, 60)
                     .Option(UpdateOption.Encoding, Encoding.UTF8)
-                    .Option(UpdateOption.Patch, false)
-                    .Option(UpdateOption.BackUp, false)
+                    //.Option(UpdateOption.Patch, false)
+                    //.Option(UpdateOption.BackUp, false)
                     .LaunchAsync();
                 Console.WriteLine($"主程序已启动，{DateTime.Now}！");
             }
diff --git a/src/c#/GeneralUpdate.ClientCore/GeneralClientOSS.cs b/src/c#/GeneralUpdate.ClientCore/GeneralClientOSS.cs
@@ -35,31 +35,38 @@ await Task.Run(() =>
                 var versionsFilePath = Path.Combine(basePath, configGlobalConfigInfo.VersionFileName);
                 DownloadFile(configGlobalConfigInfo.Url, versionsFilePath);
                 if (!File.Exists(versionsFilePath)) return;
-                var versions = StorageManager.GetJson<List<VersionOSS>>(versionsFilePath, VersionOSSJsonContext.Default.ListVersionOSS);
+                var versions = StorageManager.GetJson<List<VersionOSS>>(versionsFilePath,
+                    VersionOSSJsonContext.Default.ListVersionOSS);
                 if (versions == null || versions.Count == 0) return;
                 versions = versions.OrderByDescending(x => x.PubTime).ToList();
                 var newVersion = versions.First();
                 //Determine whether the current client version needs to be upgraded.
                 GeneralTracer.Debug("3.Determine whether the current client version needs to be upgraded.");
-                if (!IsUpgrade(configGlobalConfigInfo.CurrentVersion, newVersion.Version)) 
+                if (!IsUpgrade(configGlobalConfigInfo.CurrentVersion, newVersion.Version))
                     return;
-                
+
                 //If you confirm that an update is required, start the upgrade application.
                 var appPath = Path.Combine(basePath, $"{upgradeAppName}");
-                if (!File.Exists(appPath)) 
+                if (!File.Exists(appPath))
                     throw new Exception($"The application does not exist {upgradeAppName} !");
-                
+
                 GeneralTracer.Debug("4.Start upgrade app.");
-                var json = JsonSerializer.Serialize(configGlobalConfigInfo, GlobalConfigInfoOSSJsonContext.Default.GlobalConfigInfoOSS);
+                var json = JsonSerializer.Serialize(configGlobalConfigInfo,
+                    GlobalConfigInfoOSSJsonContext.Default.GlobalConfigInfoOSS);
                 Environments.SetEnvironmentVariable("GlobalConfigInfoOSS", json);
                 Process.Start(appPath);
                 Process.GetCurrentProcess().Kill();
             }
             catch (Exception exception)
             {
-                GeneralTracer.Error("The BaseStart method in the GeneralClientOSS class throws an exception.", exception);
+                GeneralTracer.Error("The BaseStart method in the GeneralClientOSS class throws an exception.",
+                    exception);
                 throw exception;
             }
+            finally
+            {
+                GeneralTracer.Dispose();
+            }
         });
     }
 
diff --git a/src/c#/GeneralUpdate.ClientCore/GeneralUpdate.ClientCore.csproj b/src/c#/GeneralUpdate.ClientCore/GeneralUpdate.ClientCore.csproj
@@ -75,6 +75,7 @@
         <Compile Include="..\GeneralUpdate.Common\Shared\Object\VersionOSS.cs" Link="Common\VersionOSS.cs" />
         <Compile Include="..\GeneralUpdate.Common\Shared\Service\VersionService.cs" Link="Common\VersionService.cs" />
         <Compile Include="..\GeneralUpdate.Common\Shared\Trace\GeneralTracer.cs" Link="Common\GeneralTracer.cs" />
+        <Compile Include="..\GeneralUpdate.Common\Shared\Trace\TextTraceListener.cs" Link="Common\TextTraceListener.cs" />
         <Compile Include="..\GeneralUpdate.Common\Shared\Trace\WindowsOutputDebugListener.cs" Link="Common\WindowsOutputDebugListener.cs" />
         <Compile Include="..\GeneralUpdate.Differential\Binary\BinaryHandler.cs" Link="Common\BinaryHandler.cs" />
         <Compile Include="..\GeneralUpdate.Differential\Binary\BZip2Constants.cs" Link="Common\BZip2Constants.cs" />
diff --git a/src/c#/GeneralUpdate.ClientCore/Strategys/LinuxStrategy.cs b/src/c#/GeneralUpdate.ClientCore/Strategys/LinuxStrategy.cs
@@ -117,6 +117,7 @@ public override void StartApp()
         }
         finally
         {
+            GeneralTracer.Dispose();
             Process.GetCurrentProcess().Kill();
         }
     }
diff --git a/src/c#/GeneralUpdate.ClientCore/Strategys/WindowsStrategy.cs b/src/c#/GeneralUpdate.ClientCore/Strategys/WindowsStrategy.cs
@@ -112,6 +112,7 @@ public override void StartApp()
         }
         finally
         {
+            GeneralTracer.Dispose();
             Process.GetCurrentProcess().Kill();
         }
     }
diff --git a/src/c#/GeneralUpdate.Common/Shared/Trace/GeneralTracer.cs b/src/c#/GeneralUpdate.Common/Shared/Trace/GeneralTracer.cs
@@ -10,7 +10,7 @@ public static class GeneralTracer
     private static readonly object _lockObj = new();
     private static bool _isTracingEnabled;
     private static string _currentLogDate;
-    private static TextWriterTraceListener _fileListener;
+    private static TextTraceListener _fileListener;
   
     static GeneralTracer()
     {
@@ -51,7 +51,8 @@ private static void InitializeFileListener()
         Directory.CreateDirectory(logDir);
 
         var logFileName = Path.Combine(logDir, $"generalupdate-trace {today}.log");
-        _fileListener = new TextWriterTraceListener(logFileName) { Name = "FileListener" };
+        //_fileListener = new TextWriterTraceListener(logFileName) { Name = "FileListener" };
+        _fileListener = new TextTraceListener(logFileName);
             
         Trace.Listeners.Add(_fileListener);
         _currentLogDate = today;
@@ -140,17 +141,24 @@ private static void WriteTraceMessage(TraceLevel level, string message)
 
     public static void Dispose()
     {
-        lock (_lockObj)
+        try
         {
-            if (_fileListener is not null)
+            lock (_lockObj)
             {
-                _fileListener.Flush();
-                _fileListener.Close();
-                _fileListener.Dispose();
-                _fileListener = null;
+                if (_fileListener is not null)
+                {
+                    _fileListener.Flush();
+                    _fileListener.Close();
+                    _fileListener.Dispose();
+                    _fileListener = null;
+                }
+
+                Trace.Listeners.Clear();
             }
-
-            Trace.Listeners.Clear();
+        }
+        catch
+        {
+            // ignored
         }
     }
 }
diff --git a/src/c#/GeneralUpdate.Common/Shared/Trace/TextTraceListener.cs b/src/c#/GeneralUpdate.Common/Shared/Trace/TextTraceListener.cs
@@ -0,0 +1,63 @@
+﻿using System;
+using System.Diagnostics;
+using System.IO;
+using System.Collections.Concurrent;
+using System.Threading;
+
+public class TextTraceListener : TraceListener, IDisposable
+{
+    private readonly string _filePath;
+    private readonly BlockingCollection<string> _messageQueue;
+    private readonly Thread _loggingThread;
+    private volatile bool _isDisposed;
+
+    public TextTraceListener(string filePath)
+    {
+        _filePath = filePath;
+        _messageQueue = new BlockingCollection<string>();
+        _loggingThread = new Thread(ProcessQueue);
+        _loggingThread.IsBackground = true;
+        _loggingThread.Start();
+    }
+
+    public override void Write(string? message)
+    {
+        QueueMessage(message);
+    }
+
+    public override void WriteLine(string? message)
+    {
+        QueueMessage(message + Environment.NewLine);
+    }
+
+    private void QueueMessage(string? message)
+    {
+        if (!_isDisposed && message != null)
+        {
+            _messageQueue.Add(message);
+        }
+    }
+
+    private void ProcessQueue()
+    {
+        foreach (var message in _messageQueue.GetConsumingEnumerable())
+        {
+            using (var fileStream = new FileStream(_filePath, FileMode.Append, FileAccess.Write, FileShare.ReadWrite))
+            using (var writer = new StreamWriter(fileStream))
+            {
+                writer.Write(message);
+            }
+        }
+    }
+
+    public void Dispose()
+    {
+        if (!_isDisposed)
+        {
+            _isDisposed = true;
+            _messageQueue.CompleteAdding();
+            _loggingThread.Join();
+            _messageQueue.Dispose();
+        }
+    }
+}
diff --git a/src/c#/GeneralUpdate.Core/GeneralUpdate.Core.csproj b/src/c#/GeneralUpdate.Core/GeneralUpdate.Core.csproj
@@ -78,6 +78,7 @@
     <Compile Include="..\GeneralUpdate.Common\Shared\Object\VersionOSS.cs" Link="Common\VersionOSS.cs" />
     <Compile Include="..\GeneralUpdate.Common\Shared\Service\VersionService.cs" Link="Common\VersionService.cs" />
     <Compile Include="..\GeneralUpdate.Common\Shared\Trace\GeneralTracer.cs" Link="Common\GeneralTracer.cs" />
+    <Compile Include="..\GeneralUpdate.Common\Shared\Trace\TextTraceListener.cs" Link="Common\TextTraceListener.cs" />
     <Compile Include="..\GeneralUpdate.Common\Shared\Trace\WindowsOutputDebugListener.cs" Link="Common\WindowsOutputDebugListener.cs" />
     <Compile Include="..\GeneralUpdate.Differential\Binary\BinaryHandler.cs" Link="Common\BinaryHandler.cs" />
     <Compile Include="..\GeneralUpdate.Differential\Binary\BZip2Constants.cs" Link="Common\BZip2Constants.cs" />
diff --git a/src/c#/GeneralUpdate.Core/GeneralUpdateOSS.cs b/src/c#/GeneralUpdate.Core/GeneralUpdateOSS.cs
@@ -37,16 +37,22 @@ private static async Task BaseStart()
                 if (string.IsNullOrWhiteSpace(json))
                     return;
 
-                var parameter = JsonSerializer.Deserialize<GlobalConfigInfoOSS>(json, GlobalConfigInfoOSSJsonContext.Default.GlobalConfigInfoOSS);
+                var parameter = JsonSerializer.Deserialize<GlobalConfigInfoOSS>(json,
+                    GlobalConfigInfoOSSJsonContext.Default.GlobalConfigInfoOSS);
                 var strategy = new OSSStrategy();
                 strategy.Create(parameter);
                 await strategy.ExecuteAsync();
             }
             catch (Exception exception)
             {
-                GeneralTracer.Error("The BaseStart method in the GeneralUpdateOSS class throws an exception.",exception);
+                GeneralTracer.Error("The BaseStart method in the GeneralUpdateOSS class throws an exception.",
+                    exception);
                 throw exception;
             }
+            finally
+            {
+                GeneralTracer.Dispose();
+            }
         }
         
         #endregion Private Methods
diff --git a/src/c#/GeneralUpdate.Core/Strategys/OSSStrategy.cs b/src/c#/GeneralUpdate.Core/Strategys/OSSStrategy.cs
@@ -103,6 +103,7 @@ private void LaunchApp()
             Process.Start(appPath);
             
             GeneralTracer.Debug("5.Upgrade complete.");
+            GeneralTracer.Dispose();
         }
 
         private void Decompress(List<VersionOSS> versions)
diff --git a/src/c#/GeneralUpdate.Core/Strategys/WindowsStrategy.cs b/src/c#/GeneralUpdate.Core/Strategys/WindowsStrategy.cs
@@ -124,6 +124,7 @@ public override void StartApp()
             }
             finally
             {
+                GeneralTracer.Dispose();
                 Process.GetCurrentProcess().Kill();
             }
         }
diff --git a/src/c#/GeneralUpdate.Upgrad/GeneralUpdate.Upgrad.csproj b/src/c#/GeneralUpdate.Upgrad/GeneralUpdate.Upgrad.csproj
@@ -5,9 +5,7 @@
     <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-    <PublishAot>true</PublishAot>
     <LangVersion>default</LangVersion>
-    <PublishAot>true</PublishAot>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/c#/GeneralUpdate.Upgrad/Program.cs b/src/c#/GeneralUpdate.Upgrad/Program.cs
@@ -33,7 +33,7 @@ static async Task Main(string[] args)
                     //.SetFieldMappings(fieldMappingsCN)
                     //是否开启驱动更新
                     //.Option(UpdateOption.Drive, true)
-                    .Option(UpdateOption.Patch, false)
+                    //.Option(UpdateOption.Patch, false)
                     .LaunchAsync();
                 Console.WriteLine($"升级程序已启动，{DateTime.Now}！");
             }

Original file line number	Diff line number	Diff line change
`@@ -117,6 +117,7 @@ public override void StartApp()`
`117`	`117`	`}`
`118`	`118`	`finally`
`119`	`119`	`{`
	`120`	`+ GeneralTracer.Dispose();`
`120`	`121`	`Process.GetCurrentProcess().Kill();`
`121`	`122`	`}`
`122`	`123`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ public override void StartApp()`
`112`	`112`	`}`
`113`	`113`	`finally`
`114`	`114`	`{`
	`115`	`+ GeneralTracer.Dispose();`
`115`	`116`	`Process.GetCurrentProcess().Kill();`
`116`	`117`	`}`
`117`	`118`	`}`