Propriedades não devem ser somente para gravar

Artigo
08/25/2010

TypeName	PropertiesShouldNotBeWriteOnly
CheckId	CA1044
Category (Categoria)	Microsoft.Design
Quebrando alterar	Quebrando

Causa

A propriedade pública ou protegida tem um acessador conjunto, mas não tem um acessador get.

Descrição da regra

Obter acessadores fornecem acesso de leitura a uma propriedade e acessadores conjunto fornecerem acesso de gravar.Enquanto é aceitável e com freqüência necessário ter uma propriedade somente leitura, as diretrizes de design proíbem usando as propriedades somente gravar porque o que permite ao usuário conjunto um valor e, em seguida, impedindo que o usuário exibir o valor não fornece nenhuma segurança.Também, sem acesso de leitura, o estado de objetos compartilhados não pode ser visto, que limita sua utilidade.

Como corrigir violações

Para corrigir uma violação dessa regra, adicione um acessador get da propriedade.Como alternativa, se o comportamento de uma propriedade somente gravar for necessário, considere a possibilidade de converter essa propriedade para um método.

Quando suprimir avisos

É altamente recomendável que você eliminar um aviso da regra.

Exemplo

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

Imports System

Namespace DesignLibrary

   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

      Dim someName As String

      Property Name As String
         Get 
            Return someName
         End Get 

         Set 
            someName = Value
         End Set 
      End Property

   End Class

End Namespace

using System;

namespace DesignLibrary
{
   public class BadClassWithWriteOnlyProperty
   {
      string someName;

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

   public class GoodClassWithReadWriteProperty
   {
      string someName;

      public string Name 
      { 
         get 
         { 
            return someName; 
         } 
         set 
         { 
            someName = value; 
         } 
      }
   }
}

Partilhar via