refactor: 重构日志上下文

Author: jianxuanbing

framework/src/Bing.AspNetCore/Bing/AspNetCore/Logs/AspNetCoreLogContext.cs

@@ -28,14 +28,11 @@ public class AspNetCoreLogContext : LogContext
         /// <summary>
         /// 初始化一个<see cref="AspNetCoreLogContext"/>类型的实例
         /// </summary>
-        /// <param name="scopedDictionary">作用域字典</param>
         /// <param name="webClientInfoProvider">Web客户端信息提供程序</param>
         /// <param name="httpContextAccessor">Http上下文访问器</param>
         public AspNetCoreLogContext(
-            ScopedDictionary scopedDictionary, 
-            IHttpContextAccessor httpContextAccessor, 
+            IHttpContextAccessor httpContextAccessor,
             IWebClientInfoProvider webClientInfoProvider)
-            : base(scopedDictionary)
         {
             HttpContextAccessor = httpContextAccessor;
             WebClientInfoProvider = webClientInfoProvider;
@@ -50,9 +47,10 @@ protected override LogContextInfo CreateInfo()
 
             logContextInfo.Ip = WebClientInfoProvider.ClientIpAddress;
             logContextInfo.Browser = WebClientInfoProvider.ClientIpAddress;
-
             logContextInfo.Url = HttpContextAccessor.HttpContext?.Request?.GetDisplayUrl();
-
+            logContextInfo.IsWebEnv = HttpContextAccessor.HttpContext?.Request != null;
+            if (logContextInfo.IsWebEnv)
+                logContextInfo.TraceId = TraceId;
             return logContextInfo;
         }
 
@@ -65,7 +63,7 @@ protected override string GetTraceId()
             if (!string.IsNullOrWhiteSpace(correlationId))
                 return correlationId;
             var traceId = HttpContextAccessor.HttpContext?.TraceIdentifier;
-            return string.IsNullOrWhiteSpace(traceId) ? Guid.NewGuid().ToString() : Guid.TryParse(traceId, out _) ? traceId : Guid.NewGuid().ToString();
+            return string.IsNullOrWhiteSpace(traceId) ? Guid.NewGuid().ToString("N") : Guid.TryParse(traceId, out _) ? traceId : Guid.NewGuid().ToString("N");
         }
     }
 }

framework/src/Bing.Datas.Dapper/Bing/Data/Sql/Queries/SqlQuery.cs

@@ -6,6 +6,7 @@
 using Bing.Data.Sql.Diagnostics;
 using Bing.Helpers;
 using Bing.Logs;
+using Bing.Logs.Internal;
 using Dapper;
 
 namespace Bing.Data.Sql.Queries
