CA1044: As propriedades não devem ser gravadas apenas

Artigo
09/06/2023

Property	valor
ID da regra	CA1044
Título	As propriedades não devem ser apenas gravadas
Categoria	Desenho
A correção está quebrando ou não quebrando	Quebrando
Habilitado por padrão no .NET 9	Não

Motivo

Uma propriedade tem um acessador definido, mas não um acessor get.

Por padrão, essa regra examina apenas tipos visíveis externamente, mas isso é configurável.

Descrição da regra

Obter acessadores fornecem acesso de leitura a uma propriedade e definir acessadores fornecem acesso de gravação. Embora seja aceitável e muitas vezes necessário ter uma propriedade somente leitura, as diretrizes de design proíbem o uso de propriedades somente gravação. Isso ocorre porque permitir que um usuário defina um valor e, em seguida, impedir que o usuário visualize o valor não fornece nenhuma segurança. Além disso, sem acesso de leitura, o estado dos objetos compartilhados não pode ser visualizado, o que limita sua utilidade.

Como corrigir violações

Para corrigir uma violação dessa regra, adicione um acessor get à propriedade. Como alternativa, se o comportamento de uma propriedade somente gravação for necessário, considere converter essa propriedade em um método.

Quando suprimir avisos

É recomendável que você não suprima avisos dessa regra.

Configurar código para análise

Use a opção a seguir para configurar em quais partes da sua base de código executar essa regra.

Incluir superfícies de API específicas

Você pode configurar essa opção apenas para esta regra, para todas as regras às quais ela se aplica ou para todas as regras nesta categoria (Design) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da regra de qualidade de código.

Incluir superfícies de API específicas

Você pode configurar em quais partes da sua base de código executar essa regra, com base em sua acessibilidade. Por exemplo, para especificar que a regra deve ser executada somente na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Exemplo

No exemplo a seguir, BadClassWithWriteOnlyProperty é um tipo com uma propriedade somente gravação. GoodClassWithReadWriteProperty contém o código corrigido.

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

Partilhar via