Vergleichen von ASP.NET-Webdiensten mit WCF auf Grundlage der Entwicklung

Windows Communication Foundation (WCF) besitzt eine ASP.NET-Kompatibilitätsmodusoption, mit der die Programmierung und Konfiguration von WCF-Anwendungen entsprechend den ASP.NET-Webdiensten und das Imitieren von deren Verhalten ermöglicht wird. In den folgenden Abschnitten werden ASP.NET-Webdienste und WCF ausgehend von den Anforderungen der Anwendungsentwicklung mithilfe beider Technologien verglichen.

Datendarstellung

Die Entwicklung eines Webdiensts mit ASP.NET beginnt normalerweise mit der Definition aller komplexen Datentypen, die vom Dienst verwendet werden sollen. ASP.NET verwendet XmlSerializer, um Daten, die von .NET Framework-Typen dargestellt werden, zur Übertragung an oder von einem Dienst in XML zu übersetzen und als XML empfangene Daten in .NET Framework-Objekte zu übersetzen. Die Definition der komplexen Datentypen, die ein ASP.NET-Dienst verwenden soll, erfordert die Definition von .NET Framework-Klassen, die XmlSerializer in und aus XML serialisieren kann. Derartige Klassen können manuell geschrieben oder aus Definitionen der Typen in XML-Schema generiert werden. Dies geschieht mithilfe von xsd.exe, dem Befehlszeilen-Unterstützungsprogramm für XML-Schemas\/-Datentypen.

Nachfolgend finden Sie eine Auflistung wesentlicher Probleme, die beim Definieren von .NET Framework-Klassen auftreten können, die XmlSerializer in und aus XML serialisieren kann:

  • Nur die öffentlichen Felder und Eigenschaften von .NET Framework-Objekten werden in XML übersetzt.

  • Instanzen der Auflistungsklassen können nur in XML serialisiert werden, wenn die Klassen entweder die IEnumerable-Schnittstelle oder die ICollection-Schnittstelle implementieren.

  • Klassen, die die IDictionary-Schnittstelle, zum Beispiel Hashtable, implementieren, können nicht in XML serialisiert werden.

  • Die zahlreichen Attributtypen im System.Xml.Serialization-Namespace können einer .NET Framework-Klasse und deren Membern hinzugefügt werden, um die Darstellung der Klasseninstanzen in XML zu steuern.

Die WCF-Anwendungsentwicklung beginnt normalerweise ebenfalls mit der Definition komplexer Typen. WCF kann dazu veranlasst werden, dieselben .NET Framework-Typen wie ASP.NET-Webdienste zu verwenden.

WCF DataContractAttribute und DataMemberAttribute können .NET Framework-Typen hinzugefügt werden, um anzugeben, dass Instanzen des Typs in XML serialisiert werden sollen und welche bestimmten Felder oder Eigenschaften des Typs zu serialisieren sind (siehe folgender Beispielcode).

//Example One:   
[DataContract]  
public class LineItem  
{  
    [DataMember]  
    public string ItemNumber;  
    [DataMember]  
    public decimal Quantity;  
    [DataMember]  
    public decimal UnitPrice;  
}  

//Example Two:   
public class LineItem  
{  
    [DataMember]  
    private string itemNumber;  
    [DataMember]  
    private decimal quantity;  
    [DataMember]  
    private decimal unitPrice;  

    public string ItemNumber  
    {  
      get  
      {  
          return this.itemNumber;  
      }  

      set  
      {  
          this.itemNumber = value;  
      }  
    }  

    public decimal Quantity  
    {  
        get  
        {  
            return this.quantity;  
        }  

        set  
        {  
            this.quantity = value;  
        }  
    }  

    public decimal UnitPrice  
    {  
      get  
      {  
          return this.unitPrice;  
      }  

      set  
      {  
          this.unitPrice = value;  
      }  
    }  
}  

//Example Three:   
public class LineItem  
{  
     private string itemNumber;  
     private decimal quantity;  
     private decimal unitPrice;  

     [DataMember]  
     public string ItemNumber  
     {  
       get  
       {  
          return this.itemNumber;  
       }  

       set  
       {  
           this.itemNumber = value;  
       }  
     }  

     [DataMember]  
     public decimal Quantity  
     {  
          get  
          {  
              return this.quantity;  
          }  

          set  
          {  
             this.quantity = value;  
          }  
     }  

     [DataMember]  
     public decimal UnitPrice  
     {  
          get  
          {  
              return this.unitPrice;  
          }  

          set  
          {  
              this.unitPrice = value;  
          }  
     }  
}  

DataContractAttribute gibt an, dass null oder mehr Felder oder Eigenschaften eines Typs serialisiert werden sollen. DataMemberAttribute gibt dagegen an, dass ein bestimmtes Feld oder eine Eigenschaft serialisiert werden soll. DataContractAttribute kann für eine Klasse oder Struktur übernommen werden. DataMemberAttribute kann auf ein Feld oder eine Eigenschaft angewendet werden, und die Felder und Eigenschaften, für die das Attribut übernommen wird, können entweder öffentlich oder privat sein. Instanzen von Typen, für die DataContractAttribute übernommen wurde, werden in WCF als Datenverträge bezeichnet. Sie werden mit DataContractSerializer in XML serialisiert.

