NLog自定义LayoutRenderer批量运行XUnit测试时输出空字符串问题

嘿，我仔细看了你的问题，这个批量运行XUnit测试时断言失败的情况，本质是XUnit并行测试+NLog全局配置共享导致的状态冲突，咱们一步步拆解问题并解决：

问题根源 #

1. XUnit默认并行执行：TestA和TestB的构造函数会同时修改NLog的全局LogManager.Configuration，两个测试类的配置逻辑互相干扰，导致目标的Layout被意外覆盖，或者日志事件分发错乱。
2. 全局LayoutRenderer注册+竞态：虽然LayoutRenderer.Register多次注册同名Renderer不会覆盖，但并行初始化时，NLog的布局解析器可能出现竞态，导致渲染时无法正确匹配到对应的Renderer，最终输出空字符串。
3. 日志对象共享全局状态：Loggable里用的是全局GetCurrentClassLogger，所有测试共享同一个Logger实例，日志会被分发到所有已注册的目标，进一步加剧了混乱。

解决方案：让测试完全隔离（推荐） #

我们需要让每个测试类拥有独立的NLog配置和Logger，避免全局状态污染，具体修改如下：

1. 重构Log类，使用独立配置

把原来依赖全局LogManager.Configuration的逻辑改成创建局部配置，确保每个测试的配置独立：

class Log
{
    private string _target_name;
    private readonly LoggingConfiguration _localConfig;
    private readonly Logger _localLogger;

    public Log(Layout layout, string target_name)
    {
        // 为每个测试创建独立的配置，不共享全局实例
        _localConfig = new LoggingConfiguration();
        // 每个测试生成独立的调试日志，方便排查
        InternalLogger.LogFile = Path.Combine(Environment.CurrentDirectory, $"nlog.{target_name}.debug.txt");
        InternalLogger.LogLevel = LogLevel.Trace;

        _target_name = target_name;

        // 初始化测试目标并绑定布局
        TestTarget target = new TestTarget(_target_name);
        Target.Register<TestTarget>(_target_name);
        target.Layout = layout;
        _localConfig.AddTarget(_target_name, target);
        _localConfig.AddRule(LogLevel.Trace, LogLevel.Fatal, target);

        // 创建基于本地配置的专属Logger
        _localLogger = LogManager.GetLogger(target_name, _localConfig);
    }

    // 对外提供专属Logger，供Loggable使用
    public Logger GetLocalLogger() => _localLogger;

    public void AssertLogContains(string message)
    {
        TestTarget target = _localConfig.FindTargetByName<TestTarget>(_target_name);
        target.Messages.Should().Contain(message);
    }
}

2. 修改Loggable，支持传入自定义Logger

让Loggable可以使用我们创建的局部Logger，而不是全局共享的实例：

class Loggable
{
    private Logger _logger;

    // 构造函数允许传入自定义Logger，保持默认兼容原有逻辑
    public Loggable(Logger logger = null)
    {
        _logger = logger ?? LogManager.GetCurrentClassLogger();
    }

    public void Error(string message)
    {
        _logger.Error(message);
    }

    public void Info(string message)
    {
        _logger.Info(message);
    }
}

3. 更新测试类，使用局部Logger

修改TestA和TestB，让Loggable使用当前测试的专属Logger：

public class TestA
{
    private Log _log;

    public TestA()
    {
        LayoutRenderer.Register<RendererOne>("renderer-one");
        _log = new Log("${renderer-one}", GetType().Name);
    }

    [Fact]
    public void SomeTest()
    {
        // 使用测试专属Logger
        Loggable l = new Loggable(_log.GetLocalLogger());
        l.Info("Test A - SomeTest");
        l.Error("Test A - SomeTest");
        _log.AssertLogContains("RendererOne - Info: Test A - SomeTest");
        _log.AssertLogContains("RendererOne - Error: Test A - SomeTest");
    }

    [Fact]
    public void AnotherTest()
    {
        Loggable l = new Loggable(_log.GetLocalLogger());
        l.Info("Test A - AnotherTest");
        l.Error("Test A - AnotherTest");
        _log.AssertLogContains("RendererOne - Info: Test A - AnotherTest");
        _log.AssertLogContains("RendererOne - Error: Test A - AnotherTest");
    }
}

TestB同理修改：

public class TestB
{
    private Log _log;

    public TestB()
    {
        LayoutRenderer.Register<RendererTwo>("renderer-two");
        _log = new Log("${renderer-two}", GetType().Name);
    }

    [Fact]
    public void SomeTest()
    {
        Loggable l = new Loggable(_log.GetLocalLogger());
        l.Info("Test B - SomeTest");
        l.Error("Test B - SomeTest");
        _log.AssertLogContains("RendererTwo - Info -> Test B - SomeTest");
        _log.AssertLogContains("RendererTwo - Error -> Test B - SomeTest");
    }
}

额外优化：避免重复注册LayoutRenderer

因为LayoutRenderer.Register是全局操作，我们可以在测试集初始化时只注册一次，减少冗余：

using Xunit;

// 定义测试集合，确保Fixture只初始化一次
[CollectionDefinition("LoggingTests")]
public class LoggingTestCollection : ICollectionFixture<LoggingFixture>
{
}

// 测试初始化Fixture，注册所有需要的Renderer
public class LoggingFixture
{
    public LoggingFixture()
    {
        LayoutRenderer.Register<RendererOne>("renderer-one");
        LayoutRenderer.Register<RendererTwo>("renderer-two");
    }
}

然后给测试类加上集合标记：

[Collection("LoggingTests")]
public class TestA { /* ... */ }

[Collection("LoggingTests")]
public class TestB { /* ... */ }

临时快速解决方案（禁用并行） #

如果暂时不想改代码，可以通过xunit.runner.json禁用XUnit并行测试：
在项目根目录创建该文件，内容如下：

{
  "parallelizeTestCollections": false,
  "parallelizeAssembly": false
}

不过这只是权宜之计，长期来看还是让测试隔离更可靠。

这样修改后，每个测试类都有独立的NLog配置和Logger，即使XUnit并行运行也不会互相干扰，LayoutRenderer的Append方法能正确处理对应的日志事件，断言就不会失败了。

内容的提问来源于stack exchange，提问作者Gros Lalo