Konfigurieren von Diensten mit Konfigurationsdateien

  • Artikel

Das Konfigurieren eines WCF-Diensts (Windows Communication Foundation) mit einer Konfigurationsdatei bietet Ihnen eine flexible Möglichkeit, Daten zum Endpunkt- und Dienstverhalten während der Bereitstellung anstatt zur Entwurfszeit bereitzustellen. Dieses Thema beschreibt die dafür verfügbaren grundlegenden Verfahren.

Ein WCF-Dienst kann mithilfe der .NET Framework-Konfigurationstechnologie konfiguriert werden. Am häufigsten werden der Web.config-Datei für eine Internetinformationsdienste-Website (IIS), die einen WCF-Dienst hostet, XML-Elemente hinzugefügt. Mithilfe der Elemente können Sie Details ändern, zum Beispiel die Endpunktadressen (die eigentlichen für die Kommunikation mit dem Dienst verwendeten Adressen) für einzelne Computer. Zusätzlich umfasst WCF mehrere vom System bereitgestellte Elemente, mit deren Hilfe Sie schnell die grundlegendsten Funktionen für einen Dienst auswählen können. Ab .NET Framework 4 stellt WCF ein neues Standardkonfigurationsmodell bereit, das die WCF-Konfigurationsanforderungen vereinfacht. Wenn Sie keine WCF-Konfiguration für einen bestimmten Dienst bereitstellen, konfiguriert die Runtime den Dienst automatisch mit Standardendpunkten, -bindungen und -verhalten. In der Praxis ist das Schreiben einer Konfiguration ein wesentlicher Bestandteil beim Programmieren von WCF-Anwendungen.

Weitere Informationen finden Sie unter Konfigurieren von Bindungen für Dienste. Informationen zu den am häufigsten verwendeten Elementen finden Sie unter Vom System bereitgestellte Bindungen. Weitere Informationen über Standardendpunkte, Bindungen und Verhalten finden Sie unter Simplified Configuration (Vereinfachte Konfiguration) und Simplified Configuration for WCF Services (Vereinfachte Konfiguration für WCF-Dienste).

Wichtig

Beim Bereitstellen paralleler Szenarien, in denen zwei verschiedene Versionen eines Diensts bereitgestellt werden, müssen bei Verweisen in Konfigurationsdateien partielle Assemblynamen angegeben werden. Dies liegt daran, dass die Konfigurationsdatei gemeinsam von allen Versionen eines Diensts verwendet wird und dass diese Dienste ggf. unter unterschiedlichen Versionen von .NET Framework ausgeführt werden.

System.Configuration: Web.config und App.config

WCF verwendet das Konfigurationssystem „System.Configuration“ von .NET Framework.

Verwenden Sie für die Konfiguration eines Diensts in Visual Studio entweder eine Web.config- oder App.config-Datei, um die Einstellungen anzugeben. Die Wahl der Konfigurationsdatei wird durch die Hostumgebung des Diensts bestimmt. Wenn Sie den Dienst in IIS hosten, verwenden Sie eine Web.config-Datei. Bei einer anderen Hostumgebung verwenden Sie eine App.config-Datei.

In Visual Studio wird die App.config-Datei verwendet, um die endgültige Konfigurationsdatei zu erstellen. Der tatsächlich für die Konfigurationsdatei verwendete Name hängt vom Assemblynamen ab. Einer Assembly mit dem Namen "Cohowinery.exe" ist beispielsweise die Konfigurationsdatei namens "Cohowinery.exe.config" zugeordnet. Sie müssen jedoch nur die Datei App.config ändern. An dieser Datei vorgenommene Änderungen werden bei der Kompilierung automatisch an die tatsächliche Anwendungskonfigurationsdatei weitergegeben.

