共用方式為

傳輸：UDP

  • 發行項

這個 UDP 傳輸範例示範如何實作做為自訂 Windows Communication Foundation (WCF) 傳輸的 UDP 單點傳送 (Unicast) 和多點傳送 (Multicast)。範例會使用通道架構並遵循 WCF 最佳做法，以說明在 WCF 中建立自訂傳輸的建議程序。建立自訂傳輸的步驟如下：

  1. 決定 ChannelFactory 和 ChannelListener 所要支援的通道Message Exchange Patterns (IOutputChannel、IInputChannel、IDuplexChannel、IRequestChannel 或 IReplyChannel)，然後決定是否要支援這些介面的工作階段變化。

  2. 建立支援「訊息交換模式」的通道處理站和接聽項。

  3. 確認已將所有網路特定例外狀況正規化為適當的 CommunicationException 衍生類別。

  4. 新增 <binding> 項目，而此項目會將自訂傳輸新增至通道堆疊。如需詳細資訊，請參閱Adding a Binding Element。

  5. 新增繫結項目延伸區段，即可將新的繫結項目公開至組態系統。

  6. 新增中繼資料延伸，即可將功能傳達給其他端點。

  7. 新增繫結，此繫結會根據妥善定義的設定檔來預先設定繫結項目的堆疊。如需詳細資訊，請參閱Adding a Standard Binding。

  8. 新增繫結區段和繫結組態項目，即可將繫結公開至組態系統。如需詳細資訊，請參閱Adding Configuration Support。

訊息交換模式

撰寫自訂傳輸時的第一個步驟是決定傳輸所需要的「訊息交換模式」(Message Exchange Patterns，MEP)。您可以從三個 MEP 中選擇：

  • 資料包 (IInputChannel/IOutputChannel)

    當使用資料包 (Datagram) MEP 時，用戶端會使用「射後不理」(Fire and Forget) 交換來傳送訊息。射後不理交換是一種需要以超出範圍之外的方式確認傳遞成功的交換。訊息可能會在傳輸時遺失而永遠無法抵達服務。即使傳送作業在用戶端已成功完成，也無法保證遠端端點已接收到該訊息。資料包是訊息的基本建置組塊，您可以在資料包的最上層建立自己的通訊協定，其中包括可靠的通訊協定和安全的通訊協定。用戶端資料包通道會實作 IOutputChannel 介面，服務資料包通道則會實作 IInputChannel 介面。

  • 要求-回應 (IRequestChannel/IReplyChannel)

    在此 MEP 中，會傳送訊息，而且會接收回覆。此模式是由要求-回應組合所構成。遠端程序呼叫 (Remote Procedure Call，RPC) 與瀏覽器的 GET 就是要求-回應呼叫的例子。這個模式又稱為「半雙工」。在此 MEP 中，用戶端通道會實作 IRequestChannel，服務通道則會實作 IReplyChannel。

  • 雙工 (IDuplexChannel)

    雙工 MEP 會允許用戶端傳送任意數目的訊息，並以任何順序接收這些訊息。雙工 MEP 就像是電話交談，談話中說出的每個字都是一則訊息。由於兩端都可以透過此種 MEP 來傳送和接收訊息，所以由用戶端和服務通道所實作的介面會是 IDuplexChannel。

上述的每個 MEP 都能支援「工作階段」(Session)。工作階段感知通道提供的新增功能可以將通道中傳送及接收的所有訊息相互關聯。因為要求與回覆相互關聯，「要求-回應」模式是一個獨立的兩訊息工作階段。相較之下，支援工作階段的「要求-回應」模式，就意味著該通道上的所有要求/回應組合都是彼此相互關聯的。如此一來，您總共有六種 MEP (資料包、要求-回應、雙工、搭配工作階段的資料包、搭配工作階段的要求-回應以及搭配工作階段的雙工) 可以選擇。

ms751494.note(zh-tw,VS.100).gif注意：
就 UDP 傳輸而言，唯一支援的 MEP 是「資料包」，因為 UDP 原本就是「射後不理」(Fire and Forget) 通訊協定。

ICommunicationObject 和 WCF 物件生命週期

