#111 - Personalizzare la serializzazione delle entità di ADO.NET Data Services

di Marco Leoncini, in Windows Communication Foundation, Entity Framework, 27 marzo 2009

Archiviato in: .NET Framework, .NET Framework 3.0, .NET Framework 3.5, Entity Framework, LINQ, WCF Data Services, Web Service

Utilizzando ADO .NET Data Services si può presentare la necessità di aggiungere alle entità generate da Visual Studio, alcune proprietà che non trovano nessuna corrispondenza nel database che si sta mappando, ne si trovano sull'entità presenti sul server. Queste proprietà sono esclusivamente a uso e consumo del client, sia esso un'applicazione WPF, Silvelight o asp.net.

Il servizio in esempio espone una collezione di entità Games, con tre proprietà GamesID, Name e description, sul Client, nel nostro caso una semplice applicazione asp.net, per motivi progettuali è necessaria una nuova proprietà chiamata Score.

Sfruttando che le classi generate dal Visual Studio sono contrassegnate come Partial, aggiungere la proprietà Score non è certo un problema. Discorso ben diverso se si tenta di persistere l'entità, inesorabilmente riceveremo il seguente errore:

Error processing request stream. The property name 'Score' specified for type 'MyGamesDBModel.Games' is not valid

Allo stato attuale l'unico modo per risolvere il problema è intervenire nel processo di serializzazione in formato Atom dell'entità. Creiamo quindi un event handler per l'evento WritingEntity da agganciare sfruttando il partial method OnContextCreated() del la classe proxy del servizio.

partial void OnContextCreated() 
{ 
  this.WritingEntity += new System.EventHandler<System.Data.Services.Client.ReadingWritingEntityEventArgs>(MyGamesDBEntities_WritingEntity); 
}

Nel'event handler sfruttando Linq To Xml recuperiamo l'elemento da rimuovere

void MyGamesDBEntities_WritingEntity(object sender, System.Data.Services.Client.ReadingWritingEntityEventArgs e) 
{ 
  XName _xnEntityProperties = XName.Get("properties", e.Data.GetNamespaceOfPrefix("m").NamespaceName); 
  XElement _xePayload = e.Data.Descendants().Where<XElement>(xe => xe.Name == _xnEntityProperties).First<XElement>(); 
 
  //indivudio la proprietà da rimuovere 
  XName _xnProperty = XName.Get("Score", e.Data.GetNamespaceOfPrefix("d").NamespaceName); 
 
  //indivudo l'elemento  
  XElement _xeRemoveThisProperty = _xePayload.Descendants().Where<XElement>(xe => xe.Name == _xnProperty).First<XElement>(); 
  //e lo rimuovo 
  _xeRemoveThisProperty.Remove(); 
 
}

Così facendo al server arriva l'entità serializzata priva della proprietà definita sul Client.

Nota: Questo script contiene un allegato.