fix: 优化真实IP中间件注入方式

Author: jianxuanbing

framework/src/Bing.AspNetCore/Bing/AspNetCore/Extensions/Extensions.ApplicationBuilder.cs

@@ -4,6 +4,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 
 namespace Bing.AspNetCore.Extensions
 {
@@ -22,7 +23,13 @@ public static class BingApplicationBuilderExtensions
         /// 注册真实IP中间件
         /// </summary>
         /// <param name="builder">应用程序生成器</param>
-        public static IApplicationBuilder UseRealIp(this IApplicationBuilder builder) => builder.UseMiddleware<RealIpMiddleware>();
+        /// <param name="setupAct">配置操作</param>
+        public static IApplicationBuilder UseRealIp(this IApplicationBuilder builder, Action<RealIpOptions> setupAct = null)
+        {
+            var options = new RealIpOptions { HeaderKey = "x-forwarded-for" };
+            setupAct?.Invoke(options);
+            return builder.UseMiddleware<RealIpMiddleware>(Options.Create(options));
+        }
 
         /// <summary>
         /// 注册真实IP

framework/src/Bing.AspNetCore/Bing/AspNetCore/RealIp/RealIpMiddleware.cs

@@ -1,10 +1,10 @@
 using System;
 using System.Net;
 using System.Threading.Tasks;
-using Bing.Logs;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 
 namespace Bing.AspNetCore.RealIp
@@ -24,15 +24,22 @@ public class RealIpMiddleware : IMiddleware
         /// </summary>
         private readonly RealIpOptions _options;
 
+        /// <summary>
+        /// 日志
+        /// </summary>
+        private readonly ILogger<RealIpMiddleware> _logger;
+
         /// <summary>
         /// 初始化一个<see cref="RealIpMiddleware"/>类型的实例
         /// </summary>
         /// <param name="next">方法</param>
         /// <param name="options">真实IP选项</param>
-        public RealIpMiddleware(RequestDelegate next, IOptions<RealIpOptions> options)
+        /// <param name="logger">日志</param>
+        public RealIpMiddleware(RequestDelegate next, IOptions<RealIpOptions> options, ILogger<RealIpMiddleware> logger)
         {
             _next = next;
             _options = options.Value;
+            _logger = logger;
         }
 
         /// <summary>
@@ -47,33 +54,17 @@ public async Task InvokeAsync(HttpContext context)
                 if (headers.ContainsKey(_options.HeaderKey))
                 {
                     context.Connection.RemoteIpAddress = IPAddress.Parse(
-                        _options.HeaderKey.Equals("x-forwarded-for",StringComparison.CurrentCultureIgnoreCase)
+                        _options.HeaderKey.Equals("x-forwarded-for", StringComparison.CurrentCultureIgnoreCase)
                             ? headers["X-Forwarded-For"].ToString().Split(',')[0]
                             : headers[_options.HeaderKey].ToString());
-
-                    WriteLog(context, context.Connection.RemoteIpAddress);
+                    _logger.LogDebug($"解析真实IP成功: {context.Connection.RemoteIpAddress}");
                 }
             }
             finally
             {
                 await _next(context);
             }
         }
-
-        /// <summary>
-        /// 写入日志
-        /// </summary>
-        /// <param name="context">Http上下文</param>
-        /// <param name="address">IP地址</param>
-        private void WriteLog(HttpContext context, IPAddress address)
-        {
-            if (context == null)
-                return;
-            var log = Log.GetLog(this)
-                .Caption("真实IP中间件");
-            log.Content($"解析真实IP成功 : {address}")
-                .Debug();
-        }
     }
 
     /// <summary>

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

@@ -2,6 +2,7 @@
 using System.Text;
 using AspectCore.Configuration;
 using Bing.AspNetCore;
+using Bing.AspNetCore.Extensions;
 using Bing.AspNetCore.Mvc.ExceptionHandling;
 using Bing.AspNetCore.Mvc.Filters;
 using Bing.Core.Modularity;
@@ -75,6 +76,7 @@ public override void UseModule(IApplicationBuilder app)
             Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
             app.UseCorrelationId();
             app.UseBingExceptionHandling();
+            app.UseRealIp(x => x.HeaderKey = "test");
             // 初始化Http上下文访问器
             Web.HttpContextAccessor = app.ApplicationServices.GetService<IHttpContextAccessor>();
             app.UseAuthentication();