CA1051:不要宣告可見的執行個體欄位

發行項
09/06/2023

屬性	值
規則識別碼	CA1051
標題	不要宣告可見的執行個體欄位
類別	設計
修正程式是中斷或非中斷	中斷
預設在 .NET 8 中啟用	No

原因

類型具有非私用實例欄位。

根據預設，此規則只會查看外部可見的類型，但這是可設定的。

檔案描述

欄位的主要用法應該是當做實作詳細資料。欄位應為 private 或 internal ，而且應該使用屬性來公開。存取屬性就像存取欄位一樣容易，而且屬性存取子中的程式碼可以隨著類型擴充的功能而變更，而不會引入重大變更。

只傳回私用或內部欄位值的屬性會經過優化，以在存取欄位時執行;使用外部可見欄位而非屬性的效能提升是最小的。 外部可見 是指 public 、 protected 、和 protected internal （ Public 、 Protected 和 Protected Friend 在 Visual Basic 中）協助工具層級。

此外，公用欄位無法受到連結要求的保護。（連結需求不適用於 .NET Core 應用程式。

如何修正違規

若要修正此規則的違規行為，請建立欄位 private ，或使用 internal 外部可見的屬性加以公開。

隱藏警告的時機

只有在您確定取用者需要直接存取欄位時，才隱藏此警告。對大部分的應用程式而言，公開的欄位不會提供效能或可維護性的優點，而不是屬性。

在下列情況下，取用者可能需要欄位存取：

在 ASP.NET Web Form內容控制項中。
當目標平臺用來 ref 修改欄位時，例如 WPF 和 UWP 的 model-view-viewmodel （MVVM）架構。

隱藏警告

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

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

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

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

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

包含或排除 API

使用下列選項來設定程式碼基底要執行此規則的部分。

包含特定 API 介面
排除結構

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則（設計）設定這些選項。如需詳細資訊，請參閱程式碼品質規則組態選項。

包含特定 API 介面

您可以根據程式碼基底的存取範圍，設定要執行此規則的部分。例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal

排除結構

您可以在 Visual Basic 中排除 struct （ Structure 在 Visual Basic 中）欄位無法進行分析。

dotnet_code_quality.ca1051.exclude_structs = true

範例

下列範例顯示違反此規則的類型（ BadPublicInstanceFields ）。 GoodPublicInstanceFields 顯示更正的程式碼。

public class BadPublicInstanceFields
{
    // Violates rule DoNotDeclareVisibleInstanceFields.
    public int instanceData = 32;
}

public class GoodPublicInstanceFields
{
    private int instanceData = 32;

    public int InstanceData
    {
        get { return instanceData; }
        set { instanceData = value; }
    }
}

另請參閱

連結要求