Bei Verwendung einer App.config-Datei führt das Konfigurationssystem den Inhalt dieser Datei mit dem Inhalt der Datei Machine.config zusammen, sobald die Anwendung gestartet und die Konfiguration übernommen wird. Dieser Mechanismus ermöglicht es, computerweite Einstellungen in der Datei Machine.config zu definieren. Die Datei App.config kann verwendet werden, um Einstellungen in der Datei Machine.config zu überschreiben. Sie können Einstellungen in der Datei Machine.config aber auch sperren, sodass diese verwendet werden. Im Fall der Datei Web.config führt das Konfigurationssystem den Inhalt aller Web.config-Dateien in allen Verzeichnissen zur schließlich verwendeten Konfiguration im Anwendungsverzeichnis zusammen. Weitere Informationen zur Konfiguration und Priorität der Einstellungen finden Sie in den Themen zum System.Configuration-Namespace.

Hauptabschnitte der Konfigurationsdatei

Die Hauptabschnitte der Konfigurationsdatei umfassen folgende Elemente:

<system.ServiceModel>

   <services>
   <!-- Define the service endpoints. This section is optional in the new
    default configuration model in .NET Framework 4. -->
      <service>
         <endpoint/>
      </service>
   </services>

   <bindings>
   <!-- Specify one or more of the system-provided binding elements,
    for example, <basicHttpBinding> -->
   <!-- Alternatively, <customBinding> elements. -->
      <binding>
      <!-- For example, a <BasicHttpBinding> element. -->
      </binding>
   </bindings>

   <behaviors>
   <!-- One or more of the system-provided or custom behavior elements. -->
      <behavior>
      <!-- For example, a <throttling> element. -->
      </behavior>
   </behaviors>

</system.ServiceModel>

Hinweis

Die Bindungs- und Verhaltensabschnitte sind optional und nur bei Bedarf enthalten.

Das <services>-Element

Das services -Element enthält die Spezifikationen aller Dienste, die die Anwendung hostet. Wenn das vereinfachte Konfigurationsmodell in .NET Framework 4 verwendet wird, ist dieser Abschnitt optional.

<services>

Das <service>-Element

Jeder Dienst verfügt über diese Attribute:

  • name. Gibt den Typ an, der eine Implementierung eines Dienstvertrags bereitstellt. Dies ist ein vollqualifizierter Name, der aus dem Namespace und einem Punkt gefolgt von dem Typnamen besteht. Beispiel: "MyNameSpace.myServiceType".

  • behaviorConfiguration. Gibt den Namen eines behavior -Elements an, das im behaviors -Element gefunden wurde. Das angegebene Verhalten steuert Aktionen, beispielsweise ob der Dienst Identitätswechsel erlaubt. Wenn der Wert ein leerer Name oder kein behaviorConfiguration ist, wird dem Dienst der Standardsatz von Dienstverhalten hinzugefügt.

  • <service>

Das <endpoint>-Element

Jeder Endpunkt benötigt eine Adresse, eine Bindung und einen Vertrag. Diese Elemente werden durch die folgenden Attribute dargestellt:

  • address. Gibt den Uniform Resource Identifier (URI) des Diensts an. Er kann als absolute Adresse oder als eine zur Basisadresse des Diensts relative Adresse angegeben werden. Eine leere Zeichenfolge zeigt an, dass der Endpunkt unter der Basisadresse verfügbar ist. Diese Basisadresse wird bei der Erstellung des ServiceHost für den Dienst angegeben.

  • binding. Gibt üblicherweise eine vom System bereitgestellte Bindung, beispielsweise WSHttpBindingan, kann aber auch eine benutzerdefinierte Bindung angeben. Die angegebene Bindung bestimmt, welcher Typ von Transport, Sicherheit und Codierung verwendet wird, und ob zuverlässige Sitzungen, Transaktionen oder Streaming unterstützt werden oder aktiviert sind.

  • bindingConfiguration. Müssen die Standardwerte einer Bindung geändert werden, kann dies geschehen, indem das entsprechende binding -Element im bindings -Element konfiguriert wird. Diesem Attribut sollte derselbe Wert zugewiesen werden, wie dem name -Attribut des binding -Elements, das verwendet wird, um die Standardwerte zu ändern. Wenn kein Name angegeben wird oder kein bindingConfiguration in der Bindung festgelegt ist, wird die Standardbindung des Bindungstyp im Endpunkt verwendet.

  • contract. Gibt die Schnittstelle an, die den Vertrag definiert. Das ist die Schnittstelle, die im CLR-Typ (Common Language Runtime) implementiert ist, der vom name -Attribut des service -Elements angegeben wird.

  • <endpoint>

