使用Visual Studio Code開發Asp.Net Core WebApi學習筆記（三）-- Logger

本篇是在上一篇的基礎上添加日志功能，並記錄NLog在Asp.Net Core里的使用方法。

第一部分：默認Logger支持

一、project.json添加日志包引用，並在cmd窗口使用 dotnet restore 命令還原包文件。

{
  "version": "1.0.0-*",
  "buildOptions": {
    "debugType": "portable",
    "emitEntryPoint": true
  },
  "dependencies": {
    "Microsoft.NETCore.App": {
      "type": "platform",
      "version": "1.0.0"
    },
    "Microsoft.AspNetCore.Server.Kestrel": "1.0.0",
    "Microsoft.AspNetCore.Mvc": "1.0.0",
    "Microsoft.Extensions.Logging": "1.0.0",
    "Microsoft.Extensions.Logging.Console": "1.0.0",
    "Microsoft.Extensions.Logging.Debug": "1.0.0",
    "Microsoft.Extensions.Logging.Filter": "1.0.0"
  },
  "frameworks": {
    "netcoreapp1.0": {
      "imports": "dnxcore50"
    }
  }
}

二、修改Startup.cs文件，添加命令行窗口和調試窗口的日志記錄功能。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace WebApiFrame
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            // 注入MVC框架
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();            

            // 添加MVC中間件
            app.UseMvc();
        }
    }
}

三、分別使用VS Code的調試功能和命令行的 dotnet run 命令啟動程序，瀏覽器訪問 http://localhost:5000/api/users/1 地址后，可以查看到窗口日志打印信息。

 

第二部分：Logger日志級別

日志級別從低到高一共六級，默認情況下，控制台上輸出的日志會采取下面的格式：

我們在DemoController.cs控制器里演示如何設置和輸出對應級別的日志。

一、修改Startup.cs內容，設置日志級別。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace WebApiFrame
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            // 注入MVC框架
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持

            // 設置日志最小級別Warning
            loggerFactory.AddConsole(LogLevel.Warning);
            
            //loggerFactory.AddDebug();

            // 添加MVC中間件
            app.UseMvc();
        }
    }
}

二、修改UsersController.cs文件內容，添加日志輸出。

using System;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using WebApiFrame.Models;

namespace WebApiFrame.Controllers
{

    [Route("api/[controller]")]
    public class UsersController : Controller
    {
        private ILogger<UsersController> _logger;

        public UsersController(ILogger<UsersController> logger){
            _logger = logger;
        }

        [HttpGet("{id}")]
        public IActionResult Get(int id)
        {
            // 演示日志輸出
            _logger.LogInformation("This is Information Log!");
            _logger.LogWarning("This is Warning Log!");
            _logger.LogError("This is Error Log!");

            var user = new User() { Id = id, Name = "Name:" + id, Sex = "Male" };
            return new ObjectResult(user);
        }

        [HttpPost]
        public IActionResult Post([FromBody] User user){
            if(user == null){
                return BadRequest();
            }

            // TODO：新增操作
            user.Id = new Random().Next(1, 10);
            return CreatedAtAction("Get", new { id = user.Id }, user);
        }

        [HttpPut("{id}")]
        public IActionResult Put(int id, [FromBody] User user){
            if(user == null){
                return BadRequest();
            }

            // TODO: 更新操作
            return new NoContentResult();
        }

        [HttpDelete("{id}")]
        public void Delete(int id){
            // TODO: 刪除操作
            
        }
    }
}

三、cmd窗口執行 dotnet run 命令，瀏覽器訪問 http://localhost:5000/api/users/1 地址，查看cmd窗口日志輸出。

 

或者，使用Filter設置日志級別，重新執行訪問並查看日志輸出。

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持

            // 設置日志最小輸出級別為Error
            loggerFactory.WithFilter(new FilterLoggerSettings()
            {
                // 設置以命名空間開頭的日志的最小輸出級別
                { "Microsoft", LogLevel.Warning },
                { "WebApiFrame", LogLevel.Error }
            }).AddConsole();

            //loggerFactory.AddDebug();

            // 添加MVC中間件
            app.UseMvc();
        }

 

第三部分：NLog

NLog是一個簡單靈活的.Net日志記錄類庫。相比Log4Net來說，配置要簡單許多。

一、project.json添加NLog包引用，並使用 dotnet restore 命令還原包文件。

{
  "version": "1.0.0-*",
  "buildOptions": {
    "debugType": "portable",
    "emitEntryPoint": true
  },
  "dependencies": {
    "Microsoft.NETCore.App": {
      "type": "platform",
      "version": "1.0.0"
    },
    "Microsoft.AspNetCore.Server.Kestrel": "1.0.0",
    "Microsoft.AspNetCore.Mvc": "1.0.0",
    "Microsoft.Extensions.Logging": "1.0.0",
    "Microsoft.Extensions.Logging.Console": "1.0.0",
    "Microsoft.Extensions.Logging.Debug": "1.0.0",
    "Microsoft.Extensions.Logging.Filter": "1.0.0",
    "NLog.Extensions.Logging": "1.0.0-rtm-alpha2"
  },
  "frameworks": {
    "netcoreapp1.0": {
      "imports": "dnxcore50"
    }
  }
}

二、添加NLog配置文件nlog.config。

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true"
      internalLogLevel="Warn"
      internalLogFile="internal-nlog.txt">

  <!-- define various log targets -->
  <targets>
    <!-- write logs to file -->
    <target xsi:type="File" name="allfile" fileName="nlog-all-${shortdate}.log"
                 layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />


    <target xsi:type="File" name="ownFile-web" fileName="nlog-own-${shortdate}.log"
             layout="${longdate}|${logger}|${uppercase:${level}}|  ${message} ${exception}" />

    <target xsi:type="Null" name="blackhole" />
  </targets>

  <rules>
    <!--All logs, including from Microsoft-->
    <logger name="*" minlevel="Trace" writeTo="allfile" />

    <!--Skip Microsoft logs and so log only own logs-->
    <logger name="Microsoft.*" minlevel="Trace" writeTo="blackhole" final="true" />
    <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
  </rules>
</nlog>

三、修改Startup.cs文件內容，添加NLog支持。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using NLog.Extensions.Logging;

namespace WebApiFrame
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            // 注入MVC框架
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            //loggerFactory.AddConsole();
            //loggerFactory.AddDebug();

            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加MVC中間件
            app.UseMvc();
        }
    }
}

四、重新執行訪問並查看日志輸出。

生成的日志文件和內容

 

第四部分、其他相關內容

最后，同時放開三種日志輸出方式，不修改控制器里的任何代碼，可以發現將同時以三種方式記錄相同的日志內容。

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加MVC中間件
            app.UseMvc();
        }

在.Net Core框架里，日志功能主要由 ILoggerFactory, ILoggerProvider, ILogger 這三個接口體現：

ILoggerFactory：工廠接口。只提供注冊LoggerProvider的方法和創建單實例Logger對象的方法。

ILoggerProvider：提供真正具有日志輸出功能的Logger對象的接口。每一種日志輸出方式對應一個不同的LoggerProvider類。

ILogger：Logger接口。Logger實例內部會維護一個ILogger接口的集合，集合的每一項都是由對應的LoggerProvider類注冊生成的Logger對象而來。當調用Logger的日志輸出方法時，實際是循環調用內部集合的每一個Logger對象的輸出方法，所以就能看到上面出現的效果。