作法:使用組態檔發行服務的中繼資料

這是兩個使用說明主題的其中一種,示範如何發行 Windows Communication Foundation (WCF) 服務的中繼資料。 有兩種方法可以指定服務發行中繼資料的方式,分別是使用組態檔和使用程式碼。 本主題說明如何使用組態檔發行服務的中繼資料。

警告

本主題將示範以不安全的方法發行中繼資料。 任何用戶端都能從服務擷取中繼資料。 如果您的服務需要以安全的方式發行中繼資料,請參閱 自訂安全中繼資料端點

如需在程式碼中發行中繼資料的詳細資訊,請參閱 如何:使用程式碼發行服務的中繼資料。 發行中繼資料可讓用戶端透過 WS-Transfer GET 要求,或是透過使用 ?wsdl 查詢字串的 HTTP/GET 要求來擷取中繼資料。 若要確定程式碼是否正常運作,請建立基本的 WCF 服務。 為了方便使用,下列程式碼提供基本的自我裝載服務。

using System;  
using System.Runtime.Serialization;  
using System.ServiceModel;  
using System.ServiceModel.Description;  
  
namespace Metadata.Samples  
{  
    [ServiceContract]  
    public interface ISimpleService  
    {  
        [OperationContract]  
        string SimpleMethod(string msg);  
    }  
  
    class SimpleService : ISimpleService  
    {  
        public string SimpleMethod(string msg)  
        {  
            Console.WriteLine("The caller passed in " + msg);  
            return "Hello " + msg;  
        }  
    }  
  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            ServiceHost host = new ServiceHost(typeof(SimpleService),  
                new Uri("http://localhost:8001/MetadataSample"));
            try  
            {  
                // Open the service host to accept incoming calls  
                host.Open();  
  
                // The service can now be accessed.  
                Console.WriteLine("The service is ready.");  
                Console.WriteLine("Press <ENTER> to terminate service.");  
                Console.WriteLine();  
                Console.ReadLine();  
  
                // Close the ServiceHostBase to shutdown the service.  
                host.Close();  
            }  
            catch (CommunicationException commProblem)  
            {  
                Console.WriteLine("There was a communication problem. " + commProblem.Message);  
                Console.Read();  
            }  
        }  
    }  
}  

此服務是透過組態檔設定的自我裝載服務。 下列組態檔將做為起點。

<configuration>  
  <system.serviceModel>  
    <services>  
      <service name="Metadata.Example.SimpleService">  
        <endpoint address=""  
                  binding="basicHttpBinding"  
                  contract="Metadata.Example.ISimpleService" />  
      </service>  
    </services>  
    <behaviors>  
  
    </behaviors>  
  </system.serviceModel>  
</configuration>  

