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.NET : Aggregare stringhe con LINQ

Tip facile facile, ma a qualcuno potrebbe servire. Supponiamo di avere una lista di stringhe (magari come risultato di una query LINQ) e di voler ottenere una stringa con la concatenazione delle stesse: Dim list = CreateList() Dim concatStr = (From s In list _ Select s).Aggregate( Function (currentString, nextString) currentString + nextString) MessageBox.Show(concatStr) Il metodo CreateList non ci interessa, in questo momento, ma crea una lista di oggetti String. Protected Function CreateList() As IEnumerable( Of String ) Dim list As String () = {" stringa1 ", " stringa2 ", " stringa3 ", " stringa4 ", " stringa5 "} Return list.AsEnumerable() End Function Questo metodo potrebbe restituire una qualsiasi lista di oggetti di cui, nella select successiva recuperiamo solo stringhe. La stessa tecnica è utilizzabile per concatenare stringhe inserendovi un carattere separatore Dim list = CreateList() Dim

VB.NET: SplashScreen con effetto fade-in

In questo post vorrei proporvi un modo per realizzare una splash screen per le nostre applicazioni Windows Form che appare progressivamente con un effetto fade. Supponiamo di avere il nostro progetto VB.NET in una soluzione Visual Studio 2008 in cui abbiamo il sorgente della nostra applicazione Windows Form. Inseriamo una splash screen utilizzando il menù Progetto->Aggiungi Nuovo Elemento e selezionando il tipo di elemento “Schermata Iniziale” A questo punto Visual Studio creerà, automaticamente, la schermata iniziale che possiamo personalizzare graficamente come vogliamo. Per poter fare in modo che questa finestra appaia nel momento in cui avviamo l’applicazione, è necessario aprire le proprietà del progetto e impostare la maschera di avvio: In questo modo, all’avvio dell’applicazione, la schermata appare immediatamente e scompare un attimo prima della visualizzazione della finestra dell’applicazione. Possiamo far apparire la schermata iniziale con un ef

VB.NET: Convertire un file DOC in RTF e PDF con office interop

In questo post vorrei proporvi del codice per poter convertire un file .doc in un file .rtf oppure .pdf utilizzando le API di interoperabilità di Office. Creeremo una classe, DocConverter, che esporrà le due funzionalità sopra citate. Cominciamo con il prevedere un attributo privato della classe che rappresenterà l’applicazione Word che utilizzeremo per la conversione. Creeremo l’istanza dell’attributo privato all’interno del costruttore della classe: Public Sub New () If Not CreateWordApp() Then Throw New ApplicationException(" Assembly di interoperabilità con Office non trovato! ") End If End Sub Private _wordApp As Word.ApplicationClass Protected Function CreateWordApp() As Boolean Dim retval = True Try _wordApp = New Word.ApplicationClass() _wordApp.Visible = False Catch ex As System.Exception _wordApp = Nothing retval = False End Try Return retval End Function La conve