1. 程式人生 > >WCF入門教程

WCF入門教程

 這一系列文章的內容是從MSDNCOPY過來的,講述的是最簡單的WCF程式示例:如何在控制檯應用程式實現和承載WCF服務,以及如何建立、配置和使用WCF客戶端。

   文章主體可分為兩部分,分別介紹伺服器端和客戶端的程式設計實現。細分的話,可以分為六項任務。

  • 伺服器端

定義WCF服務協定(任務一)

   這是建立基本 Windows Communication Foundation (WCF) 服務和可以使用該服務的客戶端所需的六項任務中的第一項任務。

   建立基本 WCF 服務時,第一項任務是為與外界共享的服務建立協定,並在其中描述如何與該服務進行通訊。

 

   具體步驟為:   

   1 建立新的控制檯應用程式專案。 新建專案對話方塊中,選中“Visual Basic”“Visual C#”,並選擇控制檯應用程式模板,並命名為Service 使用預設的位置。

   2、將預設的Service 名稱空間更改為 Microsoft.ServiceModel.Samples

   3、為專案提供對 System.ServiceModel 名稱空間的引用:右擊

解決方案資源管理器中的“Service”專案,選擇新增引用項,在彈出的對話方塊中的“.NET”選項卡里的元件名稱中選擇“System.ServiceModel”,然後單擊確定

 

   下面是程式設計步驟:

   1、為 System.ServiceModel 名稱空間新增一個 using 語句。      

      using System.ServiceModel;

   2、建立一個新的ICalculator 介面,並將 ServiceContractAttribute 屬性應用於該介面,並將 Namespace 值設定為“http://Microsoft.ServiceModel.Samples” 此名稱空間指定該服務在計算機上的路徑,並構成該服務的基址部分。 請注意,在通過採用方括號表示法的屬性來批註介面或類時,該屬性類可以從其名稱中去掉“Attribute”部分。

    [ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")] 

    public interface ICalculator

   3、在介面中建立方法宣告,並將 OperationContractAttribute 屬性應用於每個要作為公共 WCF 協定的一部分公開的方法。    

   [OperationContract]

   double Add(double n1, double n2);

   [OperationContract]

   double Subtract(double n1, double n2);

   [OperationContract]

   double Multiply(double n1, double n2);

   [OperationContract]

   double Divide(double n1, double n2);

   

 

   下面是建立服務協定的完整程式碼段:   

using System;

// Add the using statement for the Sytem.ServiceModel namespace

using System.ServiceModel;

namespace Microsoft.ServiceModel.Samples

{

  //  Define a service contract.

  [ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]

  public interface ICalculator

  {

    //  Create the method declaration for the contract.

    [OperationContract]

    double Add(double n1, double n2);

    [OperationContract]

    double Subtract(double n1, double n2);

    [OperationContract]

    double Multiply(double n1, double n2);

    [OperationContract]

    double Divide(double n1, double n2);

  }

}

........(整個伺服器端的程式碼未完,等講完任務三時,再給出完整程式碼)

 

實現WCF服務協定(任務二)

   1、建立一個新 CalculatorService 類,該類從使用者定義的 ICalculator 介面繼承而來並實現該介面定義的協定功能。   

   public class CalculatorService : ICalculator

   

   2、實現每個算術運算子的功能。

    

public double Add(double n1, double n2)

{

    double result = n1 + n2;

    Console.WriteLine("Received Add({0},{1})", n1, n2);

    // Code added to write output to the console window.

    Console.WriteLine("Return: {0}", result);

    return result;

}

 

public double Subtract(double n1, double n2)

{

    double result = n1 - n2;

    Console.WriteLine("Received Subtract({0},{1})", n1, n2);

    Console.WriteLine("Return: {0}", result);

    return result;

}

 

public double Multiply(double n1, double n2)

{

    double result = n1 * n2;

    Console.WriteLine("Received Multiply({0},{1})", n1, n2);

    Console.WriteLine("Return: {0}", result);

    return result;

}

 

public double Divide(double n1, double n2)

{

    double result = n1 / n2;

    Console.WriteLine("Received Divide({0},{1})", n1, n2);

    Console.WriteLine("Return: {0}", result);

    return result;

}

 

   在建立和實現了服務協定後,下一步是執行該服務。 執行服務由三個步驟組成:配置、承載和開啟服務。

配置、承載和執行服務(任務三)

  • 為服務配置基址   

    為服務的基址建立 Uri 例項。  URI 指定 HTTP 方案、本地計算機、埠號 8000,以及服務協定中為服務名稱空間指定的服務路徑ServiceModelSample/Services    

    Uri baseAddress = new Uri("http://localhost:8000/ServiceModelSamples/Service");

  • 承載服務
  1. 建立一個新的 ServiceHost 例項以承載服務。 必須指定實現服務協定和基址的型別。 對於此示例,我們將基址指定為http://localhost:8000/ServiceModelSamples/Services,並將 CalculatorService 指定為實現服務協定的型別。

ServiceHost selfHost = new ServiceHost(typeof(CalculatorService), baseAddress);

  1. 新增一個捕獲 CommunicationException  try-catch 語句,並在接下來的三個步驟中將該程式碼新增到 try 塊中。
  2. 新增公開服務的終結點。 為此,必須指定終結點公開的協議、繫結和終結點的地址。 此例,將 ICalculator 指定為協定,將 WSHttpBinding 指定為繫結,並將 CalculatorService 指定為地址。 在這裡請注意,我們指定的是相對地址。 終結點的完整地址是基址和終結點地址的組合 在此例中,完整地址是 http://localhost:8000/ServiceModelSamples/Services/CalculatorService

selfHost.AddServiceEndpoint(

    typeof(ICalculator),

    new WSHttpBinding(),

    "CalculatorService");

  1. 啟用元資料交換。 為此,必須新增服務元資料行為。 首先建立一個 ServiceMetadataBehavior 例項,將 HttpGetEnabled 屬性設定為 true,然後為服務新增新行為。

ServiceMetadataBehavior smb = new ServiceMetadataBehavior();

smb.HttpGetEnabled = true;

selfHost.Description.Behaviors.Add(smb);

  1. 開啟 ServiceHost 並等待傳入訊息。 使用者按 Enter 鍵時,關閉 ServiceHost

    selfHost.Open();

    Console.WriteLine("The service is ready.");

    Console.WriteLine("Press <ENTER> to terminate service.");

    Console.WriteLine();

    Console.ReadLine();

    // Close the ServiceHostBase to shutdown the service.

    selfHost.Close();

 

    下面是伺服器端(即“Service”專案中program.cs檔案中)的完整程式程式碼:

using System;

using System.ServiceModel;

using System.ServiceModel.Description;

 

namespace Microsoft.ServiceModel.Samples

{

    // Define a service contract.

    [ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]

    public interface ICalculator

    {

        [OperationContract]

        double Add(double n1, double n2);

        [OperationContract]

        double Subtract(double n1, double n2);

        [OperationContract]

        double Multiply(double n1, double n2);

        [OperationContract]

        double Divide(double n1, double n2);

    }

 

    // Service class that implements the service contract.

    // Added code to write output to the console window.

    public class CalculatorService : ICalculator

    {

        public double Add(double n1, double n2)

        {

            double result = n1 + n2;

            Console.WriteLine("Received Add({0},{1})", n1, n2);

            Console.WriteLine("Return: {0}", result);

            return result;

        }

 

        public double Subtract(double n1, double n2)

        {

            double result = n1 - n2;

            Console.WriteLine("Received Subtract({0},{1})", n1, n2);

            Console.WriteLine("Return: {0}", result);

            return result;

        }

 

        public double Multiply(double n1, double n2)

        {

            double result = n1 * n2;

            Console.WriteLine("Received Multiply({0},{1})", n1, n2);

            Console.WriteLine("Return: {0}", result);

            return result;

        }

 

        public double Divide(double n1, double n2)

        {

            double result = n1 / n2;

            Console.WriteLine("Received Divide({0},{1})", n1, n2);

            Console.WriteLine("Return: {0}", result);

            return result;

        }

    }

 

 

    class Program

    {

        static void Main(string[] args)

        {

 

            // Create a URI to serve as the base address.

            Uri baseAddress = new Uri("http://localhost:8000/ServiceModelSamples/Service");

 

            // Create ServiceHost

            ServiceHost selfHost = new ServiceHost(typeof(CalculatorService), baseAddress);

            try

            {

                 //  Add a service endpoint.

                selfHost.AddServiceEndpoint(

                    typeof(ICalculator),

                    new WSHttpBinding(),

                    "CalculatorService");

 

                // Enable metadata exchange.

                ServiceMetadataBehavior smb = new ServiceMetadataBehavior();

                smb.HttpGetEnabled = true;

                selfHost.Description.Behaviors.Add(smb);

 

                // Start (and then stop) the service.

                selfHost.Open();

                Console.WriteLine("The service is ready.");

                Console.WriteLine("Press <ENTER> to terminate service.");

                Console.WriteLine();

                Console.ReadLine();

 

                // Close the ServiceHostBase to shutdown the service.

                selfHost.Close();

            }

            catch (CommunicationException ce)

            {

                Console.WriteLine("An exception occurred: {0}", ce.Message);

                selfHost.Abort();

            }

        }

    }

}

若要執行服務,啟動專案資料夾下bin目錄中的 Service.exe即可。

 前面三篇文章是講伺服器端的部署和執行,下面講講客戶端如何配置和使用。

建立WCF客戶端(任務四)

  1. 通過執行以下步驟,在 Visual Studio 2005 中為客戶端建立新專案:
    1. 在包含該服務(之前文章所述的服務)的同一解決方案中的解決方案資源管理器(位於右上角)中,右擊當前解決方案,然後選擇新增新專案
    2. 新增新專案對話方塊中,選擇“Visual Basic”“Visual C#”,選擇控制檯應用程式模板,然後將其命名為 Client 使用預設的位置。
    3. 單擊確定
    4. 為專案提供對 System.ServiceModel 名稱空間的引用:在解決方案資源管理器中右擊“Service”專案,從“.NET”選項卡上的元件名稱列中選擇“System.ServiceModel”,然後單擊確定
    5.  System.ServiceModel 名稱空間新增 using 語句:using System.ServiceModel;
    6. 啟動在前面的步驟中建立的服務。(即開啟在伺服器專案中生成的Service.exe可執行檔案)
    7. 通過執行以下步驟,使用適當的開關執行Service Model Metadata Utility Tool (SvcUtil.exe) 以建立客戶端程式碼和配置檔案:
      1. 通過選擇開始選單中的“Microsoft Windows SDK”項下的“CMD Shell”,啟動 Windows SDK 控制檯會話。
      2. 導航到要放置客戶端程式碼的目錄。 如果使用預設設定建立 Client 專案,則目錄為 C:\Documents and Settings\<使用者名稱>\Documents\Visual Studio 2008\Projects\Service\Client
      3. 將命令列工具Service Model Metadata Utility Tool (SvcUtil.exe) 與適當的開關一起使用以建立客戶端程式碼。 下面的示例生成服務的程式碼檔案和配置檔案。

svcutil.exe /language:cs /out:generatedProxy.cs /config:app.config http://localhost:8000/ServiceModelSamples/service

  1. Visual Studio 中將生成的代理新增到 Client 專案中,方法是在解決方案資源管理器中右擊“Client”並選擇新增現有項 然後選擇在上一步中生成的 generatedProxy.cs 檔案。

配置WCF客戶端(任務五)

    Visual Studio 中,將在前一過程中生成的 App.config 配置檔案新增到客戶端專案中。 在解決方案資源管理器中右擊該客戶端,選擇新增現有項,然後從 C:\Documents and Settings\<使用者名稱>\Documents\Visual Studio 2008\Projects\Service\Client\bin 目錄中選擇 App.config 配置檔案。

    app.config新增到專案中後,就算是完成了wcf客戶端的配置。因為具體的配置資訊,我們在使用svcutil.exe工具時,它就幫我們配置好並寫入了app.config檔案。

 

使用WCF客戶端(任務六)

1、為要呼叫的服務的基址建立 EndpointAddress 例項,然後建立 WCF Client 物件。

    //Create an endpoint address and an instance of the WCF Client.

    EndpointAddress epAddress = new EndpointAddress("http://localhost:8000/ServiceModelSamples/Service/CalculatorService");

    CalculatorClient client = new CalculatorClient(new WSHttpBinding(), epAddress);

2、從 Client 內呼叫客戶端操作。

// Call the service operations.

// Call the Add service operation.

double value1 = 100.00D;

double value2 = 15.99D;

double result = client.Add(value1, value2);

Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result);

 

