CA1051: No declarar campos de instancia visibles

  • Artículo
Propiedad Value
Identificador de la regla CA1051
Título No declarar campos de instancia visibles
Categoría Diseño
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Un tipo tiene un campo de instancia no privado.

De forma predeterminada, esta regla solo examina los tipos visibles externamente, pero es configurable.

Descripción de la regla

El uso principal de un campo debe ser como un detalle de implementación. Los campos deben ser private o internal, y deben exponerse mediante el uso de propiedades. Es tan fácil acceder a una propiedad como a un campo, y el código de los descriptores de acceso de una propiedad puede cambiar a medida que las características del tipo se expanden sin introducir cambios importantes.

Las propiedades que solo devuelven el valor de un campo privado o interno están optimizadas para funcionar de manera similar al acceso a un campo. La mejora del rendimiento que supone usar campos visibles externamente en lugar de propiedades es mínima. Externamente visible hace referencia a los niveles de accesibilidad public, protected y protected internal (Public, Protected y Protected Friend en Visual Basic).

Además, los campos públicos no se pueden proteger mediante peticiones de vínculos. (Las peticiones de vínculos no se aplican a aplicaciones .NET Core).

Cómo corregir infracciones

Para corregir una infracción de esta regla, haga que el campo sea private o internal y expóngalo mediante una propiedad externamente visible.

Cuándo suprimir las advertencias

Solo debe suprimir esta advertencia si está seguro de que los consumidores necesitan acceso directo al campo. Para la mayoría de las aplicaciones, los campos expuestos no aportan ventajas de rendimiento o de mantenimiento con respecto a las propiedades.

Es posible que los consumidores necesiten acceso al campo en las situaciones siguientes:

  • En controles de contenido de ASP.NET Web Forms.
  • Cuando la plataforma de destino usa ref para modificar campos, como los marcos de Modelo-Vista-Modelo de vista (MVVM) para WPF y UWP.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Inclusión o exclusión de API

Use las opciones siguientes para configurar en qué partes del código base ejecutar esta regla.

Puede configurar estas opciones solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Diseño) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Excluir structs

Puede excluir del análisis los campos struct (Structure en Visual Basic).

dotnet_code_quality.ca1051.exclude_structs = true

Ejemplo

En el ejemplo siguiente se muestra un tipo (BadPublicInstanceFields) que infringe la regla. GoodPublicInstanceFields muestra el código corregido.

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

Consulte también