net core天馬行空系列-微服務篇:全宣告式http使用者端feign快速接入微服務中心nacos

2022-06-06 09:00:44

1.前言

hi,大家好,我是三合,距離上一篇部落格已經過去了整整兩年,這兩年裡,博主通關了《人生》這個遊戲裡的兩大關卡,買房和結婚。最近閒了下來,那麼當然要繼續寫部落格了,今天這篇部落格的主要內容是,net core/.net6中,如何利用SummerBoot(點我開啟詳情介紹)中的feign模組快速接入微服務中心nacos(點我開啟詳情介紹),接下來我會從微服務的概念到feign的使用方法,由淺入深的進行介紹。

2.服務與範例

服務與範例的關係,可以類比為程式設計師與你我的關係,程式設計師是服務,我們是範例,比如老闆要實現一個功能,那麼他一般會說,交給程式設計師開發,而不是說交給張三開發,萬一張三離職了,他還要問還有誰是程式設計師,然後才能說找誰開發,太麻煩了,畢竟老闆的重點是找人開發出來,而不是具體找哪個人,直接說交給程式設計師開發,那麼無論公司裡哪個程式設計師離職或者入職,只要程式設計師群體有人就行,服務在這裡就起到了一個統一入口,遮蔽底層細節,減少溝通成本的作用。拉回正題,當我們的系統對外提供了api介面給其他系統呼叫的時候,我們就可以說這個系統對外提供了服務,當然,為了高可用性,我們一般會部署多個站點進行負載均衡,免得一個站點掛了,整個系統就掛了,在微服務中,我們一般稱呼這一個個站點為一個個服務範例,服務與範例一般是一對多的關係。

3.nacos的安裝

安裝具體參考nacos官網,博主這裡推薦使用docker的方式安裝,簡單又快速,免得大家邁出微服務第一步的時候就出師未捷身先死。

4.安裝SummerBoot

在nuget中搜尋Summerboot,安裝即可,SummerBoot支援net core 3.1和.net 6。

5. 服務範例註冊與服務呼叫

我們平時呼叫其他的系統的介面,一般都需要,ip(域名)+port+具體介面,但在nacos中,則可以簡化為,服務名+具體介面,nacos中,服務是一等公民,我們呼叫的都是服務,至於哪些服務範例聯合一起提供了這些服務,則不是我們關心的內容,換言之,nacos中,服務幫我們遮蔽了一個個站點的細節,我們不用去關心要呼叫的介面的ip地址和埠號。使用nacos服務中心,分為兩步,服務範例註冊和服務呼叫。

5.1 服務範例註冊

我們以程式設計師的身份入職公司,這一步就是服務範例註冊,這樣我們就成為我們公司程式設計師群體中的一員了。拉回正題,服務範例註冊就是將我們的應用註冊為服務的一個範例,由服務作為對外統一入口,為其他系統提供介面服務,以供他們呼叫。這裡提一下nacos檢測範例是否存活的心跳機制就是範例每5秒鐘向nacos註冊中心傳送一個心跳包,確認存活狀態。那麼在feign中是如何註冊服務範例的呢,非常簡單,只需要兩步

5.1.1 在組態檔appsettings.json/appsettings.Development.json中新增nacos的設定資訊

"nacos": {
    //nacos服務地址,如http://172.16.189.242:8848
    "serviceAddress": "http://172.16.189.242:8848/",
    //是否要把應用註冊為服務範例
    "registerInstance": true,
    //名稱空間id,如832e754e-e845-47db-8acc-46ae3819b638或者public
    "namespaceId": "dfd8de72-e5ec-4595-91d4-49382f500edf",
    //要註冊的服務名
    "serviceName": "test",
    //服務的分組名
    "groupName": "DEFAULT_GROUP",
    //權重,一個服務下有多個範例,權重越高,存取到該範例的概率越大,比如有些範例所在的伺服器設定高,那麼權重就可以大一些,多引流到該範例,與上面的引數lbStrategy設定為WeightRandom搭配使用
    "weight": 1,
    //本應用對外的網路協定,http或https
    "protocol": "http",
    //本應用對外的埠號,比如5000
    "port": 5000
  }

每一個設定引數我都新增了詳細的說明,大家注意這裡,我們把應用對外的埠號和協定都設定了,為什麼沒設定ip呢,因為ip可以自動獲取,就免得大家設定了,這裡weight(即權重)引數是什麼意思呢,我們平時部署應用的伺服器的設定有的高,有的低,比如兩臺伺服器,A和B,A是4c8g,B是128c256g,那麼明顯B伺服器設定更高,我們就應該把更多的請求分配給B伺服器去處理,畢竟能者多勞嘛,那麼我們在A和B伺服器上部署應用,設定weight引數時,A伺服器上的應用應當設定為1,B設定為32,代表1臺B伺服器相當於32臺A伺服器,這些設定資訊會作為元資訊上傳到nacos中心,這樣我們在服務呼叫的時候才會知道,該用怎麼樣的方式,什麼ip什麼埠去請求哪個範例上的介面。

5.1.2 在StartUp.cs中新增設定

