Ocelot簡易教程(二)之快速開始2

爲何這篇的標題叫「Ocelot簡易教程(二)之快速開始2」呢,由於不少朋友跟我說上一篇「 Ocelot簡易教程(二)之快速開始1」內容太少了,只是簡單介紹Ocelot的一些簡單配置,讓Ocelot能跑起來!因此纔有了這篇快速開始2.在這篇文章中,我會一步一步記錄怎麼跑起來一個Ocelot項目,並簡單的介紹一下Ocelot怎麼實現接口間的負載均衡!此篇文章的代碼我會放在個人github上面。後續深刻的記錄Ocelot的使用的時候也會沿用此次的代碼。html

Ocelot簡易教程目錄

  1. Ocelot簡易教程(一)之Ocelot是什麼
  2. Ocelot簡易教程(二)之快速開始1
  3. Ocelot簡易教程(二)之快速開始2
  4. Ocelot簡易教程(三)之主要特性及路由詳解
  5. Ocelot簡易教程(四)之請求聚合以及服務發現
  6. Ocelot簡易教程(五)之集成IdentityServer認證以及受權
  7. Ocelot簡易教程(六)之重寫配置文件存儲方式並優化響應數據
  8. Ocelot簡易教程(七)之配置文件數據庫存儲插件源碼解析git

    本文做者:依樂祝
    原文地址:http://www.javashuo.com/article/p-qkgaxres-dn.htmlgithub

    一步一步開始

  9. 演示項目概述
    此次的演示項目由於要實現Ocelot的負載均衡的功能,所以至少須要三個項目:Ocelot網關,OrderApi,GoodApi .名字隨便取的,可能博主認爲這樣起名字比較順口,沒有其餘特別的含義。web

  10. 新建上面的三個asp.net core web api項目
    相信看這篇文章的朋友至少應該懂asp.net core了吧,否則你也接觸不到Ocelot的。因此,這裏假設你們都會建立asp.net core web api(由於真的沒什麼技術含量)。建立後的項目接口以下圖所示:數據庫

1536760414707

  1. 給OcelotDemo網關項目添加Ocelot包以及配置文件
    首先給OcelotDemo添加Nuget包,能夠右鍵「管理Nuget」包,而後搜索Ocelot添加,以下圖所示:

1536760891676
也能夠經過命令 Install-Package Ocelot進行安裝。方式隨你喜歡。json

而後給OcelotDemo項目新建一個json文件,新建的方式就是,右鍵OcelotDemo項目,而後選擇「添加」-》「新建項」,在彈出的窗口裏面找到json文件,並寫好文件的名字便可,(固然,也能夠用快捷鍵 Ctrl+Shilt+A)以下圖所示:c#

1536761555713

固然,你還須要右鍵你剛剛設置的ocelot.json文件,並設置「複製到輸出目錄」的屬性爲「始終複製」以下所示:api

1536762570080

接下來,能夠按照我寫的很是簡單的配置進行配置。數組

{
  "ReRoutes": [
    {
      "DownstreamPathTemplate": "/api/{everything}",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 1001
        },
        {
          "Host": "localhost",
          "Port": 1002
        }
      ],
      "UpstreamPathTemplate": "/{everything}",
      "UpstreamHttpMethod": [ "Get", "Post" ],
      "LoadBalancerOptions": {
        "Type": "RoundRobin"
      }
    }
  ],
  "GlobalConfiguration": {

  }
}

上面配置,有兩個節點,分別是ReRoutes數組,以及GlobalConfiguration。這裏簡單作一下闡述:服務器

ReRoutes:告訴Ocelot如何處理上游的請求。

DownstreamPathTemplate:下游的路由模板,即真實處理請求的路徑模板

DownstreamScheme:請求的方式,如:http,htttps

DownstreamHostAndPorts:下游的IP以及端口,能夠有多個(若是使用負載均衡),方便實現負載均衡,固然你也可使用服務發現,實現下游服務的自動註冊與發現,這篇文章不會講解。

UpstreamPathTemplate:上游請求的模板,即用戶真實請求的連接

UpstreamHttpMethod:上游請求的http方法,是個數組,你能夠寫多個。

LoadBalancerOptions:負載均衡選項(DownstreamHostAndPorts有多個的時候才能看到效果),有三種方式

LeastConnection : 將請求發往最空閒的那個服務器

RoundRobin :輪流發送

NoLoadBalance :不啓用負載均衡,老是發往第一個請求或者服務發現的那個服務器

