.net core Ocelot Consul 實現API網關 服務註冊 服務發現 負載均衡

時間  2019-11-08
標籤 core ocelot consul 實現 api 網關 服務 註冊 發現 負載 均衡 欄目 負載均衡 简体版
原文   原文鏈接

大神張善友 分享過一篇 《.NET Core 在騰訊財付通的企業級應用開發實踐》裏面就是用.net core 和 Ocelot搭建的可擴展的高性能Api網關。html

Ocelot(http://ocelot.readthedocs.io)是一個用.NET Core實現而且開源的API網關，它功能強大，包括了：路由、負載均衡、請求聚合、認證、鑑權、限流熔斷等，這些功能只都只須要簡單的配置便可完成。node

Consul(https://www.consul.io)是一個分佈式，高可用、支持多數據中心的服務註冊、發現、健康檢查和配置共享的服務軟件,由 HashiCorp 公司用 Go 語言開發。git

Ocelot天生集成對Consul支持，在OcelotGateway項目中Ocelot.json配置就能夠開啓ocelot+consul的組合使用，實現服務註冊、服務發現、健康檢查、負載均衡。github

 

軟件版本 json

Asp.net Core:2.0bootstrap

Ocelot:7.1.0-unstable0011(開發時最新)windows

Consul:1.1.0(開發時最新)api

 

 本文分開兩部分：一、基於Ocelot搭建Api網關；二、Ocelot+Consul 實現下游服務的服務註冊、服務發現、健康檢查、負載均衡。數組

 

項目結構瀏覽器

Snai.Ocelot 網關：

Snai.ApiGateway Asp.net Core 2.0 Api網關

Snai.ApiServiceA  Asp.net Core 2.0 Api下游服務A

Snai.ApiServiceB  Asp.net Core 2.0 Api下游服務B

ApiServiceA和ApiServiceB實際上是同樣的，用於負載，爲了測試方便，我建了兩個項目

Consul：

conf 配置目錄

data 緩存數據目錄，可清空裏面內容

dist Consul UI目錄

consul.exe 註冊軟件

startup.bat 執行腳本

 

項目實現

1、基於Ocelot搭建Api網關

新建Snai.Ocelot解決方案

一、搭建Api網關

新建 Snai.ApiGateway 基於Asp.net Core 2.0空網站，在 依賴項 右擊 管理NuGet程序包 瀏覽 找到 Ocelot 版本7.1.0-unstable0011安裝

1.一、在項目根目錄下新建一個 Ocelot.json 文件，打開 Ocelot.json 文件，配置Ocelot參數，Ocelot.json 代碼以下

{
  "ReRoutes": [
    {
      "UpstreamPathTemplate": "/apiservice/{controller}",
      "UpstreamHttpMethod": [ "Get" ],
      "DownstreamPathTemplate": "/apiservice/{controller}",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "host": "localhost",
          "port": 5011
        },
        {
          "host": "localhost",
          "port": 5012
        }
      ],
      "LoadBalancerOptions": {
        "Type": "LeastConnection"
      }
    }
  ],

  "GlobalConfiguration": {
    "BaseUrl": "http://localhost:5000"
  }
}

 若是有多個下游服務，把ReRoutes下 {...} 複製多份，最終如： "ReRoutes":[{...},{...}]

Ocelot參數說明以下，詳情查看官網（http://ocelot.readthedocs.io）

ReRoutes 路由配置

UpstreamPathTemplate 請求路徑模板
UpstreamHttpMethod 請求方法數組
DownstreamPathTemplate 下游請求地址模板
DownstreamScheme 請求協議，目前應該是支持http和https
DownstreamHostAndPorts 下游地址和端口
LoadBalancerOptions 負載均衡 RoundRobin(輪詢)/LeastConnection(最少鏈接數)/CookieStickySessions(相同的Sessions或Cookie發往同一個地址)/NoLoadBalancer(不使用負載)

DownstreamHostAndPorts配了兩個localhost 5011和localhost 5012用於負載均衡，負載均衡已經能夠了，但沒有健康檢查，當其中一個掛了，負載可能仍是會訪問這樣就會報錯，因此咱們要加入Consul，咱們稍後再講。

請求聚合，認證，限流，熔錯告警等查看官方配置說明

GlobalConfiguration 全局配置
BaseUrl 告訴別人網關對外暴露的域名

1.二、修改 Program.cs 代碼，讀取Ocelot.json配置，修改網關地址爲 http://localhost:5000

代碼以下：

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

namespace Snai.ApiGateway
{
    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }

        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((context, builder) => {
                    builder.SetBasePath(context.HostingEnvironment.ContentRootPath)
                    .AddJsonFile("Ocelot.json");
                })
                .UseUrls("http://localhost:5000")
                .UseStartup<Startup>()
                .Build();
    }
}

