CA1810:必須將參考類型內部的靜態欄位初始化

  • 發行項
屬性 值
規則識別碼 CA1810
職稱 必須將參考類型內部的靜態欄位初始化
類別 效能
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 No

原因

參考型別會宣告明確的靜態建構函式。

檔案描述

當類型宣告明確的靜態建構函式時，Just-In-Time (JIT) 編譯器會將檢查加入至類型的每個靜態方法和執行個體建構函式，確保之前已呼叫該靜態建構函式。 當存取任何靜態成員或建立型別的實例時，就會觸發靜態初始化。 不過，如果您宣告型別的變數，但不要使用它，則不會觸發靜態初始化，如果初始化變更全域狀態，這可能很重要。

當所有靜態數據內嵌初始化，且未宣告明確的靜態建構函式時，通用中繼語言 （CIL） 編譯程式會將旗標和隱含靜態建構函式， beforefieldinit 以初始化靜態數據至 CIL 類型定義。 當 JIT 編譯程式遇到 beforefieldinit 旗標時，大部分時間都不會新增靜態建構函式檢查。 靜態初始化保證會在存取任何靜態字段之前發生，但在叫用靜態方法或實例建構函式之前不會發生。 請注意，在宣告型別的變數之後，隨時都可以進行靜態初始化。

靜態建構函式檢查會降低效能。 靜態建構函式通常只會用來初始化靜態欄位，在此情況下，您只能確定靜態初始化發生在靜態字段的第一次存取之前。 此 beforefieldinit 行為適用於這些和其他大部分類型。 只有在靜態初始化會影響全域狀態，且下列其中一項為 true 時，才不合適：

  • 全域狀態的影響很昂貴，而且若未使用類型，則不需要此效果。

  • 全域狀態效果可以存取，而不需要存取類型的任何靜態字段。

如何修正違規

若要修正此規則的違規情形，請在宣告所有靜態資料時將靜態資料初始化，並移除靜態建構函式。

隱藏警告的時機

如果適用下列其中一項，則隱藏此規則的警告是安全的：

  • 效能並不相關。
  • 靜態初始化所造成的全域狀態變更成本很高，或必須在呼叫型別的靜態方法或建立型別的實例之前發生。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

#pragma warning disable CA1810
// The code that's violating the rule is on this line.
#pragma warning restore CA1810

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

[*.{cs,vb}]
dotnet_diagnostic.CA1810.severity = none

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

範例

下列範例顯示 StaticConstructor違反規則的類型和類型 ， NoStaticConstructor以內嵌初始化取代靜態建構函式，以滿足規則。

public class StaticConstructor
{
    static int someInteger;
    static string? resourceString;

    static StaticConstructor()
    {
        someInteger = 3;
        ResourceManager stringManager =
           new ResourceManager("strings", Assembly.GetExecutingAssembly());
        resourceString = stringManager.GetString("string");
    }

    public void Print()
    {
        Console.WriteLine(someInteger);
    }
}

public class NoStaticConstructor
{
    static int someInteger = 3;
    static string? resourceString = InitializeResourceString();

    static string? InitializeResourceString()
    {
        ResourceManager stringManager =
           new ResourceManager("strings", Assembly.GetExecutingAssembly());
        return stringManager.GetString("string");
    }

    public void Print()
    {
        Console.WriteLine(someInteger);
    }
}

Imports System
Imports System.Resources

Namespace ca1810

    Public Class StaticConstructor

        Shared someInteger As Integer
        Shared resourceString As String

        Shared Sub New()

            someInteger = 3
            Dim stringManager As New ResourceManager("strings",
            System.Reflection.Assembly.GetExecutingAssembly())
            resourceString = stringManager.GetString("string")

        End Sub

    End Class


    Public Class NoStaticConstructor

        Shared someInteger As Integer = 3
        Shared resourceString As String = InitializeResourceString()

        Private Shared Function InitializeResourceString()

            Dim stringManager As New ResourceManager("strings",
            System.Reflection.Assembly.GetExecutingAssembly())
            Return stringManager.GetString("string")

        End Function

    End Class

End Namespace

請注意，在類別的 CIL 定義NoStaticConstructor上新增 beforefieldinit 旗標。

.class public auto ansi StaticConstructor
extends [mscorlib]System.Object
{
} // end of class StaticConstructor

.class public auto ansi beforefieldinit NoStaticConstructor
extends [mscorlib]System.Object
{
} // end of class NoStaticConstructor