支持简单的日志级别

Author: JiuLing-zhang

src/JiuLing.CommonLibs/Log/ILogger.cs

@@ -1,4 +1,6 @@
-namespace JiuLing.CommonLibs.Log
+using System;
+
+namespace JiuLing.CommonLibs.Log
 {
     /// <summary>
     /// 日志接口
@@ -10,20 +12,37 @@ public interface ILogger
         /// </summary>
         /// <returns></returns>
         ILogger SetLogDirectory(string path);
+
         /// <summary>
         /// 设置日志文件名的格式
         /// </summary>
         /// <returns></returns>
         ILogger SetFileNameFormat(string datetimeFormat);
+
         /// <summary>
         /// 设置日志文件扩展名
         /// </summary>
         /// <returns></returns>
         ILogger SetFileExpandedName(string expandedName);
+
         /// <summary>
         /// 写日志
         /// </summary>
         /// <param name="message">日志内容</param>
+        [Obsolete("请使用 Info() 方法替代。")]
         void Write(string message);
+
+        /// <summary>
+        /// 写入消息日志
+        /// </summary>
+        /// <param name="message">日志内容</param>
+        void Info(string message);
+
+        /// <summary>
+        /// 写入错误日志
+        /// </summary>
+        /// <param name="message">日志内容</param>
+        /// <param name="ex">异常信息</param>
+        void Error(string message, Exception ex = null);
     }
 }

src/JiuLing.CommonLibs/Log/LogLevel.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace JiuLing.CommonLibs.Log
+{
+    /// <summary>
+    /// 日志级别
+    /// </summary>
+    internal enum LogLevel
+    {
+        /// <summary>
+        /// 消息
+        /// </summary>
+        Info,
+        /// <summary>
+        /// 错误
+        /// </summary>
+        Error
+    }
+}

src/JiuLing.CommonLibs/Log/LogManager.cs

@@ -1,4 +1,6 @@
-namespace JiuLing.CommonLibs.Log
+using System;
+
+namespace JiuLing.CommonLibs.Log
 {
     /// <summary>
     /// 日志管理
@@ -26,5 +28,17 @@ public static ILogger GetLogger()
                 return _logger;
             }
         }
+
+        /// <summary>
+        /// 注册日志写入异常回调
+        /// </summary>
+        /// <param name="callback">异常处理回调</param>
+        public static void RegisterLogExceptionCallback(Action<Exception> callback)
+        {
+            if (_logger is TextLogger)
+            {
+                TextLogger.OnLogWriteException += callback;
+            }
+        }
     }
 }

src/JiuLing.CommonLibs/Log/TextLogger.cs

@@ -12,16 +12,28 @@ internal class TextLogger : ILogger
         private string _logDirectory;
         private string _logNameDatetimeFormat;
         private string _logExpandedName;
+        /// <summary>
+        /// 不同日志级别是否单独记录到不同文件
+        /// </summary>
+        private bool _separateByLogLevel;
         private static readonly object LockObj = new object();
+
+        /// <summary>
+        /// 异常回调，供LogManager注册使用
+        /// </summary>
+        internal static Action<Exception> OnLogWriteException { get; set; }
+
         /// <summary>
         /// 实例化
         /// </summary>
         public TextLogger()
         {
-            _logDirectory = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "log");
+            _logDirectory = Path.GetFullPath(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "log"));
             _logNameDatetimeFormat = "yyyy-MM-dd";
             _logExpandedName = ".log";
+            _separateByLogLevel = true;
         }
+
         /// <summary>
         /// 设置日志目录
         /// </summary>
@@ -32,14 +44,17 @@ public ILogger SetLogDirectory(string path)
         {
             if (path.IsEmpty())
             {
-                throw new ArgumentException(nameof(path));
+                throw new ArgumentException("日志路径不能为空", nameof(path));
             }
+
             lock (LockObj)
             {
-                _logDirectory = path;
+                _logDirectory = Path.GetFullPath(path);
             }
+
             return this;
         }
+
         /// <summary>
         /// 设置日志文件名格式
         /// </summary>
