怎么在Asp.Net Core中使用NLog實(shí)現(xiàn)請(qǐng)求監(jiān)控？很多新手對(duì)此不是很清楚，為了幫助大家解決這個(gè)難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來學(xué)習(xí)下，希望你能有所收獲。

成都創(chuàng)新互聯(lián)專注于企業(yè)成都營銷網(wǎng)站建設(shè)、網(wǎng)站重做改版、子長網(wǎng)站定制設(shè)計(jì)、自適應(yīng)品牌網(wǎng)站建設(shè)、H5高端網(wǎng)站建設(shè)、商城網(wǎng)站制作、集團(tuán)公司官網(wǎng)建設(shè)、外貿(mào)網(wǎng)站制作、高端網(wǎng)站制作、響應(yīng)式網(wǎng)頁設(shè)計(jì)等建站業(yè)務(wù)，價(jià)格優(yōu)惠性價(jià)比高，為子長等各大城市提供網(wǎng)站開發(fā)制作服務(wù)。

一：比較 asp.net web api 和 asp.net core 的請(qǐng)求管道

觀察這兩張圖，可以發(fā)現(xiàn)他們非常的相似，都是管道式的設(shè)計(jì)，在 asp.net web api 中，我們可以注冊(cè)一系列的 DelegatingHandler 來處理請(qǐng)求上下文 HttpRequestMessage，在 asp.net core 中，我們可以注冊(cè)一系列中間件來處理請(qǐng)求上下文，他們兩者從功能和意義上是非常相似的，我這里這里不會(huì)詳細(xì)介紹各自的管道是如何的（這樣的文章非常多，博客園隨處可見），他們都完成了類似中間件的功能，只是在代碼設(shè)計(jì)上有一點(diǎn)區(qū)別。

我們先看一段代碼，新建一個(gè) asp.net web api 項(xiàng)目，添加幾個(gè) DelegatinHandler

然后在 Global 中注冊(cè)

public class DelegatingHandler1 : DelegatingHandler
  {
    protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
      Trace.WriteLine("DelegatingHandler1 HashCode: " + this.GetHashCode());
      Trace.WriteLine("DelegatingHandler1 base InnerHandler HashCode: " + base.InnerHandler.GetHashCode());
      Trace.WriteLine("DelegatingHandler1 start");
      var response = await base.SendAsync(request, cancellationToken);
      Trace.WriteLine("DelegatingHandler1 end");
      return response;
    }
  }
  public class DelegatingHandler2 : DelegatingHandler
  {
    protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
      Trace.WriteLine("DelegatingHandler2 HashCode: " + this.GetHashCode());
      Trace.WriteLine("DelegatingHandler2 base InnerHandler HashCode: " + base.InnerHandler.GetHashCode());
      Trace.WriteLine("DelegatingHandler2 start");
      var response = await base.SendAsync(request, cancellationToken);
      Trace.WriteLine("DelegatingHandler2 end");
      return response;
    }
  }
  public class DelegatingHandler3 : DelegatingHandler
  {
    protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
      Trace.WriteLine("DelegatingHandler3 HashCode: " + this.GetHashCode());
      Trace.WriteLine("DelegatingHandler3 base InnerHandler HashCode: " + base.InnerHandler.GetHashCode());
      Trace.WriteLine("DelegatingHandler3 start");
      var response = await base.SendAsync(request, cancellationToken);
      Trace.WriteLine("DelegatingHandler3 end");
      return response;
    }
  }

修改一下 ValuesController

public class WebApiApplication : System.Web.HttpApplication
  {
    protected void Application_Start()
    {
      AreaRegistration.RegisterAllAreas();
      GlobalConfiguration.Configure(WebApiConfig.Register);
      FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
      RouteConfig.RegisterRoutes(RouteTable.Routes);
      BundleConfig.RegisterBundles(BundleTable.Bundles);

      GlobalConfiguration.Configuration.MessageHandlers.Add(new DelegatingHandler1());
      GlobalConfiguration.Configuration.MessageHandlers.Add(new DelegatingHandler2());
      GlobalConfiguration.Configuration.MessageHandlers.Add(new DelegatingHandler3());
    }
  }

