eShopOnContainers 知多少[9]：Ocelot gateways

本文轉載自查看原文 2019-03-05 14:13 1657 eShopOnContainers

引言

客戶端與微服務的通信問題永遠是一個繞不開的問題，對於小型微服務應用，客戶端與微服務可以使用直連的方式進行通信，但對於對於大型的微服務應用我們將不得不面對以下問題：

如何降低客戶端到后台的請求數量，並減少與多個微服務的無效交互？
如何處理微服務間的交叉問題，比如授權、數據轉換和動態請求派發？
客戶端如何與使用非互聯網友好協議的服務進行交互？
如何打造移動端友好的服務？

而解決這一問題的方法之一就是借助API網關，其允許我們按需組合某些微服務以提供單一入口。

接下來，本文就來梳理一下eShopOnContainers是如何集成Ocelot網關來進行通信的。

使用自定義的API 網關服務

Hello Ocelot

關於Ocelot，張隊在Github上貼心的整理了awesome-ocelot系列以便於我們學習。這里就簡單介紹下Ocelot，不過多展開。
Ocelot是一個開源的輕量級的基於ASP.NET Core構建的快速且可擴展的API網關，核心功能包括路由、請求聚合、限速和負載均衡，集成了IdentityServer4以提供身份認證和授權，基於Consul提供了服務發現能力，借助Polly實現了服務熔斷，能夠很好的和k8s和Service Fabric集成。

Ocelot 集成

eShopOnContainers中的以下六個微服務都是通過網關API進行發布的。

引入網關層后，eShopOnContainers的整體架構如下圖所示：
引入網關層后的整體架構設計

從代碼結構來看，其基於業務邊界（Marketing和Shopping）分別為Mobile和Web端建立多個網關項目，這樣做利於隔離變化，降低耦合，且保證開發團隊的獨立自主性。所以我們在設計網關時也應注意到這一點，切忌設計大一統的單一API網關，以避免整個微服務架構體系的過度耦合。在網關設計中應當根據業務和領域去決定API網關的邊界，盡量設計細粒度而非粗粒度的API網關。

eShopOnContainers中ApiGateways文件下是相關的網關項目。相關項目結構如下圖所示。

ApiGateways 代碼結構

從代碼結構看，有四個configuration.json文件，該文件就是ocelot的配置文件，其中主要包含兩個節點：

{
 "ReRoutes": [],
 "GlobalConfiguration": {}
}

那4個獨立的配置文件是怎樣設計成4個獨立的API網關的呢？
在eShopOnContainers中，首先基於OcelotApiGw項目構建單個Ocelot API網關Docker容器鏡像，然后在運行時，通過使用docker volume分別掛載不同路徑下的configuration.json文件來啟動不同類型的API-Gateway容器。示意圖如下：
重用Ocelot Docker鏡像啟動多個網關容器服務

docker-compse.yml中相關配置如下：

// docker-compse.yml
mobileshoppingapigw:
 image: eshop/ocelotapigw:${TAG:-latest}
 build:
 context: .
 dockerfile: src/ApiGateways/ApiGw-Base/Dockerfile

// docker-compse.override.yml
mobileshoppingapigw:
 environment:
 - ASPNETCORE_ENVIRONMENT=Development
 - IdentityUrl=http://identity.api
 ports:
 - "5200:80"
 volumes:
 - ./src/ApiGateways/Mobile.Bff.Shopping/apigw:/app/configuration

通過這種方式將API網關分成多個API網關，不僅可以同時重復使用相同的Ocelot Docker鏡像，而且開發團隊可以專注於團隊所屬微服務的開發，並通過獨立的Ocelot配置文件來管理自己的API網關。

而關於Ocelot的代碼集成，主要就是指定配置文件以及注冊Ocelot中間件。核心代碼如下：

public void ConfigureServices(IServiceCollection services)
{
    //..
    services.AddOcelot (new ConfigurationBuilder ()
    .AddJsonFile (Path.Combine ("configuration", "configuration.json"))
    .Build ());
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
     //...
    app.UseOcelot().Wait();
}

請求聚合

