CA1044: 속성은 쓰기 전용이면 안 됩니다.

아티클
09/06/2023

속성	값
규칙 ID	CA1044
타이틀	속성은 쓰기 전용이면 안 됩니다.
범주	디자인
수정 사항이 주요 변경인지 여부	주요 변경
.NET 8에서 기본적으로 사용	아니요

원인

속성에 set 접근자는 있지만 get 접근자가 없습니다.

기본적으로 이 규칙은 외부에 표시되는 형식만 확인하지만 이는 구성 가능합니다.

규칙 설명

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; }
}