Mock 单元测试详细

介绍

在单元测试中，Mock 是一种模拟依赖对象行为的技术，主要用于隔离待测试对象（SUT: System Under Test）与其依赖项（通常是接口、类或外部系统）。这样，我们可以专注于测试目标代码的逻辑，而不需要考虑其依赖项的实现细节或副作用。

为什么使用 Mock？

隔离测试：使测试代码仅专注于目标逻辑，而不受外部依赖的影响。
提高效率：无需初始化真实的依赖对象（如数据库、API 服务等）。
简化外部依赖的复杂性：通过 Mock 模拟复杂对象的行为（如返回固定的结果）。
控制边界条件：方便模拟异常或边界情况（如抛出异常、返回空值等）。

Mock 的常见功能

1. 模拟依赖行为

使用 Mock 对象代替实际实现，通过设置返回值或行为控制测试流程。

2. 验证依赖调用

检查目标代码是否以正确的参数调用了依赖方法。

3. 模拟异常

模拟依赖项抛出异常，测试目标代码是否能正确处理异常。

使用场景

服务依赖：模拟服务的返回值（如模拟 HTTP 请求）。
数据库操作：模拟数据库查询和存储。
外部系统交互：如支付网关、消息队列等。
定时任务或异步任务：模拟特定时间点或异步回调的行为。

C# 中常用的 Mock 框架

- 优势：语法简洁，功能强大，社区支持广泛。
- 适用场景：模拟接口和抽象类。

NSubstitute

- 优势：语法接近自然语言，更易读。
- 适用场景：接口和虚方法的 Mock。

FakeItEasy

- 优势：非常易用，适合初学者。
- 适用场景：快速构造简单 Mock。

Rhino Mocks

- 优势：历史悠久，功能全面。
- 缺点：语法略显复杂，社区活跃度较低。

Mock 的实现步骤

1. 定义依赖项接口

在单元测试中，为了方便 Mock，我们通常为目标对象的依赖项定义接口。

csharp复制代码
public interface IInventoryService
{bool IsInStock(string productId);
}

2. 注入依赖项

通过依赖注入（Dependency Injection, DI）的方式，将依赖项传递给目标对象。

csharp复制代码
public class OrderService
{private readonly IInventoryService _inventoryService;public OrderService(IInventoryService inventoryService){_inventoryService = inventoryService;}public bool PlaceOrder(string productId){if (_inventoryService.IsInStock(productId)){// 处理订单逻辑...return true;}return false;}
}

3. 创建 Mock 对象并设置行为

使用 Moq 示例

csharp复制代码
using Moq;
using Xunit;public class OrderServiceTests
{[Fact]public void PlaceOrder_ProductInStock_ReturnsTrue(){// 创建 Mock 对象var inventoryServiceMock = new Mock<IInventoryService>();// 设置 Mock 行为：指定返回值inventoryServiceMock.Setup(s => s.IsInStock("Product123")).Returns(true);// 将 Mock 对象注入到目标对象中var orderService = new OrderService(inventoryServiceMock.Object);// 调用目标方法var result = orderService.PlaceOrder("Product123");// 验证结果Assert.True(result);// 验证依赖方法被正确调用inventoryServiceMock.Verify(s => s.IsInStock("Product123"), Times.Once);}
}

4. 验证依赖交互

Mock 框架支持验证目标代码与依赖项之间的交互是否符合预期。

Verify 方法：验证指定方法是否被调用、调用次数及参数。

csharp复制代码
inventoryServiceMock.Verify(s => s.IsInStock("Product123"), Times.Once);

验证调用未发生：

csharp复制代码
inventoryServiceMock.Verify(s => s.IsInStock(It.IsAny<string>()), Times.Never);

5. 模拟异常

模拟依赖方法抛出异常，测试目标代码是否能够正确处理。

csharp复制代码
[Fact]
public void PlaceOrder_ServiceThrowsException_ThrowsException()
{var inventoryServiceMock = new Mock<IInventoryService>();// 模拟依赖项抛出异常inventoryServiceMock.Setup(s => s.IsInStock(It.IsAny<string>())).Throws(new Exception("Service error"));var orderService = new OrderService(inventoryServiceMock.Object);// 测试目标代码是否能正确处理异常Assert.Throws<Exception>(() => orderService.PlaceOrder("Product123"));
}

Moq 的常用方法

方法	描述
`Setup`	定义依赖方法的返回值或行为。
`Returns`	指定返回值。
`Throws`	模拟方法抛出异常。
`Verify`	验证方法是否被调用，调用次数及参数。
`It.IsAny<T>()`	表示任意类型的参数。
`It.Is<T>(expr)`	指定参数匹配条件。
`Callback`	为 Mock 方法定义回调逻辑（如记录日志、修改状态）。
`Times`	指定方法调用次数（如 `Times.Once` , `Times.Never` 等）。