Condividi tramite

Progettazione dei contratti di servizio

  • Articolo

In questo argomento vengono descritti i contratti di servizio, la relativa modalità di definizione, le operazioni disponibili (e le implicazioni per gli scambi di messaggi sottostanti), i tipi di dati utilizzati e altri temi che consentono di progettare operazioni in linea con i requisiti del proprio scenario.

Creazione di un contratto di servizio

I servizi espongono una serie di operazioni. Nelle applicazioni Windows Communication Foundation (WCF) definire le operazioni creando un metodo e contrassegnandolo con l'attributo OperationContractAttribute. Quindi, per creare un contratto di servizio, si raggruppano le operazioni, dichiarandole all'interno di un'interfaccia contrassegnata con l'attributo ServiceContractAttribute oppure definendole in una classe contrassegnata con lo stesso attributo. Per un esempio di base, vedere Procedura: Definire un contratto di servizio.

I metodi che non presentano un attributo OperationContractAttribute non sono operazioni del servizio e non sono esposti dai servizi WCF.

In questo argomento vengono descritte le decisioni seguenti da prendere durante la progettazione di un contratto di servizio:

  • Utilizzo di classi o interfacce.

  • Modalità di indicazione dei tipi di dati che si desidera scambiare.

  • Tipi di modello di scambio che è possibile usare.

  • Possibilità di inserimento nel contratto di requisiti di sicurezza espliciti.

  • Restrizioni per input e output dell'operazione.

Classi o interfacce

Tanto le classi quanto le interfacce rappresentano un raggruppamento di funzionalità e, quindi, entrambe possono essere utilizzate per definire un contratto di servizio WCF. È tuttavia consigliabile utilizzare le interfacce dal momento che modellano direttamente i contratti di servizio. Senza implementazione, le interfacce si limitano a definire un raggruppamento di metodi con determinate firme. Implementando un'interfaccia del contratto di servizio si ottiene l'implementazione di un servizio WCF.

Le interfacce del contratto di servizio assumono tutti i vantaggi delle interfacce gestite:

  • Le interfacce del contratto di servizio possono estendere un numero qualsiasi di altre interfacce del contratto di servizio.

  • Una sola classe è in grado di implementare più contratti di servizio implementandone le interfacce.

  • È possibile modificare l'implementazione di un contratto di servizio modificando l'implementazione dell'interfaccia mentre il contratto di servizio rimane lo stesso.

  • È possibile modificare la versione del servizio implementando l'interfaccia obsoleta e l'interfaccia nuova. I client obsoleti si connettono alla versione originale mentre i client più recenti possono connettersi alla versione nuova.

Nota

Quando si eredita da altre interfacce del contratto di servizio, non è possibile eseguire l'override delle proprietà dell'operazione, ad esempio il nome o lo spazio dei nomi. Se si tenta di farlo, si crea una nuova operazione nel contratto di servizio corrente.

Per un esempio di utilizzo di un'interfaccia per creare un contratto di servizio, vedere Procedura: Creare un servizio con un'interfaccia del contratto.

È tuttavia possibile utilizzare una classe per definire un contratto di servizio e contemporaneamente implementare il contratto. Il vantaggio della creazione dei servizi applicando direttamente ServiceContractAttribute e OperationContractAttribute rispettivamente alla classe e ai metodi della classe è rappresentano dalla velocità e dalla semplicità. Gli svantaggi consistono nel fatto che le classi gestite non supportano l'ereditarietà multipla e di conseguenza possono implementare solo un contratto di servizio alla volta. Qualsiasi modifica alle firme della classe o del metodo, inoltre, modifica il contratto pubblico per quel servizio impedendo potenzialmente ai client non modificati di utilizzare il servizio. Per altre informazioni, vedere Implementazione dei contratti di servizio.

Per un esempio che usa una classe per creare un contratto di servizio e la implementa contemporaneamente, vedere Procedura: Creare un servizio con una classe Contract.