啟動(dòng)后輸入路徑 /api/values，我們可以在VS 的輸出欄看到下面這些內(nèi)容

public class ValuesController : ApiController
  {
    // GET api/values
    public IEnumerable Get()
    {
      Trace.WriteLine("/api/values");
      var handlers = this.RequestContext.Configuration.MessageHandlers;
      return new string[] { "value1", "value2" };
    }
  }

啟動(dòng)后輸入路徑 /api/values，我們可以在VS 的輸出欄看到下面這些內(nèi)容

DelegatingHandler1 HashCode: 58154627
DelegatingHandler1 base InnerHandler HashCode: 35529478
DelegatingHandler1 start
DelegatingHandler2 HashCode: 35529478
DelegatingHandler2 base InnerHandler HashCode: 47422476
DelegatingHandler2 start
DelegatingHandler3 HashCode: 47422476
DelegatingHandler3 base InnerHandler HashCode: 65273341
DelegatingHandler3 start
/api/values
DelegatingHandler3 end
DelegatingHandler2 end
DelegatingHandler1 end

輸出中我們可以看到 DelegatingHandler1 的 InnerHandler 是 DelegatingHandler2，以此類推，在 DelegatingHandler3 的 InnerHandler 處理請(qǐng)求的時(shí)候就轉(zhuǎn)發(fā)到了相關(guān)控制器，這里和 .net core 中的中間件非常相似，在.net core 中間件順序是 RequestServicesContainerMiddleware（給請(qǐng)求上下文綁定容器）-> AuthenticationMiddleware（認(rèn)證）-> RouterMiddleware （路由以及MVC）

如果我們?cè)?nbsp;ValuesController 中觀察表達(dá)式 this.RequestContext.Configuration.MessageHandlers 還可以看到最終處理請(qǐng)求的是一個(gè) HttpRoutingDispatcher，最也是是分配到路由以及控制器來處理的，按照如此方式我們可以很容易在 asp.net web api 中對(duì)請(qǐng)求統(tǒng)計(jì)。這里是比較簡陋的，對(duì)此我們可以記錄客戶端和服務(wù)器更詳細(xì)的信息，包括 IP 地址，http狀態(tài)碼，是否是認(rèn)證用戶等等，但是這篇主要是以 asp.net core 為主的，所以這里就不詳細(xì)寫下去了。

public class ApplicationInsight : DelegatingHandler
  {
    protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
      var stopWatch = new Stopwatch();
      stopWatch.Start();

      var response = await base.SendAsync(request, cancellationToken);

      stopWatch.Stop();
      //停止計(jì)時(shí)器，并記錄
    }
  }
  public partial class Startup
  {
    public void Configuration(IAppBuilder app)
    {
      GlobalConfiguration.Configuration.MessageHandlers.Add(new ApplicationInsight());
    }
  }

二：asp.net core 中間件 + NLog 實(shí)現(xiàn)請(qǐng)求監(jiān)控

先看統(tǒng)計(jì)結(jié)果，start 開始時(shí)間，time 是請(qǐng)求消耗時(shí)間（毫秒），authenicate 是認(rèn)證通過的 schema，使用 NLog 自定義字段也是非常方便的

先說一說遇到的問題

（1）NLog 記錄一張以上的表如何實(shí)現(xiàn)，應(yīng)為首先會(huì)有一個(gè)一般性的日志表（稱他為 log），并且這些統(tǒng)計(jì)不對(duì)寫到 log 表

（2）使用 NLog 自定義字段 LayoutRenderer 沒有類似 .net framework 中的 System.Web.Current

