WCF學習——構建一個簡單的WCF應用（一）

本文的WCF服務應用功能很簡單，卻涵蓋了一個完整WCF應用的基本結構。希望本文能對那些准備開始學習WCF的初學者提供一些幫助。

在這個例子中，我們將實現一個簡單的計算器和傳統的分布式通信框架一樣，WCF本質上提供一個跨進程、跨機器、跨網絡的服務調用。在本例中，客戶端和WCF應用服務通過運行在同一台機器上的不同進程模擬。

 

步驟一、構建整個解決方案

 　　　　1.創建一個空白的解決方案

　　　　　　

 

        　　2.添加四個項目和引用及關系

　　　　　　

 

           　　 Service.Interface  用於定義服務契約的類庫項目，引用WCF核心程序集System.ServuceModel.dll
            　　Service           用於定義服務類型的類庫項目，由於服務類型需要實現定義在ervice.Interface中相應的接口，因此需要引用Service.Interface
           　　 Hosting           作為服務寄主的控制台應用，該項目同時引用Service.Interface、System.ServuceModel.dll、Service
            　　Client           模擬服務的客服端控制台應用  該醒目引用System.ServuceModel.dll

 　　　　　 

 

　　　　　

 

 

 

步驟二、創建服務契約（一般將服務契約定義為接口）

 　　　　WCF采用基於接口（MSDN上翻譯為：服務協定）的交互方式實現了服務功能，以及客戶端和服務端之間的松耦合。WCF包含五種類型的協定：服務協定、操作協定、消息協定、錯誤協定和數據協定。

       從功能上講，服務協定將多個相關的操作聯系在一起，組成單個功能單元。協定可以定義服務級設置，如服務的命名空間、對應的回調協定以及其他此類設置，以及各種操作。

      從消息交換的角度來講，服務協定則定義了基於服務調用的消息交換過程中， 請求消息和回復消息的結構，以及采用的消息交換模式。

      從使用編程語言的角度來講，協定是通過所選的編程語言創建一個接口，然后將 ServiceContractAttribute 屬性應用於該接口。通過實現該接口，可生成實際的服務代碼。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ServiceModel;

namespace Service.Interface
{
    /// <summary>
    /// 計算器
    /// </summary>
    [ServiceContract(Name = "CalculatorService",Namespace="http://www.artech.com/")]
    public interface ICalculator
    {
        /// <summary>
        /// 加
        /// </summary>
        /// <param name="x"></param>
        /// <param name="y"></param>
        /// <returns></returns>
        [OperationContract]
        double Add(double x,double y);

        /// <summary>
        /// 減
        /// </summary>
        /// <param name="x"></param>
        /// <param name="y"></param>
        /// <returns></returns>
        [OperationContract]
        double Subtract(double x,double y);

        /// <summary>
        /// 乘
        /// </summary>
        /// <param name="x"></param>
        /// <param name="y"></param>
        /// <returns></returns>
        [OperationContract]
        double Multiply(double x,double y);

        /// <summary>
        /// 除
        /// </summary>
        /// <param name="x"></param>
        /// <param name="y"></param>
        /// <returns></returns>
        [OperationContract]
        double Divide(double x,double y);
    }
}

 

 

步驟三、實現WCF服務契約

　　

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Service.Interface;

namespace Service
{
    public class CalculatorService:ICalculator
    {

 
        public double Add(double x, double y)
        {
            return x + y;
        }

        public double Subtract(double x, double y)
        {
            return x - y;
        }

        public double Multiply(double x, double y)
        {
            return x * y;
        }

        public double Divide(double x, double y)
        {
            return x / y;
        }
    }
}

 

步驟四、通過自我寄宿的方式寄宿服務

 　　 WCF服務需要依存一個運行着的進程（宿主），服務寄宿就是為服務指定一個宿主的過程。WCF是一個基於消息的通信框架，采用基於終結點（Endpoint）的通信手段。

       終結點主要由地址（Address）、綁定（Binding）和協定（Contract）三要素組成，如圖所示。由於三要素應為首字母分別為ABC，所以就有了易於記憶的公式：Endpoint = ABC。一個終結包含了實現通信所必需的所有信息。如下圖。

終結點三要素  

• 地址（Address）：一個指示可以查找終結點的位置的地址。地址決定了服務的位置，解決了服務尋址的問題
• 綁定（Binding）：一個指定客戶端如何與終結點進行通信的綁定。綁定實現了通信的所有細節，包括網絡傳輸、消息編碼，以及其他為實現某種功能（比如安全、可靠傳輸、事務等）對消息進行的相應處理。WCF中具有一系列的系統定義綁定，比如BasicHttpBinding、WsHttpBinding、NetTcpBinding等，
• 協定（Contract）：一個標識可用操作的協定。協定是對服務操作的抽象，也是對消息交換模式以及消息結構的定義。
  
• 行為(Behavior)：一組指定終結點的本地實現細節的行為。
  

      服務寄宿的目的就是開啟一個進程，為WCF服務應用提供一個運行的環境。通過為服務添加一個或多個終結點，使之暴露給潛在的服務調用者。服務調用者最終通過相匹配的終結點對該服務進行調用。

一）代碼方式實現寄宿

