單元測試

跨平臺應用程式應該經過測試,因為它們會在真實世界中用來改善其品質、可靠性和效能。 許多類型的測試皆應在應用程式上執行,包括單元測試、整合測試和使用者介面測試。 單元測試是最常見的形式,對於建置高品質的應用程序至關重要。

單元測試會採用應用程式的小型單元,通常是方法,將它與程式代碼的其餘部分隔離,並確認其行為如預期般。 其目標是檢查每個功能單位是否正常執行,使錯誤不至於傳播到整個應用程式。 在發生地點偵測 Bug 比在次要故障點間接觀察 Bug 的效果更有效率。

單元測試通常應該使用arrange-act-assert模式:

Step Description
Arrange 初始化 物件,並設定傳遞給受測方法的數據值。
Act 使用必要的自變數叫用受測方法。
Assert 確認受測方法的動作如預期般運作。

此模式可確保單元測試是可讀取、自我描述和一致的。

當單元測試是軟體開發工作流程不可或缺的一部分時,單元測試對程式代碼質量的影響最大。 單元測試可作為應用程式的設計檔和功能規格。 一旦方法撰寫完畢,就應該撰寫單元測試,以驗證回應標準、界限和不正確輸入資料案例的方法行為,並檢查程式碼所做的任何明確或隱含假設。 或者,在測試驅動開發中,也可以在程式碼之前撰寫單元測試。

Important

單元測試對防止回歸非常有效。 也就是說,功能在過去運作正常,但卻因錯誤更新而受到干擾。

xUnit 是 .NET MAUI 應用程式的建議測試架構。

將 xUnit 測試新增至 .NET MAUI 解決方案

若要將 xUnit 測試新增至 .NET MAUI 解決方案,請執行下列其中一項:

xUnit 測試項目的項目檔 (.csproj) 將類似下列範例:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net9.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>

    <IsPackable>false</IsPackable>
    <IsTestProject>true</IsTestProject>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="coverlet.collector" Version="6.0.2" />
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
    <PackageReference Include="xunit" Version="2.9.2" />
    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
  </ItemGroup>

  <ItemGroup>
    <Using Include="Xunit" />
  </ItemGroup>

</Project>

$(TargetFramework) build 屬性會指定測試專案的目標架構。 這會是計算機上安裝的最新版本 .NET。

套件 xunit 會引進包含測試架構本身的子套件,以及偵測單元測試常見問題的 Roslyn 分析器。 必須使用 xunit.runner.visualstudio 和 Microsoft.NET.Test.Sdk 套件來在 Visual Studio 中,及執行 dotnet test 命令時運行單元測試。 套件 coverlet.collector 允許收集程式代碼涵蓋範圍。 如果您不想要收集程式代碼涵蓋範圍,您可以移除此套件參考。 如需單元測試之程式代碼涵蓋範圍的詳細資訊,請參閱 使用程式碼涵蓋範圍進行單元測試。

建構應用程式以進行單元測試的主要方法有兩種:

  1. 您將進行單元測試的程式代碼位於 .NET MAUI 類別庫專案中。
  2. 您將進行單元測試的程式代碼位於 .NET MAUI 應用程式專案中。

每個方法都需要特定的設定。

設定用於單元測試的 .NET MAUI 類別庫專案

使用此方法時,您想要進行單元測試的程式代碼位於 .NET MAUI 類別庫專案中,而 .NET MAUI 應用程式專案會取用。 若要針對 .NET MAUI 類別庫撰寫單元測試,您必須更新專案所使用的目標架構。 這可以藉由將 xUnit 測試項目檔 ($(TargetFramework)) 的 build 屬性的值新增至 $(TargetFrameworks) .NET MAUI 類別庫專案檔中的組建屬性來達成:

<TargetFrameworks>net9.0;net9.0-android;net9.0-ios;net9.0-maccatalyst</TargetFrameworks>

在此範例中,已將值 net9.0 新增至 .NET MAUI 類別庫專案檔中的 $(TargetFrameworks) 建置屬性。

然後,您必須在 xUnit 測試專案中新增對 .NET MAUI 類別庫專案的參考。

設定用於單元測試的 .NET MAUI 應用程式專案

使用此方法時,您想要進行單元測試的程式代碼位於 .NET MAUI 應用程式專案中。 若要針對 .NET MAUI 應用程式專案撰寫單元測試,您必須更新專案所使用的目標架構。 這可以藉由將 xUnit 測試項目檔 ($(TargetFramework)) 的組建屬性的值新增至 $(TargetFrameworks) .NET MAUI 應用程式專案檔中的組建屬性來達成:

<TargetFrameworks>net9.0;net9.0-android;net9.0-ios;net9.0-maccatalyst</TargetFrameworks>

在此範例中,已將值 net9.0 新增至 $(TargetFrameworks) 的 .NET MAUI 應用程式專案檔中的組建屬性。

您也必須修改 .NET MAUI 應用程式專案,使其不會輸出 xUnit 測試專案所使用之目標架構的可執行檔。 將條件新增至 $(OutputType) .NET MAUI 應用程式項目檔中的組建屬性,即可達成此目的:

<OutputType Condition="'$(TargetFramework)' != 'net9.0'">Exe</OutputType>

在此範例中,.NET MAUI 應用程式專案只有在目標架構不是 net9.0時才會產生可執行檔。

然後,您必須在 xUnit 測試專案中新增對 .NET MAUI 應用程式專案的參考。

撰寫單元測試

xUnit 支援兩種不同類型的單元測試:

測試類型 Attribute Description
Facts Fact 始終為 true 的測試,用於檢驗不變的條件。
理論 Theory 僅適用於特定資料集的測試。

單元測試應該放在 xUnit 測試專案中,並以 [Fact] 或 [Theory] 屬性裝飾。 下列範例顯示使用 `[Fact]` 屬性的單元測試:

namespace MyUnitTests
{
    public class MyTests
    {
        [Fact]
        public void PassingTest()
        {
            Assert.AreEqual(4, 2+2);
        }

        [Fact]
        public void FailingTest()
        {
            Assert.AreEqual(5, 2+2);
        }
    }
}

在此範例中,測試代表故意通過和失敗的測試。

下列範例顯示使用 `[Theory]` 屬性的單元測試:

namespace MyUnitTests
{
    public class MyTests
    {
        [Theory]
        [InlineData(3)]
        [InlineData(4)]
        [InlineData(5)]
        public void MyTheoryTest(int value)
        {
            Assert.True(value % 2 == 1);
        }
    }
}

在此範例中,即使只有一個測試方法,實際上還是有三個測試,因為理論會針對每個數據項執行一次。

Tip

使用每個單元測試來測試一項操作。 測試的複雜度擴大,會使該測試的驗證更加困難。 藉由將單元測試限制為單一考慮,您可以確保測試可重複、隔離且運行時間較短。 如需詳細資訊,請參閱 單元測試最佳做法。

執行單元測試

單元測試可以在 Visual Studio 中的 [測試總管] 中執行,或使用 dotnet test 命令來執行。 如需測試總管的相關信息,請參閱 使用測試總管執行單元測試。 如需命令的相關信息dotnet test,請參閱使用 dotnet test 和 xUnit 和 dotnet test 在 .NET 中對 C# 進行單元測試。

使用裝置執行器執行單元測試

單元測試也可以透過裝置執行器在裝置上執行。 裝置執行器是一種測試執行器應用程式,提供視覺化的執行器殼與掛鉤,用於從 CLI 執行帶有 XHarness 的測試。 更多資訊請參閱 測試裝置執行者維基。

在平台應用程式中執行測試

.NET 11 包含 Microsoft。Android與Apple平台的Testing.Platform(MTP)測試專案範本:

Template 平台 測試流程
androidtest Android 連接裝置或模擬器上的應用程式程序
iostest iOS 連接裝置或模擬器上的應用程式程序
tvostest tvOS 連接裝置或模擬器上的應用程式程序
macostest macOS 桌面應用程式流程
maccatalysttest Mac Catalyst 桌面應用程式流程

每個範本都會建立一個 MSTest 專案,並在平台應用程式中執行。 平台測試工具會透過 MTP 向 dotnet test 回報結果。 欲了解更多關於MTP的資訊,請參閱Microsoft。Testing.Platform (MTP) 概述。

例如,請使用以下指令建立並執行 Android 測試專案:

dotnet new androidtest -n MyAndroidTests
dotnet test --project ./MyAndroidTests/MyAndroidTests.csproj

在執行測試指令前,先啟動 Android 模擬器或連接 Android 裝置。 這個指令會建置並安裝測試應用程式,然後在應用程式中用 Android 儀器執行測試。

平台測試專案與本文前述的 xUnit 專案不同。 一般的 xUnit 專案針對主機 .NET 執行環境,測試不需要平台應用程式程序的程式碼。 當測試必須使用 Android、iOS、tvOS、macOS 或 Mac 的 Catalyst API 與行為時,請使用平台測試專案。 欲了解更多關於 MTP 測試指令形式的資訊,請參閱 dotnet test Microsoft。測試平台。

另請參閱