重複造輪子系列——基於Ocelot實現相似支付寶接口模式的網關

時間 2019-11-18

標籤重複輪子系列基於 ocelot 實現相似支付寶接口模式網關简体版

原文原文鏈接

重複造輪子系列——基於Ocelot實現相似支付寶接口模式的網關

引言

重複造輪子系列是本身平時的一些總結。有的輪子依賴社區提供的輪子爲基礎，這裏把使用過程的一些以爲有意思的作個分享。有些思路或者方法在大神看來可能會比較low。可是能解決實際問題，相信有須要的人也在尋找相似的解決方案。這裏能夠算做是提供了一種思路，相似問題若是有讀者能有更好的解決方案，願聞其詳。json

如有閱讀後引發心裏衝突或者憤怒等不適以及自覺被誤導者，不須要切換到抖音等歡樂頻道進行綜合調理，直接就能夠在評論區吐槽。api

網關簡介

什麼是網關，爲何用網關。這些問題網上有不少文章，講解的很是全面。這裏就不作重複的講解了。瀏覽器

但後面的內容至少須要瞭解網關下面兩點。服務器

API網關是一個服務器，是系統的惟一入口。app

API網關方式的核心要點是，全部的客戶端和消費端都經過統一的網關接入微服務，在網關層處理全部的非業務功能（提供監控、鑑權、負載均衡等）。負載均衡

默認實現

下面演示的項目使用vs2019，Asp.Net Core 2.1開發async

一、建立一個ASP.NET Core API項目Agile.Demo1.API，使用Swagger做爲在線UI展現微服務

項目結構如圖1post

圖1測試

發佈而且運行，爲了方面啓動運行，寫了個批處理腳本，如圖2

圖2

直接雙擊start運行如圖3

圖3

瀏覽器打開顯示效果如圖4

圖4

直接Swagger文檔在線測試各個接口正常。

二、建立一個ASP.NET Core API項目Agile.Demo2.API 與Agile.Demo1.API項目相似。

三、建立一個基於ocelot的網關服務，項目結構如圖5

圖5

這裏使用Ocelot來作網關，Ocelot是一堆特定順序的中間件

配置ocelot.json，配置內容以下

{

  "ReRoutes": [

    //API01 業務接口1

    {

      "DownstreamPathTemplate": "/{url}",

      "DownstreamScheme": "http",

      "DownstreamHostAndPorts": [

        {

          "Host": "127.0.0.1",

          "Port": 9001

        }

      ],

      "UpstreamPathTemplate": "/demo1/{url}",

      "UpstreamHttpMethod": [ "Post", "Get" ],

      "ReRoutesCaseSensitive": false

    },

    //API02 業務接口2

    {

      "DownstreamPathTemplate": "/{url}",

      "DownstreamScheme": "http",

      "DownstreamHostAndPorts": [

        {

          "Host": "127.0.0.1",

          "Port": 9002

        }

      ],

      "UpstreamPathTemplate": "/demo2/{url}",

      "UpstreamHttpMethod": [ "Post", "Get" ],

      "ReRoutesCaseSensitive": false

    }

  ]

}

這個配置比較簡單，就配置了兩個下游的業務接口。

把兩個業務接口站點和網關站點都運行起來，如圖6

圖6

使用postman直接測試demo1 裏面的 saveorder接口，如圖7

圖7

使用postman直接測試demo2 裏面的 saveorder接口，如圖8

圖8

使用postman經過網關訪問demo1，如圖9

圖9

能正常返回數據，說明網關的轉發正常。

經過網關訪問demo2也相似，這裏就不截圖了。下面提供demo代碼能夠下載本身測試下。

這裏只介紹，經過網關的轉發，其餘網關方面的更多應用不在這裏作介紹。

新的問題

有一次，咱們提供接口和其餘部門對接。按照慣例把接口以及網關部署好，文檔提供，讓他們按照文檔規定的傳就能夠了。

結果，他們看了文檔後提出了疑問，這是什麼網關。每一個接口請求地址還得拼接出來做爲完整的請求，咱們代碼要作不少調整啊。能不能作成支付寶那種，就一個地址固定不變，而後公共參數，業務參數封裝的模式。由於這種模式封裝的東西都有現成的，這樣咱們就不用很大的改動就能夠快速對接了。看下支付寶接口，如圖10

圖10

我想你這公共參數還不是動態的，至關於原來咱們提供的網關地址後面加的就是對應的動態數據，道理都同樣的啊，但受阿里系影響，他們接口的開發仍是對接都是習慣按照支付寶這種模式來的，封裝的公共參數什麼的都作好了，要調整很麻煩。接口不按照他們的樣子來就彆扭，增長他們工做量。