Nachfolgend finden Sie eine Liste der wichtigen Unterschiede zwischen der Verwendung von DataContractSerializer und der Verwendung von XmlSerializer sowie der verschiedenen Attribute des System.Xml.Serialization-Namespace.

  • XmlSerializer und die Attribute des System.Xml.Serialization-Namespace ermöglichen das Zuordnen von .NET Framework-Typen zu jedem gültigen Typ, der in XML-Schema definiert ist. Dadurch ermöglichen sie eine außerordentlich genaue Steuerung der Darstellung eines Typs in XML. DataContractSerializer, DataContractAttribute und DataMemberAttribute bieten nur sehr wenige Möglichkeiten zur Steuerung der Darstellung eines Typs in XML. Angegeben werden können nur die Namespaces und Namen, die zum Darstellen des Typs und der Felder oder Eigenschaften in XML verwendet werden, sowie die Reihenfolge, in der die Felder und Eigenschaften in XML angezeigt werden:

    [DataContract(  
    Namespace="urn:Contoso:2006:January:29",  
    Name="LineItem")]  
    public class LineItem  
    {  
         [DataMember(Name="ItemNumber",IsRequired=true,Order=0)]  
         public string itemNumber;  
         [DataMember(Name="Quantity",IsRequired=false,Order = 1)]  
         public decimal quantity;  
         [DataMember(Name="Price",IsRequired=false,Order = 2)]  
         public decimal unitPrice;  
    }  
    

    Alle anderen Aspekte der Struktur von XML, mit der der .NET-Typ dargestellt wird, werden von DataContractSerializer bestimmt.

  • Dadurch, dass keine umfassenden Möglichkeiten zur Steuerung der Darstellung eines Typs in XML gewährt werden, wird der Serialisierungsprozess für DataContractSerializer leicht vorhersehbar und die Optimierung dadurch vereinfacht. Ein praktischer Vorteil des Entwurfs von DataContractSerializer ist eine um etwa zehn Prozent höhere Leistung.

  • Die Attribute für die Verwendung mit XmlSerializer geben nicht an, welche Felder oder Eigenschaften des Typs in XML serialisiert werden, wohingegen DataMemberAttribute für die Verwendung mit DataContractSerializer explizit die zu serialisierenden Felder oder Eigenschaften anzeigt. Daher handelt es sich bei den Datenverträgen um explizite Verträge über die Struktur der Daten, die von einer Anwendung gesendet und empfangen werden.

  • XmlSerializer kann nur die öffentlichen Member eines .NET-Objekts in XML übersetzen, und DataContractSerializer kann die Member eines Objekts unabhängig von den Zugriffsmodifizierern dieser Member in XML übersetzen.

  • Da die nicht öffentlichen Member der Typen in XML serialisiert werden können, gelten für DataContractSerializer weniger Einschränkungen bezüglich der Vielfalt der .NET-Typen, die in XML serialisiert werden können. Insbesondere ist eine Übersetzung in XML-Typen wie Hashtable möglich, mit denen die IDictionary-Schnittstelle implementiert wird. DataContractSerializer ist mit einer weitaus höheren Wahrscheinlichkeit in der Lage, die Instanzen eines beliebigen zuvor vorhandenen .NET-Typs in XML zu serialisieren, ohne entweder die Definition des Typs ändern oder einen Wrapper dafür entwickeln zu müssen.

  • Da DataContractSerializer auf die nicht öffentlichen Member eines Typs zugreifen kann, ist im Gegensatz zu XmlSerializer zudem volle Vertrauenswürdigkeit erforderlich. Die Codezugriffsberechtigung für volle Vertrauenswürdigkeit ermöglicht vollständigen Zugriff auf alle Ressourcen eines Computers, auf die mithilfe der Anmeldeinformationen, unter denen der Code ausgeführt wird, zugegriffen wird. Verwenden Sie diese Optionen mit Bedacht, da vollständig vertrauenswürdiger Code auf alle Ressourcen auf dem Computer zugreift.

  • DataContractSerializer bietet einige Unterstützung für Versionsverwaltung:

    • DataMemberAttribute verfügt über eine IsRequired-Eigenschaft, der der Wert false für Member zugewiesen werden kann, die neuen Versionen eines Datenvertrags hinzugefügt werden, die in früheren Versionen noch nicht vorhanden waren. Dadurch wird Anwendungen mit der neueren Version des Vertrags das Verarbeiten früherer Versionen ermöglicht.

    • Wenn mit einem Datenvertrag die IExtensibleDataObject-Schnittstelle implementiert wird, kann DataContractSerializer das Übergeben von Membern gestattet werden, die in neueren Versionen eines Datenvertrags durch Anwendungen mit älteren Versionen des Vertrags definiert sind.

Ungeachtet aller Unterschiede ist das XML, in das XmlSerializer standardmäßig einen Typ serialisiert, semantisch identisch mit dem XML, in das DataContractSerializer einen Typ serialisiert, vorausgesetzt, dass der Namespace für das XML explizit definiert ist. Die folgende Klasse, die über Attribute für die Verwendung mit beiden Serialisierungsprogrammen verfügt, wird von XmlSerializer und DataContractAttribute in ein semantisch identisches XML übersetzt:

[Serializable]  
[XmlRoot(Namespace="urn:Contoso:2006:January:29")]  
[DataContract(Namespace="urn:Contoso:2006:January:29")]  
public class LineItem  
{  
     [DataMember]  
     public string ItemNumber;  
     [DataMember]  
     public decimal Quantity;  
     [DataMember]  
     public decimal UnitPrice;  
}  

Das Windows Software Development Kit (SDK) beinhaltet ein Befehlszeilentool mit der Bezeichnung ServiceModel Metadata Utility-Tool (Svcutil.exe). Ebenso wie das mit ASP.NET-Webdiensten verwendete Tool xsd.exe können mit Svcutil.exe Definitionen von .NET-Datentypen aus dem XML-Schema generiert werden. Bei den Typen handelt es sich um Datenverträge, sofern DataContractSerializer XML in dem vom XML-Schema definierten Format ausgeben kann; andernfalls sind sie für die Serialisierung mithilfe von XmlSerializer vorgesehen. Mit dem Tool Svcutil.exe kann auch das XML-Schema aus Datenverträgen generiert werden (unter Verwendung von /dataContractOnly).

Hinweis

Obgleich XmlSerializer von ASP.NET-Webdiensten verwendet wird und WCF-Diensten vom WCF-ASP.NET-Kompatibilitätsmodus das Imitieren des Verhaltens der ASP.NET-Webdienste ermöglicht wird, schränkt die ASP.NET-Kompatibilitätsoption nicht die Verwendung von XmlSerializer ein. DataContractSerializer kann nach wie vor verwendet werden, während die Dienste im ASP.NET-Kompatibilitätsmodus ausgeführt werden.

Dienstentwicklung

Soll ein Dienst mithilfe von ASP.NET entwickelt werden, wird einer Klasse üblicherweise das WebService-Attribut hinzugefügt, und WebMethodAttribute wird einer beliebigen Methode dieser Klasse, bei denen es sich um Vorgänge des Diensts handeln soll, hinzugefügt:

[WebService]  
public class Service : T:System.Web.Services.WebService  
{  
    [WebMethod]  
    public string Echo(string input)   
    {  
       return input;  
    }  
}  

Seit ASP.NET 2.0 steht eine Option zur Verfügung, mit der der WebService und das WebMethodAttribute des Attributs einer Schnittstelle und nicht einer Klasse hinzugefügt werden und eine Klasse zum Implementieren der Schnittstelle geschrieben wird:

[WebService]  
public interface IEcho  
{  
    [WebMethod]  
    string Echo(string input);  
}  

public class Service : IEcho  
{  

   public string Echo(string input)  
   {  
        return input;  
    }  
}  

Die Verwendung dieser Option wird empfohlen, da die Schnittstelle mit dem WebService-Attribut einen Vertrag für die vom Dienst ausgeführten Vorgänge darstellt. Dieser Vertrag kann erneut mit verschiedenen Klassen verwendet werden, die denselben Vertrag möglicherweise auf unterschiedliche Art und Weise implementieren.

Ein WCF-Dienst wird bereitgestellt, indem mindestens ein WCF-Endpunkt definiert wird. Ein Endpunkt wird durch eine Adresse, eine Bindung und einen Dienstvertrag definiert. Die Adresse wird am Standort des Diensts definiert. Die Bindung gibt an, wie eine Kommunikation mit dem Dienst stattfindet. Mit dem Dienstvertrag werden die Vorgänge, die der Dienst ausführen kann, definiert.

Der Dienstvertrag wird normalerweise zuerst definiert, indem einer Schnittstelle ServiceContractAttribute und OperationContractAttribute hinzugefügt werden:

[ServiceContract]  
public interface IEcho  
{  
     [OperationContract]  
     string Echo(string input);  
}  

ServiceContractAttribute gibt an, dass die Schnittstelle einen WCF-Dienstvertrag definiert, und OperationContractAttribute gibt an, von welchen Schnittstellenmethoden ggf. Vorgänge des Dienstvertrags definiert werden.

Nach der Definition eines Dienstvertrags wird dieser in einer Klasse implementiert, indem die Klasse die Schnittstelle implementiert, nach der der Dienstvertrag definiert ist:

public class Service : IEcho  
{  
    public string Echo(string input)  
    {  
       return input;  
    }  
}  

Eine Klasse, die einen Dienstvertrag implementiert, wird in WCF als Diensttyp bezeichnet.

Der nächste Schritt besteht in der Zuordnung einer Adresse und einer Bindung zu einem Diensttyp. Dieser Schritt wird normalerweise in einer Konfigurationsdatei ausgeführt, und zwar entweder durch direktes Bearbeiten der Datei oder durch Verwendung eines in WCF enthaltenen Konfigurationseditors. Hier sehen Sie ein Beispiel einer Konfigurationsdatei.

<?xml version="1.0" encoding="utf-8" ?>  
<configuration>  
     <system.serviceModel>  
      <services>  
      <service name="Service ">  
       <endpoint   
        address="EchoService"  
        binding="basicHttpBinding"  
        contract="IEchoService "/>  
      </service>  
      </services>  
     </system.serviceModel>  
</configuration>  

Die Bindung gibt den Satz der Protokolle für die Kommunikation mit der Anwendung an. In der folgenden Tabelle sind die vom System bereitgestellten Bindungen, die allgemeine Optionen darstellen, aufgeführt.

Name Zweck
BasicHttpBinding Interoperabilität mit Webdiensten und Clients, die WS-BasicProfile 1.1 und Basic Security Profile 1.0 unterstützen.
WSHttpBinding Interoperabilität mit Webdiensten und Clients, die die Protokolle vom Typ WS-* über HTTP unterstützen.
WSDualHttpBinding Duplex-HTTP-Kommunikation, bei der der Empfänger einer ursprünglichen Nachricht nicht direkt dem ursprünglichen Absender antwortet, jedoch eine beliebige Anzahl von Antworten über einen bestimmten Zeitraum übertragen kann, indem er HTTP in Übereinstimmung mit WS-*-Protokollen verwendet.
WSFederationBinding HTTP-Kommunikation, in der der Zugriff auf Ressourcen eines Diensts auf Basis der Anmeldeinformationen gesteuert wird, die von einem explizit identifizierten Anmeldeinformationsanbieter ausgestellt werden.
NetTcpBinding Sichere, zuverlässige, leistungsstarke Kommunikation zwischen WCF-Softwareentitäten in einem Netzwerk.
NetNamedPipeBinding Sichere, zuverlässige, leistungsstarke Kommunikation zwischen WCF-Softwareentitäten auf demselben Computer.
NetMsmqBinding Kommunikation zwischen WCF-Softwareentitäten mithilfe von MSMQ.
MsmqIntegrationBinding Kommunikation zwischen einer WCF-Softwareentität und einer anderen Softwareentität mithilfe von MSMQ.
NetPeerTcpBinding Kommunikation zwischen WCF Softwareentitäten mithilfe von Windows-Peer-to-Peer-Netzwerken.

Mit der vom System bereitgestellten Bindung, BasicHttpBinding, wird der Satz der von ASP.NET-Webdiensten unterstützten Protokolle integriert.

Benutzerdefinierte Bindungen für WCF-Anwendungen können problemlos als Auflistungen der Bindungselementklassen definiert werden, die WCF zum Implementieren einzelner Protokolle verwendet. Neue Bindungselemente können zur Darstellung zusätzlicher Protokolle geschrieben werden.

Das interne Verhalten der Diensttypen kann mithilfe der Eigenschaften einer Klassenfamilie mit der Bezeichnung Verhaltensweisen angepasst werden. Hier wird mit der ServiceBehaviorAttribute-Klasse angegeben, dass der Diensttyp Multithread sein soll.

