Contratto di errore
Nell'esempio Errori viene illustrato come comunicare informazioni relative all'errore da un servizio a un client. L'esempio è basato su Introduzione, con altro codice aggiunto al servizio per convertire un'eccezione interna in un errore. Il client tenta di eseguire una divisione per zero per imporre una condizione di errore al servizio.
Nota
La procedura di installazione e le istruzioni di compilazione per questo esempio si trovano alla fine di questo argomento.
Il contratto della calcolatrice è stato modificato per includere un FaultContractAttribute, come illustrato nell'esempio di codice seguente.
[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
[OperationContract]
int Add(int n1, int n2);
[OperationContract]
int Subtract(int n1, int n2);
[OperationContract]
int Multiply(int n1, int n2);
[OperationContract]
[FaultContract(typeof(MathFault))]
int Divide(int n1, int n2);
}
L'attributo FaultContractAttribute indica che l'operazione Divide può restituire un errore di tipo MathFault. Un errore può essere di qualsiasi tipo che può essere serializzato. In questo caso, MathFault è un contratto dati, come segue:
[DataContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public class MathFault
{
private string operation;
private string problemType;
[DataMember]
public string Operation
{
get { return operation; }
set { operation = value; }
}
[DataMember]
public string ProblemType
{
get { return problemType; }
set { problemType = value; }
}
}
Il metodo Divide genera un'eccezione FaultException<TDetail> quando si verifica un'eccezione di divisione per zero, come illustrato nell'esempio di codice seguente. Questa eccezione comporta che un errore venga inviato al client.
public int Divide(int n1, int n2)
{
try
{
return n1 / n2;
}
catch (DivideByZeroException)
{
MathFault mf = new MathFault();
mf.operation = "division";
mf.problemType = "divide by zero";
throw new FaultException<MathFault>(mf);
}
}
Il codice client forza un errore richiedendo una divisione per zero. Quando si esegue l'esempio, le richieste e le risposte dell'operazione vengono visualizzate nella finestra della console client. Viene visualizzata la divisione per zero segnalata come un errore. Premere INVIO nella finestra del client per arrestare il client.
Add(15,3) = 18
Subtract(145,76) = 69
Multiply(9,81) = 729
FaultException<MathFault>: Math fault while doing division. Problem: divide by zero
Press <ENTER> to terminate client.
Il client esegue questa operazione rilevando l'eccezione FaultException<MathFault> appropriata:
catch (FaultException<MathFault> e)
{
Console.WriteLine("FaultException<MathFault>: Math fault while doing " + e.Detail.operation + ". Problem: " + e.Detail.problemType);
client.Abort();
}
Per impostazione predefinita, i dettagli delle eccezioni impreviste non vengono inviati al client per evitare che i dettagli dell'implementazione del servizio escano dal limite protetto del servizio. FaultContract rappresenta un modo per descrivere gli errori di un contratto e contrassegnare certi tipi di eccezioni come appropriati per essere trasmessi al client. FaultException<T> rappresenta il meccanismo in fase di esecuzione per l'invio di errori agli utenti.
È anche utile per visualizzare i dettagli interni di un errore del servizio durante l'esecuzione del debug. Per disattivare il comportamento protetto precedentemente descritto, è possibile indicare che i dettagli di ogni eccezione non gestita del server devono essere inclusi nell'errore inviato al client. Questa operazione viene eseguita impostando IncludeExceptionDetailInFaults su true. È possibile impostarlo nel codice o nella configurazione, come illustrato nell'esempio seguente.
<behaviors>
<serviceBehaviors>
<behavior name="CalculatorServiceBehavior">
<serviceMetadata httpGetEnabled="True"/>
<serviceDebug includeExceptionDetailInFaults="True" />
</behavior>
</serviceBehaviors>
</behaviors>
Il comportamento deve inoltre essere associato al servizio impostando l'attributo behaviorConfiguration del servizio nel file di configurazione su "CalculatorServiceBehavior".
Per intercettare questi errori nel client, è necessario intercettare l'oggetto FaultException non generico.
Questo comportamento deve essere usato solo a scopo di debug e non deve essere mai attivato in produzione.
Per impostare, compilare ed eseguire l'esempio
Assicurarsi di aver eseguito la Procedura di installazione singola per gli esempi di Windows Communication Foundation.
Per compilare l'edizione in C# o Visual Basic .NET della soluzione, seguire le istruzioni in Building the Windows Communication Foundation Samples.
Per eseguire l'esempio in un solo computer o tra computer diversi, seguire le istruzioni in Esecuzione degli esempi di Windows Communication Foundation.