ABP框架日志系统深度解析：配置、实践与最佳实践

public class UserAppService : ApplicationService
{
    // 方式1：使用.NET官方ILogger
    private readonly ILogger<UserAppService> _logger;
    // 方式2：使用ABP扩展的IAbpLogger
    // private readonly IAbpLogger<UserAppService> _abpLogger;
 
    public UserAppService(ILogger<UserAppService> logger)
    {
        _logger = logger;
    }
 
    public async Task CreateUserAsync(CreateUserDto input)
    {
        // 记录信息级日志
        _logger.LogInformation("开始创建用户：{UserName}（租户ID：{TenantId}）", 
            input.UserName, CurrentTenant.Id);
 
        try
        {
            // 业务逻辑：创建用户...
            await _userManager.CreateAsync(new User(input.UserName));
        }
        catch (Exception ex)
        {
            // 记录错误级日志，包含异常信息
            _logger.LogError(ex, "创建用户失败：{UserName}", input.UserName);
            throw; // 重新抛出异常，确保上层能捕获处理
        }
 
        _logger.LogInformation("用户创建成功：{UserName}", input.UserName);
    }
}

public class UserManager : DomainService
{
    private readonly ILogger<UserManager> _logger;
 
    public UserManager(ILogger<UserManager> logger)
    {
        _logger = logger;
    }
 
    public async Task<User> CreateAsync(string userName)
    {
        _logger.LogDebug("领域服务：创建用户{UserName}", userName);
        // 领域逻辑...
        return new User(userName);
    }
}

[DependsOn(typeof(AbpIdentityModule))]
public class MyApplicationModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        Logger.LogDebug("配置MyApplicationModule服务...");
        // 服务配置逻辑...
    }
 
    public override void PostConfigureServices(ServiceConfigurationContext context)
    {
        Logger.LogInformation("MyApplicationModule服务配置完成");
    }
}

[ApiController]
[Route("api/users")]
public class UserController : ControllerBase
{
    private readonly ILogger<UserController> _logger;
    private readonly IUserAppService _userAppService;
 
    public UserController(ILogger<UserController> logger, IUserAppService userAppService)
    {
        _logger = logger;
        _userAppService = userAppService;
    }
 
    [HttpPost]
    public async Task<IActionResult> CreateUser(CreateUserDto input)
    {
        _logger.LogInformation("收到创建用户请求：{UserName}", input.UserName);
        var result = await _userAppService.CreateUserAsync(input);
        return Ok(result);
    }
}

_logger.LogTrace("Trace级日志");
_logger.LogDebug("Debug级日志");
_logger.LogInformation("Information级日志");
_logger.LogWarning("Warning级日志");
_logger.LogError(ex, "Error级日志，包含异常");
_logger.LogCritical("Critical级日志");

{
  "Logging": {
    "LogLevel": {
      "Default": "Information", // 全局默认级别
      "Microsoft": "Warning",   // 第三方库日志级别
      "Volo.Abp.Identity": "Debug", // 特定ABP模块的日志级别
      "MyCompany.MyProject": "Debug" // 自定义模块的日志级别
    },
    // 多租户环境下按租户配置（可选）
    "TenantLogLevels": {
      "2": { // 租户ID为2时
        "MyCompany.MyProject": "Error"
      }
    }
  }
}

Install-Package Serilog.AspNetCore
Install-Package Serilog.Sinks.Console
Install-Package Serilog.Sinks.File
Install-Package Serilog.Sinks.Seq // 可选：集成Seq日志分析平台

public class Program
{
    public static async Task<int> Main(string[] args)
    {
        // 配置Serilog
        Log.Logger = new LoggerConfiguration()
            .Enrich.FromLogContext() // 启用日志上下文
            .Enrich.WithProperty("Application", "MyABPProject") // 全局添加应用标识
            .WriteTo.Console(
                outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {TenantId} {SourceContext} {Message:lj}{NewLine}{Exception}"
            )
            .WriteTo.File(
                path: "logs/log-.txt",
                rollingInterval: RollingInterval.Day, // 按天滚动生成日志文件
                outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {TenantId} {SourceContext} {Message:lj}{NewLine}{Exception}"
            )
            .WriteTo.Seq("http://localhost:5341") // 可选：发送日志到Seq
            .CreateLogger();
 
        try
        {
            var builder = WebApplication.CreateBuilder(args);
            builder.Host.UseSerilog(); // 替换.NET默认日志系统
 
            await builder.AddApplicationAsync<MyApplicationModule>();
 
            var app = builder.Build();
            await app.InitializeApplicationAsync();
 
            await app.RunAsync();
            return 0;
        }
        catch (Exception ex)
        {
            Log.Fatal(ex, "应用程序启动失败");
            return 1;
        }
        finally
        {
            await Log.CloseAndFlushAsync();
        }
    }
}

{
  "Timestamp": "2024-05-20T10:30:00.000Z",
  "Level": "Information",
  "TenantId": 1,
  "SourceContext": "MyCompany.MyProject.UserAppService",
  "Message": "用户创建成功：Alice"
}

// 自定义日志分类
private readonly ILogger _customLogger;
 
public UserAppService(ILoggerFactory loggerFactory)
{
    _customLogger = loggerFactory.CreateLogger("MyCompany.MyProject.UserManagement");
}

public async Task CreateUserAsync(CreateUserDto input)
{
    var requestId = Guid.NewGuid().ToString();
    // 推送自定义属性到日志上下文
    using (AbpLoggingHelper.PushProperty("RequestId", requestId))
    {
        _logger.LogInformation("开始处理请求：{RequestId}", requestId);
        // 业务逻辑...
    }
}