单元测试库启动宿主后控制器中Microsoft ILogger无输出问题
首先需要澄清的是,项目统一使用NLog/Serilog等框架做规范化配置,所有应用层代码仅使用*Microsoft.*命名空间下的日志接口。
以下是测试场景中使用的Site启动类示例,该类直接复用真实应用的主机构建逻辑,完全适配集成测试场景,可在NUnit的SetUp和TearDown方法中调用:
public sealed class Site { private IHost _host; public readonly string BaseAddress; public Site(string baseAddress) { BaseAddress = baseAddress; } public async Task StartAsync() { if (_host != null) throw new InvalidOperationException("Already started."); var cfgBuilder = new ConfigurationBuilder(); var args = string.Format("--urls {0}", BaseAddress); cfgBuilder.AddCommandLine(args.Split(' ', System.StringSplitOptions.RemoveEmptyEntries)); cfgBuilder.AddJsonFile("appsettings.json"); cfgBuilder.AddEnvironmentVariables(); using (var cts = new CancellationTokenSource()) { cts.CancelAfter(5000); Log.Logger = new LoggerConfiguration() .MinimumLevel.Debug() .WriteTo.Console() .CreateLogger(); _host = Performance.Program.CreateHostBuilder(cfgBuilder.Build()).UseSerilog(Log.Logger).Build(); await _host.StartAsync(cts.Token).ConfigureAwait(false); } } public async Task StopAsync() { if (_host == null) return; using (var cts = new CancellationTokenSource()) { cts.CancelAfter(5000); await _host.StopAsync(cts.Token).ConfigureAwait(false); } } }
项目使用的appsettings.json基本为默认配置:
{ "Logging": { "LogLevel": { "Default": "Information", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information" } }, "AllowedHosts": "*" }
遇到的问题
目前日志的异常表现为:Microsoft ILogger在IHostedService或Startup实例中可正常工作,但在所有控制器、中间件中完全停止输出:
public class ErrorController : ControllerBase { private readonly ILogger<ErrorController> _logger; public ErrorController(ILogger<ErrorController> logger) { _logger = logger; } [HttpGet] [Route("error")] public async Task<IActionResult> OnError() { _logger.LogError("This one won't ever show up in test library except if you stop using serilog/nlog/whatever."); return BadRequest(); } }
如果直接通过Program.cs正常启动应用,而非从TestExplorer运行,所有日志功能正常。相同配置下不同日志框架的问题复现情况如下:
| 日志框架 | NUnit下Startup日志 | NUnit下控制器日志 | 直接启动Startup日志 | 直接启动控制器日志 |
|---|---|---|---|---|
| NLog | 正常输出 | 无输出 | 正常输出 | 正常输出 |
| Serilog | 正常输出 | 无输出 | 正常输出 | 正常输出 |
| 微软原生日志提供程序 | 正常输出 | 正常输出 | 正常输出 | 正常输出 |
通过复现规律可以发现,微软原生日志提供程序在全场景下工作正常,且测试项目是Visual Studio生成的干净默认项目。已经尝试过清空所有日志提供程序、组合各类扩展方法等操作,仍未解决问题。
问题根因与修复方案
这个现象是集成测试场景下日志管道的初始化顺序错位导致的,和配置本身无关:
- Host启动早期的日志(Startup类初始化、IHostedService运行)是在日志管道完全初始化前输出的,不受后期加载的过滤规则影响,因此可以正常输出。
- 控制器、中间件的日志是在请求处理阶段产生的,此时Serilog/NLog的集成组件已经被框架的默认逻辑接管:默认的
UseSerilog(Log.Logger)重载会自动从宿主配置中读取Logging:LogLevel节点的规则,重建日志管道、替换你手动创建的静态Logger实例。由于测试场景下配置加载顺序和正式启动不一致,重建后的日志管道会错误拦截用户自定义类别的日志事件,导致请求阶段的日志完全丢失。 - 原生的微软日志提供程序是在Host构建初期就初始化完成的,不受后期管道重建逻辑的影响,因此全场景下都能正常工作。
具体修复操作
- 调整
UseSerilog的调用参数,关闭框架自动覆盖自定义Logger的逻辑,确保你手动创建的日志规则被保留:
其中_host = Performance.Program.CreateHostBuilder(cfgBuilder.Build()) .UseSerilog( logger: Log.Logger, preserveStaticLogger: true, writeToProviders: true) .Build();preserveStaticLogger: true会阻止框架读取配置重建日志管道,完全沿用你手动创建的Logger配置;writeToProviders: true会确保日志事件可以同步传递到其他已注册的日志提供程序,避免管道割裂。 - 确保测试项目中,主项目输出的
appsettings.json、NLog/Serilog配置文件的复制行为设置为“如果较新则复制”,避免测试场景下因为内容根目录不对,加载不到正确的配置文件。 - 如果使用NLog替代Serilog,需要将NLog提供程序的注册放到
ConfigureLogging阶段,不要在Host构建的最后一步追加,避免MVC管道替换日志实例时丢失NLog的注册逻辑:.ConfigureLogging(logging => { logging.ClearProviders(); logging.AddNLog("nlog.config"); })
内容的提问来源于stack exchange,提问作者eocron
相关产品推荐
相关产品推荐