@@ -264,7 +265,7 @@ protected override void WriteTraceLog(string sql, IReadOnlyDictionary<string, ob
             if (IsEnabled(log) == false)
                 return;
             log.Class(GetType().FullName)
-                .Caption("SqlQuery查询调试:")
+                .Caption($"SqlQuery查询调试: {sql}")
                 .Sql("原始Sql:")
                 .Sql($"{sql}{Common.Line}")
                 .Sql("调试Sql:")

framework/src/Bing.Datas.EntityFramework/Core/UnitOfWorkBase.cs

@@ -20,6 +20,7 @@
 using Bing.Exceptions;
 using Bing.Extensions;
 using Bing.Logs;
+using Bing.Logs.Core;
 using Bing.Uow;
 using Bing.Users;
 using Microsoft.EntityFrameworkCore;
@@ -68,6 +69,11 @@ public abstract class UnitOfWorkBase : DbContext, IUnitOfWork, IDatabase, IEntit
         [Autowired]
         public virtual ILazyServiceProvider LazyServiceProvider { get; set; }
 
+        /// <summary>
+        /// 日志
+        /// </summary>
+        public ILog Log => LazyServiceProvider.LazyGetService<ILog>() ?? NullLog.Instance;
+
         /// <summary>
         /// 当前用户
         /// </summary>
@@ -158,7 +164,7 @@ protected virtual string GetUserName()
         protected void EnableLog(DbContextOptionsBuilder builder)
         {
             ConfiguringIgnoreEvent(builder);
-            var log = GetLog();
+            var log = Log;
             if (IsEnabled(log) == false)
                 return;
             builder.EnableSensitiveDataLogging();
@@ -170,6 +176,7 @@ protected void EnableLog(DbContextOptionsBuilder builder)
         /// 配置忽略事件
         /// </summary>
         /// <param name="builder">配置事件</param>
+        /// <remarks>参考：https://docs.microsoft.com/zh-cn/ef/core/logging-events-diagnostics </remarks>
         protected virtual void ConfiguringIgnoreEvent(DbContextOptionsBuilder builder)
         {
             builder.ConfigureWarnings(x => x.Ignore(
@@ -196,21 +203,6 @@ protected virtual void ConfiguringIgnoreEvent(DbContextOptionsBuilder builder)
             ));
         }
 
-        /// <summary>
-        /// 获取日志操作
-        /// </summary>
-        protected virtual ILog GetLog()
-        {
-            try
-            {
-                return Log.GetLog(EfLog.TraceLogName);
-            }
-            catch
-            {
-                return Log.Null;
-            }
-        }
-
         /// <summary>
         /// 是否启用EF日志
         /// </summary>

framework/src/Bing.Datas.EntityFramework/Logs/EfLog.cs

@@ -38,13 +38,16 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
             Func<TState, Exception, string> formatter)
         {
             var config = GetConfig();
-            var log = Bing.Logs.Log.GetLog(TraceLogName);
+            var log = GetUnitOfWork()?.Log;
+            if (log == null)
+                return;
             if (IsEnabled(eventId, config, exception) == false)
                 return;
             if (!string.IsNullOrWhiteSpace(GetUnitOfWork().TraceId))
                 log.Tag(GetUnitOfWork()?.TraceId);
+            log.Tag(TraceLogName);
             log
-                .Caption("执行EF操作：")
+                .Caption($"执行EF操作：{formatter(state, exception)}")
                 .Content($"工作单元跟踪号：{GetUnitOfWork()?.TraceId}")
                 .Content($"事件ID：{eventId.Id}")
                 .Content($"事件名称：{eventId.Name}");

framework/src/Bing.Events/Cap/MessageEventBus.cs

@@ -25,15 +25,24 @@ public class MessageEventBus : IMessageEventBus
         /// </summary>
         public ITransactionActionManager TransactionActionManager { get; set; }
 
+        /// <summary>
+        /// 日志操作
+        /// </summary>
+        protected ILog Log { get; set; }
+
         /// <summary>
         /// 初始化一个<see cref="MessageEventBus"/>类型的实例
         /// </summary>
         /// <param name="publisher">事件发布器</param>
         /// <param name="transactionActionManager">事务操作管理器</param>
-        public MessageEventBus(ICapPublisher publisher, ITransactionActionManager transactionActionManager)
+        /// <param name="log">日志操作</param>
+        public MessageEventBus(ICapPublisher publisher, 
+            ITransactionActionManager transactionActionManager,
+            ILog log)
         {
             Publisher = publisher ?? throw new ArgumentNullException(nameof(publisher));
             TransactionActionManager = transactionActionManager ?? throw new ArgumentNullException(nameof(transactionActionManager));
+            Log = log;
         }
 
         /// <summary>
@@ -86,7 +95,7 @@ private async Task InternalPublishAsync(string name, object data, IDictionary<st
         /// <param name="callback">回调名称</param>
         private void WriteLog(string name, object data, string callback)
         {
-            var log = Log.GetLog(this);
+            var log = Log;
             if (log.IsDebugEnabled == false)
                 return;
             log.Tag(name)

framework/src/Bing.Logs.Exceptionless/Bing/Logs/Exceptionless/ExceptionlessProvider.cs

@@ -1,4 +1,4 @@
-using System;
+using System.Diagnostics;
 using System.Linq;
 using Bing.Configuration;
 using Bing.Extensions;
@@ -72,6 +72,7 @@ public void WriteLog(LogLevel level, ILogContent content)
             // 致命错误
             if (level == LogLevel.Fatal || level == LogLevel.Error)
                 builder.MarkAsCritical();
+            Debug.WriteLine($"【Exceptionless】Thread: {content.ThreadId}, LogId: {content.LogId}, TraceId: {content.TraceId}, Message: {GetMessage(content)}, Tags: [{content.Tags.ExpandAndToString()}]");
             SetUser(content);
             SetSource(builder, content);
             SetReferenceId(builder, content);

framework/src/Bing.Logs/Bing/Logs/Aspects/LogAttributeBase.cs

@@ -3,6 +3,7 @@
 using AspectCore.DynamicProxy.Parameters;
 using Bing.Aspects.Base;
 using Bing.Extensions;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace Bing.Logs.Aspects
 {
@@ -17,7 +18,7 @@ public abstract class LogAttributeBase : InterceptorBase
         public override async Task Invoke(AspectContext context, AspectDelegate next)
         {
             var methodName = GetMethodName(context);
-            var log = Log.GetLog(methodName);
+            var log = context.ServiceProvider.GetService<ILog>();
             if (!Enabled(log))
                 return;
             ExecuteBefore(log, context, methodName);

framework/src/Bing.Logs/Bing/Logs/Extensions/LogExtensions.cs

@@ -25,7 +25,7 @@ public static ILog BusinessId(this ILog log, string businessId)
         {
             return log.Set<LogContent>(content =>
             {
-                if (string.IsNullOrWhiteSpace(content.BusinessId) == false) 
+                if (string.IsNullOrWhiteSpace(content.BusinessId) == false)
                     content.BusinessId += ",";
                 content.BusinessId += businessId;
             });
@@ -90,7 +90,7 @@ public static ILog Params(this ILog log, IDictionary<string, object> dictionary)
         {
             if (dictionary == null || dictionary.Count == 0)
                 return log;
-            foreach (var item in dictionary) 
+            foreach (var item in dictionary)
                 Params(log, item.Key, item.Value.SafeString());
             return log;
         }

framework/src/Bing.Logs/Bing/Logs/LogBase.cs

@@ -245,10 +245,10 @@ public void Fatal(string message)
         /// <param name="content">日志内容</param>
         protected virtual void Init(TContent content)
         {
-            Context.InitLogId();
             content.LogName = Provider.LogName;
             content.TraceId = Context.TraceId;
-            content.LogId = Context.LogId;
+            if (string.IsNullOrWhiteSpace(content.LogId))
+                content.LogId = Context.LogId;
             content.OperationTime = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
             content.Duration = Context.Stopwatch.Elapsed.Description();
             content.Ip = Context.Ip;

framework/src/Bing/Logs/Abstractions/ILogContext.cs

@@ -44,9 +44,9 @@ public interface ILogContext
         /// </summary>
         string Url { get; }
 
-        /// <summary>
-        /// 初始化日志标识
-        /// </summary>
-        void InitLogId();
+        ///// <summary>
+        ///// 初始化日志标识
+        ///// </summary>
+        //void InitLogId();
     }
 }