WCF 具有可用於管理物件生命週期的通用狀態機器，例如用於通訊的 IChannel、IChannelFactory 和 IChannelListener。這些通訊物件可能呈現的狀態有五種。這些狀態是由 CommunicationState 列舉表示，如下所述：

  • Created：這是 ICommunicationObject 在初次具現化 (Instantiated) 時的狀態。在這個狀態下不會發生任何輸入/輸出 (I/O)。

  • Opening：呼叫 Open 時物件會轉換至此狀態。此時會將屬性設為不變，並且可以開始輸入/輸出。只有從 Created 狀態轉變過來，這種轉換才算有效。

  • Opened：當開啟處理序完成時，物件會轉換至此狀態。只有從 Opening 狀態轉變過來，這種轉換才算有效。此時，物件完全無法進行傳輸。

  • Closing：當呼叫 Close 以執行非失誤性關機時，物件會轉換至此狀態。只有從 Opened 狀態轉變過來，這種轉換才算有效。

  • Closed：在 Closed 狀態中，物件就不再可供使用。一般來說，大部分組態仍然可供存取以便檢查，但是無法進行任何通訊。這種狀態相當於正在處置。

  • Faulted：在 Faulted 狀態中，物件可供存取以便檢查，但是無法供使用。當發生無法修復的錯誤時，物件會轉換至此狀態。這種狀態只有在轉變到 Closed 狀態時，才算是有效的轉換。

每個狀態轉換都會引發一些事件。Abort 方法可在任何時間加以呼叫，讓物件立即從目前的狀態轉換為 Closed 狀態。呼叫 Abort 會終止任何未完成的工作。

通道處理站和通道接聽項

撰寫自訂傳輸的下一個步驟是，建立用戶端通道的 IChannelFactory 實作以及服務通道的 IChannelListener 實作。通道層會使用建構通道所需的處理站模式。WCF 則會為這個處理序提供基底類別 Helper。

  • CommunicationObject 類別會實作 ICommunicationObject，並強制執行先前在步驟 2 中所述的狀態機器。

  • ChannelManagerBase 類別會實作 CommunicationObject，並為 ChannelFactoryBase 和 ChannelListenerBase 提供統一的基底類別。ChannelManagerBase 類別可以和 ChannelBase 一起運作，而後者是實作 IChannel 的基底類別。

  • ChannelFactoryBase 類別會實作 ChannelManagerBase 和 IChannelFactory，並且將 CreateChannel 多載合併為單一 OnCreateChannel 抽象方法。

  • ChannelListenerBase 類別會實作 IChannelListener。它會負責基礎的狀態管理。

在這個範例中，處理站的實作包含在 UdpChannelFactory.cs 中，而接聽項的實作則包含在 UdpChannelListener.cs 中。IChannel 的實作是在 UdpOutputChannel.cs 和 UdpInputChannel.cs 中。

UDP 通道處理站

UdpChannelFactory 是衍生自 ChannelFactoryBase。範例會覆寫 GetProperty，以提供訊息編碼器之訊息版本的存取權。範例也會覆寫 OnClose，以便在狀態機器進行轉換時卸除 BufferManager 的執行個體。

UDP 輸出通道

UdpOutputChannel 會實作 IOutputChannel。建構函式會驗證引數，並根據傳進的 EndpointAddress 建構目的地 EndPoint 物件。

this.socket = new Socket(this.remoteEndPoint.AddressFamily, SocketType.Dgram, ProtocolType.Udp);

可以依正常程序或非正常程序關閉通道。如果依正常程序關閉通道，將會關閉通訊端，並且會呼叫基底類別 OnClose 方法。如果因此發生例外狀況，則基礎結構會呼叫 Abort，確保已清除通道。

this.socket.Close(0);

接著實作 Send() 和 BeginSend()/EndSend()。這分成兩個主要區段。首先，將訊息序列化為位元組陣列。

ArraySegment<byte> messageBuffer = EncodeMessage(message);

然後在網路上傳送產生的資料。

this.socket.SendTo(messageBuffer.Array, messageBuffer.Offset, messageBuffer.Count, SocketFlags.None, this.remoteEndPoint);

UdpChannelListener