// Call the Subtract service operation.

value1 = 145.00D;

value2 = 76.54D;

result = client.Subtract(value1, value2);

Console.WriteLine("Subtract({0},{1}) = {2}", value1, value2, result);

 

// Call the Multiply service operation.

value1 = 9.00D;

value2 = 81.25D;

result = client.Multiply(value1, value2);

Console.WriteLine("Multiply({0},{1}) = {2}", value1, value2, result);

 

// Call the Divide service operation.

value1 = 22.00D;

value2 = 7.00D;

result = client.Divide(value1, value2);

Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result);

3、在 WCF 客戶端上呼叫 Close

// Closing the client gracefully closes the connection and cleans up resources.

client.Close();

下面是客戶端的完整程式碼:

using System;

using System.Collections.Generic;

using System.Text;

using System.ServiceModel;

 

namespace ServiceModelSamples

{

    class Client

    {

        static void Main()

        {

    //Step 1: Create an endpoint address and an instance of the WCF Client.

            EndpointAddress epAddress = new EndpointAddress("http://localhost:8000/ServiceModelSamples/Service/CalculatorService");

            CalculatorClient client = new CalculatorClient(new WSHttpBinding(), epAddress);

 

            // Step 2: Call the service operations.

            // Call the Add service operation.

            double value1 = 100.00D;

            double value2 = 15.99D;

            double result = client.Add(value1, value2);

            Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result);

 

