dotnet-testing-private-internal-testing

name

dotnet-testing-private-internal-testing

description

Private 與 Internal 成員測試策略指南。當需要測試私有或內部成員、設定 InternalsVisibleTo 或評估可測試性設計時使用。涵蓋設計優先思維、反射測試、策略模式重構、AbstractLogger 模式與決策框架。 Make sure to use this skill whenever the user mentions private method testing, internal testing, InternalsVisibleTo, reflection testing, or testability design, even if they don't explicitly ask for testing strategy guidance. Keywords: private method testing, internal testing, InternalsVisibleTo, 私有方法測試, 內部成員測試, 反射測試, reflection testing, GetMethod BindingFlags, Meziantou.MSBuild.InternalsVisibleTo, 可測試性設計, 策略模式重構, testability

私有與內部成員測試策略指南

本技能協助您在 .NET 測試中正確處理私有與內部成員的測試，強調設計優先的測試思維。

回覆策略

回覆時必須完整涵蓋以下三種路徑，讓使用者根據實際情境選擇最適合的方式：

1. 設計優先（重構） — 將複雜的私有邏輯提取為獨立類別或策略模式，使其透過公開 API 可測試
2. InternalsVisibleTo 設定 — 將 private 改為 internal，搭配 InternalsVisibleTo 開放給測試專案存取
3. 反射測試（過渡方案） — 用反射直接測試私有方法，適合短期內難以重構的遺留系統

不要只推薦其中一種而忽略其他。即使首推重構，也必須說明 InternalsVisibleTo 和反射的做法與適用時機。

核心原則：設計優先思維

黃金法則

好的設計自然就有好的可測試性。如果你發現自己經常需要測試私有方法，很可能是設計出了問題。 但在實務上，並非所有情境都能立即重構，因此也需要了解 InternalsVisibleTo 和反射測試等替代方案。

設計問題的徵兆

• 私有方法超過 10 行且包含複雜邏輯
• 私有方法包含重要的業務規則
• 私有方法難以透過公開方法間接測試
• 類別承擔多個職責

解決方案：重構而非測試

將複雜私有邏輯提取為獨立類別（責任分離），或使用策略模式將計算邏輯注入為可測試的公開介面。包含 OrderProcessor 重構範例、PricingService 策略模式重構（重構前/後）、部分模擬範例。

完整重構範例與策略模式程式碼請參考 references/refactoring-patterns.md

Internal 成員測試策略

何時需要測試 Internal 成員

適合的情境： 框架或類別庫開發、複雜的內部演算法驗證、效能關鍵的內部組件、安全相關的內部邏輯

不適合的情境： 應用層的業務邏輯（應該是 public）、簡單的輔助方法、可以透過公開 API 間接測試的邏輯

方法一：使用 InternalsVisibleTo 屬性

// 在主專案中的 AssemblyInfo.cs 或任何類別檔案中
using System.Runtime.CompilerServices;

[assembly: InternalsVisibleTo("YourProject.Tests")]
[assembly: InternalsVisibleTo("YourProject.IntegrationTests")]

方法二：在 csproj 中設定

<!-- YourProject.csproj -->
<ItemGroup>
  <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
    <_Parameter1>$(AssemblyName).Tests</_Parameter1>
  </AssemblyAttribute>
</ItemGroup>

方法三：使用 Meziantou.MSBuild.InternalsVisibleTo（推薦）

<!-- YourProject.csproj -->
<ItemGroup>
  <PackageReference Include="Meziantou.MSBuild.InternalsVisibleTo" Version="1.0.2">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
</ItemGroup>

<ItemGroup>
  <InternalsVisibleTo Include="$(AssemblyName).Tests" />
  <InternalsVisibleTo Include="$(AssemblyName).IntegrationTests" />
  <InternalsVisibleTo Include="DynamicProxyGenAssembly2" Key="002400000480000094..." />
</ItemGroup>

參考資源：