範例實作的 UdpChannelListener 是衍生自 ChannelListenerBase 類別。它會使用單一 UDP 通訊端來接收資料包。OnOpen 方法會透過非同步迴圈的 UDP 通訊端來接收資料，然後透過下列「訊息編碼架構」將資料轉換為訊息。

    message = MessageEncoderFactory.Encoder.ReadMessage(new ArraySegment<byte>(buffer, 0, count), bufferManager);

由於相同的資料包通道代表來自幾個來源的訊息，因此 UdpChannelListener 是單一接聽程式。與此接聽項相關聯的作用中 IChannel 一次最多只有一個。只有當 AcceptChannel 方法所傳回的通道被接著處理後，範例才會產生另一個通道。收到訊息時，就會將它加入此單一通道佇列中。

UdpInputChannel

UdpInputChannel 類別會實作 IInputChannel。它包含由 UdpChannelListener 通訊端所填入的傳入訊息佇列。這些訊息佇列會由 IInputChannel.Receive`` 方法加以清除。

新增繫結項目

既然建置了處理站和通道，就必須透過繫結公開至 ServiceModel 執行階段。繫結是繫結項目的集合，表示與服務位址相關聯的通訊堆疊。堆疊中的每個項目都是由 <binding> 項目表示。

在此範例中，繫結項目為 UdpTransportBindingElement，其衍生自 TransportBindingElement。它會覆寫下列方法來建置與繫結關聯的處理站。

public IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)
{
            return (IChannelFactory<TChannel>)(object)new UdpChannelFactory(this, context);
}

public IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)
{
            return (IChannelListener<TChannel>)(object)new UdpChannelListener(this, context);
}

它還包含可以用來複製 BindingElement 以及傳回我們的結構描述 (soap.udp) 的成員。

新增傳輸繫結項目的中繼資料支援

若要將傳輸整合到中繼資料系統中，必須同時支援匯入與匯出原則。如此一來，就可以透過 ServiceModel 中繼資料公用程式工具 (Svcutil.exe) 產生繫結的用戶端。

新增 WSDL 支援

繫結中的傳輸繫結項目是負責匯出與匯入中繼資料中的定址資訊。當使用 SOAP 繫結時，傳輸繫結項目也應該匯出中繼資料中的正確傳輸 URI。

WSDL 匯出

若要匯出定址資訊，UdpTransportBindingElement 會實作 IWsdlExportExtension 介面。ExportEndpoint 方法會新增正確的定址資訊至 WSDL 連接埠。

if (context.WsdlPort != null)
{
    AddAddressToWsdlPort(context.WsdlPort, context.Endpoint.Address, encodingBindingElement.MessageVersion.Addressing);
}

當端點使用 SOAP 繫結時，ExportEndpoint 方法的 UdpTransportBindingElement 實作也會匯出傳輸 URI。

WsdlNS.SoapBinding soapBinding = GetSoapBinding(context, exporter);
if (soapBinding != null)
{
    soapBinding.Transport = UdpPolicyStrings.UdpNamespace;
}

WSDL 匯入

若要延伸 WSDL 匯入系統以處理位址匯入，就必須將下列組態新增至 Svcutil.exe 的組態檔中，如 Svcutil.exe.config 檔案所示。

<configuration>
  <system.serviceModel>
    <client>
      <metadata>
        <wsdlImporters>
          <extension type=" Microsoft.ServiceModel.Samples.UdpBindingElementImporter, UdpTransport" />
        </policyImporters>
      </metadata>
    </client>
  </system.serviceModel>
</configuration>

當執行 Svcutil.exe 時，有兩個選項可以讓 Svcutil.exe 載入 WSDL 匯入延伸：

  1. 使用 /SvcutilConfig:<file> 將 Svcutil.exe 指向組態檔。

  2. 將組態區段新增至與 Svcutil.exe 位於相同目錄的 Svcutil.exe.config 中。

UdpBindingElementImporter 型別會實作 IWsdlImportExtension 介面。ImportEndpoint 方法會從 WSDL 連接埠匯入位址。

BindingElementCollection bindingElements = context.Endpoint.Binding.CreateBindingElements();
TransportBindingElement transportBindingElement = bindingElements.Find<TransportBindingElement>();
if (transportBindingElement is UdpTransportBindingElement)
{
    ImportAddress(context);
}

新增原則支援

自訂繫結項目可以匯出服務端點之 WSDL 繫結的原則判斷提示，以表示該繫結項目的功能。