GlobalConfiguration:顧名思義就是全局配置,此節點的配置容許覆蓋ReRoutes裏面的配置,你能夠在這裏進行通用的一些配置信息。

  1. OcelotDemo中添加Ocelot支持。

    首先在OcelotDemo項目的Program.cs中加載上一步咱們添加的Ocelot的配置文件,以下所示:

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
                WebHost.CreateDefaultBuilder(args)
                    .ConfigureAppConfiguration((hostingContext, config) =>
                    {
                        config
                            .SetBasePath(hostingContext.HostingEnvironment.ContentRootPath)
                            .AddJsonFile("appsettings.json", true, true)
                            .AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", true, true)
                            .AddJsonFile("Ocelot.json")
                            .AddEnvironmentVariables();
                    })
                    .UseUrls("http://localhost:1000")
                    .UseStartup<Startup>();

    而後,在Startup.cs中,添加Ocelot服務並啓用Ocelot中間件,這裏你須要在Startup.cs文件中引入下面兩個命名空間:

    using Ocelot.DependencyInjection;
    using Ocelot.Middleware;

    而後,分別在ConfigureServices中註冊Ocelot服務以及Configure中啓用Ocelot中間件:

    public void ConfigureServices(IServiceCollection services)
            {
                services.AddOcelot();//注入Ocelot服務
                services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
            }
    
            // 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();//使用Ocelot中間件
                app.UseMvc();
            }

    這時候,Ocelot的配置基本完成了,下面咱們驗證下Ocelot有沒有正常工做,以及咱們配置的負載均衡,有沒有起做用吧。

    1. 測試Ocelot項目以及負載均衡有沒有起做用

      這裏,首先分別對三個項目的ValuesController控制器作以下改造:

      OcelotDemo項目ValuesController中的Get方法改造以下:

      [HttpGet]
              public ActionResult<IEnumerable<string>> Get()
              {
                  return new string[] { "value1 from Ocelot", "value2 from Ocelot" };
              }

      OrderApi項目中的ValuesController中的Get方法改造以下:

      [HttpGet]
              public ActionResult<IEnumerable<string>> Get()
              {
                  return new string[] { "value1 from Order Api", "value2 from Order Api" };
              }

      GoodApi項目中的ValuesController中的Get方法改造以下:

      [HttpGet]
              public ActionResult<IEnumerable<string>> Get()
              {
                  return new string[] { "value1 from Good Api", "value2 from Good Api" };
              }

    結合咱們上面的配置,能夠知道改造的目的就是爲了以下的測試,咱們作出以下假設:

    1. 爲了驗證上游模板/{everything} 對應下游模板/api/{everything} 咱們請求的路徑即爲http://localhost:1000/Values 而且把GoodApi以及GoodApi響應路徑分別設置爲:http://localhost:1001/api/Values ,http://localhost:1003/api/Values 並獲得正確的響應
    2. 爲了驗證Ocelot項目起做用,咱們請求ocelotDemo項目的路徑values,應該返回GoodApi,或者OrderApi項目中values控制器的值,而不是返回ocelotDemo中values控制器的值
    3. 爲了驗證Ocelot負載均衡起做用,咱們連續訪問ocelotDemo項目的路徑values,則返回的結果應該是輪流返回GoodApi以及OrderApi的值。

    下面咱們利用 dotnet run命令分別啓動三個項目,固然你也能夠多項目啓動。而後訪問OcelotDemo項目的Url並訪問Values控制器,完整路徑「http://localhost:1000/Values」,看到

    OcelotDemo的Url:http://localhost:1000

    GoodApi的Url:http://localhost:1001

    OrderApi的Url:http://localhost:1002

    咱們第一次訪問http://localhost:1000/Values 獲得以下結果:

1536765413775

說明咱們的假設1以及假設2都是沒問題的。也就是說咱們的Ocelot已經在起做用了,並且根據上下游路由進行了映射。

接下來咱們刷新下頁面,獲得以下結果:

1536765539347

說明咱們的假設3即Ocelot的負載均衡也起做用了。固然,你能夠多刷新幾回,能夠看到返回的結果在GoodApi與Order Api之間來回切換。由於咱們的負載均衡策略就是輪詢啊!

源碼連接

Github地址:https://github.com/yilezhu/OcelotDemo

最後

這篇文章主要是爲了讓記錄如何快速的開始使用Ocelot。關於Ocelot的配置不少都沒有描述,包括限流以及熔斷策略,以及多配置文件自動加載功能,等等。這個超出了快速開始的範圍,固然這些高級的用法會在下面的系列文章中會一一記錄。

本文使用的是Ocelot最新版本,爲了保持技術上的跟進,所以沒有使用上篇文章介紹的老版本,因此演示都是經過最新的ocelot版原本跟進的!

總結

本篇文章只是記錄了,如何快速的成功的使用ocelot,並進行了簡單的配置,配置中又引入了一個負載均衡的策略,最後經過代碼進行了相關的實現以及測試!關於其餘的一些配置,我會在下面的文章中進行闡述。這裏只是對上篇文章「Ocelot簡易教程(二)之快速開始1」的補充!感謝你們的閱讀!

相關文章
相關標籤/搜索