（3）使用 UseMiddleware 無法在讓我們的中間件成為第一個(gè)中間件

（4）實(shí)現(xiàn)忽略記錄的方法，肯定有一些接口是不希望記錄的，所以這個(gè)也要實(shí)現(xiàn)

NLog 配置

這里只列出了部分內(nèi)容，github 地址在最后，數(shù)據(jù)庫是 mysql ，apiinsight 表示請(qǐng)求統(tǒng)計(jì)，log 是一般性的日志，debughelper 可以加快我們調(diào)試時(shí)日志的檢索速度

在 Startup 中

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  //省略了其他配置

  //全局的 HttpContext
  app.UseGlobalHttpContext();

  //省略了其他配置

  LogManager.Configuration = new XmlLoggingConfiguration(Path.Combine(env.ContentRootPath, "nlog.config"));
  LogManager.Configuration.Variables["root"] = env.ContentRootPath;
  LogManager.Configuration.Variables["connectionString"] = Configuration.GetConnectionString("DefaultConnection");
}

自定義字段都是通過 LayoutRenderer 實(shí)現(xiàn)，由于自定義字段有很多，這里只列出了一個(gè)開始時(shí)間是如何查詢的，這個(gè)時(shí)間是在我們注冊(cè)的第一個(gè)中間件執(zhí)行 Invoke 方法的時(shí)候?qū)戇M(jìn) HttpContext.Items 的

[LayoutRenderer("apiinsight-start")]
  public class StartApiInsightRenderer : LayoutRenderer
  {
    protected override void Append(StringBuilder builder, LogEventInfo logEvent)
    {
      var httpContext = HttpContextProvider.Current;
      if (httpContext == null)
      {
        return;
      }
      var _apiInsightsKeys = httpContext.RequestServices.GetService();

      if (httpContext != null)
      {
        if (httpContext.Items.TryGetValue(_apiInsightsKeys.StartTimeName, out var start) == true)
        {
          builder.Append(start.ToString());
        }
      }
    }
  }

NLog 規(guī)則，很容易理解日志統(tǒng)計(jì)只記錄 Cheers 命名空間下的日志

核心 ApiInsightMiddleware 中間件

public class ApiInsightMiddleware
  {
    private readonly RequestDelegate _next;
    private readonly IServiceProvider _serverProvider;
    private readonly IApiInsightsKeys _apiInsightsKeys;
    private readonly ILogger _logger;
    private HttpContext _httpContext;

    public ApiInsightMiddleware(RequestDelegate next, IServiceProvider serviceProvider, ILogger logger)
    {
      _next = next;
      _serverProvider = serviceProvider;
      _apiInsightsKeys = _serverProvider.GetService();
      _logger = logger;
    }

    public async Task Invoke(HttpContext httpContext)
    {
      _httpContext = httpContext;
      var flag = SetValues();

      await _next(httpContext);

      if (flag == true)
      {
        ApiInsight();
      }
    }
    //省略了其他的代碼
  }

很好理解，在執(zhí)行下一個(gè)中間件之前調(diào)用 SetValues 開始計(jì)時(shí)，下一個(gè)中間件執(zhí)行成功開始統(tǒng)計(jì)并寫入日志（或者忽略不寫）。現(xiàn)在他是 asp.net core mvc 的第一個(gè)中間件了，好處就是更符合這個(gè)中間件本身的所做的事情了，但是帶來的問題就是 httpContext.RequestService 是 null ，因?yàn)?nbsp;RequestService 是在 RequestServicesContainerMiddleware 這個(gè)中間件寫進(jìn)去的，在者其實(shí)很多地方我們都需要 HttpContext ，并且目前微軟還沒有給我們定義一個(gè)靜態(tài)的 HttpContext。

靜態(tài)的 HttpContext