1.三、修改Startup.cs代碼，注入Ocelot到容器，並使用Ocelot

代碼以下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Ocelot.DependencyInjection;
using Ocelot.Middleware;

namespace Snai.ApiGateway
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddOcelot();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseOcelot().Wait();
        }
    }
}

 最終項目結構以下：

 二、搭建服務Snai.ApiServiceA，Snai.ApiServiceB

新建 Snai.ApiServiceA 基於Asp.net Core 2.0 Api網站

2.一、修改Controllers/ValuesController.cs代碼

修改路由爲Ocelot 配置的下游地址 apiservice/[controller]，注入appsettings.json配置實體，修改Get方法爲返回讀取配置內容，其餘方法能夠刪除

代碼以下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;

namespace Snai.ApiServiceA.Controllers
{
    [Route("apiservice/[controller]")]
    public class ValuesController : Controller
    {
        public IConfiguration Configuration { get; }

        public ValuesController(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        // GET api/values
        [HttpGet]
        public string Get()
        {
            return HttpContext.Request.Host.Port + " " + Configuration["AppName"] + " " + DateTime.Now.ToString();
        }
    }
}

 2.二、修改appsettings.json配置，加入 "AppName": "ServiceA"

{
  "Logging": {
    "IncludeScopes": false,
    "Debug": {
      "LogLevel": {
        "Default": "Warning"
      }
    },
    "Console": {
      "LogLevel": {
        "Default": "Warning"
      }
    }
  },
  "AppName": "ServiceA"
}

 2.三、修改Program.cs代碼，修改該服務地址爲 http://localhost:5011

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

namespace Snai.ApiServiceA
{
    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }

        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseUrls("http://localhost:5011")
                .UseStartup<Startup>()
                .Build();
    }
}

 2.四、新建 Snai.ApiServiceB 基於Asp.net Core 2.0 Api網站，幾乎與Snai.ApiServiceA同樣，除了 "AppName": "ServiceB"，.UseUrls("http://localhost:5012")

到此 基於Ocelot Api網關 搭建完成

三、啓動 運行 Snai.ApiServiceA，Snai.ApiServiceB，Snai.ApiGateway項目，在瀏覽器打開 http://localhost:5000/apiservice/values 地址

刷新頁面負載獲得ServiceA，ServiceB返回內容。

 

Ocelot已內置負載均衡，但沒有健康檢查，不能踢除壞掉的服務，因此加入Consul，Consul提供服務註冊發現、健康檢查，配合Ocelot負載就能發現壞掉的服務，只負載到正常的服務上，下面介紹加入Consul。

2、在Ocelot網關加入Consul，實現服務註冊發現、健康檢查

一、啓動Consul，開啓服務註冊、服務發現

首先下載Consul：https://www.consul.io/downloads.html，本項目是windows下進行測試，獲得consul.exe

再下載Consul配置文件和Consul UI(配置文件適合本例Demo的，可根據具體項目修改調整)：https://github.com/Liu-Alan/Ocelot-Consul/tree/master/Consul

conf:配置文件目錄

data:緩存數據目錄，可清空裏面內容

dist:Consul UI，用於瀏覽器查看註冊的服務狀況；若是用Consul默認自帶UI，該目錄能夠刪除，Consul 啓動腳本 -ui-dir ./dist 改成 -ui

Consul支持配置文件和Api兩種方式服務註冊、服務發現，下面主要講解配置文件方式

Consul 配置文件service.json配置以下：

{
  "encrypt": "7TnJPB4lKtjEcCWWjN6jSA==",
  "services": [
    {
      "id": "ApiServiceA",
      "name": "ApiService",
      "tags": [ "ApiServiceA" ],
      "address": "localhost",
      "port": 5011,
      "checks": [
        {
          "id": "ApiServiceA_Check",
          "name": "ApiServiceA_Check",
          "http": "http://localhost:5011/health",
          "interval": "10s",
          "tls_skip_verify": false,
          "method": "GET",
          "timeout": "1s"
        }
      ]
    },
    {
      "id": "ApiServiceB",
      "name": "ApiService",
      "tags": [ "ApiServiceB" ],
      "address": "localhost",
      "port": 5012,
      "checks": [
        {
          "id": "ApiServiceB_Check",
          "name": "ApiServiceB_Check",
          "http": "http://localhost:5012/health",
          "interval": "10s",
          "tls_skip_verify": false,
          "method": "GET",
          "timeout": "1s"
        }
      ]
    }
  ]
}

 兩個服務ApiServiceA和ApiServiceB，跟着兩個健康檢查ApiServiceA_Check和ApiServiceB_Check

因爲ApiServiceA和ApiServiceB作負載均衡，如今 "name": "ApiService" 配置同樣