原則匯出

UdpTransportBindingElement 型別會實作 ``IPolicyExportExtension 以增加對匯出原則的支援。因此，System.ServiceModel.MetadataExporter 會針對包含它的任何繫結，在產生原則時包含 UdpTransportBindingElement。

在 IPolicyExportExtension.ExportPolicy 中，我們會新增 UDP 的判斷提示以及其他判斷提示 (如果使用多點傳送模式)。這是因為多點傳送模式會影響通訊堆疊的建構方式，所以必須同時對兩端進行協調。

ICollection<XmlElement> bindingAssertions = context.GetBindingAssertions();
XmlDocument xmlDocument = new XmlDocument();
bindingAssertions.Add(xmlDocument.CreateElement(
UdpPolicyStrings.Prefix, UdpPolicyStrings.TransportAssertion, UdpPolicyStrings.UdpNamespace));
if (Multicast)
{
    bindingAssertions.Add(xmlDocument.CreateElement(
UdpPolicyStrings.Prefix, UdpPolicyStrings.MulticastAssertion,     UdpPolicyStrings.UdpNamespace));
}

因為自訂傳輸繫結項目會負責處理定址，所以 UdpTransportBindingElement 上的 IPolicyExportExtension 實作也必須處理適當之 WS-Addressing 原則判斷提示的匯出，以表示所使用的 WS-Addressing 版本。

AddWSAddressingAssertion(context, encodingBindingElement.MessageVersion.Addressing);

原則匯入

若要延伸原則匯入系統，就必須將下列組態新增至 Svcutil.exe 的組態檔中，如 Svcutil.exe.config 檔案所示。

<configuration>
  <system.serviceModel>
    <client>
      <metadata>
        <policyImporters>
          <extension type=" Microsoft.ServiceModel.Samples.UdpBindingElementImporter, UdpTransport" />
        </policyImporters>
      </metadata>
    </client>
  </system.serviceModel>
</configuration>

然後從已註冊類別 (UdpBindingElementImporter) 實作 IPolicyImporterExtension。在 ImportPolicy() 中，查看命名空間中的判斷提示，然後處理用來產生傳輸的判斷提示，並且檢查其是否使用多點傳送。此外，從繫結判斷提示清單中移除匯入所處理的判斷提示。同樣地，當執行 Svcutil.exe 時有兩個整合的選項：

  1. 使用 /SvcutilConfig:<file> 將 Svcutil.exe 指向組態檔。

  2. 將組態區段新增至與 Svcutil.exe 位於相同目錄的 Svcutil.exe.config 中。

新增標準繫結

可以透過下列兩種方式使用繫結項目：

  • 透過自訂繫結：自訂繫結允許使用者根據任意一組繫結項目，建立自己的繫結。

  • 使用由系統所提供、可包含繫結項目的繫結。WCF 會提供一些系統定義的繫結，例如 BasicHttpBinding、NetTcpBinding 和 WsHttpBinding。每個這個繫結都會與妥善定義的設定檔相關聯。

範例會在衍生自 Binding 的 SampleProfileUdpBinding 中實作設定檔繫結。SampleProfileUdpBinding 中最多包含四個繫結項目：UdpTransportBindingElement、TextMessageEncodingBindingElement CompositeDuplexBindingElement 和 ReliableSessionBindingElement。

public override BindingElementCollection CreateBindingElements()
{   
    BindingElementCollection bindingElements = new BindingElementCollection();
    if (ReliableSessionEnabled)
    {
        bindingElements.Add(session);
        bindingElements.Add(compositeDuplex);
    }
    bindingElements.Add(encoding);
    bindingElements.Add(transport);
    return bindingElements.Clone();
}

新增自訂標準繫結匯入工具

根據預設，Svcutil.exe 和 WsdlImporter 型別會辨識並匯入系統定義的繫結。否則，會將繫結當做 CustomBinding 執行個體匯入。為了讓 Svcutil.exe 和 WsdlImporter 能夠匯入 SampleProfileUdpBinding，UdpBindingElementImporter 也會當做自訂標準繫結匯入工具。

自訂標準繫結匯入工具會實作 IWsdlImportExtension 介面上的 ImportEndpoint 方法，檢視從中繼資料匯入的 CustomBinding 執行個體，以檢查特定標準繫結是否已產生該執行個體。

