Passa ai contenuti principali

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 modo per serializzare oggetti anche complessi con un formato molto compatto e facilmente interoperabile con Javascript che, quindi, si adatta partoicolarmente bene per gli scenari web di tipo AJAX.

La serializzazione JSON può essere eseguita utilizzando la classe DataContractJsonSerializer che nel framework 4.0 è contenuta nel namespace System.Runtime.Serialization.Json all’interno dell’omonimo assembly.

Fate attenzione perchè, se state sviluppando per il framework 3.5 (prima di questo la classe DataContractJsonSerialization non era presente), trovate la classe nello stesso namespace ma l’assembly è System.ServiceModel.Web.

La classe DataContractJsonSerializer prevede, tra i vari metodi, WriteObject e ReadObject che permettono , rispettivamente, di serializzare e deserializzare un’oggetto in formato JSON.

Entrambi i metodi sfruttano uno stream per serializzare l’oggetto. In base alle nostre esigenze tale stream potrebbe essere in memoria (come nell’esempio riportato in seguito), su file o su un canale web (ad esempio come risposta ad una richiesta di un client remoto).

I metodi per la serializzazione e deserializzazione dell’oggetto Fattura sono:

  1. Public Shared Function SerializzaJSON(ByVal fattura As Fattura) As String
  2.     If fattura Is Nothing Then Throw New ArgumentNullException("Fattura")
  3.     Dim strJSON As String = Nothing
  4.     Dim serializer = New DataContractJsonSerializer(GetType(Fattura))
  5.     Using memStream = New MemoryStream()
  6.         serializer.WriteObject(memStream, fattura)
  7.         strJSON = Encoding.Default.GetString(memStream.ToArray())
  8.     End Using
  9.     Return strJSON
  10. End Function
  11.  
  12. Public Shared Function DeserializzaJSON(ByVal strFattura As String) As Fattura
  13.     Dim retObj As Fattura = Nothing
  14.     Dim serializer = New DataContractJsonSerializer(GetType(Fattura))
  15.     Using memStream = New MemoryStream(Encoding.Default.GetBytes(strFattura))
  16.         retObj = CType(serializer.ReadObject(memStream), Fattura)
  17.     End Using
  18.     Return retObj
  19. End Function

Il risultato è il seguente:

image

Osserviamo che, negli esempi, abbiamo utilizzato l’encoding di default per le stringhe. Evidentemente, all’occorrenza, l’encoding può essere quello da noi desiderato.

Se la nostra classe (come accade nella Fattura) è composta da oggetti .NET serializzabili, possiamo utilizzare immediatamente la serializzazione JSON.

In alternativa possiamo decorare la nostra classe (e tutte quelle eventualmente utilizzate come proprietà) con l’attributo Serializable o con l’attributo DataContract.

Nel primo caso è sufficiente decorare le sole classi e la serializzazione JSON avrà le proprietà espresse con il nome dell’attributo privato che viene incapsulato dalle proprietà. Nel caso delle proprietà definite in modo compatto (come accade nella Fattura) il compilatore crea, dietro le quinte un attributo per ogni proprietà con lo stesso nome della proprietà a cui viene anteposto il carattere “_”. In questo caso il JSON risultante vedrà le proprietà espresse con il nome della proprietà preceduta da “_”.

Nel caso dell’attributo DataContract, invece, è necessario decorare anche ogni proprietà con l’attributo DataMember (se una proprietà non viene decorata con DataMember, questa non finisce nella serializzazione).

L’attributo DataMember permette di rinominare la proprietà all’interno del JSON risultante:

  1. <DataMember(Name:="numeroDocumento")>
  2. Public Property NumeroDocumento As String

In questo caso la proprietà, all’interno del JSON, si chiamerà “numeroDocumento” e non “NumeroDocumento”.

Utilizzando DataContract e DataMember possiamo intervenire nel JSON risultante in modo da personalizzare il risultato a nostro piacimento (utile soprattutto quando ci viene dato il tracciato e dobbiamo ricreare la classe).

Serializzazion personalizzata

Solo un accenno alla possibilità di creare una serializzazione custom di oggetti.

Per fare questo, il framework ci mette a disposizione l’interfaccia IFormatter che dispone dei due metodi Serialize e Deserialize che dobbiamo ridefinire implementando la nostra logica di serializzazione/deserializzazione:

Un esempio può essere il seguente:

  1. Imports System.Runtime.Serialization
  2.  
  3. Public Class MioSerializzatore
  4.     Implements IFormatter
  5.  
  6.     Public Property Binder As System.Runtime.Serialization.SerializationBinder Implements System.Runtime.Serialization.IFormatter.Binder
  7.         Get
  8.  
  9.         End Get
  10.         Set(ByVal value As System.Runtime.Serialization.SerializationBinder)
  11.  
  12.         End Set
  13.     End Property
  14.  
  15.     Public Property Context As System.Runtime.Serialization.StreamingContext Implements System.Runtime.Serialization.IFormatter.Context
  16.         Get
  17.  
  18.         End Get
  19.         Set(ByVal value As System.Runtime.Serialization.StreamingContext)
  20.  
  21.         End Set
  22.     End Property
  23.  
  24.     Public Function Deserialize(ByVal serializationStream As System.IO.Stream) As Object Implements System.Runtime.Serialization.IFormatter.Deserialize
  25.         ' qui ci va la logica di deserializzazione
  26.     End Function
  27.  
  28.     Public Sub Serialize(ByVal serializationStream As System.IO.Stream, ByVal graph As Object) Implements System.Runtime.Serialization.IFormatter.Serialize
  29.         ' qui ci va la logica di serializzazione
  30.     End Sub
  31.  
  32.     Public Property SurrogateSelector As System.Runtime.Serialization.ISurrogateSelector Implements System.Runtime.Serialization.IFormatter.SurrogateSelector
  33.         Get
  34.  
  35.         End Get
  36.         Set(ByVal value As System.Runtime.Serialization.ISurrogateSelector)
  37.  
  38.         End Set
  39.     End Property
  40. End Class

Commenti

Post popolari in questo blog

MVP Reconnect …… ovvero quando entri nella “famigghia” resti sempre nella “famigghia”!!!

Ma di che “famigghia” stiamo parlando!!!!

Fermi tutti, non si tratta di robe strane o sette segrete o affari malavitosi….stiamo parlando della grande famiglia dei Microsoft MVP.

Per chi non sapesse cosa sono i Microsoft MVP, vi consiglio di fare un giro sul sito ufficiale del programma (link), ma, volendolo spiegare in pochisime parole, si tratta di un riconoscimento che Microsoft da a persone che si distinguono per il loro impegno, aiutando gli altri ad ottenere il massimo grazie alle tecnologie Microsoft. Si tratta di persone, non dipendenti Microsoft, che mettono la loro passione, il loro tempo, la loro buona volontà per la divulgazione e la condivisione della conoscenza. Non necessariamente (come qualcuno erroneamente sostiene, evidentemente non conoscendo le basi del programma) si tratta di professionisti nel termine letterale del termine ma si tratta comunque di un gruppo di persone che sacrifica un pò del suo tempo (e, a volte, vi assicuro neanche pò!!!) per la sua passione.

Pe…

Nuova versione del Band SDK

E’ di ieri l’annuncio del rilascio della nuova versione dell’SDK per il Microsoft Band.
Si tratta della versione 1.3.10417 (la precedente e, prima della serie, era la 1.3.10219 preview).
Maggiori informazioni, download dell’SDK per le tre piattaforme Windows Phone, iOS e Android all’indirizzo http://developer.microsoftband.com/.
Allo stesso indirizzo potrete trovare anche la documentazione.
Nei mesi scorsi mi sono gia’ occupato della precedente versione e questi sono i post che ne parlano:
Microsoft Band SDK Preview - First LookMicrosoft Band SDK Preview - ”Hello Band”Microsoft Band SDK Preview - Accesso ai sensoriMicrosoft Band SDK Preview - TileMicrosoft Band SDK Preview - NotificheMicrosoft Band SDK Preview - Personalizzazione
Gli argomenti trattati e il codice proposto dovrebbe, ad una prima lettura delle nuove funzionalita’ inserite, essere ancora valido e funzionante ma nei prossimi giorni prendero’ in esame tutti gli argomenti dei precedenti post e vedremo cosa cambia e cosa e’ …

Template di progetto per sviluppare applicazioni WPF con Intel® RealSense™

E’ disponibile, nella gallery di Visual Studio, la prima versione del mio template di progetto per applicazioni WPF scritte in C# che permette di realizzare applicazioni con l’SDK di Intel® RealSense™.Il template si può scaricare direttamente all’interno Visual Studio utilizzando il tool “Extensions and Updates”oppure all’indirizzo https://visualstudiogallery.msdn.microsoft.com/1c36ecfd-8c00-4aee-b20c-a1726ab6424dIl template esegue le seguenti operazioni per voi:Aggiunge la reference all’assembly libpxcclr.cs.dll (nelle due distinte versioni per x86 e x64);Aggiunge lo script di post build per copiare la libreria libpxccpp2c.dll dalla cartella dell’SDK alla cartella bin del vostro progetto.Una volta creato il progetto dovete rimuovere la configurazione di compilazione AnyCPU (che non ha più senso) dalla vostra solution e sarete pronti per sviluppare con Intel® RealSense™.Ovviamente dovete installare l’SDK che potete scaricare all’indirizzo https://software.intel.com/en-us/intel-realsen…