修改Snai.ApiServiceA、Snai.ApiServiceB項目 加入health 健康檢查地址

打開ValuesController.cs 加入 health

代碼以下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;

namespace Snai.ApiServiceA.Controllers
{
    [Route("apiservice/[controller]")]
    public class ValuesController : Controller
    {
        public IConfiguration Configuration { get; }

        public ValuesController(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        // GET api/values
        [HttpGet]
        public string Get()
        {
            return HttpContext.Request.Host.Port + " " + Configuration["AppName"] + " " + DateTime.Now.ToString();
        }

        [HttpGet("/health")]
        public IActionResult Heathle()
        {
            return Ok();
        }
    }
}

 從新生成運行項目Snai.ApiServiceA、Snai.ApiServiceB

清除Consul/data 內容，新建startup.bat文件，輸入下面代碼，雙擊啓動Consul，本項目測試時一臺機器，因此把 本機IP 改爲 127.0.0.1

consul agent -server -datacenter=dc1 -bootstrap -data-dir ./data -config-file ./conf -ui-dir ./dist -node=n1 -bind 本機IP -client=0.0.0.0

再在Consul目錄下啓動另外一個cmd命令行窗口，輸入命令：consul operator raft list-peers 查看狀態查看狀態，結果以下

 

打開Consul UI：http://localhost:8500 查看服務狀況，能夠看到ApiServiceA、ApiServiceB 服務，且健康檢查都是正常的。

因爲ApiServiceA、ApiServiceB是在一臺機器上兩個服務作負載 因此在一個Consul裏配置了兩個name同樣的服務。

若是用兩個機器作ApiServiceA負載，本機IP是192.168.0.5，另外一臺IP是192.168.0.6上，以本機上主Consul

 本機 0.5 Consul配置以下

{
  "encrypt": "7TnJPB4lKtjEcCWWjN6jSA==",
  "services": [
    {
      "id": "ApiServiceA",
      "name": "ApiService",
      "tags": [ "ApiServiceA" ],
      "address": "192.168.0.5",
      "port": 5011,
      "checks": [
        {
          "id": "ApiServiceA_Check",
          "name": "ApiServiceA_Check",
          "http": "http://192.168.0.5:5011/health",
          "interval": "10s",
          "tls_skip_verify": false,
          "method": "GET",
          "timeout": "1s"
        }
      ]
    }
  ]
}

 把ApiServiceA和Consul拷到另外一個0.6機器，修改Consul配置文件

{
  "encrypt": "7TnJPB4lKtjEcCWWjN6jSA==",
  "services": [
    {
      "id": "ApiServiceA",
      "name": "ApiService",
      "tags": [ "ApiServiceA" ],
      "address": "192.168.0.6",
      "port": 5011,
      "checks": [
        {
          "id": "ApiServiceA_Check",
          "name": "ApiServiceA_Check",
          "http": "http://192.168.0.6:5011/health",
          "interval": "10s",
          "tls_skip_verify": false,
          "method": "GET",
          "timeout": "1s"
        }
      ]
    }
  ]
}

修改啓動Consul腳本的IP爲192.168.0.6，-node=n2，去掉 -bootstrap，啓動Consul，在Consul UI下查看服務是否正常

在192.168.0.5下，把192.168.0.6加到集羣中，命令以下

consul join 192.168.0.6

注意，consul集羣中，consul配置文件中的encrypt，必定要相同，不然沒法放加入同一個集羣

用consul operator raft list-peers查看狀態，會發現n1,n2在一個集羣中了

Node  ID                                    Address             State     Voter  RaftProtocol

n1    d02c3cd0-d9c8-705b-283e-121a9105cf52  192.168.0.5:8300   leader    true   3

n2    efe954ce-9840-5c66-fa80-b9022167d782  192.168.0.6:8300  follower  true   3

二、配置Ocelot，加入Consul，啓用服務健康檢查，負載均衡

打開 Snai.ApiGateway 網關下的Ocelot.json文件，加入下面配置

ServiceName 是Cousul配置中服務的name名字

UseServiceDiscovery 是否啓用Consul服務發現

ServiceDiscoveryProvider 是Consul服務發現的地址和端口

從新生成啓動Ocelot網關，到此Ocelot+Consul配置完成

3、運行測試Ocelot+Consul服務發現、負載均衡

打開 http://localhost:5000/apiservice/values 地址，刷新頁面負載獲得ServiceA，ServiceB返回內容

 

當把ApiServiceB服務關掉，再屢次刷新頁面，只能獲得ServiceA的內容

打開Consul UI去看，ServiceB健康檢查失敗

 

Ocolot+Consul實現API網關 服務註冊、服務發現、健康檢查和負載均衡已完成

源碼訪問地址：https://github.com/Liu-Alan/Ocelot-Consul

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程