.NET中大型專案開發必備(5)--Web服務/WebApi的負載均衡

相關下載：

Web服務的負載均衡-示例代碼(dp4-WebBalance.rar)

Web服務的負載均衡-示例代碼(dp4-WebBalance.rar)

【要點綜述1】：為了演示Web服務的負載均衡，本文會創建3個形式一致的web服務（或者說，創建1個web服務但分別拷貝部署在3個不同的地址），然后在客戶端創建一個代理以“負載均衡”的演算法形式遠程呼叫這3個web服務，

【要點綜述2】：為了實作“統一/透明”的呼叫形式連接“web服務端”與“客戶端”兩者，一個居中的“介面”類是必須創建的，且所有遠程web服務需要繼承此介面，

【要點綜述3】：Web Api是一個經典的http服務提供形式，WCF也是一個經典的兩端通信模式，本文還將會極巧妙的整合這兩者，讓一個服務一次撰寫同時具備Web Api與WCF兩者的特性，

我們首先在Visual Studio中新建第一個名字叫“YZZ.Interface”的解決方案+類別庫工程，并在此工程中創建“IBase介面”與“Person物體類”，代碼分別如下：

IBase介面：

using System.ServiceModel;//需要添加對System.ServiceModel.dll程式集的參考
using System.ServiceModel.Web;//需要添加對System.ServiceModel.Web.dll程式集的參考

namespace YZZ.Interface
{
    [ServiceContract]
    public interface IBase
    {
        [OperationContract]
        [WebInvoke(Method = "POST", UriTemplate = "/AccessRight", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.WrappedRequest)]
        Person AccessRight(int age);
    }
}

Person物體類：

namespace YZZ.Interface
{
    public class Person
    {
        public string name;
        public int age;
        public int right;
    }
}

如上代碼所示，IBase介面中定義了一個通過年齡來做權限判斷的AccessRight方法，并在該方法上附加了OperationContract與WebInvoke兩個屬性，OperationContract這個屬性是用來給方法賦予WCF的特性，而WebInvoke這個屬性則是給方法賦予了Web Api的特性，

編譯該解決方案，獲得YZZ.Interface.dll，

然后，我們再在Visual Studio中新建第二個名字叫“YZZ.Service”的解決方案+WCF服務應用程式工程，并在此工程中創建名為“MyBaseService.svc”的WCF服務檔案，該檔案的后臺代碼如下：

using YZZ.Interface;//需要添加前述IBase介面定義的YZZ.Interface.dll的參考

namespace YZZ.Service
{
    public class MyBaseService : IBase
    {
        public Person AccessRight(int age)
        {
            if (age > 27)
                return new Person { name = "管理員", age = age, right = 1 };
            else
                return new Person { name = "學生/員工", age = age, right = 0 };
        }
    }
}

如上代碼所示，MyBaseService類實作了IBase介面中定義的AccessRight方法，

并且，此時我們還需要在此工程的Web.config中做如下兩項配置，才能使得WCF與Web Api的特性在AccessRight方法身上完全見效，

配置一：在<system.serviceModel>節點下添加如下配置

    <!--用來對外發布WCF與WebAPI-->
    <services>
      <service name="YZZ.Service.MyBaseService">
        <!-- 對應Web API的End Point -->
        <endpoint address="webapi" binding="webHttpBinding" contract="YZZ.Interface.IBase" behaviorConfiguration="WebApiEndPointBehavior" />
        <!-- 對應WCF的End Point -->
        <endpoint address="" binding="basicHttpBinding" contract="YZZ.Interface.IBase" />
      </service>  
    </services>

配置二：在<behaviors>節點下添加如下配置

      <!-- WCF Service轉換為Web API后，使用的behavior -->
      <endpointBehaviors>
        <behavior name="WebApiEndPointBehavior">
          <webHttp />
        </behavior>
      </endpointBehaviors>

如此一來，AccessRight方法就兼具了Web Api與WCF的雙重特性，其Web Api（Web服務）的呼叫路徑如下：

