log – ASP.NET Core Web API کردن با NLog

چرا لاگ کردن در طول توسعه اپلیکیشن مهم است؟ خب، در حالیکه اپلیکیشن شما در مرحله توسعه است، خطایابی کد و فهمیدن اینکه اشکال کار کجاست خیلی راحت است. اما آیا در محیط production (مرحله استفاده از نرم افزار توسط کاربر نهایی) نیز میتوانید خطایابی کنید؟

البته که نه.

به این دلیل است که پیامهای log شده برای فهمیدن اینکه چه اشکالی در برنامه رخ داده است و خطاها کجای کد شما اتفاق افتاده است، رویکردی عالی در محیط production محسوب میشود. NET Core. برای log کردن پیغامها، شیوه های خودش را دارد. اما من در تمام پروژه های خود، ترجیح میدهم که سرویس log سفارشی خودم را داشته باشم.

این مقاله، قسمتی از مجموعه آموزشی زیر میباشد:

اگر می خواهید تمام آموزشهای لازم و پایه مربوط به این دوره آموزشی را ببینید ، لطفاً روی این لینک کلیک کنید: صفحه مقدمه برای این آموزش.

برای مطالعه قسمت قبلی، این لینک را بررسی کنید: ایجاد پروژه Net Core WebApi. – کدهای آماده سازی اولیه.

این مقاله شامل قسمتهای زیر میباشد:

ایجاد پروژه های مورد نیاز
ایجاد اینترفیس و نصب NLog
پیاده سازی اینترفیس و فایل Nlog.Config
پیکربندی سرویس Logger
DI, IOC و تست سرویس Logger
نتیجه گیری

ایجاد پروژه های مورد نیاز

دو پروژه جدید میسازیم. نام اولی را Contracts میگذاریم. ما میخواهیم اینترفیسها را داخل این پروژه ذخیره کنیم. نام دومی را LoggerService میگذاریم. از این پروژه برای استفاده از logger logic استفاده میکنیم.

برای ایجاد پروژه جدید، بر روی solution راست کلیک کرده، Add و سپس NewProject را انتخاب کنید. Class Library (.NET Core) را انتخاب کرده و نام آن را Contracts بگذارید:

همین کار را برای پروژه دوم نیز انجام دهید و نام آن را LoggerService بگذارید.

حال با در اختیار داشتن این دو پروژه، باید پروژه LoggerService را به پروژه اصلی رفرنس دهیم. در پروژه اصلی داخل solution explorer بر روی Dependencies راست کلیک کرده و AddReference را انتخاب کنید. در قسمت Projects، بر روی Solution کلیک کنید و تیک پروژه LoggerService را بزنید:

قبل از شروع به پیاده سازی LoggerService ، یک کار دیگر نیز انجام دهیم.

در پروژه LoggerService، بر روی Dependencies راست کلیک کنید و بر روی Add Reference کلیک کنید. در داخل پنجره، تیک پروژه Contracts را برای import کردن رفرنس آن به داخل پروژه LoggerService بزنید. این کار، رفرنس Contracts را به طور خودکار به پروژه اصلی نیز اضافه میکند، زیرا از قبل، رفرنس LoggerService را داخل پروژه اصلی داریم.

ایجاد اینترفیس و نصب NLog

سرویس logger ما شامل 4 متد برای log کردن میباشد:

Info message ها
Debug message ها
Warning message ها
و error message ها

علاوه بر این، داخل پروژه Contracts، اینترفیس ILoggerManager را ایجاد میکنیم که شامل تعریف چهار متد زیر میباشد.

پس اینترفیس ILoggerManager را به شکل زیر ایجاد میکنیم:

namespace Contracts
{
    public interface ILoggerManager
    {
        void LogInfo(string message);
        void LogWarn(string message);
        void LogDebug(string message);
        void LogError(string message);
    }
}

namespace Contracts

