fix: 优化日志跟踪上下文方法

Author: jianxuanbing

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

@@ -31,9 +31,10 @@ public class AspNetCoreLogContext : LogContext
         /// <param name="scopedDictionary">作用域字典</param>
         /// <param name="webClientInfoProvider">Web客户端信息提供程序</param>
         /// <param name="httpContextAccessor">Http上下文访问器</param>
-        public AspNetCoreLogContext(ScopedDictionary scopedDictionary
-            , IHttpContextAccessor httpContextAccessor
-            , IWebClientInfoProvider webClientInfoProvider)
+        public AspNetCoreLogContext(
+            ScopedDictionary scopedDictionary, 
+            IHttpContextAccessor httpContextAccessor, 
+            IWebClientInfoProvider webClientInfoProvider)
             : base(scopedDictionary)
         {
             HttpContextAccessor = httpContextAccessor;

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

@@ -3,7 +3,9 @@
 using System.IO;
 using System.Threading.Tasks;
 using Bing.Logs;
+using Bing.Logs.Core;
 using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace Bing.AspNetCore.Logs
 {
@@ -76,19 +78,23 @@ private async Task WriteLogAsync(HttpContext context, Stopwatch stopwatch)
                 context.Response.Body.Seek(0, SeekOrigin.Begin);
                 return;
             }
-            var log = Log.GetLog(this).Caption("请求日志中间件");
-            log.Content(new Dictionary<string, string>()
-            {
-                {"请求方法", context.Request.Method},
+
+            var log = context?.RequestServices?.GetService<ILog>() ?? NullLog.Instance;
+            log
+                .Class(this.GetType().FullName)
+                .Caption("请求日志中间件")
+                .Content(new Dictionary<string, string>
                 {
-                    "请求地址",
-                    $"{context.Request.Scheme}://{context.Request.Host}{context.Request.Path}{context.Request.QueryString}"
-                },
-                {"IP", context.Connection.RemoteIpAddress.ToString()},
-                {"请求耗时", $"{stopwatch.Elapsed.TotalMilliseconds} 毫秒"},
-                {"请求内容", await FormatRequestAsync(context.Request)},
-                {"响应内容", await FormatResponseAsync(context.Response)}
-            });
+                    { "请求方法", context.Request.Method },
+                    {
+                        "请求地址",
+                        $"{context.Request.Scheme}://{context.Request.Host}{context.Request.Path}{context.Request.QueryString}"
+                    },
+                    { "IP", context.Connection.RemoteIpAddress.ToString() },
+                    { "请求耗时", $"{stopwatch.Elapsed.TotalMilliseconds} 毫秒" },
+                    { "请求内容", await FormatRequestAsync(context.Request) },
+                    { "响应内容", await FormatResponseAsync(context.Response) }
+                });
             log.Trace();
         }
 

framework/src/Bing.Logs/Bing/Logs/Formats/ContentFormat.cs

@@ -28,6 +28,7 @@ public string Format(ILogContent logContent)
         /// <summary>
         /// 内容格式化器实例
         /// </summary>
+        // ReSharper disable once InconsistentNaming
         public static readonly ILogFormat Instance = new ContentFormat();
 
         /// <summary>

framework/src/Bing.Logs/Bing/Logs/Log.cs

@@ -1,5 +1,4 @@
-using System;
-using System.Linq;
+using System.Linq;
 using Bing.DependencyInjection;
 using Bing.Logs.Abstractions;
 using Bing.Logs.Contents;
@@ -32,7 +31,11 @@ public class Log : LogBase<LogContent>
         /// <param name="context">日志上下文</param>
         /// <param name="format">日志格式器</param>
         /// <param name="currentUser">当前用户</param>
-        public Log(ILogProviderFactory providerFactory, ILogContext context, ILogFormat format, ICurrentUser currentUser)
+        public Log(
+            ILogProviderFactory providerFactory, 
+            ILogContext context, 
+            ILogFormat format, 
+            ICurrentUser currentUser)
             : base(providerFactory.Create("", format), context, currentUser)
         {
         }