在單體應用中時，進行頁面展示時，可以一次性關聯查詢所需的對象並返回，但是對於微服務應用來說，某一個頁面的展示可能需要涉及多個微服務的數據，那如何進行將多個微服務的數據進行聚合呢？首先，不可否認的是，Ocelot提供了請求聚合功能，但是就其靈活性而言，遠不能滿足我們的需求。因此，一般會選擇自定義聚合器來完成靈活的聚合功能。在eShopOnContainers中就是通過獨立ASP.NET Core Web API項目來提供明確的聚合服務。Mobile.Shopping.HttpAggregator和Web.Shopping.HttpAggregator即是用於提供自定義的請求聚合服務。

使用聚合服務的架構

下面就以Web.Shopping.HttpAggregator項目為例來講解自定義聚合的實現思路。
首先，該網關項目是基於ASP.NET Web API構建。其代碼結構如下圖所示：
Web.Shopping.HttpAggregator 自定義聚合服務代碼結構

其核心思路是自定義網關服務借助HttpClient發起請求。我們來看一下BasketService的實現代碼：

public class BasketService : IBasketService
{
    private readonly HttpClient _apiClient;
    private readonly ILogger<BasketService> _logger;
    private readonly UrlsConfig _urls;
    public BasketService(HttpClient httpClient,ILogger<BasketService> logger, IOptions<UrlsConfig> config)
    {
        _apiClient = httpClient;
        _logger = logger;
        _urls = config.Value;
    }
    public async Task<BasketData> GetById(string id)
    {
        var data = await _apiClient.GetStringAsync(_urls.Basket +  UrlsConfig.BasketOperations.GetItemById(id));
        var basket = !string.IsNullOrEmpty(data) ? JsonConvert.DeserializeObject<BasketData>(data) : null;
        return basket;
    }
}

代碼中主要是通過構造函數注入HttpClient，然后方法中借助HttpClient實例發起相應請求。那HttpClient實例是如何注冊的呢，我們來看下啟動類里服務注冊邏輯。

public static IServiceCollection AddApplicationServices(this IServiceCollection services)
{
    //register delegating handlers
    services.AddTransient<HttpClientAuthorizationDelegatingHandler>();
    services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

    //register http services  
    services.AddHttpClient<IBasketService, BasketService>()
        .AddHttpMessageHandler<HttpClientAuthorizationDelegatingHandler>()
        .AddPolicyHandler(GetRetryPolicy())
        .AddPolicyHandler(GetCircuitBreakerPolicy());

    services.AddHttpClient<ICatalogService, CatalogService>()
        .AddPolicyHandler(GetRetryPolicy())
        .AddPolicyHandler(GetCircuitBreakerPolicy());

    services.AddHttpClient<IOrderApiClient, OrderApiClient>()
        .AddHttpMessageHandler<HttpClientAuthorizationDelegatingHandler>()
        .AddPolicyHandler(GetRetryPolicy())
        .AddPolicyHandler(GetCircuitBreakerPolicy());
    return services;
}

從代碼中可以看到主要做了三件事：

注冊HttpClientAuthorizationDelegatingHandler負責為HttpClient構造Authorization請求頭
注冊IHttpContextAccessor用於獲取HttpContext
為三個網關服務分別注冊獨立的HttpClient，其中IBasketServie和IOrderApiClient需要認證，所以注冊了HttpClientAuthorizationDelegatingHandler用於構造Authorization請求頭。另外，分別注冊了Polly的請求重試和斷路器策略。

那HttpClientAuthorizationDelegatingHandler是如何構造Authorization請求頭的呢？直接看代碼實現：

public class HttpClientAuthorizationDelegatingHandler
     : DelegatingHandler
{
    private readonly IHttpContextAccessor _httpContextAccesor;
    public HttpClientAuthorizationDelegatingHandler(IHttpContextAccessor httpContextAccesor)
    {
        _httpContextAccesor = httpContextAccesor;
    }
    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        var authorizationHeader = _httpContextAccesor.HttpContext
            .Request.Headers["Authorization"];
        if (!string.IsNullOrEmpty(authorizationHeader))
        {
            request.Headers.Add("Authorization", new List<string>() { authorizationHeader });
        }
        var token = await GetToken();
        if (token != null)
        {
            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
        }
        return await base.SendAsync(request, cancellationToken);
    }
    async Task<string> GetToken()
    {
        const string ACCESS_TOKEN = "access_token";
        return await _httpContextAccesor.HttpContext
            .GetTokenAsync(ACCESS_TOKEN);
    }
}

代碼實現也很簡單：首先從 _httpContextAccesor.HttpContext.Request.Headers["Authorization"]中取，若沒有則從_httpContextAccesor.HttpContext.GetTokenAsync("access_token")中取，拿到訪問令牌后，添加到請求頭request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);即可。

