CA1044:屬性不應該為唯寫的

文章
11/14/2023

屬性	值
規則識別碼	CA1044
標題	屬性不應該為唯寫的
類別	設計
修正程式是中斷或非中斷	中斷
預設在 .NET 8 中啟用	No

原因

屬性具有 set 存取子，但沒有 get 存取子。

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

檔案描述

取得存取子提供屬性的讀取許可權，而 set 存取子則提供寫入存取權。雖然它是可接受並經常需要具有唯讀屬性，設計方針會禁止使用唯寫屬性的屬性。這是因為讓用戶設定值，然後防止用戶檢視該值不提供任何安全性。同時，如果沒有讀取權限，則無法檢視共用物件的狀態，進而限制這些物件的使用性。

如何修正違規

若要修正此規則的違規，請將 get 存取子新增至屬性。或者，如果需要寫入屬性的行為，請考慮將此屬性轉換成方法。

隱藏警告的時機

建議您不要隱藏此規則的警告。

設定程式代碼以分析

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

包含特定 API 介面

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

範例

在下列範例中， BadClassWithWriteOnlyProperty 是具有唯寫屬性的類型。 GoodClassWithReadWriteProperty 包含更正的程式碼。

Imports System

Namespace ca1044

    Public Class BadClassWithWriteOnlyProperty

        Dim someName As String

        ' Violates rule PropertiesShouldNotBeWriteOnly.
        WriteOnly Property Name As String
            Set
                someName = Value
            End Set
        End Property

    End Class

    Public Class GoodClassWithReadWriteProperty

        Property Name As String

    End Class

End Namespace

public class BadClassWithWriteOnlyProperty
{
    string? _someName;

    // Violates rule PropertiesShouldNotBeWriteOnly.
    public string? Name
    {
        set
        {
            _someName = value;
        }
    }
}

public class GoodClassWithReadWriteProperty
{
    public string? Name { get; set; }
}

分享方式：