A questo punto è necessario capire la differenza tra definire il contratto di servizio utilizzando un'interfaccia e utilizzare una classe. Il passaggio successivo consiste nel decidere quali dati possono essere scambiati tra un servizio e i relativi client.

Parametri e valori restituiti

Ogni operazione presenta un valore restituito e un parametro, anche se soltanto void. Diversamente da un metodo locale, tuttavia, nel quale è possibile passare riferimenti a oggetti da un oggetto all'altro, le operazioni del servizio non passano riferimenti agli oggetti. In realtà passano copie degli oggetti.

Ciò è significativo poiché ogni tipo utilizzato in un parametro o valore restituito deve essere serializzabile, ovvero deve essere possibile convertire un oggetto di quel tipo in un flusso di byte e un flusso di byte in un oggetto.

I tipi primitivi sono serializzabili per impostazione predefinita, come molti tipi in .NET Framework.

Nota

Il valore dei nomi di parametro nella firma dell'operazione fa parte del contratto e supporta la distinzione tra maiuscole e minuscole. Se si desidera utilizzare localmente lo stesso nome di parametro ma modificarlo nei metadati pubblicati, vedere System.ServiceModel.MessageParameterAttribute.

Contratti dati

Le applicazioni orientate al servizio come le applicazioni Windows Communication Foundation (WCF) sono progettate per interagire con il maggior numero possibile di applicazioni client su piattaforme Microsoft e diverse da Microsoft. Poiché l'interazione sia la più ampia possibile, è consigliabile contrassegnare i tipi con gli attributi DataContractAttribute e DataMemberAttribute per creare un contratto dati, parte del contratto di servizio che descrive i dati scambiati nelle operazioni del servizio.

I contratti dati sono contratti di tipo con consenso esplicito: nessun tipo o membro dati viene serializzato a meno che non si applichi in modo esplicito l'attributo del contratto dati. I contratti dati non sono correlati all'ambito di accesso del codice gestito: i membri dati privati possono essere serializzati e inviati altrove perché vi si possa accedere pubblicamente. Per un esempio di base di un contratto di dati, vedere Procedura: Creare un contratto di dati di base per una classe o una struttura. In WCF viene gestita la definizione dei messaggi SOAP sottostanti che abilitano la funzionalità dell'operazione nonché la serializzazione dei tipi di dati dentro e fuori il corpo dei messaggi. Purché i tipi di dati siano serializzabili, non è necessario occuparsi dell'infrastruttura dello scambio di messaggi sottostante durante la progettazione delle operazioni.

Sebbene le applicazioni WCF tipiche utilizzino gli attributi DataContractAttribute e DataMemberAttribute per creare contratti dati per le operazioni, è possibile utilizzare altri meccanismi di serializzazione. I meccanismi ISerializable, SerializableAttribute e IXmlSerializable standard gestiscono tutti la serializzazione dei tipi di dati nei messaggi SOAP sottostanti che li trasportano da un'applicazione all'altra. È possibile utilizzare più strategie di serializzazione se i tipi di dati richiedono un supporto speciale. Per altre informazioni sulle scelte per la serializzazione dei tipi di dati nelle applicazioni WCF, vedere Specifica del trasferimento dei dati nei contratti di servizio.

Esecuzione del mapping di parametri e valori restituiti agli scambi di messaggi

Le operazioni del servizio sono supportate da uno scambio sottostante di messaggi SOAP che trasferiscono i dati dell'applicazione avanti e indietro, oltre ai dati necessari per l'applicazione per supportare alcune funzionalità standard di sicurezza, transazione e correlate alla sessione. Poiché questa è la situazione in esame, la firma di un'operazione del servizio determina un determinato modello di scambio dei messaggi (MEP, message exchange pattern) sottostante che può supportare il trasferimento dei dati e le funzioni necessarie per un'operazione. È possibile specificare tre modelli nel modello di programmazione WCF: Request/Reply, unidirezionale e duplex.

Request/Reply