　　　　　　　using Service;
            using Service.Interface;
            using System.ServiceModel;
            using System.ServiceModel.Description;

            namespace Hosting
            {
                class Program
                {
                    static void Main(string[] args)
                    {
                        //在進行真正的開放時一般在配置文件里面進行配置添加終結點和服務行為的定義
                        using(ServiceHost host = new ServiceHost(typeof(CalculatorService)))
                        {
                            //指定綁定和總結點的地址
                            host.AddServiceEndpoint(typeof(ICalculator), new WSHttpBinding(), "http://127.0.0.1:3721/calculatorservice");
                            //數據的發布
                            if(host.Description.Behaviors.Find<ServiceMetadataBehavior>() == null)
                            {
                                //創建服務行為
                                ServiceMetadataBehavior behavior = new ServiceMetadataBehavior();
                                //是否發布元數據以便使用HTTPS/GET請求進行檢索
                                behavior.HttpGetEnabled = true;
                                //使用HTTPS/GET請求的元數據發布的位置
                                behavior.HttpGetUrl = new Uri("http://127.0.0.1:3721/calculatorservice/metadata");
                                //添加到發布上
                                host.Description.Behaviors.Add(behavior);
                            }
                            host.Opened += delegate
                            {
                                Console.WriteLine("CalculatorService已經啟動,按任意鍵終止服務！");
                            };
                            //通訊狀態轉換到已打開
                            host.Open();
                            Console.ReadLine();
                        }
                    }
                }
            }

 　　1) WCF服務寄宿通過一個特殊的對象完成：ServiceHost。在上面的代碼基本實現的功能說明，基於WCF服務應用的類型（typeof(CalculatorService)）創建了ServieHost對象，並添加了一個終結點。具體的地址為http://127.0.0.1:3721/calculatorservice/metadata，采用了WSHttpBinding，並指定了服務協定的類型ICalculator。

        2) 松耦合是SOA的一個基本的特征，WCF服務應用中客戶端和服務端的松耦合體現在客戶端只需要了解WCF服務基本的描述，而無需知道具體的實現細節，就可以實現正常的WCF服務調用。WCF服務的描述通過元數據（Metadata）的形式發布出來。WCF中元數據的發布通過一個特殊的服務行為ServiceMetadataBehavior實現。在上面提供的服務寄宿代碼中，我們為創建的ServiceHost添加了ServiceMetadataBehavior，並采用了基於HTTP-GET的元數據獲取方式，元數據的發布地址通過ServiceMetadataBehavior的HttpGetUrl指定。在調用ServiceHost的Open方法對服務成功寄宿后，我們可以通過該地址獲取服務相關的元數據。

 

     3) 運行已經生成的hosting.exe，

 

　　4）然后在瀏覽器地址欄上鍵入http://127.0.0.1:3721/calculatorservice/metadata，你將會得到以WSDL形式體現的服務元數據，如下圖所示。

 

二）配置文件方式實現寄宿

        在實際應用中，對於WCF應用服務的寄宿，一般不會直接通過編碼的方式進行終結點的添加和服務行為的定義，而是通過寫配置文件的方式實現，這樣可以方便修改。

       1)  現在我在Hosting項目中添加一個app.config配置文件，把下面的配置信息添加到配置文件app.config中。

　　　　

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  <system.serviceModel>
    
    <behaviors>
      <serviceBehaviors>
        <behavior name="metadataBehavior">
          <serviceMetadata httpGetEnabled="true" httpGetUrl="http://127.0.0.1:3721/calculatorservice/metadata" />
        </behavior>
      </serviceBehaviors>
    </behaviors> 
    
    <services>
      <service  behaviorConfiguration="metadataBehavior" name="Service.CalculatorService">
        <endpoint address="http://127.0.0.1:3721/calculatorservice"
            binding="wsHttpBinding" bindingConfiguration="" contract="Service.Interface.ICalculator" />
      </service>
    </services>
    
  </system.serviceModel>
</configuration>

 

 

 

 　　2)  增加app.config配置文件與配置信息之后，我們原來寫的寄宿代碼就不能使用了，需要進行服務寄宿代碼的修改，而且代碼會變的更簡潔，只需幾行代碼就可以了。代碼如下。

 　　

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Service;
using Service.Interface;
using System.ServiceModel;
using System.ServiceModel.Description;

namespace Hosting
{
    class Program
    {
        static void Main(string[] args)
        {
            using(ServiceHost host = new ServiceHost(typeof(CalculatorService)))
            {
                ////指定綁定和終結點的地址
                //host.AddServiceEndpoint(typeof(ICalculator), new WSHttpBinding(), "http://127.0.0.1:3721/calculatorService");
                ////數據的發布
                //if(host.Description.Behaviors.Find<ServiceMetadataBehavior>() == null)
                //{
                //    //創建服務行為
                //    ServiceMetadataBehavior behavior = new ServiceMetadataBehavior();
                //    //是否發布元數據以便使用HTTPS/GET請求進行檢索
                //    behavior.HttpGetEnabled = true;
                //    //使用HTTPS/GET請求的元數據發布的位置
                //    behavior.HttpGetUrl = new Uri("http://127.0.0.1:3721/calculatorService/metadata");
                //    //添加到發布上
                //    host.Description.Behaviors.Add(behavior);
                //}
                host.Opened += delegate
                {
                    Console.WriteLine("CalculatorService已經啟動,按任意鍵終止服務！");
                };
                //通訊狀態轉換到已打開
                host.Open();
                Console.ReadLine();
            }
        }
    }
}

 

 　　　3) 執行hosting.exe應用程序，結果如下圖。

　　

 

 

 下一章節講怎么通過客戶端去調用我們成功寄宿后的服務 (歡迎關注)

 

 源碼地址：

 

    https://github.com/JamelsAr/WcfServicesFirst

 

    https://github.com/JamelsAr/WcfServicesSecond

 

    https://github.com/JamelsAr/WcfServicesThird