Passa ai contenuti principali

Deserializzazione JSON e costruttori: OnDeserialized e OnDeserializing

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:

  1. {"nome":"Giuseppe","cognome":"Verdi"}

una possibile classe che permette la deserializzazione di tale JSON potrebbe essere:

  1. Imports System.Xml.Serialization
  2. Imports System.Runtime.Serialization
  3.  
  4. <DataContract()>
  5. Public Class Persona
  6.  
  7.     Public Sub New()
  8.  
  9.     End Sub
  10.  
  11.     <DataMember(Name:="nome")>
  12.     Public Property Nome As String
  13.     <DataMember(Name:="cognome")>
  14.     Public Property Cognome As String
  15.  
  16.     Private _DataCreazione As DateTime = DateTime.Now
  17.     Public ReadOnly Property DataCreazione As DateTime
  18.         Get
  19.             Return Me._DataCreazione
  20.         End Get
  21.     End Property
  22.  
  23. 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:

  1. Imports System.Xml.Serialization
  2. Imports System.IO
  3. Imports System.Runtime.Serialization.Json
  4. Imports System.Text
  5.  
  6. Module Module1
  7.  
  8.     Sub Main()
  9.         Dim persona As Persona
  10.         Dim serializer = New DataContractJsonSerializer(GetType(Persona))
  11.         Using memStream = New MemoryStream(Encoding.Default.GetBytes(GetJSON()))
  12.             persona = CType(serializer.ReadObject(memStream), Persona)
  13.         End Using
  14.     End Sub
  15.     
  16.     Private Function GetJSON() As String
  17.         Return "{""nome"":""Giuseppe"",""cognome"":""Verdi""}"
  18.     End Function
  19.  
  20. End Module

Se eseguiamo il metodo e ci fermiamo immediatamente dopo la deserializzazione (metodo ReadObject della classe DataContractJsonSerializer), otteniamo:

image

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:

  1. Imports System.Xml.Serialization
  2. Imports System.Runtime.Serialization
  3.  
  4. <DataContract()>
  5. Public Class Persona
  6.  
  7.     Public Sub New()
  8.  
  9.     End Sub
  10.  
  11.     <DataMember(Name:="nome")>
  12.     Public Property Nome As String
  13.     <DataMember(Name:="cognome")>
  14.     Public Property Cognome As String
  15.  
  16.     Private _DataCreazione As DateTime = DateTime.Now
  17.     Public ReadOnly Property DataCreazione As DateTime
  18.         Get
  19.             Return Me._DataCreazione
  20.         End Get
  21.     End Property
  22.  
  23.     <OnDeserialized()>
  24.     Public Sub OnDeserialized(context As StreamingContext)
  25.  
  26.     End Sub
  27.  
  28.     <OnDeserializing()>
  29.     Public Sub OnDeserializing(context As StreamingContext)
  30.         Me._DataCreazione = DateTime.Now
  31.     End Sub
  32. 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:

image

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 Sorriso :

  1. <OnDeserializing()>
  2. Public Sub OnDeserializing(context As StreamingContext)
  3.     If DateTime.Now.Minute Mod 2 = 0 Then
  4.         Throw New Exception()
  5.     End If
  6.     Me._DataCreazione = DateTime.Now
  7. End Sub

Esistono dei corrispettivi attributi OnSerializing e OnSerialized per le operazioni di serializzazione.

 

Commenti

Post popolari in questo blog

VB for Dummies: La serializzazione – parte 2

Questo post è la continuazione del precedente post sulla serializzazione. In particolare vedremo la serializzazione SOAP e quella JSON.   Serializzazione SOAP La serializzazione SOAP è demandata alla classe SOAPFormatter contenuta nel namespace System.Runtime.Serialization.Formatters.Soap contenuto nella libreria omonima. Il formatter SOAP risale alle primissime versioni del framework e, purtroppo, da un certo punto in poi, pur non essendo stato dichiarato obsoleto, non è stato portato avanti nello sviluppo e non supporta alcuni tipi di dati usatissimi nel mondo .NET quali i generici e i nullable. Per questo motivo, non possiamo serializzare in formato SOAP (utilizzando il SOAPFormatter) la nostra Fattura (vedi post precedente) poichè questa ha una proprietà di tipo List(Of DettagliFattura) (generico).   Serializzazione JSON Il formato di serializzazione JSON (maggiori info qui ) è un formato testuale molto in voga nelle applicazioni AJAX. Si trata di un mod...

Recensione: Windows Runtime via C#

Può sembrare strano che un VB-ista legga un libro su C#, ma come diceva Sun Tzu: “ Se conosci il tuo nemico, conosci te stesso ”. A parte gli scherzi, il libro vale la pena di essere letto a prescindere dal linguaggio .NET con cui si lavora. Oltre  290 pagine dedicate agli aspetti fondamentali dello sviluppo con Windows Runtime per le Windows Store App. I prerequisiti per poter leggere il libro sono la conoscenza di C# e di Visual Studio e gli autori non danno per scontato quasi nulla partendo dai concetti di base quali il type system e i suoi principi (argomento che di solito è saltato a piedi pari da chi si avvicina al mondo WinRT dal framework completo e che, se non compreso, può dare problemi nello sviluppo quotidiano). Tra i concetti che possiamo definire “core”, troviamo anche i capitoli dedicati all’app packaging e al process model, entrambi ben strutturati e chiari. Già solo questi tre capitoli iniziali giustificherebbero, in un certo qual modo, l’acquisto del libro, ...

Alla scoperta del Kinect : questione di profondità

Nei due precedenti post ( link e link ) abbiamo fatto conoscenza con “l’aggeggio” kinect e visto come sia possibile, in maniera molto semplice, gestire lo stream video proveniente dalla camera. In questo post diamo un’occhiata alla capacità che ha il Kinect di fornire frame in cui l’immagine non è la rappresentazione fedele della realtà che ci circonda ma la rappresentazione bidimensionale della distanza degli oggetti dai sensori di profondità. L’aggeggio, infatti, dispone di un sensore di profondità che è in grado di fornirci la distanza dei punti inquadrati da se stesso e, in più, è in grado di dirci a quale “player” fa riferimento ogni singolo pixel. Ma andiamo con ordine. Per abilitare la ricezione del depth stream è necessario: Istanziare la classe Runtime; Agganciare il gestore dell’evento DepthFrameReady; Inizializzare l’istanza della Runtime scegliendo una delle opzioni che abilitano il sensore di profondità; Aprire lo stream dei dati relativi alla pro...