Nel modello Request/Reply il mittente di una richiesta (un'applicazione client) riceve una risposta alla quale è correlata la richiesta. Si tratta del modello di scambio dei messaggi predefinito perché supporta un'operazione in cui uno o più parametri vengono passati all'operazione e un valore restituito viene passato di nuovo al chiamante. Nell'esempio di codice C# seguente viene illustrata un'operazione di base del servizio che accetta una stringa e restituisce una stringa.

[OperationContractAttribute]  
string Hello(string greeting);

Il codice seguente è l'equivalente del codice Visual Basic.

<OperationContractAttribute()>  
Function Hello (ByVal greeting As String) As String

Questa firma dell'operazione determina la forma dello scambio di messaggi sottostante. Se non esistesse alcuna correlazione, sarebbe impossibile per WCF determinare l'operazione alla quale è destinato il valore restituito.

Si noti che, a meno che non si specifichi un modello di messaggi sottostante diverso, anche le operazioni del servizio che restituiscono void (Nothing in Visual Basic) sono scambi di messaggi Request/Reply. Il risultato per l'operazione è che, a meno che un client non richiami l'operazione in modo asincrono, il client interrompe l'elaborazione fino alla ricezione del messaggio di risposta, anche se normalmente si tratta di un messaggio vuoto. Nell'esempio di codice di C# seguente viene illustrata un'operazione che restituisce un risultato solo dopo che il client ha ricevuto un messaggio di risposta vuoto.

[OperationContractAttribute]  
void Hello(string greeting);

Il codice seguente è l'equivalente del codice Visual Basic.

<OperationContractAttribute()>  
Sub Hello (ByVal greeting As String)

L'esempio precedente può rallentare le prestazioni e la velocità di risposta del client se l'esecuzione dell'operazione richiede molto tempo, tuttavia le operazioni Request/Reply presentano vantaggi anche quando restituiscono void. Il vantaggio più ovvio consiste nel fatto che gli errori SOAP possono essere restituiti nel messaggio di risposta, a indicare che si è verificata una condizione di errore correlata al servizio, nella comunicazione o nell'elaborazione. Gli errori SOAP specificati in un contratto di servizio vengono passati all'applicazione client sotto forma di oggetto FaultException<TDetail>, dove il parametro tipo è il tipo specificato nel contratto di servizio. Risulta così semplificata la notifica di condizioni di errore nei servizi di WCF ai client. Per altre informazioni su eccezioni, errori SOAP e gestione degli errori, vedere Impostazione e gestione degli errori in contratti e servizi. Per un esempio di servizio di richiesta/risposta e client, vedere Procedura: Creare un contratto request-reply. Per altre informazioni sui problemi relativi al modello request-reply, vedere Servizi request-reply.

Unidirezionale

Se per il client di un'applicazione del servizio WCF non è necessario attendere il completamento dell'operazione e se tale client non elabora errori SOAP, l'operazione può specificare un modello di messaggio unidirezionale. Nell'operazione unidirezionale un client richiama un'operazione e continua l'elaborazione dopo la scrittura del messaggio nella rete da parte di WCF. In genere ciò significa che, a meno che le dimensioni dei dati inviati nel messaggio in uscita non siano eccessive, il client continua l'esecuzione quasi immediatamente (purché non si verifichi un errore durante l'invio dei dati). Questo tipo di modello di scambio dei messaggi supporta il comportamento simile a quello degli eventi da un client a un'applicazione di servizio.

Uno scambio di messaggi in cui un messaggio viene inviato e non ne viene ricevuto nessuno non è in grado di supportare un'operazione del servizio che specifichi un valore restituito diverso da void, nel quale caso viene generata un'eccezione InvalidOperationException.