Das <bindings>-Element

Das bindings -Element enthält die Spezifikationen für alle Bindungen, die von jedem in einem Dienst definierten Endpunkt verwendet werden können.

<bindings>

Das <binding>-Element

Das binding -Elemente, die im bindings -Element enthalten sind, können entweder eine der systemeigenen Bindungen (siehe System-Provided Bindings) oder eine benutzerdefinierte Bindung (siehe Custom Bindings) sein. Das binding -Element verfügt über ein name -Attribut, das eine Beziehung zwischen der Bindung und dem Endpunkt herstellt, der im bindingConfiguration -Attribut des endpoint -Elements angegeben ist. Wenn kein Name angegeben wird, entspricht die Bindung der Standardbindung für diesen Bindungstyp.

Weitere Informationen zum Konfigurieren von Diensten und Clients finden Sie unter Konfigurieren von WCF-Diensten.

<binding>

Das <behaviors>-Element

Dies ist ein Containerelement für die behavior -Elemente, die das Verhalten eines Diensts definieren.

<behaviors>

Das <behavior>-Element

Jedes behavior-Element wird durch ein name-Attribut identifiziert und stellt entweder ein vom System definiertes Verhalten, beispielsweise <throttling>, oder ein benutzerdefiniertes Verhalten bereit. Wenn kein Name angegeben wird, entspricht dieses Verhaltenselement dem standardmäßigen Dienst- oder Endpunktverhalten.

<behavior>

Gewusst wie: Verwenden von Bindungs- und Verhaltenskonfigurationen

WCF erleichtert die gemeinsame Nutzung von Konfigurationen zwischen Endpunkten mithilfe eines Verweissystems in der Konfiguration. Statt einem Endpunkt direkt Konfigurationswerte zuzuweisen, werden bindungsrelevante Konfigurationswerte in bindingConfiguration -Elementen des <binding> -Abschnitts gruppiert. Eine Bindungskonfiguration ist eine benannte Gruppe von Einstellungen einer Bindung. Endpunkte können dann mithilfe des Namens auf eine bindingConfiguration verweisen.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <system.serviceModel>
  <bindings>
    <basicHttpBinding>
     <binding name="myBindingConfiguration1" closeTimeout="00:01:00" />
     <binding name="myBindingConfiguration2" closeTimeout="00:02:00" />
     <binding closeTimeout="00:03:00" />  <!-- Default binding for basicHttpBinding -->
    </basicHttpBinding>
     </bindings>
     <services>
      <service name="MyNamespace.myServiceType">
       <endpoint
          address="myAddress" binding="basicHttpBinding"
          bindingConfiguration="myBindingConfiguration1"
          contract="MyContract"  />
       <endpoint
          address="myAddress2" binding="basicHttpBinding"
          bindingConfiguration="myBindingConfiguration2"
          contract="MyContract" />
       <endpoint
          address="myAddress3" binding="basicHttpBinding"
          contract="MyContract" />
       </service>
      </services>
    </system.serviceModel>
</configuration>

Das name -Attribut der bindingConfiguration wird im <binding> -Element festgelegt. name muss eine eindeutige Zeichenfolge im Bereich des Bindungstyps sein – in diesem Fall <basicHttpBinding> oder ein leerer Wert, um auf die Standardbindung zu verweisen. Der Endpunkt wird mit der Konfiguration verknüpft, indem das bindingConfiguration -Attribut auf diese Zeichenfolge festgelegt wird.

Eine behaviorConfiguration wird genauso implementiert, wie das folgende Beispiel zeigt.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <system.serviceModel>
    <behaviors>
      <endpointBehaviors>
        <behavior name="myBehavior">
           <callbackDebug includeExceptionDetailInFaults="true" />
         </behavior>
      </endpointBehaviors>
      <serviceBehaviors>
        <behavior>
          <serviceMetadata httpGetEnabled="true" />
        </behavior>
      </serviceBehaviors>

    </behaviors>
    <services>
     <service name="NewServiceType">
       <endpoint
          address="myAddress3" behaviorConfiguration="myBehavior"
          binding="basicHttpBinding"
          contract="MyContract" />
      </service>
    </services>
   </system.serviceModel>