• Declaring InternalsVisibleTo in the csproj - Meziantou's blog
• GitHub - meziantou/Meziantou.MSBuild.InternalsVisibleTo

Internal 測試的風險評估

評估面向	風險程度	說明
封裝性破壞	中等	增加了測試對內部實作的依賴
重構阻力	高	改變 internal 成員會影響測試
維護成本	中等	需要同步維護生產代碼和測試代碼
設計品質	低	如果過度使用，可能表示設計有問題

私有方法測試技術

涵蓋決策樹（是否應測試私有方法）、反射測試私有實例方法與靜態方法、ReflectionTestHelper 輔助類別封裝，以及反射測試的風險與最佳實踐。

完整程式碼範例與技術細節請參考 references/private-method-testing.md

實務決策框架

三層次風險評估法

1. 設計品質評估 — 這是設計問題還是測試問題？優先考慮重構（提取類別、策略模式）
2. 維護成本評估 — 測試是否會成為重構的阻礙？如果維護成本高，重新考慮測試策略
3. 價值產出評估 — 測試帶來的價值是否超過成本？如果價值不足，尋找替代測試策略

決策矩陣

情境	建議做法	理由
簡單私有方法（< 10 行）	透過公開方法測試	維護成本低
複雜私有邏輯（> 10 行）	重構為獨立類別	改善設計與可測試性
框架內部演算法	使用 InternalsVisibleTo	需要精確測試內部行為
遺留系統私有方法	考慮使用反射測試	短期內難以重構
安全相關私有邏輯	重構或使用反射測試	需要獨立驗證正確性
頻繁變動的實作細節	避免直接測試	測試會變得脆弱

最佳實踐

1. 設計優先 — 需要測試私有方法通常意味著類別承擔了過多責任。優先考慮重構（依賴注入、策略模式、責任分離），讓邏輯透過公開 API 自然可測。
2. 測試公開行為 — 專注測試公開 API 的行為，透過公開方法間接覆蓋私有邏輯。
3. 明智使用 InternalsVisibleTo — 僅用於框架或類別庫開發場景。使用 Meziantou.MSBuild.InternalsVisibleTo 簡化設定。
4. 謹慎使用反射 — 反射是最後手段，建立輔助方法封裝反射邏輯以降低維護成本。

常見誤區

1. 過度測試私有方法 — 為每個私有方法寫測試會讓測試套件變得脆弱。
2. 忽略設計問題 — 用測試技巧繞過封裝只是治標不治本。
3. 依賴實作細節 — 測試私有方法的呼叫順序會讓測試與實作緊密耦合。
4. 濫用 InternalsVisibleTo — 為應用層程式碼開放 internal 會破壞封裝邊界。

輸出格式

回覆必須包含以下三個區塊（依優先順序排列，但全部都要提及）：

1. 重構建議 — 說明如何透過設計改善讓邏輯可測試，附程式碼範例
2. InternalsVisibleTo 方案 — 說明三種設定方式，附設定範例
3. 反射測試方案 — 說明如何用反射測試私有方法（作為過渡方案），附程式碼範例

參考資源

原始文章

本技能內容提煉自「老派軟體工程師的測試修練 - 30 天挑戰」系列文章：

• Day 09 - 測試私有與內部成員：Private 與 Internal 的測試策略
  • 鐵人賽文章：https://ithelp.ithome.com.tw/articles/10374866
  • 範例程式碼：https://github.com/kevintsengtw/30Days_in_Testing_Samples/tree/main/day09

官方文件

• Meziantou's Blog - InternalsVisibleTo

相關技能

• unit-test-fundamentals - 單元測試基礎
• nsubstitute-mocking - 測試替身與模擬

測試清單

• 已評估是否應該重構而非測試私有方法
• Internal 成員確實需要開放給測試專案
• 使用適當的 InternalsVisibleTo 設定方法
• 反射測試已使用輔助方法封裝
• 測試名稱清楚標示測試類型
• 測試不會成為重構的阻礙
• 測試提供的價值超過維護成本