HttpContext 是通過單例 IHttpContextAccessor 提供的，當(dāng) HttpContext 創(chuàng)建的時(shí)候就會(huì)賦值給他，當(dāng)請(qǐng)求到達(dá)中間件這個(gè)管道的時(shí)候，HttpContext 就已經(jīng)存在于 IHttpContextAccessor 了，并且和 Invoke 參數(shù)列表中的 HttpContext 是一致的（同一個(gè)請(qǐng)求中），問題在于 RequestServicesContainerMiddleware 這個(gè)中間件沒有執(zhí)行就沒有容器，并且很多時(shí)候我們都要用到容器，所以就模仿源碼在這里都加進(jìn)去了。

public static class HttpContextProvider
  {
    private static IHttpContextAccessor _accessor;
    private static IServiceScopeFactory _serviceScopeFactory;

    public static Microsoft.AspNetCore.Http.HttpContext Current
    {
      get
      {
        var context = _accessor?.HttpContext;

        if (context != null)
        {
          var replacementFeature = new RequestServicesFeature(_serviceScopeFactory);
          context.Features.Set(replacementFeature);

          return context;
        }

        return null;
      }
    }

    internal static void ConfigureAccessor(IHttpContextAccessor accessor, IServiceScopeFactory serviceScopeFactory)
    {
      _accessor = accessor;
      _serviceScopeFactory = serviceScopeFactory;
    }
  }
  public static class HttpContextExtenstion
  {
    public static void AddHttpContextAccessor(this IServiceCollection services)
    {
      services.AddSingleton();
    }

    public static IApplicationBuilder UseGlobalHttpContext(this IApplicationBuilder app)
    {
      var httpContextAccessor = app.ApplicationServices.GetRequiredService();
      var serviceScopeFactory = app.ApplicationServices.GetRequiredService();
      HttpContextProvider.ConfigureAccessor(httpContextAccessor, serviceScopeFactory);
      return app;
    }
  }

我們只需要在 Startup 中使用 app.UseGlobalHttpContext(); 就可以在程序的任何地方得到 HttpContext 和容器了，肯定會(huì)有人說為什么不通過構(gòu)造函數(shù)來獲取我們想要的注入呢，因?yàn)橛行┑谌娇蚣芑蜻@某些地方我們不能使用容器獲取服務(wù)，比如這里 NLog 的自定義字段使用的 LayoutRenderer 就無法通過構(gòu)造器得到我們想要的服務(wù)。

第一個(gè)中間件

在 Startup 的 Configure 方法中目前還沒發(fā)現(xiàn)如何注冊(cè)第一個(gè)中間件，因?yàn)?nbsp;Configure 方法始終是在 IStartupFilter 這個(gè)接口之后執(zhí)行的，這也提供了我們讓自己的中間件成為第一個(gè)中間件的可能?？赡苓@樣做并不是特別有必要，甚至是沒有意義的，但是實(shí)現(xiàn)的過程確實(shí)很有意思的。這里在 Startup 中的 方法 ConfigureService 注冊(cè)我們的中間件。

  public void ConfigureServices(IServiceCollection services)
  {
    services.AddApiInsights();
    services.AddMvc();
  }

具體的

public static class ApiInsightsServiceCollectionExtensions
  {
    static readonly string stopWatchName = "__stopwatch__";
    static readonly string startTimeName = "__start__";

    /// 

    ///   注冊(cè)和 API 監(jiān)控相關(guān)的服務(wù)，中間件
    /// 
    /// 
    public static void AddApiInsights(this IServiceCollection services)
    {
      services.AddSingleton(
          new ApiInsightsKeys(stopWatchName, startTimeName)
        );
      services.FirstRegister(ServiceCollectionServiceExtensions.AddTransient);
      services.AddSingleton();
    }
  }

這里注冊(cè)了三個(gè)服務(wù)

IApiInsightsKeys

定義了存儲(chǔ)在 HttpContext.Item 中的鍵值對(duì)的名稱

  public interface IApiInsightsKeys
  {
    string StopWatchName { get; }
    string StartTimeName { get; }
  }

