In questo post vorrei illustrarvi l’utilizzo degli attributi OnDeserializingAttribute e OnDeserializedAttribute contenuti nel namespace System.Runtime.Serialization.
Il loro scopo è quello di decorare dei metodi che verranno richiamati, rispettivamente, prima (OnDeserializing) e dopo (OnDeserialized) la deserializzazione di un oggetto tramite determinati serializzatori che vedremo più avanti.
Vediamo il loro possibile utilizzo in caso di deserializzazione JSON.
Supponiamo di avere il seguente JSON:
- {"nome":"Giuseppe","cognome":"Verdi"}
una possibile classe che permette la deserializzazione di tale JSON potrebbe essere:
- Imports System.Xml.Serialization
- Imports System.Runtime.Serialization
- <DataContract()>
- Public Class Persona
- Public Sub New()
- End Sub
- <DataMember(Name:="nome")>
- Public Property Nome As String
- <DataMember(Name:="cognome")>
- Public Property Cognome As String
- Private _DataCreazione As DateTime = DateTime.Now
- Public ReadOnly Property DataCreazione As DateTime
- Get
- Return Me._DataCreazione
- End Get
- End Property
- End Class
Ho inserito la proprietà che contiene la data di creazione dell’oggetto per dimostrare una cosa che vedremo tra poco.
Prendiamo il seguente metodo che deserializza il JSON di cui sopra:
- Imports System.Xml.Serialization
- Imports System.IO
- Imports System.Runtime.Serialization.Json
- Imports System.Text
- Module Module1
- Sub Main()
- Dim persona As Persona
- Dim serializer = New DataContractJsonSerializer(GetType(Persona))
- Using memStream = New MemoryStream(Encoding.Default.GetBytes(GetJSON()))
- persona = CType(serializer.ReadObject(memStream), Persona)
- End Using
- End Sub
- Private Function GetJSON() As String
- Return "{""nome"":""Giuseppe"",""cognome"":""Verdi""}"
- End Function
- End Module
Se eseguiamo il metodo e ci fermiamo immediatamente dopo la deserializzazione (metodo ReadObject della classe DataContractJsonSerializer), otteniamo:
cioè la data di creazione non è stata impostata.
Questo accade perché il serializzatore DataContractJsonSerializer (ma non è l’unico in quanto avviene anche con il DataContractSerializer, il NetDataContractSerializer e il BinaryFormatter) non richiama il costruttore.
Quindi, se abbiamo dei valori di default da impostare o dei valori da assegnare alla creazione dell’oggetto, con la deserializzazione siamo fregati.
E’ in questo scenario che ci vengono in aiuto i due attributi OnDeserializing e OnDeserialized:
- Imports System.Xml.Serialization
- Imports System.Runtime.Serialization
- <DataContract()>
- Public Class Persona
- Public Sub New()
- End Sub
- <DataMember(Name:="nome")>
- Public Property Nome As String
- <DataMember(Name:="cognome")>
- Public Property Cognome As String
- Private _DataCreazione As DateTime = DateTime.Now
- Public ReadOnly Property DataCreazione As DateTime
- Get
- Return Me._DataCreazione
- End Get
- End Property
- <OnDeserialized()>
- Public Sub OnDeserialized(context As StreamingContext)
- End Sub
- <OnDeserializing()>
- Public Sub OnDeserializing(context As StreamingContext)
- Me._DataCreazione = DateTime.Now
- End Sub
- End Class
Il metodo decorato con Ondeserializing viene richiamato immediatamente prima della deserializzazione, mentre quello decorato con OnDeserialized immediatamente dopo.
In questo modo, se rieseguiamo il metodo di prima in cui deserializziamo il JSON:
la data è effettivamente valorizzata.
I metodi decorati con questi attributi debbono avere come argomento un oggetto di tipo StreamingContext e possono essere utilizzati per controllare la deserializzazione dei nostri oggetti:
Ad esempio il seguente metodo solleva un’eccezione quando si tenta di serializzare oggetti in orari con minuti pari :
- <OnDeserializing()>
- Public Sub OnDeserializing(context As StreamingContext)
- If DateTime.Now.Minute Mod 2 = 0 Then
- Throw New Exception()
- End If
- Me._DataCreazione = DateTime.Now
- End Sub
Esistono dei corrispettivi attributi OnSerializing e OnSerialized per le operazioni di serializzazione.
Commenti