這里你肯定有個疑問就是：為什么不是到Identity microservices去取訪問令牌，而是直接從_httpContextAccesor.HttpContext.GetTokenAsync("access_token")中取訪問令牌？

Good Question，因為對於網關項目而言，其本身也是需要認證的，在訪問網關暴露的需要認證的API時，其已經同Identity microservices協商並獲取到令牌，並將令牌內置到HttpContext中了。所以，對於同一個請求上下文，我們僅需將網關項目申請到的令牌傳遞下去即可。

Ocelot網關中如何集成認證和授權

不管是獨立的微服務還是網關，認證和授權問題都是要考慮的。Ocelot允許我們直接在網關內的進行身份驗證，如下圖所示：
網關內身份驗證

因為認證授權作為微服務的交叉問題，所以將認證授權作為橫切關注點設計為獨立的微服務更符合關注點分離的思想。而Ocelot網關僅需簡單的配置即可完成與外部認證授權服務的集成。

1. 配置認證選項
首先在configuration.json配置文件中為需要進行身份驗證保護API的網關設置AuthenticationProviderKey。比如：

{
  "DownstreamPathTemplate": "/api/{version}/{everything}",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "basket.api",
      "Port": 80
    }
  ],
  "UpstreamPathTemplate": "/api/{version}/b/{everything}",
  "UpstreamHttpMethod": [],
  "AuthenticationOptions": {
    "AuthenticationProviderKey": "IdentityApiKey",
    "AllowedScopes": []
  }
}

2. 注冊認證服務
當Ocelot運行時，它將根據Re-Routes節點中定義的AuthenticationOptions.AuthenticationProviderKey，去確認系統是否注冊了相對應身份驗證提供程序。如果沒有，那么Ocelot將無法啟動。如果有，則ReRoute將在執行時使用該提供程序。
在OcelotApiGw的啟動配置中，就注冊了AuthenticationProviderKey：IdentityApiKey的認證服務。

public void ConfigureServices (IServiceCollection services) {
    var identityUrl = _cfg.GetValue<string> ("IdentityUrl");
    var authenticationProviderKey = "IdentityApiKey";
    //…
    services.AddAuthentication ()
        .AddJwtBearer (authenticationProviderKey, x => {
            x.Authority = identityUrl;
            x.RequireHttpsMetadata = false;
            x.TokenValidationParameters = new
            Microsoft.IdentityModel.Tokens.TokenValidationParameters () {
                ValidAudiences = new [] {
                "orders",
                "basket",
                "locations",
                "marketing",
                "mobileshoppingagg",
                "webshoppingagg"
                }
            };
        });
    //...
}

這里需要說明一點的是ValidAudiences用來指定可被允許訪問的服務。其與各個微服務啟動類中ConfigureServices()內 AddJwtBearer()指定的Audience相對應。比如：

// prevent from mapping "sub" claim to nameidentifier.
JwtSecurityTokenHandler.DefaultInboundClaimTypeMap.Clear ();
var identityUrl = Configuration.GetValue<string> ("IdentityUrl");
services.AddAuthentication (options => {
    options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme
    options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
}).AddJwtBearer (options => {
    options.Authority = identityUrl;
    options.RequireHttpsMetadata = false;
    options.Audience = "basket";
});

3. 按需配置申明進行鑒權
另外有一點不得不提的是，Ocelot支持在身份認證后進行基於聲明的授權。僅需在ReRoute節點下配置RouteClaimsRequirement即可：

"RouteClaimsRequirement": {
 "UserType": "employee"
}

在該示例中，當調用授權中間件時，Ocelot將查找用戶是否在令牌中是否存在UserType:employee的申明。如果不存在，則用戶將不被授權，並響應403。

最后

經過以上的講解，想必你對eShopOnContainers中如何借助API 網關模式解決客戶端與微服務的通信問題有所了解，但其就是萬金油嗎？API 網關模式也有其缺點所在。

網關層與內部微服務間的高度耦合。
網關層可能出現單點故障。
API網關可能導致性能瓶頸。
API網關如果包含復雜的自定義邏輯和數據聚合，額外增加了團隊的開發維護溝通成本。

雖然IT沒有銀彈，但eShopOnContainers中網關模式的應用案例至少指明了一種解決問題的思路。而至於在實戰場景中的技術選型，適合的就是最好的。

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。