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: 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:PublicSubNew()
IfNot CreateWordApp() Then
ThrowNew ApplicationException("Assembly di interoperabilità con Office non trovato!")
EndIf
EndSub
Private _wordApp As Word.ApplicationClass
ProtectedFunction CreateWordApp() AsBoolean
Dim retval = True
Try
_wordApp = New Word.ApplicationClass()
_wordApp.Visible = False
Catch ex As System.Exception
_wordApp = Nothing
retval = False
EndTry
Return retval
EndFunction

La conversione del file doc sarà effettuata aprendo il file stesso ed eseguendo un’operazione di SaveAs:

Pr…

Creare uno shortcut con VB.NET

Prendendo spunto da un post comparso sul forum MSDN vorrei proporvi un tip su come creare uno shortcut utilizzando VB.NET.Per poter creare uno shortcut possiamo procedere in due modi: o ci studiamo la struttura del file .lnk e scriviamo una classe che è in grado di ricreare tale struttura oppure utilizziamo Windows Scripting Host.La prima soluzione è percorribile ma laboriosa perchè la struttura di un file lnk non è banale. Chi fosse interessato a vedere come è composto, internamente, un file lnk può scaricare la seguente reference guide (link).Io vorrei proporvi la seconda strada e realizzerò una classe che incapsula l’utilizzo di Windows Scripting Host.L’object model di Windows Scripting Host è contenuto nella dll IWshRuntimeLibrary che può essere referenziata, nel nostro progetto, utilizzando il tab COM della finestra di aggiunta delle reference:Tra gli oggetti che troviamo all’interno della libreria utilizzeremo la classe WshShell e la classe WshShortcut.La prima delle due rappres…

Cambiare la lingua di Visual Studio 2008

Oggi ho avuto qualche problema installando Windows Mobile 6 Professional SDK Refresh e Windows Mobile 6 Standard SDK Refresh.Scaricati i file di installazione e installati, ho provato a creare un progetto di tipo Windows Mobile 6.0 e mi sono beccato questo errore:Dopo qualche smanettamento abbiamo scoperto (e ringrazio il mitico Matteo per l’aiuto) che il mio Visual Studio 2008, pur essendo in Inglese (prova ne era il fatto che gli hotfix e la SP installata erano nella lingua di Albione) aveva come lingua impostata quella del sistema operativo (italiano).Ovviamente, non avrebbe mai potuto trovare la cartella 1040 (italiano) visto che l’installazione dell’SDK aveva supposto che la lingua del Visual Studio fosse Inglese (1033).La soluzione del problema è duplice:1) Duplicate la cartella 1033 presente nel percorso evidenziato dall’errore e la rinominate 10402) cambiate la lingua di Visual Studio.Per questa ultima eventualità basta andare nel menù Strumenti/Opzioni:e cambiare il linguaggi…