http://部署的服務器路徑(ip+port)/MyBaseService.svc/webapi/AccessRight

為了演示Web服務的負載均衡的效果，現在我們把AccessRight方法的內容稍做修改成3個版本，分別編譯YZZ.Service工程后部署在3個不同的地方（如何部署請參考其它資料，這是基礎知識），如下：

部署地址1：http://139.244.52.136:120/MyBaseService.svc

對應AccessRight代碼1：

        public Person AccessRight(int age)
        {
            if (age > 27)
                return new Person { name = "管理員", age = age, right = 1 };
            else
                return new Person { name = "學生/員工", age = age, right = 0 };
        }

部署地址2：http://139.244.52.136:220/MyBaseService.svc

對應AccessRight代碼2：

        public Person AccessRight(int age)
        {
            if (age > 27)
                return new Person { name = "管理員1", age = age, right = 1 };
            else
                return new Person { name = "學生/員工1", age = age, right = 0 };
        }

部署地址3：http://139.244.52.136:230/MyBaseService.svc

對應AccessRight代碼3：

        public Person AccessRight(int age)
        {
            if (age > 27)
                return new Person { name = "管理員2", age = age, right = 1 };
            else
                return new Person { name = "學生/員工2", age = age, right = 0 };
        }

當“介面”與其對應的“3個Web服務”全部準備就緒，我們最后就來創建一個客戶端以“負載均衡”的演算法形式遠程呼叫這3個web服務，

我們再次打開Visual Studio，新建第三個名字叫“YZZ.Client”的解決方案+控制臺工程，然后，我們做如下四步操作：

【第一步】：為工程添加DeveloperSharp.dll組件參考，并添加YZZ.Interface.dll的參考，

【第二步】：創建一個名為DeveloperSharp.xml的組態檔，并在該檔案中設定如上3個web服務的負載均衡策略，檔案內容如下：

<?xml version="1.0" encoding="utf-8" ?>
<DeveloperSharp>
    <IServiceList>
        <IService Id="YZZ.Interface.IBase">
            <Service Id="A11" Enable="true" Weight="100" BindType="basicHttpBinding" Address="http://139.244.52.136:120/MyBaseService.svc"/>
            <Service Id="A22" Enable="true" Weight="100" BindType="basicHttpBinding" Address="http://139.244.52.136:220/MyBaseService.svc"/>
            <Service Id="A33" Enable="true" Weight="100" BindType="basicHttpBinding" Address="http://139.244.52.136:230/MyBaseService.svc"/>
        </IService>
    </IServiceList>   
</DeveloperSharp>

對此xml組態檔說明如下：

（1）     每一個IService節點代表了一組Web服務，此節點的Id值（本文示例值是：YZZ.Interface.IBase）必須是這組Web服務的“基類介面”的完全限定名，

（2）     Service節點中的Weight屬性代表了使用權重，本文示例的3個服務的Weight值分別是100、100、100，則這3個服務的負載均衡使用分配比例將會是1：1：1，若把這三個值分別設定為100、50、50，則這3個服務的使用分配比例將會變為2：1：1，設定成你想要的比例吧，

（3）     Service節點中的Enable屬性代表了是否可用，true代表可用，false代表不可用，

【第三步】：在工程組態檔App.config（或Web.config）中添加appSettings節點，節點內容如下：

  <appSettings>
    <add key="DatabaseType" value="" />
    <add key="ConnectionString" value="" />
    <add key="ErrorPage" value="" />
    <add key="ErrorLog" value="D:\Test2\YZZ.Client\log.txt" />
    <add key="ConfigFile" value="D:\Test2\YZZ.Client\DeveloperSharp.xml" />
  </appSettings>

其中，ConfigFile的設定是為了鏈接前述的DeveloperSharp.xml這個組態檔，ErrorLog則是設定一個錯誤日志檔案，它們均需要設定為檔案的“絕對路徑”（此處使用“絕對路徑”而不是“相對路徑”，一是有利于安全性，二是有利于分布式部署）