            // Call the Subtract service operation.

            value1 = 145.00D;

            value2 = 76.54D;

            result = client.Subtract(value1, value2);

            Console.WriteLine("Subtract({0},{1}) = {2}", value1, value2, result);

 

            // Call the Multiply service operation.

            value1 = 9.00D;

            value2 = 81.25D;

            result = client.Multiply(value1, value2);

            Console.WriteLine("Multiply({0},{1}) = {2}", value1, value2, result);

 

            // Call the Divide service operation.

            value1 = 22.00D;

            value2 = 7.00D;

            result = client.Divide(value1, value2);

            Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result);

 

            //Step 3: Closing the client gracefully closes the connection and cleans up resources.

            client.Close();

 

            Console.WriteLine();

            Console.WriteLine("Press <ENTER> to terminate client.");

            Console.ReadLine();

 

        }

    }

}

若要啟動客戶端,請在開始選單中的“Microsoft Windows SDK”項下選擇“CMD Shell”,從而啟動 Windows SDK 控制檯會話。 定位至 C:\Documents and Settings\<使用者名稱>\Documents\Visual Studio 2008\Projects\Service\Client\obj\Debug 目錄,鍵入 client,然後按Enter 操作請求和響應將出現在客戶端控制檯視窗中,如下所示。

Add(100,15.99) = 115.99

Subtract(145,76.54) = 68.46

Multiply(9,81.25) = 731.25

Divide(22,7) = 3.14285714285714

 

Press <ENTER> to terminate client.

 

最後,附上我的ASP.NET學習群,歡迎各位同行入群指導交流。技術群:【ASP.NET技術社群】872894940