{

public interface ILoggerManager

{

void LogInfo(string message);

void LogWarn(string message);

void LogDebug(string message);

void LogError(string message);

}

قبل از اینکه ما این اینترفیس را داخل پروژه LoggerService پیاده سازی کنیم باید کتابخانه NLog را داخل آن نصب نماییم. NLog یک پلتفرم logging برای NET. میباشد که به ما کمک میکند تا پیغامهایمان را ایجاد و log نماییم.

ما میخواهیم برای افزودن کتابخانه NLog به پروژه، دو شیوه را به شما نشان دهیم:

در پروژه LoggerService بر روی Dependences راست کلیک کرده و Manage NuGet Packages را انتخاب کنید. بعد از اینکه پنجره NuGet باز شد مراحل زیر را دنبال کنید:
از منوی Other Windows ،View را انتخاب کرده و سپس بر روی Package Manager Console کلیک کنید. بعد از اینکه کنسول باز شد، دستور زیر را اجرا کنید:

Install-Package NLog.Extensions.Logging -Version 1.6.1

1	Install-Package NLog.Extensions.Logging -Version 1.6.1

بعد از چند ثانیه، NLog بر روی اپلیکیشن شما اجرا میشود.

پیاده سازی اینترفیس و فایل Nlog.Config

در پروژه LoggerService، یک کلاس جدید به نام LoggerManager ایجاد کنید.

این کلاس را به صورت زیر تغییر دهید:

using Contracts;
using NLog;

namespace LoggerService
{
    public class LoggerManager : ILoggerManager
    {
        private static ILogger logger = LogManager.GetCurrentClassLogger();

        public void LogDebug(string message)
        {
            logger.Debug(message);
        }

        public void LogError(string message)
        {
            logger.Error(message);
        }

        public void LogInfo(string message)
        {
            logger.Info(message);
        }

        public void LogWarn(string message)
        {
            logger.Warn(message);
        }
    }
}

using Contracts;

using NLog;

namespace LoggerService

{

public class LoggerManager : ILoggerManager

{

private static ILogger logger = LogManager.GetCurrentClassLogger();

public void LogDebug(string message)

{

logger.Debug(message);

}

public void LogError(string message)

{

logger.Error(message);

}

public void LogInfo(string message)

{

logger.Info(message);

}

public void LogWarn(string message)

{

logger.Warn(message);

}

حالا باید آن را پیکربندی کنیم وآن را به داخل کلاس Startup، در متد ConfigureServices تزریق کنیم.

NLog باید اطلاعات پوشه ای که فایلهای log قرار است درون آن ایجاد شوند و اینکه نام این فایلها چیست و minimum level از log را بداند. بنابراین، باید یک فایل متنی در پروژه اصلی با نام nlog.config ایجاد کنیم و به مانند مثال زیر آن را تکمیل نماییم. شما باید مسیر پارامترهای internal log و filename را با مسیرهای خودتان جایگزین کنید.

<?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="Trace"
      internalLogFile="d:Projects\Blog-AccountOwner\Project\internal_logs\internallog.txt">

  <targets>
    <target name="logfile" xsi:type="File"
            fileName="d:/Projects/Blog-AccountOwner/Project/logs/${shortdate}_logfile.txt"
            layout="${longdate} ${level:uppercase=true} ${message}"/>
  </targets>