【第四步】：在控制臺應用類的代碼中，添加創建“Web服務”負載均衡呼叫的工具IUtility.GetService<T>()，并通過該工具呼叫遠程的Web服務，注意：核心代碼就一行而已！！此示例連續3次呼叫Web服務，看會顯示什么結果，如下：

    class Program
    {
        static void Main(string[] args)
        {
            YZZ.Interface.Person p;
            DeveloperSharp.Framework.CoreUtility.IUtility IU = new DeveloperSharp.Framework.CoreUtility.Utility();//創建“Web服務”負載均衡呼叫的工具

            //第一次呼叫遠程Web服務
            p = IU.GetService<YZZ.Interface.IBase>().AccessRight(20);
            Console.WriteLine(p.name);

            //第二次呼叫遠程Web服務
            p = IU.GetService<YZZ.Interface.IBase>().AccessRight(20);
            Console.WriteLine(p.name);

            //第三次呼叫遠程Web服務
            p = IU.GetService<YZZ.Interface.IBase>().AccessRight(20);
            Console.WriteLine(p.name);

            Console.ReadLine();
        }
    }

從以上示例代碼我們可以清晰的得知：IUtility.GetService<T>()就是實作負載均衡的關鍵所在，泛型T需要設定為被呼叫“Web服務組”的“基類介面”，而IUtility.GetService<T>()方法則會每次根據配置的負載均衡策略創建對應的遠程Web服務代理，

YZZ.Client控制臺工程輸出顯示結果如下：

學生/員工

學生/員工1

學生/員工2

最后提示一點：若要把一組Web服務的負載均衡應用改為單Web服務應用，只需要把DeveloperSharp.xml組態檔中IService節點下的Service節點數量設定為一個即可實作，

后記：讀完本文，你有沒有發現，“微服務”中常用的注冊、發現、服務降級、等功能，往往可通過修改DeveloperSharp.xml這個組態檔來實作？未完待續… 

總結

本文技術點思路梳理：

1. 創建Web服務組的通用基類“介面”，并在該“介面”上附加ServiceContract、OperationContract、WebInvoke三屬性，
2. 創建WCF服務并實作上述“介面”，并在Web.config中添加<services>與<endpointBehaviors>兩項配置，讓WCF服務兼具Web服務的特性，
3. 把上述Web服務分別部署在網路上多個不同的地方，形成“Web服務組”，
4. 通過DeveloperSharp.xml來配置“Web服務組”的負載均衡策略，
5. 創建客戶端，在其App.config/Web.config中添加鏈接DeveloperSharp.xml的appSettings節點，再在代碼中創建基于DeveloperSharp.dll的“Web服務負載均衡呼叫”工具，并通過該工具呼叫遠程的Web服務，

推薦閱讀

• .NET中大型專案開發必備(1)–UUID全球通用唯一識別碼
• .NET中大型專案開發必備(2)–CORS跨域訪問
• .NET中大型專案開發必備(3)–資料庫的負載均衡
• .NET中大型專案開發必備(4)–資料庫的讀寫分離
• .NET中大型專案開發必備(5)–Web服務/WebApi的負載均衡
• .NET中大型專案開發必備(6)–IUtility工具介紹
• .NET中大型專案開發必備(7)–ORM資料庫訪問技術
• .NET中大型專案開發必備(8)–高效分頁

如果文章對你有幫助，請點贊、收藏、關注（原創內容，歡迎轉載，轉載請注明出處） 有疑問想獲取專業技術支持？請掃描左側微信二維碼聯系作者 出處：https://www.cnblogs.com/DeveloperSharp/ 本文采用「CC BY 4.0」知識共享協議進行許可，轉載請注明作者及出處，

標籤：.NET技术

上一篇：.NET中大型專案開發必備(4)--資料庫的讀寫分離

下一篇：.NET中大型專案開發必備(6)--IUtility工具介紹