L'assenza di messaggi di risposta implica inoltre che non verranno restituite segnalazioni SOAP per indicare eventuali errori durante l'elaborazione o la comunicazione (la comunicazione di informazioni sull'errore quando le operazioni sono unidirezionali richiede un modello di scambio dei messaggi duplex).

Per specificare uno scambio di messaggi unidirezionale per un'operazione che restituisce void, impostare la proprietà IsOneWay su true, come nell'esempio di codice C# seguente.

[OperationContractAttribute(IsOneWay=true)]  
void Hello(string greeting);

Il codice seguente è l'equivalente del codice Visual Basic.

<OperationContractAttribute(IsOneWay := True)>  
Sub Hello (ByVal greeting As String)

Questo metodo è identico all'esempio Request/Reply precedente ma impostare la proprietà IsOneWay su true implica che sebbene il metodo sia identico, l'operazione del servizio non invia un messaggio di risposta e i client rispondono immediatamente dopo l'invio del messaggio in uscita al livello del canale. Per un esempio, vedere Procedura: Creare un contratto unidirezionale. Per altre informazioni sul modello unidirezionale, vedere Servizi unidirezionali.

Duplex

Un modello duplex è caratterizzato dalla possibilità del servizio e del client di inviarsi reciprocamente messaggi indipendentemente dal modello usato, unidirezionale o Request/Reply. Questa forma di comunicazione bidirezionale è utile per i servizi con la necessità di comunicare direttamente con il client o per consentire un'esperienza asincrona a entrambe le estremità dello scambio di messaggi, compreso il comportamento simile a quello degli eventi.

Il modello duplex è leggermente più complesso del modello Request/Reply o del modello unidirezionale a causa del meccanismo supplementare di comunicazione con il client.

Per progettare un contratto duplex, è inoltre necessario progettare un contratto callback e assegnare il tipo di tale contratto callback alla proprietà CallbackContract dell'attributo ServiceContractAttribute che contrassegna il contratto di servizio.

Per implementare un modello duplex è necessario creare una seconda interfaccia contenente le dichiarazioni del metodo chiamate sul client.

Per un esempio di creazione di un servizio e di un client che accede a tale servizio, vedere Procedura: Creare un contratto duplex e Procedura: Accedere ai servizi con un contratto duplex. Per un esempio reale, vedere Duplex. Per altre informazioni sui problemi relativi all'uso di contratti duplex, vedere Servizi duplex.

Attenzione

Quando un servizio riceve un messaggio duplex, analizza l'elemento ReplyTo contenuto nel messaggio in arrivo per stabilire dove inviare la replica. Se il canale utilizzato per ricevere il messaggio non è protetto, un client non attendibile potrebbe inviare un messaggio dannoso con un ReplyTo di un computer di destinazione, sfociando in un Denial of Service (DoS) del computer di destinazione.

Parametri Out e Ref

Nella maggior parte dei casi, è possibile usare parametri in (ByVal in Visual Basic) e parametri out e ref (ByRef in Visual Basic). Poiché i parametri out e ref indicano entrambi che un'operazione restituisce dati, una firma dell'operazione come la seguente specifica che un'operazione Request/Reply è necessaria anche se la firma dell'operazione restituisce void.

[ServiceContractAttribute]  
public interface IMyContract  
{  
  [OperationContractAttribute]  
  public void PopulateData(ref CustomDataType data);  
}

Il codice seguente è l'equivalente del codice Visual Basic.

<ServiceContractAttribute()> _  
Public Interface IMyContract  
  <OperationContractAttribute()> _  
  Public Sub PopulateData(ByRef data As CustomDataType)  
End Interface

Le uniche eccezioni sono costituite dai casi in cui la firma presenta una struttura particolare. È ad esempio possibile utilizzare l'associazione NetMsmqBinding per comunicare con i client solo se il metodo utilizzato per dichiarare un'operazione restituisce void. Non sono possibili valori di output, che si tratti di un valore restituito o di un parametro ref o out.

Utilizzando il parametro out o ref, inoltre, è necessario che l'operazione disponga di un messaggio di risposta sottostante per trasportare di nuovo l'oggetto modificato. Se l'operazione è unidirezionale, in fase di esecuzione viene generata un'eccezione InvalidOperationException.

Specificare il livello di sicurezza del messaggio sul contratto

Durante la progettazione del contratto è inoltre necessario decidere il livello di sicurezza del messaggio dei servizi che implementano il contratto. È necessario solo se la protezione del messaggio è applicata all'associazione nell'endpoint del contratto. Se nell'associazione la protezione è disattivata (ovvero se l'associazione fornita dal sistema imposta System.ServiceModel.SecurityMode sul valore SecurityMode.None), non è necessario formulare una decisione sul livello di sicurezza del messaggio per il contratto. Nella maggior parte dei casi le associazioni fornite dal sistema in cui è applicata la protezione a livello di messaggio forniscono un livello di sicurezza sufficiente e non è necessario prendere in considerazione il livello di sicurezza per operazione o per messaggio.

