使用 xUnit 快速編寫 .NET 應用單元測試
在當今快速迭代的軟件開發環境中,單元測試已成為保障代碼質量和項目可靠性的重要基石,通過驗證程序最小單元(如函數、方法、類等)的獨立行為,能夠在開發階段快速發現邏輯錯誤或邊界條件問題。今天大姚將帶領大家使用 xUnit 快速編寫 .NET 應用單元測試。
項目介紹
xUnit 是一個開源、免費、以社區為中心的 .NET 單元測試框架,是用于 C# 和 F#(其他 .NET 語言可能也能運行,但未提供官方支持)進行單元測試的最新技術。xUnit 能夠與 Visual Studio、Visual Studio Code、ReSharper、CodeRush 和 TestDriven.NET 兼容。它是.NET 基金會的一部分,并遵循其行為準則。
單元測試優秀做法
微軟官方出品的 .NET 單元測試最佳做法:https://learn.microsoft.com/zh-cn/dotnet/core/testing/unit-testing-best-practices
(1) 避免基礎結構依賴項。
(2) 以最精簡方式編寫通過測試。
(3) 避免使用魔法字符串。
(4) 避免在單元測試中編寫代碼邏輯。
(5) 遵循測試命名標準:
- 要測試的方法的名稱。
- 測試方法的情境。
- 調用方案時的預期行為。
命名標準非常重要,因為它們有助于表達測試目的和應用程序。測試不僅僅是確保代碼正常工作。它們還提供文檔。只需查看單元測試套件,即可推斷代碼的行為,不必查看代碼本身。此外,測試失敗時,可以確切地看到哪些方案不符合預期。
單元測試基本步驟
我們在編寫單元測試的時候通常遵循 3A 模式(Arrange-Act-Assert),這是單元測試的核心方法論:
- Arrange(準備階段): 該階段用于模擬數據、初始化對象等準備工作。
- Act(執行階段): 該階段用于準備好的數據調用要測試的最小單元方法。
- Assert(斷言階段): 該階段是單元測試中的驗證環節,它通過將目標方法返回的實際結果與預期結果進行比對,來判定測試是否通過。
創建單元測試項目
因為 xUnit 框架與 Visual Studio 是兼容的,我們可以直接在 Visual Studio 中搜索:xUnit 測試項目 模板,然后創建一個名為:xUnitExercise 的 .NET 9 單元測試項目。
編寫簡單的單元測試
public class UnitTest
{
/// <summary>
/// 測試 Calculator 的 Add 方法功能
/// 驗證兩個正數相加返回正確的和
/// </summary>
[Fact]// 標識這是一個獨立的測試用例
public void Add_TwoPositiveNumbers_ReturnsCorrectSum()
{
// ===== Arrange(準備階段) =====
var calculator = new Calculator();
int num1 = 5;
int num2 = 7;
int expected = 12;
// ===== Act(執行階段) =====
int actual = calculator.Add(num1, num2);
// ===== Assert(斷言階段) =====
Assert.Equal(expected, actual);
}
/// <summary>
/// 測試 Calculator 的 Divide 方法異常處理
/// 驗證除數為零時正確拋出 DivideByZeroException 異常
/// </summary>
[Fact]
public void Divide_ByZero_ThrowsDivideByZeroException()
{
// Arrange
var calculator = new Calculator();
int dividend = 10;
int divisor = 0; //觸發異常的除數
// Act & Assert
// 驗證執行除法時是否拋出特定異常
var exception = Assert.Throws<DivideByZeroException>(
() => calculator.Divide(dividend, divisor));
// 驗證異常消息是否符合預期
Assert.Equal("除數不能為零", exception.Message);
}
/// <summary>
/// 參數化測試 Calculator 的 IsEven 方法功能
/// 驗證不同輸入數值的奇偶判斷是否正確
/// </summary>
/// <param name="number">測試輸入值</param>
/// <param name="expected">預期結果(true=偶數,false=奇數)</param>
[Theory] // 標識這是一個參數化測試
[InlineData(4, true)] // 測試數據1:偶數4,預期true
[InlineData(7, false)] // 測試數據2:奇數7,預期false
[InlineData(8, false)] // 測試數據3:偶數8,預期false 【這里是特意為了查看預期結果不一致的情況】
public void IsEven_Number_ReturnsCorrectResult(int number, bool expected)
{
// Arrange
var calculator = new Calculator();
// Act
bool actual = calculator.IsEven(number);
// Assert
Assert.Equal(expected, actual);
}
public class Calculator
{
public int Add(int a, int b)
{
return a + b;
}
public bool IsEven(int number)
{
return number % 2 == 0;
}
public double Divide(int dividend, int divisor)
{
if (divisor == 0)
throw new DivideByZeroException("除數不能為零");
return (double)dividend / divisor;
}
}
}
運行單元測試
選擇項目右鍵 => 運行測試:
或者直接在對應的方法正上方選擇 Run:
調試單元測試
選擇項目右鍵 => 運行調試:
或者直接在對應的方法正上方選擇 Debug:
項目源碼地址
更多項目實用功能和特性歡迎前往項目開源地址查看??,別忘了給項目一個Star支持??。
- GitHub開源地址:https://github.com/xunit/xunit
- 本文示例源碼地址:https://github.com/YSGStudyHards/DotNetExercises/tree/master/xUnitExercise