在C#项目开发过程中，单元测试是验证代码逻辑正确性、减少线上问题的重要手段，xUnit是.NET生态中主流的单元测试框架之一，具有轻量、扩展性强、运行速度快的特点，很多开发者会选择它来完成项目的测试工作。
xUnit环境准备
首先需要在项目中安装xUnit相关的NuGet包，假设我们有一个待测试的C#类库项目，步骤如下：
- 在解决方案资源管理器中右键点击解决方案，选择添加新项目
- 选择xUnit测试项目模板，命名为
Demo_Test - 项目创建完成后，会自动引用xUnit的核心包，同时需要手动添加待测试项目的引用
安装完成后，项目的csproj文件会包含如下依赖配置：
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="xunit" Version="2.6.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.4" />
<ProjectReference Include="..DemoDemo.csproj" />
</ItemGroup>
</Project>
编写第一个xUnit测试用例
假设待测试的项目中有一个简单的计算器类，代码如下：
namespace Demo;
public class Calculator
{
// 加法计算
public int Add(int a, int b)
{
return a + b;
}
// 除法计算
public int Divide(int a, int b)
{
if (b == 0)
{
throw new ArgumentException("除数不能为0");
}
return a / b;
}
}
接下来在测试项目中编写对应的测试用例，xUnit的测试方法不需要添加额外的前缀，只需要标记[Fact]特性即可：
using Demo;
using Xunit;
namespace Demo_Test;
public class CalculatorTest
{
private readonly Calculator _calculator;
public CalculatorTest()
{
_calculator = new Calculator();
}
[Fact]
public void Add_ShouldReturnCorrectSum()
{
// 准备测试数据
int a = 3;
int b = 5;
// 执行测试方法
int result = _calculator.Add(a, b);
// 断言结果
Assert.Equal(8, result);
}
}
运行测试后，如果结果符合预期，测试会显示通过状态。
xUnit常用断言方法
断言是测试用例的核心部分，xUnit提供了丰富的断言方法，常用的包括：
Assert.Equal(expected, actual)：判断两个值是否相等Assert.NotEqual(notExpected, actual)：判断两个值是否不相等Assert.True(condition)：判断条件是否为真Assert.False(condition)：判断条件是否为假Assert.Throws<TException>(() => ...)：判断是否会抛出指定类型的异常Assert.Contains(expectedSubstring, actualString)：判断字符串是否包含指定子串
我们可以为计算器的除法方法编写测试用例，验证异常抛出场景：
[Fact]
public void Divide_WhenDivisorIsZero_ShouldThrowArgumentException()
{
// 准备测试数据
int a = 10;
int b = 0;
// 断言会抛出ArgumentException异常
var exception = Assert.Throws<ArgumentException>(() => _calculator.Divide(a, b));
// 验证异常消息是否符合预期
Assert.Equal("除数不能为0", exception.Message);
}
使用[Theory]实现参数化测试
如果需要对同一个测试方法传入多组不同的参数进行验证，可以使用[Theory]特性配合[InlineData]来完成参数化测试，避免重复编写类似的测试方法：
[Theory]
[InlineData(1, 2, 3)]
[InlineData(-1, 5, 4)]
[InlineData(0, 0, 0)]
[InlineData(100, 200, 300)]
public void Add_ParameterizedTest_ShouldReturnCorrectSum(int a, int b, int expected)
{
int result = _calculator.Add(a, b);
Assert.Equal(expected, result);
}
运行这个测试方法时，xUnit会自动对每一组[InlineData]的数据执行一次测试，只要有一组数据不符合预期，整个测试方法就会显示失败。
测试分组与跳过测试
可以通过[Trait]特性给测试用例添加分组标签，方便后续按分组运行测试：
[Fact]
[Trait("Category", "Basic")]
public void Add_BasicCategory_ShouldReturnCorrectSum()
{
int result = _calculator.Add(2, 3);
Assert.Equal(5, result);
}
如果某个测试用例暂时不需要运行，可以使用[Fact(Skip = "跳过原因")]来跳过该测试：
[Fact(Skip = "该功能尚未开发完成，暂时跳过测试")]
public void Multiply_ShouldReturnCorrectResult()
{
// 待实现的计算器乘法方法测试
}
完整实战案例：用户服务测试
假设我们有一个用户服务类，提供用户查询和密码验证的功能，代码如下：
namespace Demo;
public class User
{
public int Id { get; set; }
public string UserName { get; set; }
public string PasswordHash { get; set; }
}
public class UserService
{
private readonly List<User> _users;
public UserService()
{
// 模拟数据库中的用户数据
_users = new List<User>
{
new User { Id = 1, UserName = "admin", PasswordHash = "123456" },
new User { Id = 2, UserName = "test", PasswordHash = "abcdef" }
};
}
// 根据用户名查询用户
public User GetUserByUserName(string userName)
{
if (string.IsNullOrEmpty(userName))
{
throw new ArgumentException("用户名不能为空");
}
return _users.FirstOrDefault(u => u.UserName == userName);
}
// 验证用户密码
public bool ValidatePassword(string userName, string password)
{
var user = GetUserByUserName(userName);
if (user == null)
{
return false;
}
return user.PasswordHash == password;
}
}
对应的xUnit测试用例如下：
using Demo;
using Xunit;
namespace Demo_Test;
public class UserServiceTest
{
private readonly UserService _userService;
public UserServiceTest()
{
_userService = new UserService();
}
[Fact]
public void GetUserByUserName_ValidUserName_ShouldReturnCorrectUser()
{
var user = _userService.GetUserByUserName("admin");
Assert.NotNull(user);
Assert.Equal(1, user.Id);
Assert.Equal("admin", user.UserName);
}
[Fact]
public void GetUserByUserName_InvalidUserName_ShouldReturnNull()
{
var user = _userService.GetUserByUserName("nonexistent");
Assert.Null(user);
}
[Fact]
public void GetUserByUserName_EmptyUserName_ShouldThrowArgumentException()
{
Assert.Throws<ArgumentException>(() => _userService.GetUserByUserName(""));
}
[Theory]
[InlineData("admin", "123456", true)]
[InlineData("admin", "wrongpassword", false)]
[InlineData("test", "abcdef", true)]
[InlineData("nonexistent", "123456", false)]
public void ValidatePassword_ShouldReturnCorrectResult(string userName, string password, bool expected)
{
bool result = _userService.ValidatePassword(userName, password);
Assert.Equal(expected, result);
}
}
运行所有测试用例后，可以查看每个测试的执行结果，确保所有逻辑都符合预期，后续如果修改了用户服务的代码，只需要重新运行测试就可以快速验证是否引入了新的问题。