IRequestIsAuthenticate

/// 

  ///   驗(yàn)證請(qǐng)求用戶是否已經(jīng)認(rèn)證
  /// 
  public interface IRequestIsAuthenticate
  {
    /// 

    ///   返回已經(jīng)認(rèn)證的 scheme
    /// 
    /// 
    Task IsAuthenticateAsync();
    /// 

    ///   返回已經(jīng)認(rèn)證的 用戶名
    /// 
    /// 
    Task AuthenticatedUserName();
  }

就驗(yàn)證而言可能不同的開發(fā)者使用的是不一樣的驗(yàn)證方式，可能是基于 Asp.Net Core Authentication 中間件的認(rèn)證方式，也可能是其他的比如自定義的 token，或者有一個(gè)單點(diǎn)登錄的服務(wù)器，又或者是 session，其實(shí) Asp.Net Core 的 Authentication 中間件也可以幫我們實(shí)現(xiàn)基于 restful 的token 認(rèn)證。所以就把它定義出來了，并且默認(rèn)的實(shí)現(xiàn)就是基于 Authentication 這個(gè)中間件的。

IStartupFilter

看到他是一個(gè)非常特殊的方式來注冊(cè)的，自定義的 FirstRegister 這個(gè)方法，實(shí)際上 Asp.Net Core 內(nèi)置有多個(gè) IStartup 這樣的服務(wù)，并且都是在 Startup 的 Configure 之前執(zhí)行的，所以這里一定要用這個(gè)服務(wù)來讓我們的中間件成為第一個(gè)中間件。FirstRegister 代碼也很容易理解，由于在宿主啟動(dòng)之前，內(nèi)部注冊(cè)了多個(gè) IStartup，并且最后會(huì)按先后順序配置 IApplicationBuilder，所以我們只能讓第一個(gè) StartupFilter 的 IApplicationBuilder 就注冊(cè)我們的中間件，通過改動(dòng) ServiceCollection 中服務(wù)的順序可以實(shí)現(xiàn)。雖然不是很有必要，但是可以從中觀察的 Startup 的 Configure方法 以及 接口StartupFilter （還有 IHostingStartup ）的執(zhí)行順序。

public class RequestApiInsightBeginStartupFilter : IStartupFilter
  {
    public Action Configure(Action next)
    {
      return builder =>
      {
        builder.UseMiddleware();
        next(builder);
      };
    }
  }

忽略的方法

  [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
  public class NoInsightAttribute : Attribute
  {
  }

在 ApiInsight 方法中會(huì)調(diào)用 IsIgnore 檢測(cè)該方法是否打了標(biāo)簽 NoInsightAttribute，如果是那就忽略該方法，這里建議使用特性路由，原因有兩點(diǎn)，第一特性路由不需要使用 IActionSelector 接口重新查找匹配的方法，第二，在 restful api 中，結(jié)合特性路由和 HttpMethodAttribute 標(biāo)簽可以使方法更簡潔，相同的接口名稱通過不同的請(qǐng)求方式達(dá)到不同的目的

private bool IsIgnore()
  {
    var actionDescriptor = GetSelectedActionDescriptor() as ControllerActionDescriptor;
    if (actionDescriptor == null)
    {
      return false;
    }
    else
    {
      var noInsight = actionDescriptor.MethodInfo.GetCustomAttribute();
      return noInsight != null;
    }
  }

看完上述內(nèi)容是否對(duì)您有幫助呢？如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章，請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，感謝您對(duì)創(chuàng)新互聯(lián)網(wǎng)站建設(shè)公司，的支持。

當(dāng)前題目：怎么在Asp.NetCore中使用NLog實(shí)現(xiàn)請(qǐng)求監(jiān)控-創(chuàng)新互聯(lián)
路徑分享：http://weahome.cn/article/ccdeeh.html