一個故事,一段程式碼告訴你如何使用不同語言(Golang&C#)提供相同的能力基於Consul做服務註冊與發現

引言

趁著最近休息寫一篇關於微服務架構中特別重要一環服務註冊與發現示例來互相探討學習。

什麼是微服務

傳統服務

  • 舉個栗子: 傳統服務就類似於你們家附近的商店,這個商店可以提供你基本日常所需。你可以在裡面買牙膏、零食、飲料、襪子、充電器等。
  • 優點
    1. 產品固定的情況下方便打理 (開發/維護效率高)
    2. 生意不錯的情況下可按照當前模式快速在其他地方開分店 (易於部署)
  • 缺點
    1. 如果收銀系統出問題就會導致商店無法正常營業 (宕機)
    2. 在店面商品已經放滿的情況下添加新產品要麼先存放在其他商品分類下 (耦合度高),要麼只能擴大店面 (縱向擴展)

微服務

  • 舉個栗子微服務就類似於一個商場,這個商場會有統一的入口,會有保安,導購台。商場裡面會按照不同的商品類型開不同的「店」,例如賣「牙膏」、「牙刷」的一個店,賣「襪子」、「拖鞋」的一個店,賣「手機」、「充電器」的一個店。假設你想買一部手機,進入商場時你問了下門口的保安「哪個店可以買手機」,這時保安會說「出示一下健康碼」(ApiGateway鑒權),綠碼通過後,保安問了下身後的導購員 (服務發現),得到答案時保安就會告訴你哪一層哪個店賣手機。然後你就可以按照他的指引進去購買了。
  • 優點
    1. 當賣手機的店收銀系統出現了問題,不影響其他店運營,也不會導致整個商場打烊 (服務隔離,分而治之)
    2. 如果哪天華為手機大賣,商場一個手機店不能承載用戶消費了,可以在商場中再開一個手機店 (橫向擴展)
  • 缺點
    1. 維護一個商場的治安、衛生較難 (可維護性較差)
    2. 商場發現小偷,尋找起來較麻煩 (線上問題修復時間長)

什麼是服務註冊與服務發現

服務註冊與發現就類似於上面微服務例子中的導購員角色。她可以告訴訪問者指定服務微服務系統中的哪個位置。

舉個栗子:
最近放假,商場的咖啡店生意不錯。於是我就拉著小明去商場開了兩個咖啡店準備賺一筆。為什麼開同時開兩個呢,生意太好,如果小明那邊客戶比較多的話,就可以讓部分客戶到我這邊來買 (負載均衡) 。還有如果哪天晚上我打遊戲打晚了,早上起不來,小明就正常營業。或者是小明有事呢,我就正常營業 (熔斷)
說干就干,兩個咖啡店已經被我們如火如荼的置辦起來了 (完成服務開發),我們給它起了個名字叫「三泡咖啡」 (服務名稱),小明的店在商場入口旁邊門牌號是302,我的店在商場後面門牌號是609 (服務ID)
開業以後呢,每天早上,我和小明都會分別到導購台那邊和導購小姐姐說「今天我們店正常營業」(不是撩小姐姐),這時導購小姐姐就會在小本本上記上我們的店和門牌號 (服務註冊),之後進入商場的客人如果想買「三泡咖啡」,小姐姐就會按照她登記的資訊告訴客人 (服務發現) 咖啡店在哪一層哪一號。
導購小姐姐呢也會定時來看我們店有沒有存在突發情況,影不影響正常營業 (健康檢查)。例如我這家店的收銀系統今天出現問題了,導致無法正常營業了,那麼導購小姐姐就會拿出小本本備註一下,下次再有客人想喝「三泡咖啡」,導購小姐姐就會將客人指向小明那家店了。

為什麼要使用不同的語言提供相同的服務能力

本來我是想和小明分別購置一個自動咖啡機來為用戶提供咖啡的,可是預算不足只能買一個。但沒辦法,我是老闆,所以就給小明買了一個手磨咖啡機來做咖啡。不是說自動咖啡機一定比手磨咖啡機做的好,也不能說手磨咖啡機一定比自動咖啡機做出來的香。它們做出來的味道一樣,只是結合了實際情況來定的。你說對嗎? phper。

服務協調器

服務協調器就類似於上面例子中的導購員,常用的服務協調器有:ConsulEurekaZookeeperEtcd等。這個例子中我們就選用Consul來實現我們的服務註冊與發現。

consulgoogle開源的一個使用go語言開發的服務發現、配置管理中心服務。內置了服務註冊與發現框 架、分布一致性協議實現、健康檢查、Key/Value存儲、多數據中心方案,不再需要依賴其他工具(比如ZooKeeper等)。服務部署簡單,只有一個可運行的二進位的包。每個節點都需要運行agent,他有兩種運行模式serverclient。每個數據中心官方建議需要3或5個server節點以保證數據安全,同時保證server-leader的選舉能夠正確的進行。

安裝部署方式就請參考官方文檔或百度一下吧。

官方地址://www.consul.io/

我這裡是使用Docker部署的三個Consul實例
image

服務註冊

Golang

使用Golang創建一個coffee-service服務,ID為coffee-service1

打開IDE在src目錄下創建一個文件夾coffee,並添加coffeeServer.go文件,輸入如下程式碼

package main

import (
	"fmt"
	"github.com/hashicorp/consul/api"
	"net/http"
)

func main()  {
	consulConfig := api.DefaultConfig()
	consulConfig.Address = "consul.insipid.top"				// consul 地址

	consulClient, err := api.NewClient(consulConfig)
	if err != nil {
		fmt.Println("new consul client err:", err)
		return
	}

	// 服務註冊配置
	registerService := api.AgentServiceRegistration{
		ID:      "coffee-service1",							// id唯一
		Name:    "coffee-service",							// 服務名稱,相同服務多實例註冊下名稱相同
		Tags:    []string{"demo"},							// tag
		Port:    8082,										// 當前服務埠
		Address: "39.99.248.231",
		Check: &api.AgentServiceCheck{						// 健康檢查相關配置
			HTTP:      "//39.99.248.231:8082/health",  // 健康檢查介面,response code = 200表示檢查通過
			Timeout:  "5s",									// 超時時間
			Interval: "5s",									// 檢查間隔
			DeregisterCriticalServiceAfter: "10s",			// 檢查失敗後指定時間自動踢出無效服務
		},
	}

	// 註冊當前配置服務到consul
	err = consulClient.Agent().ServiceRegister(&registerService)
	if err!=nil{
		fmt.Println("註冊到consul失敗,err:",err)
		return
	}
	fmt.Println("註冊到consul成功")

	// 添加健康檢查介面,需要和上面註冊服務配置資訊中的健康檢查path相同
	http.HandleFunc("/health", func(writer http.ResponseWriter, request *http.Request) {
		writer.Write([]byte("ok"))
	})

	// 業務處理
	http.HandleFunc("/get", func(writer http.ResponseWriter, request *http.Request) {
		writer.Write([]byte("歡迎光臨三泡咖啡(609號店)"))
	})

	// 啟動http伺服器
	http.ListenAndServe(":8082",nil)
}

打開終端,在coffeeServer.go路徑下,輸入go mod init coffee,創建go mod文件,創建完成後再在終端輸入go mod tidy拉取consul所需要的依賴包。拉取成功後如下:

module coffee

go 1.17

require github.com/hashicorp/consul/api v1.11.0

require (
	github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da // indirect
	github.com/fatih/color v1.9.0 // indirect
	github.com/hashicorp/go-cleanhttp v0.5.1 // indirect
	github.com/hashicorp/go-hclog v0.12.0 // indirect
	github.com/hashicorp/go-immutable-radix v1.0.0 // indirect
	github.com/hashicorp/go-rootcerts v1.0.2 // indirect
	github.com/hashicorp/golang-lru v0.5.0 // indirect
	github.com/hashicorp/serf v0.9.5 // indirect
	github.com/mattn/go-colorable v0.1.6 // indirect
	github.com/mattn/go-isatty v0.0.12 // indirect
	github.com/mitchellh/go-homedir v1.1.0 // indirect
	github.com/mitchellh/mapstructure v1.1.2 // indirect
	golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae // indirect
)

在終端輸入go run coffeeServer.go運行程式
image
在瀏覽器中輸入localhost:8082/get訪問,此時可以看到程式正常運行
image

打開Consul可視化面板consul.insipid.top發現,服務已經註冊上去,但健康檢查未通過,因為我的Consul是部署在雲伺服器上面的,訪問不到本地電腦。所以現在需要將程式碼編譯推送到雲伺服器上運行。
image

由於我的雲伺服器是centos系統,所以需要將GOOS設置為linux
image

設置完成後,編譯coffeeServer.go並推送到雲伺服器
image

通過遠程連接工具(XShell),連接到雲伺服器,並打開到推送的目錄。設置執行許可權並運行
image

程式運行成功後,再打開Consul可視化面板consul.insipid.top發現,服務已經註冊並通過健康檢查
image

C#(.NetCore3.1)

使用C#也創建一個coffee-service服務,功能與Golangcoffee-service一樣,ID為coffee-service2

打開IDE新建一個空WebApi項目coffeeServer,添加Nuget包Consul
image

Startup.cs文件中輸入如下程式碼:

using Consul;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System;

namespace coffeeServer
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Error");
            }

            app.UseRouting();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllerRoute("default", "{controller}/{action}");
            });

            var consulClient = new ConsulClient(x => { x.Address = new Uri("//consul.insipid.top/"); });           // consul 地址
            var httpCheck = new AgentServiceCheck()
            {
                DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(10),                                              // 檢查失敗後指定時間自動踢出無效服務
                Interval = TimeSpan.FromSeconds(10),                                                                    // 檢查間隔
                HTTP = "//39.99.248.231:8083/Health",                                                              // 健康檢查介面,response code = 200表示檢查通過
                Timeout = TimeSpan.FromSeconds(5)                                                                       // 超時時間
            };

            var registration = new AgentServiceRegistration()
            {
                Checks = new[] { httpCheck },
                ID = "coffee-service2",                                                                                 // id唯一
                Name = "coffee-service",                                                                                // 服務名稱,相同服務多實例註冊下名稱相同
                Address = "39.99.248.231",
                Port = 8083,
                Tags = new string[] { "demo" }                                                                          // tag
            };
            consulClient.Agent.ServiceRegister(registration).Wait();
        }
    }
}