@@ -50,14 +65,27 @@ public ILogger SetFileNameFormat(string datetimeFormat)
         {
             if (datetimeFormat.IsEmpty())
             {
-                throw new ArgumentException(nameof(datetimeFormat));
+                throw new ArgumentException("时间格式化规则不能为空", nameof(datetimeFormat));
+            }
+
+            // 尝试格式化当前时间，校验格式是否合法
+            try
+            {
+                DateTime.Now.ToString(datetimeFormat);
+            }
+            catch (FormatException)
+            {
+                throw new ArgumentException("时间格式无法格式化", nameof(datetimeFormat));
             }
+
             lock (LockObj)
             {
                 _logNameDatetimeFormat = datetimeFormat;
             }
+
             return this;
         }
+
         /// <summary>
         /// 设置日志文件扩展名
         /// </summary>
@@ -68,37 +96,97 @@ public ILogger SetFileExpandedName(string expandedName)
         {
             if (expandedName.IsEmpty())
             {
-                throw new ArgumentException(nameof(expandedName));
+                throw new ArgumentException("扩展名不能为空", nameof(expandedName));
             }
+
             lock (LockObj)
             {
-                _logExpandedName = expandedName;
+                _logExpandedName = expandedName.StartsWith(".") ? expandedName : "." + expandedName;
             }
+
             return this;
         }
+
+        /// <summary>
+        /// 设置是否按日志等级分文件
+        /// </summary>
+        /// <param name="separate">是否按等级分文件</param>
+        /// <returns></returns>
+        public ILogger SetSeparateByLogLevel(bool separate)
+        {
+            lock (LockObj)
+            {
+                _separateByLogLevel = separate;
+            }
+
+            return this;
+        }
+
         /// <summary>
         /// 写入日志
         /// </summary>
-        /// <param name="message"></param>
+        /// <param name="message">日志内容</param>
+        [Obsolete("请使用 Info() 方法替代。")]
         public void Write(string message)
         {
-            lock (LockObj)
+            Info(message);
+        }
+
+        /// <summary>
+        /// 写入消息日志
+        /// </summary>
+        /// <param name="message">日志内容</param>
+        public void Info(string message)
+        {
+            WriteInner(LogLevel.Info, message);
+        }
+
+        /// <summary>
+        /// 写入错误日志
+        /// </summary>
+        /// <param name="message">日志内容</param>
+        /// <param name="ex">异常信息</param>
+        public void Error(string message, Exception ex = null)
+        {
+            if (ex != null)
             {
-                if (!Directory.Exists(_logDirectory))
+                message = $"{message}{Environment.NewLine}Exception: {ex.Message}{Environment.NewLine}StackTrace: {ex.StackTrace}";
+            }
+            WriteInner(LogLevel.Error, message);
+        }
+
+        /// <summary>
+        /// 写入日志
+        /// </summary>
+        /// <param name="level">消息级别</param>
+        /// <param name="message">日志内容</param>
+        private void WriteInner(LogLevel level, string message)
+        {
+            try
+            {
+                lock (LockObj)
                 {
-                    Directory.CreateDirectory(_logDirectory);
-                }
+                    if (!Directory.Exists(_logDirectory))
+                    {
+                        Directory.CreateDirectory(_logDirectory);
+                    }
 
-                DateTime now = DateTime.Now;
-                string fileName = $"{now.ToString(_logNameDatetimeFormat)}{_logExpandedName}";
-                string path = Path.Combine(_logDirectory, fileName);
+                    DateTime now = DateTime.Now;
+                    string prefix = _separateByLogLevel ? level.ToString().ToLower() : "all";
+                    string fileName = $"{prefix}_{now.ToString(_logNameDatetimeFormat)}{_logExpandedName}";
+                    string path = Path.Combine(_logDirectory, fileName);
 
-                using (StreamWriter sw = new StreamWriter(path, true, System.Text.Encoding.UTF8))
-                {
-                    sw.Write($"{now:yyyy-MM-dd HH:mm:ss.fff} {message}{Environment.NewLine}");
-                    sw.Flush();
+                    using (var sw = new StreamWriter(path, true, System.Text.Encoding.UTF8))
+                    {
+                        sw.Write($"{now:yyyy-MM-dd HH:mm:ss.fff} [{level}] {message}{Environment.NewLine}");
+                        sw.Flush();
+                    }
                 }
             }
+            catch (Exception ex)
+            {
+                OnLogWriteException?.Invoke(ex);
+            }
         }
     }
-}
+}