使用 ILogger 的 Moq 单元测试 - C#

在 C# 中，使用 ILogger 是一种很常见的日志记录方式。ILogger 接口来自于 Microsoft.Extensions.Logging 命名空间，这个命名空间为 .NET Core 应用程序提供了一个非常灵活和可扩展的日志记录系统。在这个指南中，我们会学习如何使用 Moq 单元测试框架来测试使用 ILogger 接口的代码。

关于 Moq

Moq 是用于 C# .NET 框架的一个流行的 Mocking 框架。它允许您模拟和测试对象，这些对象通常是在您的代码中由依赖项注入容器（DI 容器）提供的服务。 在本指南中，我们将使用一个简单的示例来演示如何使用 Moq 来测试使用 ILogger 的代码。

示例应用程序

我们要建立一个名为 "Calculator" 的简单的应用程序。这个应用程序将接受两个值作为参数进行计算。计算结果将被简单的发送到输出窗口。

using Microsoft.Extensions.Logging;
using System;

namespace CalculatorApp
{
    public class Calculator
    {
        private readonly ILogger<Calculator> _logger;

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

        public void Calculate(int a, int b)
        {
            _logger.LogInformation($"Calculating the sum of {a} and {b}");
            Console.WriteLine($"The sum of {a} and {b} is {a + b}");
        }
    }
}

在上面的代码片段中，我们定义了一个名为 Calculator 的类。在这个类的构造函数中，我们注入了一个 ILogger 对象作为参数。 然后，我们定义了一个名为 Calculate 的方法，它接受两个整数作为参数，并记录了日志并输出了结果。这是我们将要测试的代码。

编写测试用例

首先，我们需要安装 Moq 库。您可以使用以下 NuGet 命令来安装 Moq：

dotnet add package Moq

现在我们可以编写我们的测试用例。下面是一个简单的测试用例，使用 Moq 和 xUnit：

using Microsoft.Extensions.Logging;
using Moq;
using System;
using Xunit;

namespace CalculatorApp.Test
{
    public class CalculatorTest
    {
        [Fact]
        public void TestCalculate()
        {
            var loggerMock = new Mock<ILogger<Calculator>>();
            var logger = loggerMock.Object;

            var calculator = new Calculator(logger);
            calculator.Calculate(2, 3);

            loggerMock.Verify(
                m => m.Log(
                    It.IsAny<LogLevel>(),
                    It.IsAny<EventId>(),
                    It.Is<It.IsAnyType>((v, t) => true),
                    It.IsAny<Exception>(),
                    It.Is<Func<It.IsAnyType, Exception, string>>((v, t) => true)),
                Times.Once);
        }
    }
}

在上面的代码片段中，我们首先创建了一个名为 loggerMock 的 Mock 对象。在接下来的行中，我们调用了 loggerMock.Object，以获取 ILogger 对象的实例。这个实例是我们将传入 Calculator 类构造函数中的 logger 对象。

然后，我们创建一个名为 calculator 的 Calculator 对象。我们使用这个对象来调用 Calculate 方法。

最后，我们使用 Moq 框架提供的 Verify 方法来确认 ILogger 被调用了一次。如果在代码执行期间没有发生日志记录，则此测试用例将失败。

结论

使用 ILogger 接口进行日志记录是一种常见和灵活的方式，这使得在应用程序中编写测试和诊断代码变得轻松快捷。使用 Moq 进行单元测试可以帮助验证代码可以像预期的那样正确工作，并且在最终产品中表现良好，这是每个开发人员都必须做到的。