Procedura: dichiarare errori nei contratti di servizio

  • Articolo

Nel codice gestito, vengono generate eccezioni quando si verificano condizioni di errore. Nelle applicazioni Windows Communication Foundation (WCF), tuttavia, i contratti di servizio specificano quali informazioni sugli errori vengono restituite dai client dichiarando errori SOAP nel contratto di servizio. Per una panoramica della relazione tra eccezioni e errori, vedere Impostazione e gestione degli errori in Contratti e servizi.

Creare un contratto di servizio che specifica un errore SOAP.

  1. Creare un contratto di servizio che contiene almeno un'operazione. Per un esempio, vedere Procedura: Definire un contratto di servizio.

  2. Selezionare un'operazione che può specificare una condizione di errore in merito alla quale i client prevedono di ricevere una notifica. Per decidere quali condizioni di errore giustificano la restituzione di errori SOAP ai client, vedere Impostazione e gestione degli errori in Contratti e servizi.

  3. Applicare una classe System.ServiceModel.FaultContractAttribute all'operazione selezionata e passare un tipo di errore serializzabile al costruttore. Per informazioni dettagliate sulla creazione e l'uso di tipi serializzabili, vedere Specifica del trasferimento dei dati nei contratti di servizio. Nell'esempio seguente viene illustrato come specificare che l'operazione SampleMethod può produrre un GreetingFault.

    [OperationContract]
[FaultContractAttribute(
  typeof(GreetingFault),
  Action="http://www.contoso.com/GreetingFault",
  ProtectionLevel=ProtectionLevel.EncryptAndSign
  )]
string SampleMethod(string msg);

    <OperationContract, FaultContractAttribute(GetType(GreetingFault), Action:="http://www.contoso.com/GreetingFault", ProtectionLevel:=ProtectionLevel.EncryptAndSign)> _
Function SampleMethod(ByVal msg As String) As String

  4. Ripetere i passaggi 2 e 3 per tutte le operazioni nel contratto che comunicano condizioni di errore ai client.

Implementazione di un'operazione per restituire un errore SOAP specificato

Dopo che un'operazione ha specificato che può essere restituito un determinato errore SOAP (come nella procedura seguente), per comunicare una condizione di errore a un'applicazione chiamante, il passaggio successivo consiste nell'implementare la specifica in questione.

Generare l'errore SOAP specificato nell'operazione

  1. Quando in un'operazione si verifica una condizione di errore specificata da FaultContractAttribute, generare una nuova eccezione System.ServiceModel.FaultException<TDetail> in cui l'errore SOAP specificato è il parametro di tipo. Nell'esempio seguente viene illustrato come generare il GreetingFault nel SampleMethod descritto nella procedura precedente e nella sezione Codice seguente.

    throw new FaultException<GreetingFault>(new GreetingFault("A Greeting error occurred. You said: " + msg));

        Throw New FaultException(Of GreetingFault)(New GreetingFault("A Greeting error occurred. You said: " & msg))
End If

Esempio

Nell'esempio di codice seguente viene illustrata un'implementazione di una singola operazione che specifica un GreetingFault per l'operazione SampleMethod.

using System;
using System.Collections.Generic;
using System.Net.Security;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.Text;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(Namespace="http://microsoft.wcf.documentation")]
  public interface ISampleService{
    [OperationContract]
    [FaultContractAttribute(
      typeof(GreetingFault),
      Action="http://www.contoso.com/GreetingFault",
      ProtectionLevel=ProtectionLevel.EncryptAndSign
      )]
    string SampleMethod(string msg);
  }

  [DataContractAttribute]
  public class GreetingFault
  {
    private string report;

    public GreetingFault(string message)
    {
      this.report = message;
    }

    [DataMemberAttribute]
    public string Message
    {
      get { return this.report; }
      set { this.report = value; }
    }
  }

  class SampleService : ISampleService
  {
  #region ISampleService Members

  public string  SampleMethod(string msg)
  {
    Console.WriteLine("Client said: " + msg);
    // Generate intermittent error behavior.
    Random rnd = new Random(DateTime.Now.Millisecond);
    int test = rnd.Next(5);
    if (test % 2 != 0)
      return "The service greets you: " + msg;
    else
      throw new FaultException<GreetingFault>(new GreetingFault("A Greeting error occurred. You said: " + msg));
  }

  #endregion
  }
}


Imports System.Collections.Generic
Imports System.Net.Security
Imports System.Runtime.Serialization
Imports System.ServiceModel
Imports System.Text

Namespace Microsoft.WCF.Documentation
    <ServiceContract(Namespace:="http://microsoft.wcf.documentation")> _
    Public Interface ISampleService
        <OperationContract, FaultContractAttribute(GetType(GreetingFault), Action:="http://www.contoso.com/GreetingFault", ProtectionLevel:=ProtectionLevel.EncryptAndSign)> _
        Function SampleMethod(ByVal msg As String) As String
    End Interface

    <DataContractAttribute> _
    Public Class GreetingFault
        Private report As String

        Public Sub New(ByVal message As String)
            Me.report = message
        End Sub

        <DataMemberAttribute> _
        Public Property Message() As String
            Get
                Return Me.report
            End Get
            Set(ByVal value As String)
                Me.report = value
            End Set
        End Property
    End Class

    Friend Class SampleService
        Implements ISampleService
#Region "ISampleService Members"

        Public Function SampleMethod(ByVal msg As String) As String Implements ISampleService.SampleMethod
            Console.WriteLine("Client said: " & msg)
            ' Generate intermittent error behavior.
            Dim rand As New Random(DateTime.Now.Millisecond)
            Dim test As Integer = rand.Next(5)
            If test Mod 2 <> 0 Then
                Return "The service greets you: " & msg
            Else
                Throw New FaultException(Of GreetingFault)(New GreetingFault("A Greeting error occurred. You said: " & msg))
            End If
        End Function

#End Region
    End Class
End Namespace

Vedi anche