</configuration>

Beachten Sie, dass dem Dienst der Standardsatz von Dienstverhalten hinzugefügt wird. Dieses System ermöglicht es Endpunkten, allgemeine Konfigurationen gemeinsam zu verwenden, ohne dass die Einstellungen neu definiert werden müssen. Wenn ein computerweiter Bereich erforderlich ist, erstellen Sie die Bindungs- oder Verhaltenskonfiguration in „Machine.config“. Die Konfigurationseinstellungen sind in allen App.config-Dateien verfügbar. Das Configuration Editor Tool (SvcConfigEditor.exe) macht es leicht, Konfigurationen zu erstellen.

Verhaltenszusammenführung

Die Funktion der Verhaltenszusammenführung erleichtert die Verwaltung von Verhalten, wenn eine Reihe allgemeiner Verhalten einheitlich verwendet werden soll. Mithilfe dieser Funktion können Sie Verhalten auf verschiedenen Ebenen der Konfigurationshierarchie angeben und festlegen, dass Dienste Verhalten von verschiedenen Ebenen der Konfigurationshierarchie erben sollen. Dies soll im Folgenden veranschaulicht werden. Angenommen, in IIS ist das folgende Layout virtueller Verzeichnisse gegeben:

~\Web.config~\Service.svc~\Child\Web.config~\Child\Service.svc

Die Datei ~\Web.config hat folgenden Inhalt:

<configuration>
  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <serviceDebug includeExceptionDetailInFaults="True" />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Außerdem ist eine untergeordnete Datei Web.config mit folgendem Inhalt unter ~\Child\Web.config vorhanden:

<configuration>
  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <serviceMetadata httpGetEnabled="True" />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Der Dienst unter ~\Child\Service.svc wird sowohl das serviceDebug-Verhalten als auch das serviceMetadata-Verhalten berücksichtigen. Der Dienst unter ~\Service.svc berücksichtigt lediglich das serviceDebug-Verhalten. Die beiden Verhaltensauflistungen mit demselben Namen (in diesem Fall einer leeren Zeichenfolge) werden zusammengeführt.

Sie können Verhaltensauflistungen auch mit dem <clear>-Tag löschen oder einzelne Verhaltensweisen mit dem <remove>-Tag aus einer Auflistung entfernen. Die folgenden beiden Konfigurationen führen beispielsweise dazu, dass der untergeordnete Dienst lediglich das serviceMetadata-Verhalten verwendet:

<configuration>
  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <remove name="serviceDebug"/>
          <serviceMetadata httpGetEnabled="True" />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

<configuration>
  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <clear/>
          <serviceMetadata httpGetEnabled="True" />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Die Verhaltenszusammenführung erfolgt für unbenannte Verhaltensauflistungen (wie oben veranschaulicht) sowie für benannte Verhaltensauflistungen.

Die Verhaltenszusammenführung funktioniert in der IIS-Hostingumgebung, in der Web.config-Dateien hierarchisch mit der Web.config- und machine.config-Stammdatei zusammengeführt werden. Sie funktioniert aber auch in der Anwendungsumgebung, in der die machine.config-Datei mit der App.config-Datei zusammengeführt werden kann.

Die Verhaltenszusammenführung wird sowohl auf Endpunktverhalten als auch auf Dienstverhalten in der Konfiguration angewendet.

Wenn eine untergeordnete Verhaltensauflistung ein Verhalten enthält, das bereits in der übergeordneten Verhaltensauflistung enthalten ist, wird das übergeordnete Verhalten vom untergeordneten überschrieben. Wenn also eine übergeordnete Verhaltensauflistung <serviceMetadata httpGetEnabled="False" /> und eine untergeordnete Verhaltensauflistung <serviceMetadata httpGetEnabled="True" />enthält, überschreibt das untergeordnete Verhalten das übergeordnete Verhalten in der Verhaltensauflistung, und httpGetEnabled wird auf „true“ festgelegt.

Weitere Informationen