新增一個控制器CoffeeController用於處理業務和健康檢查(api介面和上面的golang項目保持一樣)

using Microsoft.AspNetCore.Mvc;

namespace coffeeServer.Controllers
{
    public class CoffeeController:ControllerBase
    {
        [HttpGet("get")]
        public IActionResult Get()
        {
            return Content("歡迎光臨三泡咖啡(302號店)");
        }

        [HttpGet("health")]
        public IActionResult Health()
        {
            return Ok("ok");
        }
    }
}

本地運行成功,且服務已註冊到Consul
image
此時可以看到coffee-service已經有兩個示例了,紅色為C#寫的服務還沒推送到雲伺服器,健康檢查失敗
image

編譯推送C#程式到雲伺服器,由於.NetCore在Centos中需要安裝.Net Runtime,安裝步驟請自行百度

此時我們可以看見服務已成功運行
image

並在也註冊到Consul,這時Consul的coffee-service已經有兩個實例,一個通過Golang編寫,一個通過C#編寫
image

服務發現

當服務註冊成功後,我們如果通過Consul來獲取剛剛註冊且健康的服務清單,其實就已經實現了負載均衡。 當然一般情況下我們會統一通過ApiGateway接入到Consul的方式來訪問註冊到Consul中的服務,但ApiGateway不是我們今天的主角,下次來討論它。