[ServiceBehavior(ConcurrencyMode=ConcurrencyMode.Multiple]  
public class DerivativesCalculatorServiceType: IDerivativesCalculator  

Einige Verhaltensweisen wie zum Beispiel ServiceBehaviorAttribute sind Attribute. Andere Verhaltensweisen (diejenigen mit den Eigenschaften, die normalerweise von Administratoren festgelegt werden) können in der Konfiguration einer Anwendung geändert werden.

In Programmierdiensttypen wird häufig die OperationContext-Klasse verwendet. Die statische Current-Eigenschaft bietet Zugriff auf Informationen zu dem Kontext, in dem ein Vorgang ausgeführt wird. OperationContext ist für die Klassen HttpContext und ContextUtil ähnlich.

Hosting

ASP.NET-Webdienste werden in eine Klassenbibliothekassembly kompiliert. Eine als Dienstdatei bezeichnete Datei wird bereitgestellt, die die Erweiterung ASMX aufweist und eine @ WebService-Richtlinie zur Identifizierung der Klasse mit dem Code für den Dienst und die Assembly beinhaltet, in der sich die Klasse befindet.

<%@ WebService Language="C#" Class="Service,ServiceAssembly" %>  

Die Dienstdatei wird in das Stammverzeichnis einer ASP.NET-Anwendung in Internetinformationsdienste (IIS) und die Assembly in das \bin-Unterverzeichnis dieses Anwendungsstammverzeichnisses kopiert. Die Anwendung ist anschließend durch Angabe der URL (Uniform Resource Locator) der Dienstdatei im Stammverzeichnis der Anwendung verfügbar.

WCF-Dienste können in IIS 5.1 oder 6.0, in Windows Process Activation Service (WAS), einer Komponente von IIS 7.0, und innerhalb einer beliebigen .NET-Anwendung gehostet werden. Soll ein Dienst in IIS 5.1 oder 6.0 gehostet werden, muss HTTP als Kommunikationstransportprotokoll verwendet werden.

Soll ein Dienst innerhalb von IIS 5, 6.0 oder WAS gehostet werden, gehen Sie folgendermaßen vor:

  1. Kompilieren Sie den Diensttyp in eine Klassenbibliothekassembly.

  2. Erstellen Sie eine Dienstdatei mit einer SVC-Erweiterung und einer @ ServiceHost-Richtlinie zur Identifizierung des Diensttyps:

    <%@ServiceHost language=”c#” Service="MyService" %>  
    
  3. Kopieren Sie die Dienstdatei in ein virtuelles Verzeichnis und die Assembly in das \bin-Unterverzeichnis des virtuellen Verzeichnisses.

  4. Kopieren Sie die Konfigurationsdatei in das virtuelle Verzeichnis, und nennen Sie die Datei Web.config.

Die Anwendung ist anschließend durch Angabe der URL der Dienstdatei im Stammverzeichnis der Anwendung verfügbar.

Soll ein WCF-Dienst innerhalb einer .NET-Anwendung gehostet werden, kompilieren Sie den Diensttyp in eine Klassenbibliothekassembly, auf die durch die Anwendung verwiesen wird, und programmieren Sie die Anwendung für das Hosten des Diensts mithilfe der ServiceHost-Klasse. Nachfolgend finden Sie ein Beispiel für die erforderliche grundlegende Programmierung:

string httpBaseAddress = "http://www.contoso.com:8000/";  
string tcpBaseAddress = "net.tcp://www.contoso.com:8080/";  

Uri httpBaseAddressUri = new Uri(httpBaseAddress);  
Uri tcpBaseAddressUri = new Uri(tcpBaseAddress);  

Uri[] baseAdresses = new Uri[] {   
 httpBaseAddressUri,  
 tcpBaseAddressUri};  

using(ServiceHost host = new ServiceHost(  
typeof(Service), //”Service” is the name of the service type baseAdresses))  
{  
     host.Open();  

     […] //Wait to receive messages  
     host.Close();  
}  

In diesem Beispiel erfahren Sie, wie Adressen für mindestens ein Transportprotokoll bei der Erstellung von ServiceHost angegeben werden. Diese Adressen werden als Basisadressen bezeichnet.

Die für einen beliebigen Endpunkt eines WCF-Diensts angegebene Adresse ist eine Adresse, die relativ zu einer Basisadresse des Endpunkthosts ist. Der Host kann über eine Basisadresse für jedes Kommunikationstransportprotokoll verfügen. In der Beispielkonfiguration in der vorangegangenen Konfigurationsdatei verwendet die für den Endpunkt gewählte BasicHttpBinding HTTP als Transportprotokoll, sodass die Adresse des Endpunkts (EchoService) relativ zur HTTP-Basisadresse des Hosts ist. Im Fall des Hosts im vorhergehenden Beispiel lautet die HTTP-Basisadresse http:\/\/www.contoso.com:8000\/. Für einen in IIS oder WAS gehosteten Dienst ist die Basisadresse die URL der Dienstdatei des Diensts.

Nur in IIS oder WAS gehostete Dienste, die ausschließlich mit HTTP als Transportprotokoll konfiguriert sind, können zum Verwenden der WCF-ASP.NET-Kompatibilitätsmodusoption veranlasst werden. Das Aktivieren dieser Option erfordert die folgenden Schritte.

  1. Der Programmierer muss das AspNetCompatibilityRequirementsAttribute-Attribut dem Diensttyp hinzufügen und angeben, dass der ASP.NET-Kompatibilitätsmodus entweder zulässig oder erforderlich ist.

    [System.ServiceModel.Activation.AspNetCompatibilityRequirements(  
          RequirementsMode=AspNetCompatbilityRequirementsMode.Require)]  
    public class DerivativesCalculatorServiceType: IDerivativesCalculator  
    
  2. Der Administrator muss die Anwendung so konfigurieren, dass der ASP.NET-Kompatibilitätsmodus verwendet wird.

    <configuration>  
         <system.serviceModel>  
          <services>  
          […]  
          </services>  
          <serviceHostingEnvironment aspNetCompatibilityEnabled="true"/>  
        </system.serviceModel>  
    </configuration>  
    

    WCF-Anwendungen können auch dafür konfiguriert werden, als Erweiterung für die Dienstdateien ASMX anstelle von SVC zu verwenden.

    <system.web>  
         <compilation>  
          <compilation debug="true">  
          <buildProviders>  
           <remove extension=".asmx"/>  
           <add extension=".asmx"   
            type="System.ServiceModel.ServiceBuildProvider,   
            Systemm.ServiceModel,   
            Version=3.0.0.0,   
            Culture=neutral,   
            PublicKeyToken=b77a5c561934e089" />  
          </buildProviders>  
          </compilation>  
         </compilation>  
    </system.web>  
    

    Durch diese Option entfällt das Ändern von Clients, die dafür konfiguriert sind, die URLs von ASMX-Dienstdateien zu verwenden, wenn ein Dienst für die Verwendung von WCF konfiguriert wird.

Cliententwicklung

Clients für ASP.NET-Webdienste werden mithilfe des Befehlszeilentools WSDL.exe generiert, das die URL der ASMX-Datei als Eingabe bereitstellt. Das entsprechende von WCF bereitgestellte Tool ist ServiceModel Metadata Utility-Tool (Svcutil.exe). Damit werden ein Codemodul mit der Definition des Dienstvertrags und die Definition einer WCF-Clientklasse generiert. Es generiert auch eine Konfigurationsdatei mit der Adresse und der Bindung des Diensts.

Beim Programmieren eines Clients eines Remotediensts ist es in der Regel empfehlenswert, gemäß einem asynchronen Muster zu programmieren. Der vom Tool WSDL.exe generierte Code beinhaltet standardmäßig sowohl ein synchrones als auch ein asynchrones Muster. Im vom ServiceModel Metadata Utility-Tool (Svcutil.exe) generierten Code können beide Muster bereitgestellt werden. Standardmäßig wird das synchrone Muster bereitgestellt. Bei Ausführung des Tools mit /async wird durch den generierten Code das asynchrone Muster bereitgestellt.

Es besteht keine Garantie, dass Namen in den WCF-Clientklassen, die standardmäßig vom ASP.NET-Tool WSDL.exe generiert werden, den Namen in WCF-Clientklassen entsprechen, die vom Tool Svcutil.exe generiert werden. Insbesondere wird den Namen der Eigenschaften von Klassen, die mit XmlSerializer serialisiert werden müssen, standardmäßig die Suffixeigenschaft im vom Tool Svcutil.exe generierten Code zugewiesen. Beim Tool WSDL.exe ist dies nicht der Fall.

Nachrichtendarstellung

Die Header der SOAP-Nachrichten, die von ASP.NET-Webdiensten gesendet und empfangen werden, können angepasst werden. Eine Klasse wird von SoapHeader abgeleitet, um die Struktur des Headers zu definieren. Anschließend wird mit SoapHeaderAttribute das Vorhandensein des Headers angezeigt.

public class SomeProtocol : SoapHeader  
{  
     public long CurrentValue;  
     public long Total;  
}  

[WebService]  
public interface IEcho  
{  
     SomeProtocol ProtocolHeader  
     {  
      get;  
     set;  
     }  

     [WebMethod]  
     [SoapHeader("ProtocolHeader")]  
     string PlaceOrders(PurchaseOrderType order);  
}  

public class Service: WebService, IEcho  
{  
     private SomeProtocol protocolHeader;  

     public SomeProtocol ProtocolHeader  
     {  
         get  
         {  
              return this.protocolHeader;  
         }  

         set  
         {  
              this.protocolHeader = value;  
         }  
     }  

     string PlaceOrders(PurchaseOrderType order)  
     {  
         long currentValue = this.protocolHeader.CurrentValue;  
     }  
}  

WCF stellt die Attribute MessageContractAttribute, MessageHeaderAttribute und MessageBodyMemberAttribute zur Verfügung, um die Struktur der von einem Dienst gesendeten und empfangenen SOAP-Nachrichten zu beschreiben.

[DataContract]  
public class SomeProtocol  
{  
     [DataMember]  
     public long CurrentValue;  
     [DataMember]  
     public long Total;  
}  

[DataContract]  
public class Item  
{  
     [DataMember]  
     public string ItemNumber;  
     [DataMember]  
     public decimal Quantity;  
     [DataMember]  
     public decimal UnitPrice;  
}  

[MessageContract]  
public class ItemMesage  
{  
     [MessageHeader]  
     public SomeProtocol ProtocolHeader;  
     [MessageBody]  
     public Item Content;  
}  

[ServiceContract]  
public interface IItemService  
{  
     [OperationContract]  
     public void DeliverItem(ItemMessage itemMessage);  
}  

Diese Syntax ermöglicht eine explizite Darstellung der Nachrichtenstruktur, wohingegen die Struktur der Nachrichten vom Code eines ASP.NET-Webdiensts impliziert wird. Zudem werden in der ASP.NET-Syntax Nachrichtenheader als Eigenschaften des Diensts dargestellt, so zum Beispiel die ProtocolHeader-Eigenschaft im vorherigen Beispiel, wohingegen sie in der WCF-Syntax genauer als Nachrichteneigenschaften dargestellt werden. Zudem ermöglicht WCF das Hinzufügen von Nachrichtenheadern zur Konfiguration von Endpunkten.

<service name="Service ">  
     <endpoint   
      address="EchoService"  
      binding="basicHttpBinding"  
      contract="IEchoService ">  
      <headers>  
      <dsig:X509Certificate   
       xmlns:dsig="http://www.w3.org/2000/09/xmldsig#">  
       ...  
      </dsig:X509Certificate>  
      </headers>  
     </endpoint>  
</service>  

Mit dieser Option muss im Code für einen Client oder Dienst kein Verweis auf infrastrukturbezogene Protokollheader angegeben werden: Die Header werden Nachrichten ausgehend von der Konfiguration des Endpunkts hinzugefügt.

Dienstbeschreibung

Bei einer HTTP GET-Anforderung für die ASMX-Datei eines ASP.NET-Webdiensts mit der Abfrage-WSDL generiert ASP.NET zur Beschreibung des Diensts WSDL. Diese WSDL wird als Antwort auf diese Anforderung zurückgegeben.

Mit ASP.NET 2.0 kann überprüft werden, ob ein Dienst mit Basic Profile 1.1 von Web Services-Interoperability Organization (WS-I) kompatibel ist und ein Anspruch, mit dem der Dienst kompatibel ist, in WSDL eingefügt werden. Dies wird mithilfe des ConformsTo-Parameters und des EmitConformanceClaims-Parameters des WebServiceBindingAttribute-Attributs durchgeführt.


[WebService(Namespace = "http://tempuri.org/")]  
[WebServiceBinding(  
     ConformsTo = WsiProfiles.BasicProfile1_1,  
     EmitConformanceClaims=true)]  
public interface IEcho  

Die WSDL, die ASP.NET für einen Dienst generiert, kann angepasst werden. Anpassungen werden durch Erstellen einer abgeleiteten Klasse von ServiceDescriptionFormatExtension vorgenommen, um der WSDL Elemente hinzuzufügen.

Bei einer HTTP GET-Anforderung mit der Abfrage-WSDL für die SVC-Datei eines WCF-Diensts mit einem HTTP-Endpunkt, der in IIS 5.1, 6.0 oder WAS gehostet wird, antwortet WCF mit WSDL, um den Dienst zu beschreiben. Das Richten einer HTTP GET-Anforderung mit der Abfrage-WSDL an die HTTP-Basisadresse eines in einer .NET-Anwendung gehosteten Diensts hat die gleiche Auswirkung, wenn "httpGetEnabled" auf "true" festgelegt ist.

Allerdings antwortet WCF auch auf WS-MetadataExchange-Anforderungen mit WSDL, die zum Beschreiben eines Diensts generiert werden. ASP.NET-Webdienste verfügen über keine integrierte Unterstützung für WS-MetadataExchange-Anforderungen.

Für die WSDL, die WCF generiert, stehen umfassende Anpassungsoptionen zur Verfügung. Die ServiceMetadataBehavior-Klasse bietet einige Funktionen zum Anpassen der WSDL. WCF kann auch so konfiguriert werden, dass WSDL nicht generiert wird, sondern an einer angegebenen URL eine statische WSDL-Datei verwendet wird.

<behaviors>  
     <behavior name="DescriptionBehavior">  
     <metadataPublishing   
      enableMetadataExchange="true"   
      enableGetWsdl="true"   
      enableHelpPage="true"   
      metadataLocation=  
      "http://localhost/DerivativesCalculatorService/Service.WSDL"/>  
     </behavior>  
</behaviors>  

Ausnahmebehandlung

In ASP.NET-Webdiensten werden nicht behandelte Ausnahmen den Clients als SOAP-Fehler zurückgegeben. Sie können auch explizit Instanzen der SoapException-Klasse auslösen und eine größere Kontrolle über den Inhalt des SOAP-Fehlers erlangen, der an den Client übertragen wird.

In WCF-Diensten werden unbehandelte Ausnahmen an Clients nicht als SOAP-Fehler zurückgegeben, um das unbeabsichtigte Verfügbarmachen vertraulicher Informationen aufgrund der Ausnahmen zu verhindern. Mit einer Konfigurationseinstellung werden nicht behandelte Ausnahmen zu Debugging-Zwecken an Clients zurückgegeben.

Sollen SOAP-Fehler an Clients zurückgegeben werden, können Instanzen des generischen Typs (FaultException<TDetail>) unter Verwendung des Datenvertragstyps als generischem Typ ausgelöst werden. Sie können auch FaultContractAttribute-Attribute Vorgängen hinzufügen, um die Fehler anzugeben, die sich aus einem Vorgang ergeben können.

[DataContract]  
public class MathFault  
{   
     [DataMember]  
     public string operation;  
     [DataMember]  
     public string problemType;  
}  

[ServiceContract]  
public interface ICalculator  
{  
     [OperationContract]  
     [FaultContract(typeof(MathFault))]  
     int Divide(int n1, int n2);  
}  

Dies führt dazu, dass mögliche Fehler in der WSDL für den Dienst angekündigt werden und Clientprogrammierer somit vorab wissen, welche Fehler sich aus einem Vorgang ergeben können. Auf Grundlage dieser Ankündigung haben die Programmierer die Möglichkeit, geeignete catch-Anweisungen zu verfassen.

try  
{  
     result = client.Divide(value1, value2);  
}  
catch (FaultException<MathFault> e)  
{  
 Console.WriteLine("FaultException<MathFault>: Math fault while doing "   
  + e.Detail.operation   
  + ". Problem: "   
  + e.Detail.problemType);  
}  

Zustandsverwaltung

Die Klasse, mit der ein ASP.NET-Webdienst implementiert wird, wird möglicherweise von WebService abgeleitet.

public class Service : WebService, IEcho  
{  

 public string Echo(string input)  
 {  
  return input;  
 }  
}  

In diesem Fall kann die Klasse so programmiert werden, dass sie die WebService-Kontexteigenschaft der Basisklasse für den Zugriff auf ein HttpContext-Objekt verwendet. Mit dem HttpContext-Objekt können Anwendungszustandsinformationen durch Verwendung der Anwendungseigenschaft aktualisiert und abgerufen werden. Außerdem können Sitzungszustandsinformationen durch Verwendung der Sitzungseigenschaft aktualisiert und abgerufen werden.

ASP.NET bietet umfassende Funktionen zur Bestimmung des tatsächlichen Speicherorts der Sitzungszustandsinformationen, auf die mithilfe der Sitzungseigenschaft von HttpContext zugegriffen wird. Die Informationen können in Cookies, einer Datenbank, im Speicher des aktuellen Servers oder im Speicher eines festgelegten Servers gespeichert sein. Die Auswahl wird in der Konfigurationsdatei des Diensts getroffen.

WCF stellt erweiterbare Objekte für die Zustandsverwaltung bereit. Erweiterbare Objekte sind Objekte, mit denen IExtensibleObject<T> implementiert wird. Die wichtigsten erweiterbaren Objekte sind ServiceHostBase und InstanceContext. ServiceHostBase ermöglicht die Beibehaltung des Zustands, auf den alle Instanzen aller Diensttypen auf demselben Host zugreifen können, während InstanceContext das Beibehalten des Zustands ermöglicht, auf den mit jedem Code, der in derselben Instanz eines Diensttyps ausgeführt wird, zugegriffen werden kann.

Hier verfügt der Diensttyp (TradingSystem) über ein ServiceBehaviorAttribute, das angibt, dass alle Aufrufe von derselben WCF-Clientinstanz an dieselbe Instanz des Diensttyps weitergeleitet werden.

[ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)]  
public class TradingSystem: ITradingService  

Die Klasse (DealData) definiert den Zustand, auf den mit jedem Code, der in derselben Instanz eines Diensttyps ausgeführt wird, zugegriffen wird.

internal class DealData: IExtension<InstanceContext>  
{  
 public string DealIdentifier = null;  
 public Trade[] Trades = null;  
}  

Im Code des Diensttyps, mit dem einer der Vorgänge des Dienstvertrags implementiert wird, wird ein DealData-Statusobjekt dem Zustand der aktuellen Instanz des Diensttyps hinzugefügt.

string ITradingService.BeginDeal()  
{  
 string dealIdentifier = Guid.NewGuid().ToString();  
 DealData state = new DealData(dealIdentifier);  
 OperationContext.Current.InstanceContext.Extensions.Add(state);  
 return dealIdentifier;  
}  

Das Statusobjekt kann anschließend mit dem Code abgerufen und geändert werden, der einen anderen Dienstvertragsvorgang implementiert.

void ITradingService.AddTrade(Trade trade)  
{  
 DealData dealData =  OperationContext.Current.InstanceContext.Extensions.Find<DealData>();  
 dealData.AddTrade(trade);  
}  

ASP.NET ermöglicht die Bestimmung des tatsächlichen Speicherorts der Zustandsinformationen in der HttpContext-Klasse. Bei WCF ist zumindest in der Ausgangsversion keine Bestimmung des Speicherorts von erweiterbaren Objekten möglich. Dies stellt den besten Grund dar, den ASP.NET-Kompatibilitätsmodus für einen WCF-Dienst auszuwählen. Sofern eine konfigurierbare Zustandsverwaltung erforderlich ist, können Sie mit dem ASP.NET-Kompatibilitätsmodus die Funktionen der HttpContext-Klasse genau entsprechend ihrer Verwendung in ASP.NET nutzen und zudem den Speicherort der Zustandsinformationen konfigurieren, die mithilfe der HttpContext-Klasse verwaltet werden.

Sicherheit

Die Optionen für das Sichern der ASP.NET-Webdienste stimmen mit den Optionen für das Sichern einer beliebigen IIS-Anwendung überein. Da WCF-Anwendungen nicht nur innerhalb von IIS, sondern auch innerhalb einer beliebigen .NET-Ausführdatei gehostet werden können, müssen die Optionen für das Sichern von WCF-Anwendungen unabhängig von den Funktionen von IIS gemacht werden. Allerdings stehen die für ASP.NET-Webdienste bereitgestellten Funktionen auch für WCF-Dienste zur Verfügung, die im ASP.NET-Kompatibilitätsmodus ausgeführt werden.

Sicherheit: Authentifizierung

IIS bietet Funktionen für die Steuerung des Zugriffs auf Anwendungen, mit denen Sie entweder anonymen Zugriff oder eine Reihe von Authentifizierungsmodi auswählen können: Windows-Authentifizierung, Digestauthentifizierung, Standardauthentifizierung und .NET Passport-Authentifizierung. Die Option Windows-Authentifizierung kann verwendet werden, um Zugriff auf ASP.NET-Webdienste zu steuern. Werden die WCF-Anwendungen jedoch in IIS gehostet, muss IIS dafür konfiguriert werden, anonymen Zugriff auf die Anwendung zu gestatten, damit die Authentifizierung von WCF selbst verwaltet werden kann, das neben zahlreichen anderen Optionen auch Windows-Authentifizierung unterstützt. Zu den anderen integrierten Optionen zählen Benutzernamentoken, X.509-Zertifikate, SAML-Token und CardSpace-Karten, doch es können auch benutzerdefinierte Authentifizierungsmechanismen definiert werden.

Sicherheit: Identitätswechsel

ASP.NET verfügt über ein Identitätselement, mit dem ein ASP.NET-Webdienst für das Durchführen von Identitätswechseln konfiguriert werden kann, und zwar für einen bestimmten Benutzer oder einen beliebigen Benutzer, für den in der aktuellen Anforderung Anmeldeinformationen angegeben werden. Mit diesem Element können Identitätswechsel in WCF-Anwendungen, die im ASP.NET-Kompatibilitätsmodus ausgeführt werden, konfiguriert werden.

Das WCF-Konfigurationssystem verfügt über ein eigenes Identitätselement, mit dem ein bestimmter Benutzer festgelegt wird, für den ein Identitätswechsel vorgenommen werden soll. Außerdem können WCF-Clients und -Dienste unabhängig für Identitätswechsel konfiguriert werden. Clients können dafür konfiguriert werden, für den aktuellen Benutzer beim Übertragen von Anforderungen einen Identitätswechsel durchzuführen.

<behaviors>  
     <behavior name="DerivativesCalculatorClientBehavior">  
      <clientCredentials>  
      <windows allowedImpersonationLevel="Impersonation"/>  
      </clientCredentials>  
     </behavior>  
</behaviors>  

Dienstvorgänge können dafür konfiguriert werden, einen Identitätswechsel für einen beliebigen Benutzer durchzuführen, dessen Anmeldeinformationen in der aktuellen Anforderung angegeben werden.

[OperationBehavior(Impersonation = ImpersonationOption.Required)]  
public void Receive(Message input)  

Sicherheit: Autorisierung mithilfe von Zugriffssteuerungslisten

Mit Zugriffssteuerungslisten (ACLs) kann der Zugriff auf ASMX-Dateien beschränkt werden. Allerdings werden ACLs in WCF-SVC-Dateien ignoriert (mit Ausnahme des ASP.NET-Kompatibilitätsmodus).

Sicherheit: Rollenbasierte Autorisierung

Die Option für Windows-Authentifizierung in IIS kann zusammen mit dem von der ASP.NET-Konfigurationssprache bereitgestellten Autorisierungselement verwendet werden, um rollenbasierte Autorisierung für ASP.NET-Webdienste auf Grundlage der Windows-Gruppen, denen Benutzer zugewiesen sind, zu erleichtern. ASP.NET 2.0 verwendet einen allgemeineren rollenbasierten Autorisierungsmechanismus: Rollenanbieter.

Rollenanbieter sind Klassen, die alle eine Basisschnittstelle für die Abfrage der Rollen, denen ein Benutzer zugewiesen ist, implementieren. Allerdings können diese Informationen mit jedem Rollenanbieter von einer anderen Quelle abgerufen werden. ASP.NET 2.0 verfügt über einen Rollenanbieter zum Abrufen von Rollenzuweisungen von einer Microsoft SQL Server-Datenbank und einen weiteren Rollenanbieter zum Abrufen von Rollenzuweisungen vom Windows Server 2003-Autorisierungs-Manager.

Der Rollenanbietermechanismus kann in jeder .NET-Anwendung unabhängig von ASP.NET verwendet werden (einschließlich einer WCF-Anwendung). Die folgende Beispielkonfiguration einer WCF-Anwendung zeigt, wie die Option zur Verwendung eines ASP.NET-Rollenanbieters mithilfe von ServiceAuthorizationBehavior ausgewählt wird.

<system.serviceModel>  
     <services>  
         <service name="Service.ResourceAccessServiceType"   
             behaviorConfiguration="ServiceBehavior">  
             <endpoint   
              address="ResourceAccessService"   
              binding="wsHttpBinding"   
              contract="Service.IResourceAccessContract"/>  
         </service>  
     </services>  
     <behaviors>  
       <behavior name="ServiceBehavior">  
       <serviceAuthorization principalPermissionMode="UseAspNetRoles"/>  
      </behavior>  
     </behaviors>  
</system.serviceModel>  

Sicherheit: Anspruchbasierte Autorisierung

Eine der wichtigsten Innovationen von WCF ist die weit reichende Unterstützung für das Autorisieren von Zugriff auf geschützte Ressourcen auf Grundlage von Ansprüchen. Ansprüche bestehen beispielsweise aus einem Typ, einem Recht, einem Wert sowie einer Treiberlizenz. Ein Satz von Ansprüchen bezüglich des Trägers wird erstellt. Einer dieser Ansprüche ist das Geburtsdatum des Trägers. Der Typ des Anspruchs ist das Geburtsdatum, wohingegen der Wert des Anspruchs das Geburtsdatum des Treibers ist. Das Recht, das ein Anspruch einem Träger überträgt, gibt an, wozu der Träger den Wert des Anspruchs verwenden kann. Beim Anspruch des Treibergeburtsdatums ist das Recht der Besitz: Der Treiber besitzt dieses Geburtsdatum, kann es jedoch nicht ändern. Anspruchbasierte Autorisierung umfasst rollenbasierte Autorisierung, da Rollen ein Anspruchstyp sind.

Bei der anspruchbasierten Autorisierung wird ein Anspruchsatz mit den Zugriffsanforderungen des Vorgangs verglichen. Dabei wird der Zugriff auf den Vorgang abhängig vom Ergebnis dieses Vergleichs gewährt oder verweigert. In WCF kann eine Klasse, die zum Ausführen anspruchbasierter Autorisierung verwendet werden soll, ein weiteres Mal durch Zuweisen eines Werts zur ServiceAuthorizationManager-Eigenschaft von ServiceAuthorizationBehavior angegeben werden.

<behaviors>  
     <behavior name='ServiceBehavior'>  
     <serviceAuthorization   
     serviceAuthorizationManagerType=  
                   'Service.AccessChecker, Service' />  
     </behavior>  
</behaviors>  

Klassen, die zum Ausführen anspruchsbasierter Autorisierung verwendet werden, müssen von ServiceAuthorizationManager abgeleitet werden, der nur eine Methode zum Überschreiben besitzt (AccessCheck()). WCF ruft diese Methode beim Aufrufen eines Dienstvorgangs auf und stellt ein OperationContext-Objekt bereit, das in der ServiceSecurityContext.AuthorizationContext-Eigenschaft über die Ansprüche des Benutzers verfügt. WCF assembliert die Ansprüche bezüglich des Benutzers von jedem beliebigen vom Benutzer zur Authentifizierung angegebenen Sicherheitstoken. Anschließend ist noch zu bewerten, ob diese Ansprüche für den entsprechenden Vorgang ausreichend sind.

WCF ermöglicht die automatische Assemblierung von Ansprüchen von jeder beliebigen Art von Sicherheitstoken. Dabei handelt es sich um eine überaus bedeutende Innovation, da der auf den Ansprüchen basierende Autorisierungscode vom Authentifizierungsmechanismus vollständig unabhängig gemacht wird. Im Gegensatz dazu ist die Autorisierung mit Zugriffssteuerungslisten oder Rollen in ASP.NET eng an die Windows-Authentifizierung gebunden.

Sicherheit: Vertraulichkeit

Die Vertraulichkeit von Nachrichten, die mit ASP.NET-Webdiensten ausgetauscht werden, kann auf Transportebene dadurch sichergestellt werden, dass die Anwendung in IIS für die Verwendung von Secure Hypertext Transfer Protocol (HTTPS) konfiguriert wird. Dieselbe Maßnahme kann für in IIS gehostete WCF-Anwendungen ergriffen werden. Außerhalb von IIS gehostete WCF-Anwendungen können jedoch ebenfalls für die Verwendung eines sicheren Transportprotokolls konfiguriert werden. Noch wichtiger ist, dass WCF-Anwendungen auch für das Sichern von Nachrichten vor dem Transport konfiguriert werden können (dabei wird das WS-Sicherheitsprotokoll verwendet). Wird nur der Text einer Nachricht mithilfe von WS-Sicherheit gesichert, ist eine vertrauliche Übertragung über Vermittler möglich, bevor das endgültige Ziel erreicht wird.

Globalisierung

Die ASP.NET-Konfigurationssprache ermöglicht das Angeben der Kultur einzelner Dienste. WCF unterstützt diese Konfigurationseinstellung nur im ASP.NET-Kompatibilitätsmodus. Wenn Sie einen WCF-Dienst lokalisieren möchten, der nicht den ASP.NET-Kompatibilitätsmodus verwendet, kompilieren Sie den Dienst in kulturspezifische Assemblys, und verwenden Sie separate kulturspezifische Endpunkte für jede kulturspezifische Assembly.

Siehe auch

Vergleichen von ASP.NET-Webdiensten mit WCF nach Zweck und verwendeten Standards