若要使用應用程式組態檔來發行 WCF 服務的中繼資料

  1. 在 App.config 檔案中,於結尾的 </services> 項目之後,建立 <behaviors> 項目。

  2. <behaviors> 元素內新增 <serviceBehaviors> 元素。

  3. <behavior> 項目新增至 <serviceBehaviors> 項目,並指定 name 項目的 <behavior> 屬性值。

  4. <serviceMetadata> 項目加入至 <behavior> 項目。 將 httpGetEnabled 屬性設為 true 並將 policyVersion 屬性設為 Policy15。 httpGetEnabled 允許服務回應由 HTTP GET 要求所提出的中繼資料要求。 policyVersion 會在產生中繼資料時,要求服務符合 WS-Policy 1.5 規定。

  5. behaviorConfiguration 屬性加入至 <service> 項目,並指定 name 項目的 <behavior> 屬性 (於步驟 1 中加入),如下列程式碼範例所示。

    <services>  
      <service  
          name="Metadata.Example.SimpleService"  
          behaviorConfiguration="SimpleServiceBehavior">  
        ...  
      </service>  
    </services>  
    <behaviors>  
      <serviceBehaviors>  
        <behavior name="SimpleServiceBehavior">  
          <serviceMetadata httpGetEnabled="True" policyVersion="Policy15" />  
        </behavior>  
      </serviceBehaviors>  
    </behaviors>  
    
  6. 加入一個或多個 <endpoint> 項目,並將合約設為 IMetadataExchange,如下列程式碼範例所示。

    <services>  
      <service  
          name="Metadata.Example.SimpleService"  
          behaviorConfiguration="SimpleServiceBehavior">  
    
        <endpoint address=""  
                  binding="wsHttpBinding"  
                  contract="Metadata.Example.ISimpleService" />  
    
        <endpoint address="mex"  
                  binding="mexHttpBinding"  
                  contract="IMetadataExchange" />  
      </service>  
    </services>  
    
  7. 針對上一個步驟中加入的中繼資料端點,將 binding 屬性設為下列其中一項:

    • mexHttpBinding (適用 HTTP 發行)。

    • mexHttpsBinding (適用 HTTPS 發行)。

    • mexNamedPipeBinding (適用具名管道發行)。

    • mexTcpBinding (適用 TCP 發行)。

  8. 針對上一個步驟中加入的中繼資料端點,將位址設為與下列項目相等:

    • 如果基底位址與中繼資料繫結相同,則設定空字串以使用主應用程式的基底位址做為發行點。

    • 如果主應用程式具有基底位址,則設為相對位址。

    • 絕對位址。

  9. 建置並執行主控台應用程式。

  10. 使用 Internet Explorer,在此) 範例中流覽至服務 (http://localhost:8001/MetadataSample 的基底位址,並確認已開啟中繼資料發佈。 如果沒有的話,結果頁面上方應該會顯示:「為此服務發行的中繼資料目前停用」。

若要使用預設端點

  1. 若要對使用預設端點的服務設定中繼資料,請在組態檔中指定 ServiceMetadataBehavior (如上一個範例所示),但不要指定任何端點。 組態檔如下所示。

    <configuration>  
      <system.serviceModel>  
        <behaviors>  
          <serviceBehaviors>  
            <behavior name="SimpleServiceBehavior">  
              <serviceMetadata httpGetEnabled="True" policyVersion="Policy12" />  
            </behavior>  
          </serviceBehaviors>  
        </behaviors>  
    
      </system.serviceModel>  
    </configuration>  
    

    因為服務有 ServiceMetadataBehaviorhttpGetEnabled 設為 true,服務已經啟用發行中繼資料,但是因為沒有明確加入端點,所以執行階段加入預設端點。 如需預設端點、繫結和行為的詳細資訊,請參閱簡化的組態WCF 服務的簡化組態

範例

下列程式碼範例顯示基本 WCF 服務的執行,以及發行服務中繼資料的設定檔。

using System;  
using System.Runtime.Serialization;  
using System.ServiceModel;  
using System.ServiceModel.Description;  
  
namespace Metadata.Samples  
{  
    [ServiceContract]  
    public interface ISimpleService  
    {  
        [OperationContract]  
        string SimpleMethod(string msg);  
    }  
  
    class SimpleService : ISimpleService  
    {  
        public string SimpleMethod(string msg)  
        {  
            Console.WriteLine("The caller passed in " + msg);  
            return "Hello " + msg;  
        }  
    }  
  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            ServiceHost host = new ServiceHost(typeof(SimpleService),  
                new Uri("http://localhost:8001/MetadataSample"));
            try  
            {  
                // Open the service host to accept incoming calls  
                host.Open();  
  
                // The service can now be accessed.  
                Console.WriteLine("The service is ready.");  
                Console.WriteLine("Press <ENTER> to terminate service.");  
                Console.WriteLine();  
                Console.ReadLine();  
  
                // Close the ServiceHostBase to shutdown the service.  
                host.Close();  
            }  
            catch (CommunicationException commProblem)  
            {  
                Console.WriteLine("There was a communication problem. " + commProblem.Message);  
                Console.Read();  
            }  
        }  
    }  
}  
<configuration>  
  <system.serviceModel>  
    <behaviors>  
      <serviceBehaviors>  
        <behavior name="SimpleServiceBehavior">  
          <serviceMetadata httpGetEnabled="True" policyVersion="Policy12" />  
          <serviceDebug includeExceptionDetailInFaults="False" />  
        </behavior>  
      </serviceBehaviors>  
    </behaviors>  
  </system.serviceModel>  
</configuration>  

另請參閱