services.AddSummerBoot();
services.AddSummerBootFeign(it =>
{
	it.AddNacos(Configuration);
});

僅需這兩步,我們就完成了服務範例註冊,執行web程式,然後大家開啟nacos的面板,就可以看到我們註冊的服務,點開服務,也可以看到服務下面的範例,至此,我們的服務就可以對外提供服務了。同時啟動多個應用就意味著註冊了多個服務範例,注意要設定好相應的埠號。

5.2 服務呼叫

老闆說把某個需求交給程式設計師實現,這就是服務呼叫。那麼我們如何呼叫別的微服務系統所提供的服務呢?在feign中,這也是非常簡單的,因為feign本身是一個宣告式http使用者端,我們只需要定義介面,實現類會由SummerBoot框架自動生成,我們在要用到的地方注入介面即可直接呼叫。feign服務呼叫分為三步。

5.2.1 在組態檔appsettings.json/appsettings.Development.json中新增nacos的設定資訊

"nacos": {
    //nacos服務地址,如http://172.16.189.242:8848
    "serviceAddress": "http://172.16.189.242:8848/",
    //使用者端負載均衡演演算法,一個服務下有多個範例,lbStrategy用來挑選服務下的範例,預設為Random(隨機),也可以選擇WeightRandom(根據服務權重加權後再隨機)
    "lbStrategy": "Random",
  }

大家應該可以看到,相比於服務範例註冊,我們要呼叫別的微服務系統所提供的服務,要設定的引數要少的多,只有2個,nacos服務地址和使用者端負載均衡演演算法,我這裡要解釋一下什麼叫使用者端負載均衡演演算法,我們將多個應用註冊為服務範例後,當我們要呼叫這個服務時,feign會先請求nacos的介面,獲取這個服務下所有的健康且存活的範例,那麼理論上我們請求這些範例中的任何一個都是可以的,那麼如何挑選範例呢,這裡就涉及到一個使用者端負載均衡演演算法,避免伺服器分配到的流量旱的旱死,澇的澇死。feign在這裡總共實現了2種演演算法,1.Random演演算法,即隨機從範例列表中挑選出一個範例去發起請求,根據統計學,當請求量夠大的時候,命中每個範例的概率是相同的,所以隨機演演算法也可以稱為平均演演算法。2.WeightRandom演演算法,即根據服務範例權重加權後再隨機,此時要聯絡上面對weight引數的講解,A伺服器上的應用的權重是1,B伺服器上的應用的權重是32,那麼如果根據random演演算法,分配給A和B的流量都是50%,這明顯不合理,所以我們根據權重加權後再隨機,1+32=33,那麼此時命中A的概率為1/33,命中B的概率為32/33,這樣就合理多了。

5.2.2 在StartUp.cs中新增設定

services.AddSummerBoot();
services.AddSummerBootFeign(it =>
{
	it.AddNacos(Configuration);
});

5.2.3 定義呼叫微服務的介面

普通的feign介面像下面這樣定義即可。注意,如果返回值是類的話,該類需要具有無參建構函式,否則會反序列化失敗。

[FeignClient(Url = "http://localhost:5001/home")]
public interface ITestFeign
    {
        [PostMapping("/form")]
        Task<Test> TestForm([Body(BodySerializationKind.Form)] Test tt);

        [GetMapping("/query")]
        Task<Test> TestQuery([Query] Test tt);     

        [PostMapping("/json")]
        Task<Test> TestJson([Body(BodySerializationKind.Json)] Test tt);
}

微服務的介面定義就要複雜一些,需要設定微服務的名稱ServiceName,分組名稱NacosGroupName(不填則預設DEFAULT_GROUP),名稱空間NacosNamespaceId(不填則預設public),以及MicroServiceMode設為true即可。url不用設定,剩下的就和正常的feign介面一樣。

[FeignClient( ServiceName = "test", MicroServiceMode = true,NacosGroupName = "DEFAULT_GROUP", NacosNamespaceId = "dfd8de72-e5ec-4595-91d4-49382f500edf")]
public interface IFeignService
{
	[GetMapping("/home/index")]
	Task<string> TestGet();
}

同時ServiceName,NacosGroupName,NacosNamespaceId也支援從組態檔中讀取,設定項用${}包裹即可,如組態檔中設定為

{
  "ServiceName": "test",
  "NacosGroupName": "DEFAULT_GROUP",
  "NacosNamespaceId": "dfd8de72-e5ec-4595-91d4-49382f500edf"
}

介面定義為

[FeignClient( ServiceName = "${ServiceName}", MicroServiceMode = true,NacosGroupName = "${NacosGroupName}", NacosNamespaceId = "${NacosNamespaceId}")]
public interface IFeignService
{
	[GetMapping("/home/index")]
	Task<string> TestGet();
}

定義完介面,就可以在要用到的地方注入,然後直接呼叫了,是不是覺得很簡單。

6.結尾

更多feign的用法,可參考SummerBoot檔案,也可以加入QQ群:799648362反饋建議。同時,如果你覺得這篇文章還不錯的話,請記得一鍵三連(推薦+關注+github star)