  <rules>
    <logger name="*" minlevel="Debug" writeTo="logfile" />
  </rules>
</nlog>

<?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="Trace"

internalLogFile="d:Projects\Blog-AccountOwner\Project\internal_logs\internallog.txt">

<target name="logfile" xsi:type="File"

fileName="d:/Projects/Blog-AccountOwner/Project/logs/${shortdate}_logfile.txt"

layout="${longdate} ${level:uppercase=true} ${message}"/>

</targets>

<rules>

</rules>

</nlog>

پیکربندی سرویس Logger برای پیغامهای log

تنظیم پیکربندی برای یک سرویس logger، کاملا کار آسانی است.

ما سازنده کلاس Startup را به این صورت تغییر میدهیم:

public Startup(IConfiguration configuration)
{
    LogManager.LoadConfiguration(String.Concat(Directory.GetCurrentDirectory(), "/nlog.config"));
    Configuration = configuration;
}

public Startup(IConfiguration configuration)

{

LogManager.LoadConfiguration(String.Concat(Directory.GetCurrentDirectory(), "/nlog.config"));

Configuration = configuration;

}

در مرحله دوم ، ما باید سرویس logger را به داخل IOC container در NET Core. اضافه کنیم. سه راهکار برای این کار وجود دارد:

صدا زدن services.AddSingleton، سرویس را اولین باری که آن را درخواست میدهید ایجاد میکند و سپس درخواستهای بعد از آن، همان نمونه از سرویس را فراخوانی میکند. این به این معنی است که تمام کامپوننتها، فقط یک نمونه سرویس را به اشتراک میگذارند و هرزمان که به آن نیاز داشته باشند از آن استفاده میکنند. به عبارتی شما همیشه فقط از یک نمونه استفاده میکنید.
صدا زدن services.AddScoped، سرویس را هربار که مورد درخواست قرار میگیرد ایجاد میکند. این به این معنی است که هربار که ما یک درخواست HTTP به سمت اپلیکیشن ارسال میکنیم، یک نمونه جدید از service ایجاد میشود.
صدا زدن services.AddTransient، سرویس را هرزمان که اپلیکیشن آن را درخواست کند ایجاد میکند. این به این معنی است که اگر در طول یک درخواست به سمت اپلیکیشن، چند کامپوننت، آن سرویس را نیاز داشته باشند، این سرویس هربار که هر کامپوننت آن را نیاز داشته باشد ایجاد میشود.

بنابراین در کلاس ServiceExtensions، ما یک متد جدید اضافه میکنیم:

public static void ConfigureLoggerService(this IServiceCollection services)
{
    services.AddSingleton<ILoggerManager, LoggerManager>();
}

public static void ConfigureLoggerService(this IServiceCollection services)

{

services.AddSingleton<ILoggerManager, LoggerManager>();

}

در آخر، در متد ConfigureServices، این extension method را فراخوانی میکنیم:

services.ConfigureLoggerService();

1	services.ConfigureLoggerService();

هر زمان که میخواهیم از این سرویس logger استفاده کنیم، تمام کاری که باید انجام دهیم این است که آن را به داخل سازنده کلاسی که قرار است از این سرویس استفاده کند تزریق کنیم. NET Core. این سرویس را از طریق IOC container به کار میگیرد و تمام feature های آن سرویس برای استفاده در دسترس قرار میگیرد. به این نوع از تزریق آبجکتها، تزریق وابستگی (Dependency Injection) گفته میشود.

DI, IOC و تست سرویس Logger

Dependency Injection(DI) و IOC (Inversion of Control) دقیقا چیست؟

Dependency injection (تزریق وابستگی) یک تکنیک loose coupling (به حداقل رساندن وابستگی) بین آبجکتها و وابستگیهایشان میباشد. این به این معنی است که به جای اینکه یک آبجکت را که هرزمان مورد نیاز بود نمونه سازی کنیم، فقط یکبار آن را نمونه سازی کرده و سپس در یک کلاس، اغلب توسط یک متد سازنده، آن را بکار گیریم. این رویکرد خاصی که استفاده میکنیم به عنوان تزریق سازنده شناخته میشود.

در یک سیستمی که برای استفاده از DI طراحی شده است، ممکن است کلاسهای زیادی را پیدا کنید که وابستگیهایشان را از طریق سازنده شان درخواست میکنند. در این حالت، خوب است که یک کلاسی داشته باشیم که همه نمونه ها را از طریق سازنده در اختیار کلاسها قرار دهد. این کلاسها به عنوان container ها یا به طور ویژه تر، به عنوان Inversion of Control container ها معرفی میشوند. یک IOC container اساسا یک کارخانه ای است که مسئول فراهم نمودن نمونه هایی از type های مختلفی که مورد درخواست قرار میگیرند میباشد.

به منظور تست سرویس logger، ما میتوانیم از WeatherForecastController استفاده کنیم. ما می خواهیم آن را در پروژه اصلی درون پوشه Controllers ایجاد کنیم.

به این صورت آن را تغییر میدهیم:

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private readonly ILoggerManager _logger;