Il livello di sicurezza è un valore che specifica se i messaggi (o parti del messaggio) che supportano un servizio sono firmati, firmati e crittografati o inviati senza firma né crittografia. Il livello di sicurezza può essere impostato su vari ambiti: a livello di servizio, per un'operazione in particolare, per un messaggio all'interno dell'operazione o per una parte del messaggio. I valori impostati in un ambito diventano predefiniti per ambiti più ristretti, tranne quando sono sottoposti a override in modo esplicito. Se la configurazione di un'associazione non è in grado di fornire il livello di sicurezza minimo necessario per il contratto, viene generata un'eccezione. Quando, inoltre, nessun valore del livello di sicurezza è impostato in modo esplicito nel contratto, la configurazione dell'associazione controlla il livello di sicurezza per tutti i messaggi, se l'associazione dispone della protezione dei messaggi. Si tratta del comportamento predefinito.

Importante

Decidere se impostare in modo esplicito i vari ambiti di un contratto su una protezione di ProtectionLevel.EncryptAndSign di livello inferiore rispetto alla protezione completa, equivale solitamente a cercare un compromesso tra un certo grado di sicurezza e prestazioni maggiori. In questi casi le decisioni dipendono dalle operazioni e dal valore dei dati scambiati. Per altre informazioni, vedere Protezione dei servizi.

Nell'esempio di codice seguente non viene impostata nel contratto né la proprietà ProtectionLevel né la proprietà ProtectionLevel.

[ServiceContract]  
public interface ISampleService  
{  
  [OperationContractAttribute]  
  public string GetString();  
  
  [OperationContractAttribute]  
  public int GetInt();
}

Il codice seguente è l'equivalente del codice Visual Basic.

<ServiceContractAttribute()> _  
Public Interface ISampleService  
  
  <OperationContractAttribute()> _  
  Public Function GetString()As String  
  
  <OperationContractAttribute()> _  
  Public Function GetData() As Integer  
  
End Interface

Durante l'interazione con un'implementazione ISampleService in un endpoint con un WSHttpBinding predefinito (l'elemento System.ServiceModel.SecurityMode predefinito, ovvero Message), tutti i messaggi sono crittografati e firmati poiché questo è il livello di sicurezza predefinito. Tuttavia, quando un servizio ISampleService viene utilizzato con un oggetto BasicHttpBinding predefinito (l'oggetto SecurityMode predefinito, ovvero None), tutti i messaggi vengono inviati come testo poiché non è disponibile alcuna protezione per questa associazione, di conseguenza il livello di sicurezza viene ignorato (ovvero i messaggi non vengono crittografati né firmati). Se l'elemento SecurityMode fosse impostato su Message, i messaggi verrebbero crittografati e firmati (perché tale sarebbe il livello di sicurezza predefinito dell'associazione).

Se si desidera regolare o specificare in modo esplicito i requisiti di sicurezza per il contratto, impostare la proprietà ProtectionLevel (o una qualsiasi delle proprietà ProtectionLevel in un ambito più ristretto) sul livello necessario per il contratto di servizio in questione. In questo caso, l'utilizzo di un'impostazione esplicita impone all'associazione di supportare tale impostazione almeno per l'ambito utilizzato. Nell'esempio di codice seguente viene specificato un valore ProtectionLevel esplicitamente, per l'operazione GetGuid.