@@ -44,7 +47,11 @@ public Log(ILogProviderFactory providerFactory, ILogContext context, ILogFormat
         /// <param name="context">日志上下文</param>
         /// <param name="currentUser">当前用户</param>
         /// <param name="class">类名</param>
-        public Log(ILogProvider provider, ILogContext context, ICurrentUser currentUser, string @class) 
+        public Log(
+            ILogProvider provider, 
+            ILogContext context, 
+            ICurrentUser currentUser, 
+            string @class) 
             : base(provider, context, currentUser) => _class = @class;
 
         /// <summary>
@@ -55,7 +62,12 @@ public Log(ILogProvider provider, ILogContext context, ICurrentUser currentUser,
         /// <param name="context">日志上下文</param>
         /// <param name="currentUser">当前用户</param>
         /// <param name="class">类名</param>
-        public Log(string name, ILogProvider provider, ILogContext context, ICurrentUser currentUser, string @class) 
+        public Log(
+            string name, 
+            ILogProvider provider, 
+            ILogContext context, 
+            ICurrentUser currentUser, 
+            string @class) 
             : base(name, provider, context, currentUser) => _class = @class;
 
         /// <summary>

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

@@ -65,9 +65,10 @@ public abstract class LogBase<TContent> : ILog where TContent : class, ILogConte
         /// <param name="provider">日志提供程序</param>
         /// <param name="context">日志上下文</param>
         /// <param name="currentUser">当前用户</param>
-        protected LogBase(ILogProvider provider
-            , ILogContext context
-            , ICurrentUser currentUser)
+        protected LogBase(
+            ILogProvider provider, 
+            ILogContext context, 
+            ICurrentUser currentUser)
         {
             Provider = provider;
             Context = context;
@@ -81,10 +82,11 @@ protected LogBase(ILogProvider provider
         /// <param name="provider">日志提供程序</param>
         /// <param name="context">日志上下文</param>
         /// <param name="currentUser">当前用户</param>
-        protected LogBase(string name
-            , ILogProvider provider
-            , ILogContext context
-            , ICurrentUser currentUser)
+        protected LogBase(
+            string name, 
+            ILogProvider provider, 
+            ILogContext context, 
+            ICurrentUser currentUser)
         {
             Provider = provider;
             Context = context;

framework/src/Bing/Logs/Core/LogContext.cs

@@ -34,13 +34,25 @@ public class LogContext : ILogContext
         /// <summary>
         /// 日志标识
         /// </summary>
-        public string LogId => $"{TraceId}-{_orderId}";
+        public string LogId => $"{TraceId}-{GetInfo().GetOrderId()}";
 
         /// <summary>
         /// 跟踪号
         /// </summary>
         public string TraceId => $"{TraceIdContext.Current?.TraceId ?? GetInfo().TraceId}";
 
+        ///// <summary>
+        ///// 跟踪号
+        ///// </summary>
+        //public string TraceId
+        //{
+        //    get
+        //    {
+        //        TraceIdContext.Current ??= new TraceIdContext(string.Empty);
+        //        return TraceIdContext.Current.TraceId;
+        //    }
+        //}
+
         /// <summary>
         /// 计时器
         /// </summary>
@@ -90,20 +102,31 @@ public void InitLogId()
             var key = "Bing.Logs.LogContext_orderId";
             _scopedDictionary[key] = _scopedDictionary.ContainsKey(key) ? ++_orderId : _orderId;
         }
+
+        ///// <summary>
+        ///// 获取日志上下文信息
+        ///// </summary>
+        //private LogContextInfo GetInfo()
+        //{
+        //    if (_info != null)
+        //        return _info;
+        //    var key = "Bing.Logs.LogContext";
+        //    _info = _scopedDictionary.ContainsKey(key) ? _scopedDictionary[key] as LogContextInfo : null;
+        //    if (_info != null)
+        //        return _info;
+        //    _info = CreateInfo();
+        //    _scopedDictionary[key] = _info;
+        //    return _info;
+        //}
+
         /// <summary>
         /// 获取日志上下文信息
         /// </summary>
         private LogContextInfo GetInfo()
         {
-            if (_info != null)
-                return _info;
-            var key = "Bing.Logs.LogContext";
-            _info = _scopedDictionary.ContainsKey(key) ? _scopedDictionary[key] as LogContextInfo : null;
-            if (_info != null)
-                return _info;
-            _info = CreateInfo();
-            _scopedDictionary[key] = _info;
-            return _info;
+            if (LogContextInfo.Current == null)
+                LogContextInfo.Current = CreateInfo();
+            return LogContextInfo.Current;
         }
 
         /// <summary>

framework/src/Bing/Logs/Internal/LogContextInfo.cs

@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Threading;
 
 namespace Bing.Logs.Internal
 {
@@ -9,6 +10,11 @@ public class LogContextInfo
     {
         #region 属性
 
+        /// <summary>
+        /// 序号
+        /// </summary>
+        private int _orderId;
+
         /// <summary>
         /// 跟踪号
         /// </summary>
@@ -39,7 +45,31 @@ public class LogContextInfo
         /// </summary>
         public string Url { get; set; }
 
+        /// <summary>
+        /// 当前日志上下文信息
+        /// </summary>
+        // ReSharper disable once InconsistentNaming
+        private static readonly AsyncLocal<LogContextInfo> _current = new AsyncLocal<LogContextInfo>();
+
+        /// <summary>
+        /// 当前日志上下文信息
+        /// </summary>
+        public static LogContextInfo Current
+        {
+            get => _current.Value;
+            set => _current.Value = value;
+        }
+
         #endregion
 
+        /// <summary>
+        /// 初始化一个<see cref="LogContextInfo"/>类型的实例
+        /// </summary>
+        public LogContextInfo() => _orderId = 0;
+
+        /// <summary>
+        /// 获取序号
+        /// </summary>
+        public int GetOrderId() => _orderId++;
     }
 }

modules/admin/src/Bing.Admin/Modules/AppModule.cs

@@ -9,6 +9,7 @@
 using Bing.Domain.Entities.Events;
 using Bing.Helpers;
 using Bing.Security.Claims;
+using Bing.Tracing;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
@@ -56,6 +57,12 @@ public override IServiceCollection AddServices(IServiceCollection services)
             });
             services.AddDomainEventDispatcher();
             //services.AddAudit();
+            // 添加跟踪ID
+            services.Configure<CorrelationIdOptions>(x =>
+            {
+                x.HttpHeaderName = "X-Correlation-Id";
+                x.SetResponseHeader = true;
+            });
             return services;
         }
 
@@ -66,6 +73,7 @@ public override IServiceCollection AddServices(IServiceCollection services)
         public override void UseModule(IApplicationBuilder app)
         {
             Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
+            app.UseCorrelationId();
             app.UseBingExceptionHandling();
             // 初始化Http上下文访问器
             Web.HttpContextAccessor = app.ApplicationServices.GetService<IHttpContextAccessor>();