CA2235: marcar todos os campos não serializáveisCA2235: Mark all non-serializable fields

NomeDoTipoTypeName MarkAllNonSerializableFieldsMarkAllNonSerializableFields
CheckIdCheckId CA2235CA2235
CategoriaCategory Microsoft.UsageMicrosoft.Usage
Alteração SignificativaBreaking Change Não separávelNon Breaking

CausaCause

Um campo de instância de um tipo que não seja serializável é declarado em um tipo que é serializável.An instance field of a type that is not serializable is declared in a type that is serializable.

Descrição da regraRule description

Um tipo serializável é aquele que é marcado com o System.SerializableAttribute atributo.A serializable type is one that is marked with the System.SerializableAttribute attribute. Quando o tipo é serializado, um System.Runtime.Serialization.SerializationException exceção será gerada se um tipo contém um campo de instância de um tipo que não é serializável.When the type is serialized, a System.Runtime.Serialization.SerializationException exception is thrown if a type contains an instance field of a type that is not serializable.

Como corrigir violaçõesHow to fix violations

Para corrigir uma violação dessa regra, aplicar o System.NonSerializedAttribute de atributo para o campo que não é serializável.To fix a violation of this rule, apply the System.NonSerializedAttribute attribute to the field that is not serializable.

Quando suprimir avisosWhen to suppress warnings

Suprimir um aviso nessa regra somente se um System.Runtime.Serialization.ISerializationSurrogate tipo é declarado que permite que instâncias do campo a ser serializado e desserializado.Only suppress a warning from this rule if a System.Runtime.Serialization.ISerializationSurrogate type is declared that allows instances of the field to be serialized and deserialized.

ExemploExample

O exemplo a seguir mostra um tipo que viola a regra e um tipo que satisfaça a regra.The following example shows a type that violates the rule and a type that satisfies the rule.

using System;
using System.Runtime.Serialization;

namespace UsageLibrary
{
   public class Mouse
   {
      int buttons;
      string scanTypeValue;

      public int NumberOfButtons
      {
         get { return buttons; }
      }

      public string ScanType
      {
         get { return scanTypeValue; }
      }

      public Mouse(int numberOfButtons, string scanType)
      {
         buttons = numberOfButtons;
         scanTypeValue = scanType;
      }
   }

   [SerializableAttribute]
   public class InputDevices1
   {
      // Violates MarkAllNonSerializableFields.
      Mouse opticalMouse;

      public InputDevices1()
      {
         opticalMouse = new Mouse(5, "optical"); 
      }
   }

   [SerializableAttribute]
   public class InputDevices2
   {
      // Satisfies MarkAllNonSerializableFields.
      [NonSerializedAttribute]
      Mouse opticalMouse;

      public InputDevices2()
      {
         opticalMouse = new Mouse(5, "optical"); 
      }
   }
}
Imports System
Imports System.Runtime.Serialization

Namespace UsageLibrary

   Public Class Mouse
   
      Dim buttons As Integer
      Dim scanTypeValue As String

      ReadOnly Property NumberOfButtons As Integer
         Get
            Return buttons
         End Get
      End Property

      ReadOnly Property ScanType As String
         Get
            Return scanTypeValue
         End Get
      End Property

      Sub New(numberOfButtons As Integer, scanType As String)
         buttons = numberOfButtons
         scanTypeValue = scanType
      End Sub

   End Class

   <SerializableAttribute> _ 
   Public Class InputDevices1
   
      ' Violates MarkAllNonSerializableFields.
      Dim opticalMouse As Mouse 

      Sub New()
         opticalMouse = New Mouse(5, "optical") 
      End Sub

   End Class

   <SerializableAttribute> _ 
   Public Class InputDevices2
   
      ' Satisfies MarkAllNonSerializableFields.
      <NonSerializedAttribute> _ 
      Dim opticalMouse As Mouse 

      Sub New()
         opticalMouse = New Mouse(5, "optical") 
      End Sub

   End Class

End Namespace

CA2236: chamar métodos de classe base em tipos ISerializableCA2236: Call base class methods on ISerializable types

CA2240: implementar ISerializable corretamenteCA2240: Implement ISerializable correctly

CA2229: implementar construtores de serializaçãoCA2229: Implement serialization constructors

CA2238: implementar métodos de serialização corretamenteCA2238: Implement serialization methods correctly

CA2237: marcar tipos ISerializable com SerializableAttributeCA2237: Mark ISerializable types with SerializableAttribute

CA2239: fornecer métodos de desserialização para campos opcionaisCA2239: Provide deserialization methods for optional fields

CA2120: proteger construtores de serializaçãoCA2120: Secure serialization constructors