Sdílet prostřednictvím

Postupy: Deklarace chyb v kontraktech služeb

  • Článek

Ve spravovaném kódu jsou výjimky vyvolány, když dojde k chybám. V aplikacích WCF (Windows Communication Foundation) však kontrakty služeb určují, jaké informace o chybách se vrátí klientům deklarací chyb SOAP ve smlouvě služby. Přehled vztahu mezi výjimkami a chybami najdete v tématu Určení a zpracování chyb v kontraktech a službách.

Vytvoření kontraktu služby, který určuje chybu SOAP

  1. Vytvořte kontrakt služby, který obsahuje aspoň jednu operaci. Příklad najdete v tématu Postupy: Definování kontraktu služby.

  2. Vyberte operaci, která může určit chybový stav, o kterém mohou klienti očekávat, že budou upozorněni. Informace o tom, které chybové podmínky odůvodňují vrácení chyb SOAP klientům, najdete v tématu Určení a zpracování chyb v kontraktech a službách.

  3. Použijte pro vybranou System.ServiceModel.FaultContractAttribute operaci a předejte serializovatelný typ chyby konstruktoru. Podrobnosti o vytvářeníach Následující příklad ukazuje, jak určit, že SampleMethod operace může mít za následek 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. Opakujte kroky 2 a 3 pro všechny operace ve smlouvě, které komunikují s klienty chybové podmínky.

Implementace operace pro vrácení zadané chyby PROTOKOLU SOAP

Jakmile operace určí, že může být vrácena konkrétní chyba SOAP (například v předchozím postupu), aby komunikovala chybový stav volající aplikaci, dalším krokem je implementace této specifikace.

Vyvolá zadanou chybu SOAP v operaci.

  1. FaultContractAttributePokud dojde k chybovému stavu zadanému v operaci, vyvolá novýSystem.ServiceModel.FaultException<TDetail>, kde zadanou chybou SOAP je parametr typu. Následující příklad ukazuje, jak vyvolat GreetingFault v SampleMethod předchozím postupu a v následující části Kód.

    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

Příklad

Následující příklad kódu ukazuje implementaci jedné operace, která určuje GreetingFault operaci 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

Viz také