Bedingtes GET und PUT

In diesem Beispiel wird veranschaulicht, wie die neuen bedingten Abruf- und Aktualisierungs-APIs für das WCF REST-Programmiermodell verwendet werden. Da sich bedingte Abrufe und Aktualisierungen am besten für ressourcenorientierte und REST-Dienste eignen, wird in diesem Beispiel das Einfacher Ressourcendienst-Beispiel erweitert. In diesem Beispiel wird in erster Linie das Hinzufügen der Unterstützung für bedingtes Abrufen und Aktualisieren zum Einfacher Ressourcendienst-Beispiel mithilfe der neuen APIs in .NET Framework, Version 4 behandelt.

Veranschaulicht

Bedingtes Abrufen und Aktualisieren

Diskussion

Der WCF-Dienst in diesem Beispiel macht eine Auflistung der Kunden auf ressourcenorientierte und REST-Weise verfügbar. Eine ausführliche Beschreibung der Dienstimplementierung finden Sie im Beispiel Einfacher Ressourcendienst.

In diesem Beispiel werden bedingte Abruf- und Aktualisierungsfunktionen zum Einfacher Ressourcendienst-Beispiel hinzugefügt. Die bedingten Abruf- und Aktualisierungsfunktionen überprüfen mithilfe der HTTP-Entitätstags und der HTTP-Header If-None-Match und If-Match, dass Clients entweder über die aktuellste Entität für eine angegebene Ressource verfügen oder nicht. Die Implementierung des Codes zum ordnungsgemäßen Analysieren der HTTP-Header If-None-Match und If-Match kann sich jedoch als mühsam und fehleranfällig erweisen. Aus diesem Grund wurden die Methoden CheckConditionalRetrieve und CheckConditionalUpdate zu IncomingWebRequestContext hinzugefügt, auf die über die aktuelle WebOperationContext-Instanz zugegriffen werden kann. Darüber hinaus wurde die SetETag-Methode zu OutgoingWebRequestContext hinzugefügt, sodass es einfacher ist, gültige Entitätstags zurückzugeben.

Die CheckConditionalRetrieve-Methode ist für die Verwendung mit [WebGet]-Vorgängen bestimmt. Das aktuelle Entitätstag wird für die angegebene Ressource als entityTag-Parameter verwendet. Dabei kann es sich um string, int, long oder Guid handeln. Die CheckConditionalRetrieve-Methode vergleicht das Entitätstag mit dem HTTP-Header If-None-Match der Anforderung. Wenn das Entitätstag im HTTP-Header If-None-Match vorhanden ist, wird eine WebFaultException mit dem Statuscode 304 (Nicht geändert) ausgelöst; andernfalls gibt die Methode einen Wert zurück. Der bedingte Abrufmechanismus ermöglicht es dem Client, dem Server mitzuteilen, dass er über diese Entität verfügt, und dass die aktuelle Entität nur gesendet werden soll, wenn sie der Client nicht bereits hat. Beispiele für die Nutzung der CheckConditionalRetrieve-Methode sind in den Vorgängen GetCustomer und GetCustomers des Diensts zu finden. Wichtig: Aufrufe der CheckConditionalRetrieve-Methode geben möglicherweise keinen Wert zurück. Entwickler sollten den Vorgang so implementieren, dass die Anforderung bereits vor dem Aufruf von CheckConditionalRetrieve als erfolgreich angesehen wird, damit der Dienst eine Antwort mit erfolgreichem Statuscode senden würde, auch wenn der Aufruf von CheckConditionalRetrieve nicht vorhanden wäre.

Die CheckConditionalUpdate-Methode ähnelt der CheckConditionalRetrieve-Methode. Sie verwendet auch das aktuelle Entitätstag für die angegebene Ressource. Sie ist jedoch für die Verwendung mit [WebInvoke]-Vorgängen gedacht, in denen die Methode auf "PUT" oder "DELETE" festgelegt ist. Die CheckConditionalUpdate-Methode vergleicht das Entitätstag mit dem HTTP-Header If-Match der Anforderung. Wenn das Entitätstag im HTTP-Header If-Match nicht vorhanden ist, wird eine WebFaultException mit dem Statuscode 412 (Vorbedingungsfehler) ausgelöst. Der bedingte Aktualisierungsmechanismus ermöglicht es dem Client, dem Server mitzuteilen, dass er über diese Entität für die Ressource verfügt und dass nur er die Ressource ändern kann, vorausgesetzt dass er über die aktuelle Entität verfügt. Beispiele für die Nutzung der CheckConditionalUpdate-Methode sind in den Vorgängen UpdateCustomer und DeleteCustomer des Diensts zu finden. Wie bei der CheckConditionalRetrieve-Methode sollte auch hier beachtet werden, dass Aufrufe der CheckConditionalUpdate-Methode möglicherweise keinen Wert zurückgeben. Entwickler sollten den Vorgang so implementieren, dass die Anforderung bereits vor dem Aufruf von CheckConditionalUpdate als erfolgreich angesehen wird, damit der Dienst eine Antwort mit erfolgreichem Statuscode senden würde, auch wenn der Aufruf von CheckConditionalUpdate nicht vorhanden wäre.

Das Beispiel umfasst einen selbst gehosteten Dienst und einen Client, der in einer Konsolenanwendung ausgeführt wird. Während die Konsolenanwendung ausgeführt wird, sendet der Client Anforderungen an den Dienst und schreibt die in den Antworten enthaltenen wichtigen Informationen in das Konsolenfenster.

So führen Sie das Beispiel aus

1. Öffnen Sie die Projektmappe für das bedingte Get- und Put-Beispiel. Sie müssen Visual Studio 2010 als Administrator ausführen, damit das Beispiel erfolgreich ausgeführt werden kann. Klicken Sie dazu mit der rechten Maustaste auf das Visual Studio 2010-Symbol, und wählen Sie im Kontextmenü die Option Als Administrator ausführen aus.

2. Drücken Sie F6, um die Projektmappe zu erstellen, und dann STRG+F5, um das Konsolenanwendungsprojekt auszuführen. Wenn bei der Ausführung dieses Projekts Debuggen aktiviert ist, (durch Drücken von F5 statt STRG+F5), wird der Debugger beendet, wenn durch die bedingte GET und PUT-Überprüfung eine Ausnahme ausgelöst wird. Drücken Sie in dem Fall F5, um mit der Ausführung des Beispiels fortzufahren.

3. Im eingeblendeten Konsolenfenster werden der URI des ausgeführten Diensts und der URI der HTML-Hilfeseite für den ausgeführten Dienst angezeigt.

4. Während das Beispiel ausgeführt wird, sendet der Client Anforderungen an den Dienst und schreibt die Antworten in das Konsolenfenster.

5. Drücken Sie eine beliebige Taste, um das Beispiel zu beenden.

Hinweis:

Die Beispiele sind möglicherweise bereits auf dem Computer installiert. Überprüfen Sie das folgende (standardmäßige) Verzeichnis, bevor Sie fortfahren. <Installationslaufwerk>:\WF_WCF_Samples Wenn dieses Verzeichnis nicht vorhanden ist, rufen Sie Windows Communication Foundation (WCF) and Windows Workflow Foundation (WF) Samples for .NET Framework 4 auf, um alle Windows Communication Foundation (WCF)- und WF-Beispiele herunterzuladen. Dieses Beispiel befindet sich im folgenden Verzeichnis. <Installationslaufwerk>:\WF_WCF_Samples\WCF\Basic\Web\ConditionalGetAndPut