Generieren eines WCF-Clients oder WCF-Dienstvertrags für SQL Server-Elemente

Artikel
10/14/2023

Sie können das Visual Studio-Plug-In Adapterdienstverweis hinzufügen verwenden, um eine WCF-Clientklasse für ausgewählte Vorgänge für SQL Server Artefakte zu generieren. Sie können auch das ServiceModel Metadata Utility Tool (svcutil.exe) verwenden, um die WCF-Clientklasse zu generieren. Das Add Adapter Service Reference Plug-In macht jedoch die Funktionalität des ServiceModel Metadata Utility Tools über eine Standardmäßige Microsoft Windows-Schnittstelle verfügbar. Es bietet auch Such- und Suchfunktionen, die mit dem svcutil.exe-Tool nicht verfügbar sind, und generiert eine Konfigurationsdatei basierend auf den Bindungseigenschaften, die Sie auswählen, wenn Sie eine Verbindung mit der SQL Server-Datenbank herstellen.

Generieren einer WCF-Clientklasse mithilfe des Add Adapter Service Reference Plug-In

Führen Sie die folgenden Schritte aus, um eine WCF-Clientklasse mithilfe des Adapterdienstverweis-Plug-Ins hinzufügen zu generieren.

Klicken Sie in Visual Studio Projektmappen-Explorer mit der rechten Maustaste auf Ihr Projekt, und klicken Sie dann auf Adapterdienstverweis hinzufügen.
Nachdem das Dialogfeld Adapterdienstverweis hinzufügen geöffnet wird, führen Sie die Schritte unter Abrufen von Metadaten für SQL Server Vorgänge in Visual Studio mithilfe des SQL-Adapters zum Herstellen einer Verbindung mit SQL Server und zum Durchsuchen und Suchen nach Vorgängen aus. Um eine WCF-Clientklasse für die ausgewählten Vorgänge zu erstellen, stellen Sie sicher, dass Client (Ausgehende Vorgänge) in der Dropdownliste Vertragstyp auswählen ausgewählt ist. (Dies ist die Standardeinstellung).
Nachdem Sie alle Vorgänge ausgewählt haben, die Sie als Ziel verwenden möchten, klicken Sie auf OK , um die WCF-Clientklasse zu generieren.

Das Add Adapter Service Reference Plug-In fügt Ihrem Projekt zwei Dateien hinzu:

Die WCF-Clientcodedatei. Diese Datei enthält die generierte WCF-Clientklasse und den Hilfscode für die ausgewählten Vorgänge. Bei der ersten Ausführung des Visual Studio-Plug-Ins Adapterdienstverweis hinzufügen wird diese Datei mit dem Standardnamen SQLAdapterBindingClient.cs generiert. Wenn Sie es erneut ausführen, wird die nächste generierte Datei als SQLAdapterBindingClient1.cs bezeichnet. Das Zahlensuffix wird für jede neue Datei, die Sie generieren, um 1 erhöht. Sie können auch das Standardpräfix SQLBinding ändern, indem Sie ein anderes Präfix in das Feld Dateipräfix des Visual Studio-Plug-Ins Adapterdienstverweis hinzufügen eingeben, bevor Sie OK auswählen, um die Datei zu generieren.
App.config. Diese Datei enthält eine Bindungskonfiguration und Clientendpunktkonfigurationen, die auf den Auswahlen basieren, die Sie beim Konfigurieren der Verbindung für das Add Adapter Service Reference Plug-In vorgenommen haben.

Wichtig

Wenn Sie beim Verwenden des Add Adapter Service Reference Plug-In keinen Wert für eine Bindungseigenschaft vom Typ Zeichenfolge angeben und deren Standardwert NULL ist, ist diese Bindungseigenschaft in der app.config-Datei nicht verfügbar. Sie müssen die Bindungseigenschaft und ihren Wert bei Bedarf manuell in der app.config-Datei hinzufügen.

Generieren eines WCF-Dienstvertrags mithilfe des Add Adapter Service Reference Plug-In