if (context.Endpoint.Binding is CustomBinding)
{
    Binding binding;
    if (transportBindingElement is UdpTransportBindingElement)
    {
        //if TryCreate is true, the CustomBinding will be replace by a SampleProfileUdpBinding in the
        //generated config file for better typed generation.
        if (SampleProfileUdpBinding.TryCreate(bindingElements, out binding))
        {
            binding.Name = context.Endpoint.Binding.Name;
            binding.Namespace = context.Endpoint.Binding.Namespace;
            context.Endpoint.Binding = binding;
        }
    }
}

一般來說，實作自訂標準繫結匯入工具包含檢查已匯入之繫結項目的屬性，以驗證只有變更由標準繫結設定的屬性，而所有其他屬性都還是預設值。實作標準繫結匯入工具的基本策略，是建立標準繫結的執行個體、從繫結項目將屬性傳播至標準繫結支援的標準繫結執行個體，然後比較標準繫結與已匯入繫結項目上的繫結項目。

新增組態支援

若要透過組態公開傳輸，就必須實作兩個組態區段。第一個是 UdpTransportBindingElement 的 BindingElementExtensionElement。使用這個區段，CustomBinding 的實作就可以參考繫結項目。第二個是 SampleProfileUdpBinding 的 Configuration。

繫結項目延伸項目

區段 ``UdpTransportElement 是 BindingElementExtensionElement，會將 UdpTransportBindingElement 公開至組態系統。藉由一些基本的覆寫，範例定義了組態區段名稱、繫結項目型別和建立繫結項目的方式。因此，可以接著在組態檔中登錄延伸區段，如下列程式碼所示。

<configuration>
  <system.serviceModel>
    <extensions>
      <bindingElementExtensions>
      <add name="udpTransport" type="Microsoft.ServiceModel.Samples.UdpTransportElement, UdpTransport />
      </bindingElementExtensions>
    </extensions>
  </system.serviceModel>
</configuration>

您可以從自訂繫結參考該延伸，以使用 UDP 做為傳輸方式。

<configuration>
  <system.serviceModel>
    <bindings>
      <customBinding>
       <binding configurationName="UdpCustomBinding">
         <udpTransport/>
       </binding>
      </customBinding>
    </bindings>
  </system.serviceModel>
</configuration>

繫結區段

區段 SampleProfileUdpBindingCollectionElement 是 StandardBindingCollectionElement，它會將 SampleProfileUdpBinding 公開至組態系統。大量實作會委派至衍生自 StandardBindingElement 的 SampleProfileUdpBindingConfigurationElement。SampleProfileUdpBindingConfigurationElement 的某些屬性會對應至 SampleProfileUdpBinding 的屬性，以及有些從 ConfigurationElement 繫結對應的函式。最後，在 SampleProfileUdpBinding 中覆寫 OnApplyConfiguration 方法，如下列範例程式碼所示。

protected override void OnApplyConfiguration(string configurationName)
{
            if (binding == null)
                throw new ArgumentNullException("binding");

            if (binding.GetType() != typeof(SampleProfileUdpBinding))
            {
                throw new ArgumentException(string.Format(CultureInfo.CurrentCulture,
                    "Invalid type for binding. Expected type: {0}. Type passed in: {1}.",
                    typeof(SampleProfileUdpBinding).AssemblyQualifiedName,
                    binding.GetType().AssemblyQualifiedName));
            }
            SampleProfileUdpBinding udpBinding = (SampleProfileUdpBinding)binding;

            udpBinding.OrderedSession = this.OrderedSession;
            udpBinding.ReliableSessionEnabled = this.ReliableSessionEnabled;
            udpBinding.SessionInactivityTimeout = this.SessionInactivityTimeout;
            if (this.ClientBaseAddress != null)
                   udpBinding.ClientBaseAddress = ClientBaseAddress;
}

為了使用組態系統註冊這個處理常式，範例將下列區段新增至相關的組態檔。

<configuration>
  <configSections>
     <sectionGroup name="system.serviceModel">
         <sectionGroup name="bindings">
                 <section name="sampleProfileUdpBinding" type="Microsoft.ServiceModel.Samples.SampleProfileUdpBindingCollectionElement, UdpTransport />
         </sectionGroup>
     </sectionGroup>
  </configSections>