通過HttpClient發現服務,並訪問

打開剛剛的coffee文件夾下,添加coffeeClient.go文件,輸入如下程式碼

package main

import (
	"fmt"
	"github.com/hashicorp/consul/api"
	"io/ioutil"
	"net/http"
	"strconv"
)

func main()  {
	consulConfig := api.DefaultConfig()
	consulConfig.Address="consul.insipid.top"					// consul 地址
	registerClient, _ := api.NewClient(consulConfig)

	// 通過consul獲取coffee-service的有效服務地址
	services, _, _ := registerClient.Health().Service("coffee-service", "demo", true, nil)

	for _,service := range services{
		getCoffeeUrl := "//"+service.Service.Address+":"+strconv.Itoa(service.Service.Port)+"/get"
		fmt.Println("service:",getCoffeeUrl)

		response, err := http.Get(getCoffeeUrl)
		if err!=nil{
			fmt.Println("get err:",err)
			return
		}

		body, err:= ioutil.ReadAll(response.Body)
		if err!=nil{
			fmt.Println("read body err:",err)
			return
		}
		fmt.Println(string(body))
		response.Body.Close()
	}
}

打開終端執行go run coffeeClient.go,成功通過Consul獲取到coffee-service的有效服務
image

註銷一個coffee-service實例再訪問

打開XShell,關閉coffee-service1實例
image

打開終端再次執行go run coffeeClient.go,發現剛剛通過Golang寫的coffee-service1已經獲取不到了
image

至此,我們已經完美實現不同語言(Golang&C#)提供相同服務能力給第三方調用了。

一般情況下,我們不會使用不同的技術棧來做相同服務的構建,都是看哪塊業務哪個語言更適合。這個實驗想表達的是,語言沒有好壞,只要它支援跨平台方便移植那麼它在互聯網的技術海洋里總有一席之地的。

以上表述或步驟如有什麼不妥,歡迎留言指正。謝謝~