    public WeatherForecastController(ILoggerManager logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public IEnumerable<string> Get()
    {
        _logger.LogInfo("Here is info message from the controller.");
        _logger.LogDebug("Here is debug message from the controller.");
        _logger.LogWarn("Here is warn message from the controller.");
        _logger.LogError("Here is error message from the controller.");

        return new string[] { "value1", "value2" };
    }
}

[ApiController]

[Route("[controller]")]

public class WeatherForecastController : ControllerBase

{

private readonly ILoggerManager _logger;

public WeatherForecastController(ILoggerManager logger)

{

_logger = logger;

}

[HttpGet]

public IEnumerable<string> Get()

{

_logger.LogInfo("Here is info message from the controller.");

_logger.LogDebug("Here is debug message from the controller.");

_logger.LogWarn("Here is warn message from the controller.");

_logger.LogError("Here is error message from the controller.");

return new string[] { "value1", "value2" };

}

سپس، برنامه را start کنید و به http://localhost:5000/weatherforecast بروید. در نتیجه، شما آرایه دورشته ای میبینید . حالا به پوشه ای که در فایل nlog.config تعیین نموده بودید بروید و نتیجه را بررسی کنید. شما باید چهار خط log شده را درون این فایل ببینید.

نتیجه گیری

در حال حاضر، سرویس logger ای دارید که کار میکند و میتوانید آن را در سرتاسر فرآیند توسعه اپلیکیشن، از آن استفاده کنید.

با مطالعه این مقاله، یاد گرفتید که:

چرا log کردن اهمیت دارد
چطور یک سرویس external ایجاد کنیم
چطور از کتابخانه NLog استفاده کنیم و آن را پیکربندی کنیم
DI و IOC چیست
و چطور از DI و IOC برای تزریق سرویس استفاده کنیم

بابت مطالعه این مقاله از شما تشکر میکنیم و در مقاله بعدی، ما در مورد الگوی repository به همراه entity framework core صحبت میکنیم.

سلام و درود بر شما جناب آقای شاهی

بله انجام تنظیمات در خود فایل appsetting.json نیز امکان پذیره. شما میتونید به جای ایجاد فایل متنی nlog.config از خود فایل appsetting.json استفاده کنید.
برای این کار شما باید تنظیمات مربوط به nlog رو که ما در فایل متنی گذاشته بودیم رو به صورت زیر در فایل appsetting.gson قرار بدید:



"NLog":{
    "internalLogLevel":"Info",
    "internalLogFile":"c:\\temp\\internal-nlog.txt",
    "targets":{
        "logfile":{
            "type":"File",
            "fileName":"d:/Projects/Blog-AccountOwner/Project/logs/${shortdate}_logfile.txt",
            "layout":"${longdate} ${level:uppercase=true} ${message}"
        }
    },
    "rules":[
        {
            "logger":"*",
            "minLevel":"Debug",
            "writeTo":"logfile"
        }
    ]
}

"NLog":{

"internalLogLevel":"Info",

"internalLogFile":"c:\\temp\\internal-nlog.txt",

"targets":{

"logfile":{

"type":"File",

"fileName":"d:/Projects/Blog-AccountOwner/Project/logs/${shortdate}_logfile.txt",

"layout":"${longdate} ${level:uppercase=true} ${message}"

}

"rules":[

{

"logger":"*",

"minLevel":"Debug",

"writeTo":"logfile"

}

]

}

و سپس متد Main در فایل program.cs را برای خواندن مقادیر nlog در appsetting.json را به صورت زیر update کنید:



public static void Main(string[] args)
{
    var config = new ConfigurationBuilder()
        .SetBasePath(System.IO.Directory.GetCurrentDirectory())
        .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true).Build();
    LogManager.Configuration = new NLogLoggingConfiguration(config.GetSection("NLog"));

    var logger = NLog.Web.NLogBuilder.ConfigureNLog(LogManager.Configuration).GetCurrentClassLogger();
    try
    {
        logger.Debug("Init main");
        CreateWebHostBuilder(args).Build().Run();
    }
    catch (Exception ex)
    {
        logger.Error(ex, "Stopped program because of exception");
    }
    finally {
        LogManager.Shutdown();
    }
}

public static void Main(string[] args)

{

var config = new ConfigurationBuilder()

.SetBasePath(System.IO.Directory.GetCurrentDirectory())

.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true).Build();

LogManager.Configuration = new NLogLoggingConfiguration(config.GetSection("NLog"));

var logger = NLog.Web.NLogBuilder.ConfigureNLog(LogManager.Configuration).GetCurrentClassLogger();

try

{

logger.Debug("Init main");

CreateWebHostBuilder(args).Build().Run();

}

catch (Exception ex)

{

logger.Error(ex, "Stopped program because of exception");

}

finally {

LogManager.Shutdown();

}

در مورد لاگ کردن در دیتابیس هم باید تنظیمات مربوط به دیتابیس از جمله connection string در فایل nlog.config و یا در همون فایل appsetting.json انجام بشه که در این صورت اطلاعات لاگ درون دیتابیس ثبت میشه که بعدا یک مقاله کامل هم برای این منظور آماده میکنیم.
و در مورد سوال آخرتون، هرچیزی که بخواید رو میتونید با nlog لاگ کنید.

موفق باشید

پاسخ

آموزش برنامه نويسی و طراحی سايت