Bei eingehenden Vorgängen, z. B. abfragen der SQL Server-Datenbank oder Empfangen von Benachrichtigungen aus der Datenbank, führt der SQL-Adapter entweder eine von der Clientanwendung angegebene Abfrage aus (im Falle einer Abfrage) oder registriert eine Abfrage bei SQL Server (im Falle einer Benachrichtigung). In beiden Szenarien sendet der Adapter die eingehende Nachricht von SQL Server Datenbank an die nutzende Datenbank. In diesem Fall fungiert die verwendende Anwendung als Dienst, und der SQL-Adapter fungiert als Client. Sie müssen daher einen WCF-Dienst implementieren, der eingehende Vorgänge vom Adapter empfangen kann. Dazu verwenden Sie das Add Adapter Service Reference Plug-In, um eine .NET-Schnittstelle zu generieren, die den Dienstvertrag darstellt, der vom Adapter für die eingehenden Vorgänge angezeigt wird. Diese .NET-Schnittstelle wird auch als WCF-Dienstvertrag bezeichnet. Anschließend implementieren Sie diese Schnittstelle, um den WCF-Dienst zu erstellen, mit dem Sie die eingehenden Vorgänge empfangen können.

Führen Sie die folgenden Schritte aus, um einen WCF-Dienstvertrag mithilfe des Adapterdienstverweis-Plug-Ins hinzufügen zu generieren.

So generieren Sie einen WCF-Dienstvertrag für eingehende Vorgänge

Klicken Sie in Visual Studio Projektmappen-Explorer mit der rechten Maustaste auf Ihr Projekt, und klicken Sie dann auf Adapterdienstverweis hinzufügen.
Nachdem das Dialogfeld Adapterdienstverweis hinzufügen geöffnet wird, führen Sie die Schritte unter Herstellen einer Verbindung mit SQL Server in Visual Studio mithilfe des Adapterdienstverweis-Plug-Ins zum Herstellen einer Verbindung mit der SQL Server-Datenbank aus.

Wichtig

Wenn Sie einen WCF-Dienstvertrag für den eingehenden TypedPolling-Vorgang generieren, müssen Sie die InboundID als Teil des Verbindungs-URI und der PollingStatement-Bindungseigenschaft angeben.
Nachdem Sie eine Verbindung mit der SQL Server-Datenbank hergestellt haben, wählen Sie in der Dropdownliste Vertragstyp auswählen die Option Dienst (Eingehende Vorgänge) aus.
Klicken Sie im Feld Kategorie auswählen auf den Stammknoten (/), wählen Sie im Feld Verfügbare Kategorien und Vorgänge den eingehenden Vorgang aus, und klicken Sie dann auf Hinzufügen.
Klicken Sie auf OK, um den WCF-Dienstvertrag für den eingehenden Vorgang zu generieren.

Das Add Adapter Service Reference Plug-In fügt Ihrem Projekt drei Dateien hinzu:

SqlAdapterBindingInterface.cs. Diese Datei enthält den generierten WCF-Dienstvertrag (Schnittstelle) und Hilfscode für den eingehenden Vorgang.
SqlAdapterBindingService.cs. Diese Datei enthält eine Klasse, die die in SqlAdapterBindingInterface.cs definierte Schnittstelle implementiert. Sie können die Geschäftslogik implementieren, die die vom eingehenden Vorgang zurückgegebenen Datensätze verarbeitet.
app.config. Diese Datei enthält eine Bindungskonfiguration, Endpunktverhalten und Dienstendpunktkonfiguration, die auf den Auswahlen basieren, die Sie beim Konfigurieren der Bindung und Verbindung für das Add Adapter Service Reference Plug-In vorgenommen haben.

Wichtig

Wenn Sie beim Verwenden des Add Adapter Service Reference Plug-In keinen Wert für eine Bindungseigenschaft vom Typ Zeichenfolge angeben und deren Standardwert NULL ist, ist diese Bindungseigenschaft in der app.config-Datei nicht verfügbar. Sie müssen die Bindungseigenschaft und ihren Wert bei Bedarf manuell in der app.config-Datei hinzufügen.

Generieren einer WCF-Clientklasse mithilfe von svcutil.exe

Sie können svcutil.exe verwenden, um eine WCF-Clientklasse für Ihre Anwendung zu generieren. Sie müssen svcutil.exe für die Verwendung mit dem SQL-Adapter konfigurieren.

Svcutil.exe generiert die WCF-Clientklasse in einer Ausgabedatei mit dem Standarddateinamen output.cs. Sie müssen diese Datei manuell in Ihr Visual Studio-Projekt einschließen. Weitere Informationen zu svcutil.exe finden Sie unter ServiceModel Metadata Utility Tool (Svcutil.exe).

Weitere Informationen

Entwickeln von SQL-Anwendungen mithilfe des WCF-Dienstmodells

Freigeben über