[ServiceContract]  
public interface IExplicitProtectionLevelSampleService  
{  
  [OperationContractAttribute]  
  public string GetString();  
  
  [OperationContractAttribute(ProtectionLevel=ProtectionLevel.None)]  
  public int GetInt();
  [OperationContractAttribute(ProtectionLevel=ProtectionLevel.EncryptAndSign)]  
  public int GetGuid();
}

Il codice seguente è l'equivalente del codice Visual Basic.

<ServiceContract()> _
Public Interface IExplicitProtectionLevelSampleService
    <OperationContract()> _
    Public Function GetString() As String
    End Function
  
    <OperationContract(ProtectionLevel := ProtectionLevel.None)> _
    Public Function GetInt() As Integer
    End Function
  
    <OperationContractAttribute(ProtectionLevel := ProtectionLevel.EncryptAndSign)> _
    Public Function GetGuid() As Integer
    End Function
  
End Interface

Un servizio che implementa questo contratto IExplicitProtectionLevelSampleService e dispone di un endpoint che utilizza l'elemento WSHttpBinding predefinito (l'elemento System.ServiceModel.SecurityMode predefinito, ovvero Message) presenta il comportamento seguente:

  • I messaggi dell'operazione GetString sono crittografati e firmati.

  • I messaggi dell'operazione GetInt sono inviati come testo non crittografato né firmato, ovvero come testo normale.

  • L'elemento GetGuid dell'operazione System.Guid viene restituito in un messaggio crittografato e firmato.

Per altre informazioni sui livelli di protezione e su come usarli, vedere Informazioni sul livello di protezione. Per altre informazioni sulla sicurezza, vedere Protezione dei servizi.

Altri requisiti per la firma di un'operazione

Alcune funzionalità dell'applicazione richiedono un tipo particolare di firma dell'operazione. L'associazione NetMsmqBinding, ad esempio, supporta servizi e client durevoli in cui è possibile per un'applicazione riavviarsi durante la comunicazione e riprendere da dove era stata interrotta senza perdere messaggi. Per altre informazioni, vedere Code in WCF. Le operazioni durevoli, tuttavia, devono accettare solo un parametro in e non presentare valori restituiti.

Un altro esempio è l'utilizzo di tipi Stream nelle operazioni. Poiché il parametro Stream comprende l'intero corpo del messaggio, se un input o un output (ovvero il parametro ref, il parametro out o il valore restituito) è di tipo Stream, deve essere l'unico l'input o l'unico l'output specificato nell'operazione. Il parametro o il tipo restituito, inoltre, deve essere Stream, System.ServiceModel.Channels.Message o System.Xml.Serialization.IXmlSerializable. Per altre informazioni sui flussi, vedere Dati di grandi dimensioni e streaming.

Nomi, spazi dei nomi e offuscamento

I nomi e gli spazi dei nomi dei tipi .NET nella definizione di contratti e operazioni sono significativi quando i contratti vengono convertiti in WSDL e quando vengono creati e inviati messaggi del contratto. Di conseguenza, è consigliabile che gli spazi dei nomi e i nomi del contratto di servizio vengano impostati in modo esplicito tramite le proprietà Name e Namespace di tutti gli attributi del contratto di supporto, ad esempio ServiceContractAttribute, OperationContractAttribute, DataContractAttribute, DataMemberAttribute e altri attributi del contratto.

Se i nomi e gli spazi dei nomi non vengono impostati in modo esplicito, una delle conseguenze sarà che l'utilizzo dell'offuscamento IL sull'assembly determinerà la modifica dei nomi e degli spazi dei nomi del tipo di contratto e genererà WSDL modificato e scambi di rete che in genere hanno esito negativo. Se i nomi e gli spazi dei nomi del contratto non vengono impostati in modo esplicito, ma si intende utilizzare l'offuscamento, utilizzare gli attributi ObfuscationAttribute e ObfuscateAssemblyAttribute per impedire la modifica dei nomi e degli spazi dei nomi del tipo di contratto.

Vedi anche