微服務框架Demo.MicroServer運行手冊

2020 年 7 月 7 日
筆記
Apollo, Consul, Exceptionless, IdentityServer4, microservice, Ocelot, Polly, Skywalking, SkyWalking-dotnet, Swagger, 微服務

一.背景說明：

之前分享過一個微服務開發框架，「享一個集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking的微服務開發框架」，前兩天在Github上收到一個Issues，是想我這邊提供下完整的運行文檔和配置文件，因為之前想法是弄清楚這幾個東西的職責之後，對於運行的先後順序，和需要的配置key應該都會有了解，所以README編寫只是介紹了用到了哪些東西，沒有說如何運行，但是既然有人問起，我還是滿足一下，就當成是自己回顧了。

二.回顧下項目結構

項目結構比較簡單：

MicroServer.Instance文件夾下面存放的是微服務實例，至於微服務顆粒度的拆分得結合實際的業務情況
Demo.MicroServer.IdentityServer4 統一鑒權中心
Demo.MicroServer.Infrastructure 基礎設施，可以自行在裏面添加內容
Demo.MicroServer.Ocelot 這一層是Api網關
Demo.MicroServer.Repository 通用的數據訪問層，包含MySQL，Mongo，Redis等，之所以抽離出來，是方便各個服務實例可是直接使用這些通用方法。

而上面說的 “.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking” 中有幾個東西還未出現，分別是 Consul，Polly，Exceptionless，Apollo，SkyWalking，這裡還是分別介紹下

Consul是一種服務網格解決方案，提供具有服務發現，健康檢查，Key/Value存儲，多數據中心等功能。在這裡我們主要使用到服務發現，健康檢查，啟動場景是：微服務實例啟動的時候
Polly是.NET彈性和瞬態故障處理庫，與Ocelot天然友好集成，使用也只需要在Ocelot 層添加少數配置即可使用
Exceptionless是一款開源的實時的日誌收集框架，可以使用在線或者本地搭建好的服務（如果只是本地測試建議直接使用在線的很方便），然後在微服務中配置好Url和應用的ApiKey就可以使用。
Apollo是攜程框架部門研發的分佈式配置中心，能夠集中化管理應用不同環境、不同集群的配置，配置修改後能夠實時推送到應用端，並且具備規範的權限、流程治理等特性，適用於微服務配置管理場景，搭建好Apollo服務後，我們代碼配置文件就可以變得相當乾淨了，只用留Apollo的配置就行，其他的配置幾乎全部可以放在Apollo裏面了。
SkyWalking 關於SkyWalking 我有一篇文章專門介紹了這個，這裡不在贅述，需要了解的可以查看：在微服務框架Demo.MicroServer中添加SkyWalking+SkyApm-dotnet分佈式鏈路追蹤系統

三.安裝啟動微服務周邊應用

在運行服務之前，你或許可以先安裝或開啟以下幾個服務

MySql
Exceptionless
如果還沒安裝可以參考：//github.com/exceptionless/exceptionless/wiki/self-hosting ，建議使用docker安裝
apollo
如果還沒安裝，可以參考：//github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_software_installation_guide_cn.md
consul
這個可以直接下載編譯好的文件，直接啟動就行
./consul agent -dev -data-dir=/data/consul -node=agent-1 -client=0.0.0.0 -bind=10.34.5.101 -datacenter=demo
Skywalking
請參考我之前的文章：在微服務框架Demo.MicroServer中添加SkyWalking+SkyApm-dotnet分佈式鏈路追蹤系統

咋一看這麼多需要安裝啟動的是不是感覺很慌？
不用擔心，其實如果先排除身份驗證連數據庫都不用讀，可以只用安裝consul就可以，至於apollo可以先將配置寫在代碼的配置文件中，對於將項目跑起來這點來說apollo不是必須的，日誌收集也可以暫緩，性能檢測也一樣，我們可以先將核心的跑起來，再來完善他的周邊，秉着這個思路，我們開始運行

四.開始啟動

啟動consul

開發下我們可以這樣啟動consul服務：

./consul agent -dev -data-dir=/data/consul -node=agent-1 -client=0.0.0.0 -bind=10.34.5.101 -datacenter=demo

啟動之後的效果如圖：

啟動三個微服務實例

dotnet Demo.MicroServer.UserService.dll --urls="//*:6891" --ip="本機ip" --port=6891
dotnet Demo.MicroServer.UserService.dll --urls="//*:6892" --ip="本機ip" --port=6892
dotnet Demo.MicroServer.UserService.dll --urls="//*:6893" --ip="本機ip" --port=6893

這裡演示，分別在6891，6892，6893三個端口啟動用戶的微服務實例，啟動之後，consul就開始工作了，如圖：

而Consul是如何發現服務的，其實得益於我們在服務裏面添加的一個擴展:

public static IApplicationBuilder UseConsul(this IApplicationBuilder app, IConfiguration configuration)
{
    ConsulClient _client = new ConsulClient(c =>
    {
        c.Address = new Uri(configuration["Consul.ServerUrl"]);
        c.Datacenter = "Demo.MicroServer";
    });

    string ip = configuration["ip"];
    int port = int.Parse(configuration["port"]);
    int weight = string.IsNullOrEmpty(configuration["weight"]) ? 1 : int.Parse(configuration["weight"]);

    _client.Agent.ServiceRegister(new AgentServiceRegistration()
    {
        ID = "UserService-" + Guid.NewGuid(),
        Name = "Demo.MicroServer.UserService",
        Address = ip,
        Port = port,
        Tags = new string[] { string.IsNullOrEmpty(configuration["tags"]) ? "" : configuration["tags"] },   //標籤
        Check = new AgentServiceCheck()                                                                     //健康檢查
        {
            Interval = TimeSpan.FromSeconds(10),                                                            //每隔多久檢測一次
            HTTP = $"//{ip}:{port}/api/health/check",
            Timeout = TimeSpan.FromSeconds(5),
            DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(60)                                       //在遇到異常後關閉自身服務通道
        }
    });

    return app;
}

並在StartUp.cs中使用了他：app.UseConsul(Configuration);

其實到這裡，項目就已經跑起來了，並且具備初步的負載均衡功能，我們可以通過這三個端口其中任意一個來調用服務都是可以的。凡是都有但是，難道要人為去配置什麼場景使用哪個ip和端口的服務嗎，或者說要將我們所有的服務都暴露出去嗎，每個服務都加一套登錄鑒權機制嗎？想想都覺得很可怕，那麼怎麼解決這個問題呢，答案就是.Net 中常用的APi GateWay之：Ocelot

啟動網關Ocelot

開始啟動Ocelot層：dotnet Demo.MicroServer.Ocelot.dll
網關啟動之後就可以通過網關的ip去訪問任意被註冊過的服務，前提是在網關層中有配置好協議，以下面兩個為例子，一個是swagger，一個是用戶服務

//swagger
{
  "DownstreamPathTemplate": "/doc/Demo.MicroServer.UserService/swagger.json",
  "DownstreamScheme": "http",
  "ServiceName": "Demo.MicroServer.UserService",
  "LoadBalancer": "RoundRobin",
  "UseServiceDiscovery": true,
  "UpstreamPathTemplate": "/doc/Demo.MicroServer.UserService/swagger.json",
  "UpstreamHttpMethod": [ "GET", "POST", "DELETE", "PUT" ]
},
//UserService
{
  "DownstreamPathTemplate": "/api/{url}",
  "DownstreamScheme": "http",
  "UpstreamPathTemplate": "/api/{url}",
  "UpstreamHttpMethod": [ "Get", "Post", "DELETE", "PUT" ],
  "ServiceName": "Demo.MicroServer.UserService",
  "UseServiceDiscovery": true,
  "LoadBalancerOptions": {
    "Type": "RoundRobin"
},

由於每個服務中都已經配置好了swagger文檔，所以這裡只需要指定路由協議，一樣的可以通過網關來訪問swagger
這裡可以通過網關的ip和端口訪問swagger和userservice服務

截止到這裡服務的註冊與發現還有網關的上下游配置基本完成，但是圍繞在網關層的東西有很多，例如緩存，限流，熔斷器，在網關層統一鑒權等等，但是這些不是當前要討論的，這個具體根據後續反饋再看是否要單獨拿出來解釋.

五.Apoll配置

上面介紹了運行啟動流程，根據需求，這裡也貼一下apollo總的配置項，而網關層和用戶服務層的配置在appsetting中有配置，代碼中已經都有了，這裡着重貼下apollo中的配置

Demo.MicroServer.Ocelot 層在apollo中的配置:

Swagger.ServiceDocNames = Demo.MicroServer.UserService,Demo.MicroServer.ProductService
IdentityService4.Uri = //localhost:5000
IdentityService4.UseHttps = false

如圖：

Demo.MicroServer.UserService 層在apollo中的配置:

MySqlConnections = server=mysql_ip;port=3306;database=demo_microserver;User Id=root;pwd=123456;charset=utf8
Swagger.Name = Demo.MicroServer.UserService
Swagger.Version = v1
Swagger.DocName = Demo.MicroServer.UserService
Swagger.Title = Api interface documentation
Swagger.Description = See below for specific interface
Swagger.Contact.Name = PeyShine
Swagger.Contact.Email = [email protected]
Swagger.XmlFile = Demo.MicroServer.UserService.xml
Exceptionless.ApiKey = LmqMIxSTW0U68pKwJ3xXqrNrLqS6oEociW7OexNt
Exceptionless.ServerUrl = //exceptionless_ip:5000
Consul.ServerUrl = //consul_ip:8500
MongoDB.DefaultConnection = mongodb://dev:Aa123456@mongo_ip/demo_db
MongoDB.DefaultDatabase = demo_db
MongoDB.DefaultTable = users

如圖:

六.總結

本文作為文章”分享一個集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking的微服務開發框架“的一個補充擴展，主要是介紹如何一步步啟動Demo.MicroServer微服務框架，裏面關於網關還有IdentityServer4沒有進行深入討論，想法是只要能先將項目核心部分跑起來，周邊應用可以自行添加，後續再根據反饋是否要更加詳細的去介紹。
其實理解了幾個開源項目自己的職責之後，對運行流程就不難理解了，動手試試吧!

文章代碼在Github中的地址：//github.com/PeyShine/Demo.MicroServer,歡迎star

Tags: Apollo Consul Exceptionless IdentityServer4 microservice Ocelot Polly Skywalking SkyWalking-dotnet Swagger 微服務