支持使用 stderror 输出控制台日志

Author: walterlv

src/DotNetCampus.Logger/Writers/ConsoleLogger.cs

@@ -1,6 +1,8 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Text;
+using System.Threading;
 using DotNetCampus.Logging.Writers.ConsoleLoggerHelpers;
 using DotNetCampus.Logging.Writers.Helpers;
 using C = DotNetCampus.Logging.Writers.ConsoleLoggerHelpers.ConsoleColors;
@@ -15,7 +17,12 @@ namespace DotNetCampus.Logging.Writers;
 /// </summary>
 public class ConsoleLogger : ILogger
 {
-    private static readonly TextWriter Out = GetStandardOutputWriter();
+    private readonly Lazy<TextWriter> _outLazy;
+
+    /// <summary>
+    /// 获取用于输出日志的文本写入流。
+    /// </summary>
+    private TextWriter Out => _outLazy.Value;
 
     /// <summary>
     /// 用于处理重复的日志，避免重复日志污染控制台输出内容。
@@ -35,24 +42,25 @@ public class ConsoleLogger : ILogger
     /// </summary>
     /// <param name="threadMode">指定控制台日志的线程安全模式。</param>
     /// <param name="mainArgs">Main 方法的参数。</param>
-    public ConsoleLogger(LogWritingThreadMode threadMode = LogWritingThreadMode.NotThreadSafe, string[]? mainArgs = null)
-        : this(threadMode.CreateCoreLogWriter(SafeWriteLine), TagFilterManager.FromCommandLineArgs(mainArgs ?? []))
-    {
-    }
-
-    internal ConsoleLogger(ICoreLogWriter coreWriter, TagFilterManager? tagManager)
+    public ConsoleLogger(LogWritingThreadMode threadMode = LogWritingThreadMode.NotThreadSafe, IReadOnlyList<string>? mainArgs = null)
     {
         _repeat = new RepeatLoggerDetector(ClearAndMoveToLastLine);
-        CoreWriter = coreWriter;
-        TagManager = tagManager;
+        CoreWriter = threadMode.CreateCoreLogWriter(SafeWriteLine);
+        TagManager = TagFilterManager.FromCommandLineArgs(mainArgs ?? []);
         _isConsoleOutput = ConsoleInitializer.Initialize();
+        _outLazy = new Lazy<TextWriter>(GetStandardOutputWriter, LazyThreadSafetyMode.ExecutionAndPublication);
     }
 
     /// <summary>
     /// 高于或等于此级别的日志才会被记录。
     /// </summary>
     public LogLevel Level { get; init; }
 
+    /// <summary>
+    /// 指定控制台日志输出的目标。
+    /// </summary>
+    public LoggerConsoleOutputTo OutputTo { get; init; }
+
     /// <summary>
     /// 最终日志写入器。
     /// </summary>
@@ -239,7 +247,7 @@ private void ConsoleMultilineMessage(string message,
     /// 安全地写入一行日志，避免出现 IO 异常。
     /// </summary>
     /// <param name="message"></param>
-    internal static void SafeWriteLine(string? message)
+    internal void SafeWriteLine(string? message)
     {
         try
         {
@@ -309,14 +317,22 @@ private int SafeGetSpaceCount(params
     /// 如果当前在控制台中输出，则使用控制台的输出流；否则创建一个 UTF-8 编码的标准输出流。
     /// </summary>
     /// <returns>文本写入流。</returns>
-    private static TextWriter GetStandardOutputWriter()
+    private TextWriter GetStandardOutputWriter()
     {
         if (Console.OutputEncoding.CodePage is not 0)
         {
-            return Console.Out;
+            return OutputTo switch
+            {
+                LoggerConsoleOutputTo.StandardError => Console.Error,
+                _ => Console.Out,
+            };
         }
 
-        var standardOutput = Console.OpenStandardOutput();
+        var standardOutput = OutputTo switch
+        {
+            LoggerConsoleOutputTo.StandardError => Console.OpenStandardError(),
+            _ => Console.OpenStandardOutput(),
+        };
         var writer = new StreamWriter(standardOutput, new UTF8Encoding(encoderShouldEmitUTF8Identifier: false))
         {
             AutoFlush = true,
@@ -351,3 +367,19 @@ private static TextWriter GetStandardOutputWriter()
     private static string CriticalExceptionTag => $"{B.Black}{D.Bold}{F.Red} X {Reset}{CriticalText} ";
     private static string EmptyExceptionTag => "    ";
 }
+
+/// <summary>
+/// 指定控制台日志输出的目标。
+/// </summary>
+public enum LoggerConsoleOutputTo
+{
+    /// <summary>
+    /// 输出到标准输出流。
+    /// </summary>
+    StandardOutput,
+
+    /// <summary>
+    /// 输出到标准错误流。
+    /// </summary>
+    StandardError,
+}

src/DotNetCampus.Logger/Writers/ConsoleLoggerBuilder.cs

@@ -1,5 +1,5 @@
 using System;
-using DotNetCampus.Logging.Writers.Helpers;
+using System.Collections.Generic;
 
 namespace DotNetCampus.Logging.Writers;
 
@@ -8,8 +8,9 @@ namespace DotNetCampus.Logging.Writers;
 /// </summary>
 public sealed class ConsoleLoggerBuilder
 {
-    private TagFilterManager? _tagFilterManager;
-    private ICoreLogWriter _coreWriter = new NotThreadSafeLogWriter(ConsoleLogger.SafeWriteLine);
+    private LogWritingThreadMode _threadMode = LogWritingThreadMode.NotThreadSafe;
+    private LoggerConsoleOutputTo _outputTo = LoggerConsoleOutputTo.StandardOutput;
+    private IReadOnlyList<string>? _mainArgs;
 
     /// <summary>
     /// 高于或等于此级别的日志才会被记录。
@@ -25,6 +26,12 @@ public ConsoleLoggerBuilder WithLevel(LogLevel level)
         return this;
     }
 
+    public ConsoleLoggerBuilder WithOutput(LoggerConsoleOutputTo outputTo)
+    {
+        _outputTo = outputTo;
+        return this;
+    }
+
     /// <summary>
     /// 指定控制台日志的线程安全模式。
     /// </summary>
@@ -33,13 +40,7 @@ public ConsoleLoggerBuilder WithLevel(LogLevel level)
     /// <exception cref="ArgumentOutOfRangeException">线程安全模式不支持。</exception>
     public ConsoleLoggerBuilder WithThreadSafe(LogWritingThreadMode threadMode)
     {
-        _coreWriter = threadMode switch
-        {
-            LogWritingThreadMode.NotThreadSafe => new NotThreadSafeLogWriter(ConsoleLogger.SafeWriteLine),
-            LogWritingThreadMode.Lock => new LockLogWriter(ConsoleLogger.SafeWriteLine),
-            LogWritingThreadMode.ProducerConsumer => new ProducerConsumerLogWriter(ConsoleLogger.SafeWriteLine),
-            _ => throw new ArgumentOutOfRangeException(nameof(threadMode)),
-        };
+        _threadMode = threadMode;
         return this;
     }
 
@@ -48,19 +49,20 @@ public ConsoleLoggerBuilder WithThreadSafe(LogWritingThreadMode threadMode)
     /// </summary>
     /// <param name="args">命令行参数。</param>
     /// <returns>构造器模式。</returns>
-    public ConsoleLoggerBuilder FilterConsoleTagsFromCommandLineArgs(string[] args)
+    public ConsoleLoggerBuilder FilterConsoleTagsFromCommandLineArgs(IReadOnlyList<string> args)
     {
-        _tagFilterManager = TagFilterManager.FromCommandLineArgs(args);
+        _mainArgs = args;
         return this;
     }
 
     /// <summary>
     /// 创建控制台日志记录器。
     /// </summary>
     /// <returns>控制台日志记录器。</returns>
-    internal ConsoleLogger Build() => new(_coreWriter, _tagFilterManager)
+    internal ConsoleLogger Build() => new(_threadMode, _mainArgs)
     {
         Level = Level,
+        OutputTo = _outputTo,
     };
 }
 

src/DotNetCampus.Logger/Writers/Helpers/TagFilterManager.cs

@@ -108,7 +108,7 @@ internal bool IsTagEnabled(string text)
     /// 从命令行参数中提取过滤标签。
     /// </summary>
     /// <param name="args">命令行参数。</param>
-    public static TagFilterManager? FromCommandLineArgs(string[] args)
+    public static TagFilterManager? FromCommandLineArgs(IReadOnlyList<string> args)
     {
         if (!TryGetCommandLineValue(args, LogTagParameterName, out var value))
         {
@@ -151,11 +151,11 @@ internal bool IsTagEnabled(string text)
         };
     }
 
-    private static bool TryGetCommandLineValue(string[] args, string parameterName, [NotNullWhen(true)] out string? value)
+    private static bool TryGetCommandLineValue(IReadOnlyList<string> args, string parameterName, [NotNullWhen(true)] out string? value)
     {
-        for (var i = 0; i < args.Length; i++)
+        for (var i = 0; i < args.Count; i++)
         {
-            if (string.Equals(args[i], parameterName, StringComparison.OrdinalIgnoreCase) && i + 1 < args.Length)
+            if (string.Equals(args[i], parameterName, StringComparison.OrdinalIgnoreCase) && i + 1 < args.Count)
             {
                 value = args[i + 1];
                 return true;