</configuration>

因此，可以從 serviceModel 組態區段參考它。

<configuration>
  <system.serviceModel>
    <client>
      <endpoint configurationName="calculator"
                address="soap.udp://localhost:8001/" 
                bindingConfiguration="CalculatorServer"
                binding="sampleProfileUdpBinding" 
                contract= "Microsoft.ServiceModel.Samples.ICalculatorContract">
      </endpoint>
    </client>
  </system.serviceModel>
</configuration>

UDP 測試服務和用戶端

您可以在 UdpTestService 和 UdpTestClient 目錄中，找到使用此範例傳輸的測試程式碼。服務程式碼由兩項測試組成：其中一項測試會從程式碼設定繫結和端點，而另一項則是透過組態進行設定。這兩項測試都會使用兩個端點。一個端點會使用 SampleUdpProfileBinding，並且將 <reliableSession> 設為 true。另一個端點會使用包含 UdpTransportBindingElement 的自訂繫結。這相當於使用將 <reliableSession> 設為 false 的 SampleUdpProfileBinding。這兩項測試都會建立服務、為每個繫結新增端點、開啟服務，然後等候使用者按下 ENTER，再關閉服務。

當啟動服務的測試應用程式時，您應該會看見下列輸出。

Testing Udp From Code.
Service is started from code...
Press <ENTER> to terminate the service and start service from config...

此時，您就可以對已發行的端點執行測試用戶端應用程式。用戶端測試應用程式會為每個端點建立用戶端，並傳送五則訊息給每個端點。下列是用戶端的輸出。

Testing Udp From Imported Files Generated By SvcUtil.
0
3
6
9
12
Press <ENTER> to complete test.

下列是服務上的完整輸出。

Service is started from code...
Press <ENTER> to terminate the service and start service from config...
Hello, world!
Hello, world!
Hello, world!
Hello, world!
Hello, world!
   adding 0 + 0
   adding 1 + 2
   adding 2 + 4
   adding 3 + 6
   adding 4 + 8

若要使用組態對已發行的端點執行用戶端應用程式，請在服務上按下 ENTER，然後再執行測試用戶端一次。您應該會在服務上看見下列輸出。

Testing Udp From Config.
Service is started from config...
Press <ENTER> to terminate the service and exit...

再次執行用戶端，會產生與前面相同的結果。

若要使用 Svcutil.exe 重新產生用戶端程式碼和組態，請啟動服務應用程式，然後從範例的根目錄執行下列 Svcutil.exe。

svcutil https://localhost:8000/udpsample/ /reference:UdpTranport\bin\UdpTransport.dll /svcutilConfig:svcutil.exe.config

請注意，Svcutil.exe 不會為 SampleProfileUdpBinding 產生繫結延伸組態，所以您必須以手動方式新增。

<configuration>
    <system.serviceModel>    
        …
        <extensions>
            <!-- This was added manually because svcutil.exe does not add this extension to the file -->
            <bindingExtensions>
                <add name="sampleProfileUdpBinding" type="Microsoft.ServiceModel.Samples.SampleProfileUdpBindingCollectionElement, UdpTransport" />
            </bindingExtensions>
        </extensions>
    </system.serviceModel>
</configuration>

若要安裝、建置及執行範例

  1. 若要建置方案，請遵循建置 Windows Communication Foundation 範例中的指示。

  2. 若要在單一或跨電腦的組態中執行本範例，請遵循Running the Windows Communication Foundation Samples中的指示。

  3. 請參閱前面的＜UDP 測試服務和用戶端＞一節。

ms751494.Important(zh-tw,VS.100).gif 注意：
這些範例可能已安裝在您的電腦上。請先檢查下列 (預設) 目錄，然後再繼續。

<InstallDrive>:\WF_WCF_Samples

如果此目錄不存在，請移至用於 .NET Framework 4 的 Windows Communication Foundation (WCF) 與 Windows Workflow Foundation (WF) 範例，以下載所有 Windows Communication Foundation (WCF) 和 WF 範例。此範例位於下列目錄。

<InstallDrive>:\WF_WCF_Samples\WCF\Extensibility\Transport\Udp