从类库方法调用Serilog日志记录。NET 6最小API

Question

我设置了一个. Net 6核心最小API来使用SeriLog登录MS SQL Server。在我的类库中，只有当我修改了类库中的构造函数时，我才设法用SeriLog进行日志记录。我试图避免修改我的类库类或方法的构造函数。

在我使用控制台应用程序的经验中，如果我在我的main Program.cs中设置了SeriLog，那么我可以在我的类库中的任何类中使用日志记录，而无需将日志记录器传递给构造函数。所以，我可以用Log。信息(“我的消息”)在类库的任何地方，它的工作。我正试图在一个. Net 6最小API项目中用我的Program.cs实现同样的效果。

我觉得从这个主题的其他问题来看，应该可以做到。特别是这个答案，其中的答案是：

你不必在类库里做任何事情。只有主应用程序具有合成根（应用程序生命周期中可以设置对象图的最早点）。

因此，根据上述内容，在我的API程序中.CS，我有这个代码（我已经在注释中指出了哪些有效，哪些无效）：

//Configure SeriLog
builder.Logging.ClearProviders();
var appSettings = new ConfigurationBuilder()
   .SetBasePath(Directory.GetCurrentDirectory())
   .AddJsonFile("appsettings.json")
   .Build();

var logDB = 
builder.Configuration.GetSection("ConnectionStrings:Default").Value;
var sinkOpts = new MSSqlServerSinkOptions { TableName = "Logs" };
var columnOptions = new ColumnOptions();

var logger = new LoggerConfiguration()
   .MinimumLevel.Override("Microsoft", 
Serilog.Events.LogEventLevel.Information)
  .WriteTo.MSSqlServer(
      connectionString: logDB,        
      sinkOptions: sinkOpts,
      columnOptions: columnOptions,
      appConfiguration: appSettings
    ).CreateLogger();

builder.Logging.AddSerilog(logger);

//Depency injection for Class Library method 
//LoggerTestClass is a class in my Class Library project
builder.Services.AddScoped<ILoggerTestClass, LoggerTestClass>();

var app = builder.Build();
app.ConfigureTestAPI();

方法“ConfigureTestAPI（）”位于如下所示的扩展类中：

public static class API_Test
{

public static void ConfigureTestAPI(this WebApplication app) 
//Extension method for app
{               
    app.MapGet("/test/", GetTest);
    
}

private static async Task<IResult> GetTest(int id, 
ILogger<LoggerTestClass> logger, ILoggerTestClass testClass)
{
    try
    {
        try
        {
            //This works
            logger.LogInformation("Starting test now");  

            //This does NOT work
            Log.Information("Using Log. directly"); 

            
            testClass.Test();  //Call to class library method

            logger.LogInformation("Test finished");  //Also works
            return Results.Ok("OK");
        }
        catch (Exception ex)
        {
            return Results.Problem(ex.Message);
        }
    }
    catch (Exception ex)
    {
        return Results.Problem(ex.Message);
    }
 }
}

最后，这是我的类库中包含测试方法的类:

    namespace TestingLib.Testing;
public class LoggerTestClass : ILoggerTestClass
{

    private Microsoft.Extensions.Logging.ILogger _logger;

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

    public void Test()
    {
        try
        {

           //Does not work
           Log.Information("Test logging from class library using Log.");

           //Does not work
           Log.Logger.Information("In Test Class in DLL. Trying loging with [Log.Logger.Information]");

           //This works
           _logger.LogInformation("In Test Class in DLL. Trying loging with [_logger.LogInformation]");
        }
        catch (Exception ex)
        {
            Log.Error("An error in class library");
        }
    }

}

Answer 1

我发现问题是我的API程序中缺少一行代码.cs文件。我需要添加：“Log.Logger = logger;”在设置SeriLog记录器之后。

工作解决方案的代码如下。

在我的. NET6 APIProgram.cs文件中，我有这个：

var builder = WebApplication.CreateBuilder(args);

//Configure SeriLog
builder.Logging.ClearProviders();
var appSettings = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json")
    .Build();

var logDB = builder.Configuration.GetSection("ConnectionStrings:Default").Value;
var sinkOpts = new MSSqlServerSinkOptions { TableName = "Logs" };
var columnOptions = new ColumnOptions
{
    AdditionalColumns = new Collection<SqlColumn>
    {
        new SqlColumn("UserID", SqlDbType.Int),
        new SqlColumn("RunTag", SqlDbType.NVarChar),
        new SqlColumn("CustomType", SqlDbType.NVarChar)
    }
};

var logger = new LoggerConfiguration()
    .MinimumLevel.Override("Microsoft", Serilog.Events.LogEventLevel.Information)
    .WriteTo.MSSqlServer(
        connectionString: logDB,
        sinkOptions: sinkOpts,
        columnOptions: columnOptions,
        appConfiguration: appSettings
    ).CreateLogger();

builder.Logging.AddSerilog(logger);

//NOTE that this is not needed
//builder.Services.AddScoped<TestingLib.Testing.ILoggerTestClass, TestingLib.Testing.LoggerTestClass>();

然后在这个文件的下部，我有这个：

Log.Logger = logger; //This was the line I was missing!

var app = builder.Build();

我调用类库的API Get方法现在看起来像这样（如果与问题中的原始方法相比，您将看到不再需要传递ILogger）：

private static async Task<IResult> GetTest(int id)
    {
        try
        {
            try
            {
                string runTag = "In API GetTest(id)";
                string custom = "Calling from API method";                
                Log.Information("{Message}-{RunTag}-{CustomType}", "Message logging in API method", runTag, custom);
                
                //Call to Class Library Method - no need to pass ILogger
                LoggerTestClass testClass = new LoggerTestClass();
                testClass.Test();
               
                return Results.Ok("OK");
            }
            catch (Exception ex)
            {
                return Results.Problem(ex.Message);
            }
        }
        catch (Exception ex)
        {
            return Results.Problem(ex.Message);
        }
    }

最后，这是我的类库中的完整测试类。类库包含对 SeriLog 的引用：

using Serilog;

namespace TestingLib.Testing;
public class LoggerTestClass //: ILoggerTestClass
{

    public LoggerTestClass()
    {
        //No need to pass in ILogger to class
    }

    public void Test()
    {
        try
        {
            string runTag = "In Class Library Method)";
            string custom = "Calling class library method Test()";
            Log.Information("{Message}-{RunTag}-{CustomType}", "Message logging in Class Library", runTag, custom);            
        }
        catch (Exception ex)
        {
            Log.Error("An error in class library");
        }
    }

}

我发现这非常适合我的项目。从类库登录直接进入我的SQL数据库，带有自定义列等。