lunedì 10 gennaio 2011

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

Nessun commento: