CA1812:避免使用未執行個體化的內部類別
屬性 | 值 |
---|---|
規則識別碼 | CA1812 |
職稱 | 避免使用未執行個體化的內部類別 |
類別 | 效能 |
修正程式是中斷或非中斷 | 不中斷 |
預設在 .NET 9 中啟用 | No |
原因
永遠不會具現化內部 (元件層級) 類型。
檔案描述
此規則會嘗試找出對其中一個型別建構函式的呼叫,並在找不到呼叫時回報違規。
此規則不會檢查下列型態:
- 值類型
- 抽象類型
- 列舉
- 委派
- 編譯程式發出的數位類型
- 無法具現化且只定義
static
方法的類型。
如果您套用 System.Runtime.CompilerServices.InternalsVisibleToAttribute 至正在分析的元件,此規則不會將預設標示為 internal
(Friend
在 Visual Basic 中)的型別加上旗標,因為friend元件可能會使用欄位。 若要無論如何分析元件,請參閱 設定程式代碼以進行分析。
如何修正違規
若要修正此規則的違規,請移除類型,或新增使用該規則的程序代碼。 如果型別只 static
包含方法,請將 static
修飾詞新增至 類型,以防止編譯程式發出預設公用實例建構函式。
隱藏警告的時機
隱藏此規則的警告是安全的。 建議您在下列情況下隱藏此警告:
類別是透過晚期綁定的反映方法來建立,例如 System.Activator.CreateInstance。
類別會在相依性插入模式的反轉控件 (IoC) 容器中註冊。
類別是由運行時間或 ASP.NET 自動建立。 自動建立類別的一些範例是實 System.Configuration.IConfigurationSectionHandler 作 或 System.Web.IHttpHandler的類別。
類別會當做類別定義中的型別參數使用,而且具有
new
條件約束。 下列範例會以規則 CA1812 標示:internal class MyClass { public void DoSomething() { } } public class MyGeneric<T> where T : new() { public T Create() { return new T(); } } MyGeneric<MyClass> mc = new MyGeneric<MyClass>(); mc.Create();
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1812
// The code that's violating the rule is on this line.
#pragma warning restore CA1812
若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none
[*.{cs,vb}]
dotnet_diagnostic.CA1812.severity = none
如需詳細資訊,請參閱 如何隱藏程式代碼分析警告。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、它套用的所有規則,或針對套用至此類別的所有規則(效能)設定此選項。 如需詳細資訊,請參閱 程式代碼品質規則組態選項。
忽略 InternalsVisibleTo 屬性
根據預設,如果分析的元件使用 InternalsVisibleToAttribute 公開其內部符號,則會停用此規則。 若要指定規則應該執行,即使元件標示 InternalsVisibleToAttribute為 ,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true
此選項從 .NET 8 開始提供使用。