支持 Windows 控制台主机的着色

Author: walterlv

samples/LoggerSample.MainApp/Program.cs

@@ -32,12 +32,12 @@ public static void Main(string[] args)
             .Build()
             .IntoGlobalStaticLog();
 
-        Log.Trace($"Trace log");
-        Log.Debug($"Debug log");
-        Log.Info($"Info log");
-        Log.Warn($"Warn log");
-        Log.Error($"Error log");
-        Log.Fatal($"Fatal log");
+        Log.Trace("Trace log");
+        Log.Debug("Debug log");
+        Log.Info("Info log");
+        Log.Warn("Warn log");
+        Log.Error("Error log");
+        Log.Fatal("Fatal log");
 
         Run();
         Thread.Sleep(5000);

src/dotnetCampus.Logger/NativeMethods.txt

@@ -0,0 +1,5 @@
+GetConsoleMode
+SetConsoleMode
+GetStdHandle
+STD_HANDLE
+CONSOLE_MODE

src/dotnetCampus.Logger/Writers/ConsoleLogger.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO;
 using System.Text;
+using dotnetCampus.Logging.Writers.ConsoleLoggerHelpers;
 using dotnetCampus.Logging.Writers.Helpers;
 using C = dotnetCampus.Logging.Writers.ConsoleLoggerHelpers.ConsoleColors;
 using B = dotnetCampus.Logging.Writers.ConsoleLoggerHelpers.ConsoleColors.Background;
@@ -41,6 +42,7 @@ internal ConsoleLogger(ICoreLogWriter coreWriter, TagFilterManager? tagManager)
         _isConsoleOutput = Out == Console.Out;
         // 如果输出流是自己创建的，则不支持光标移动。
         _isCursorMovementEnabled = _isConsoleOutput ? 3 : 0;
+        ConsoleInitializer.Initialize();
     }
 
     /// <summary>

src/dotnetCampus.Logger/Writers/ConsoleLoggerHelpers/ConsoleInitializer.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
+using static Windows.Win32.System.Console.CONSOLE_MODE;
+using static Windows.Win32.PInvoke;
+using static Windows.Win32.System.Console.STD_HANDLE;
+
+namespace dotnetCampus.Logging.Writers.ConsoleLoggerHelpers;
+
+internal static class ConsoleInitializer
+{
+    internal static bool Initialize()
+    {
+#if NET6_0_OR_GREATER
+        // 最新的 .NET 可以在编译时判断。
+        if (OperatingSystem.IsWindows())
+#elif NETFRAMEWORK
+        // 更早版本的 .NET Framework 只能运行在 Windows 上。
+        if (true)
+#else
+        // 运行时判断。
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+#endif
+        {
+            return InitWindows();
+        }
+        else
+        {
+            return true;
+        }
+    }
+
+#if NET6_0_OR_GREATER
+    [SupportedOSPlatform("windows")]
+#endif
+    [MethodImpl(MethodImplOptions.NoInlining)]
+    private static bool InitWindows()
+    {
+        var iStdOut = GetStdHandle_SafeHandle(STD_OUTPUT_HANDLE);
+        if (!GetConsoleMode(iStdOut, out var outConsoleMode))
+        {
+            return false;
+        }
+
+        outConsoleMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
+        if (!SetConsoleMode(iStdOut, outConsoleMode))
+        {
+            return false;
+        }
+
+        return true;
+    }
+}

src/dotnetCampus.Logger/dotnetCampus.Logger.csproj

@@ -41,7 +41,8 @@
   <!-- Package Reference -->
   <ItemGroup>
     <PackageReference Include="dotnetCampus.LatestCSharpFeatures" Version="12.0.0" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.Windows.CsWin32" Version="0.3.183" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>