CA2238: Implementare correttamente i metodi di serializzazione

Articolo	Valore
ID regola	CA2238
Category	Microsoft.Usage
Modifica	Interruzione: se il metodo è visibile all'esterno dell'assembly. Non di rilievo: se il metodo non è visibile all'esterno dell'assembly.

Causa

Un metodo che gestisce un evento di serializzazione non dispone della visibilità, del tipo restituito o della firma corretta.

Descrizione regola

Un metodo è designato un gestore eventi di serializzazione applicando uno degli attributi dell'evento di serializzazione seguenti:

• System.Runtime.Serialization.OnSerializingAttribute

• System.Runtime.Serialization.OnSerializedAttribute

• System.Runtime.Serialization.OnDeserializingAttribute

• System.Runtime.Serialization.OnDeserializedAttribute

  I gestori eventi di serializzazione accettano un singolo parametro di tipo System.Runtime.Serialization.StreamingContext, restituiscono voide hanno private visibilità.

Come correggere le violazioni

Per correggere una violazione di questa regola, correggere la firma, il tipo restituito o la visibilità del gestore eventi di serializzazione.

Quando eliminare gli avvisi

Non escludere un avviso da questa regola.

Esempio

L'esempio seguente mostra i gestori eventi di serializzazione dichiarati correttamente.

C#

using System;
using System.Runtime.Serialization;

namespace UsageLibrary
{
   [SerializableAttribute]
   public class SerializationEventHandlers
   {
      [OnSerializingAttribute]
      void OnSerializing(StreamingContext context) {}

      [OnSerializedAttribute]
      void OnSerialized(StreamingContext context) {}

      [OnDeserializingAttribute]
      void OnDeserializing(StreamingContext context) {}

      [OnDeserializedAttribute]
      void OnDeserialized(StreamingContext context) {}
   }
}

VB

Imports System
Imports System.Runtime.Serialization

Namespace UsageLibrary

   <SerializableAttribute> _ 
   Public Class SerializationEventHandlers

      <OnSerializingAttribute> _ 
      Private Sub OnSerializing(context As StreamingContext) 
      End Sub

      <OnSerializedAttribute> _ 
      Private Sub OnSerialized(context As StreamingContext) 
      End Sub

      <OnDeserializingAttribute> _ 
      Private Sub OnDeserializing(context As StreamingContext)
      End Sub

      <OnDeserializedAttribute> _ 
      Private Sub OnDeserialized(context As StreamingContext)
      End Sub

   End Class

End Namespace

Regole correlate

CA2236: Chiamare metodi della classe base su tipi ISerializable

CA2240: Implementare ISerializable in modo corretto

CA2229: Implementare costruttori di serializzazione

CA2235: Contrassegnare tutti i campi non serializzabili

CA2237: Contrassegnare i tipi ISerializable con SerializableAttribute

CA2239: Specificare metodi di deserializzazione per i campi facoltativi

CA2120: Proteggere i costruttori di serializzazione