當時我想這怎麼辦，我出接口應該按照咱們的要求來啊，但沒辦法不夠強勢，還得按照他們阿里系規則來，那就想辦法吧。

想到ocelot也是一系列的中間件處理的，我想那就增長一箇中間件，把請求給攔截了，從新組合數據，再下發。

這樣能夠保證咱們內部的調用不變，對外兼容這種請求方式。說幹就幹，先作個demo試驗下可否行得通。

增長一箇中間件GatewayMiddleware，代碼以下，既然要按照支付寶接口的來，那乾脆把公共參數這塊總體搬過來。

// You may need to install the Microsoft.AspNetCore.Http.Abstractions package into your project

    public class GatewayMiddleware { private readonly RequestDelegate _next; public GatewayMiddleware(RequestDelegate next) { _next = next; } public async Task Invoke(HttpContext httpContext) { //支持相似支付寶的網關模式 //公共請求參數 //app_id method format charset sign_type sign timestamp version app_auth_token biz_content //請求參數(業務)，建議json格式 //trade_no out_trade_no operator_id

            if (httpContext.Request.Path.ToString().ToLower() == "/gateway"|| httpContext.Request.Path.ToString().ToLower() == "/gateway.do") { //調用方post form提交，獲取公共請求參數，處理作轉發

                if (httpContext.Request.Method.ToLower() == "get") { httpContext.Response.ContentType = "text/plain;charset=utf-8"; await httpContext.Response.WriteAsync("調試錯誤，請回到請求來源地，從新發起請求"); return; } var reqForm = httpContext.Request.Form; if (reqForm == null || reqForm.Count == 0) { httpContext.Response.ContentType = "text/plain;charset=utf-8"; await httpContext.Response.WriteAsync("調試錯誤，請回到請求來源地，從新發起請求"); return; } var app_id = reqForm.ContainsKey("appid") ? reqForm["appid"].ToString() : ""; var method = reqForm.ContainsKey("method") ? reqForm["method"].ToString() : "";//接口名稱（格式：模塊.控制器.方法） 好比demo1.Values.SaveOrder

                var format = reqForm.ContainsKey("format") ? reqForm["format"].ToString() : "json"; var charset = reqForm.ContainsKey("charset") ? reqForm["charset"].ToString() : "utf-8"; var sign_type = reqForm.ContainsKey("sign_type") ? reqForm["sign_type"].ToString() : "md5"; var sign = reqForm.ContainsKey("sign") ? reqForm["sign"].ToString() : ""; var timestamp = reqForm.ContainsKey("timestamp") ? reqForm["timestamp"].ToString() : ""; var version = reqForm.ContainsKey("version") ? reqForm["version"].ToString() : ""; var app_auth_token = reqForm.ContainsKey("app_auth_token") ? reqForm["app_auth_token"].ToString() : ""; var biz_content = reqForm.ContainsKey("biz_content") ? reqForm["biz_content"].ToString() : "";//業務接口參數 json格式 //經過method參數拆分出 模塊 控制器 方法

                var methods = method.Split('.'); var moduleName = method.Length > 0 ? methods[0] : ""; var controllerName = method.Length > 1 ? methods[1] : ""; var actionName = method.Length > 2 ? methods[2] : ""; //區分有版本和無版本兩種狀況，version不傳或傳空就是無版本

                var nextPath = string.IsNullOrEmpty(version) ? $"/{moduleName}/api/{controllerName}/{actionName}" : $"/{moduleName}/api/v{version}/{controllerName}/{actionName}"; //下游業務接口暫時只支持post json格式的請求

                byte[] postData = Encoding.GetEncoding(charset).GetBytes(biz_content); httpContext.Request.Path = nextPath; httpContext.Request.ContentType = "application/json"; httpContext.Request.ContentLength = postData.Length; httpContext.Request.Body = new MemoryStream(postData); await _next(httpContext); } else { await _next(httpContext); } } } // Extension method used to add the middleware to the HTTP request pipeline.

    public static class GatewayMiddlewareExtensions { public static void UseGatewayMiddleware(this IApplicationBuilder app) { app.UseMiddleware<GatewayMiddleware>(); } }

Startup.cs增長以下代碼，如圖11

測試攔截成功，從新組裝下發。可以正常返回，測試成功。

具體的操做看代碼的說明，這裏就再也不贅述。

這裏有一點要特別說明。由於公共參數是form表單post提交，因此調用方請求過來確定是post方式。轉到下游的時候這個請求類型沒有改變，全部暫時只支持下游是post的接口。不過能夠增長個參數或者使用format參數值來作區分下游具體是get仍是post。由於如今format是json確定只能是支持post。