<kbd id="afajh"><form id="afajh"></form></kbd>
<strong id="afajh"><dl id="afajh"></dl></strong>
    <del id="afajh"><form id="afajh"></form></del>
        1. <th id="afajh"><progress id="afajh"></progress></th>
          <b id="afajh"><abbr id="afajh"></abbr></b>
          <th id="afajh"><progress id="afajh"></progress></th>

          TarsGateway通用 API 網(wǎng)關(guān)

          聯(lián)合創(chuàng)作 · 2023-10-01 10:47

          TarsGateway是基于tars框架開發(fā)的一套通用api網(wǎng)關(guān),請(qǐng)求為http協(xié)議,后端同時(shí)支持tars-tup&tars-tars協(xié)議、tars-json協(xié)議、http協(xié)議。 除了協(xié)議轉(zhuǎn)發(fā)之外,還支持流量控制,黑白名單等功能。

          支持版本說明

          • TarsCpp: >= v2.4.5
          • TarsJava: >= v1.7.2
          • TarsGo: >= v1.1.4
          • TarsNode: rpc: >= v2.0.14, stream: >= v2.0.3, tars2node: >= v20200707
          • TarsPHP: tars-server: >= v0.6.0

          功能介紹

          1. 代理類型的判斷

          TarsGateway 是根據(jù)請(qǐng)求host+url 判斷當(dāng)前請(qǐng)求是什么類型的請(qǐng)求,具體host和url通過配置設(shè)定。配置及對(duì)應(yīng)邏輯說明如下:

          • 配置所在域: /main/base
          • tup_host: tup請(qǐng)求對(duì)應(yīng)的host,如果請(qǐng)求host在tup_host列表中,那么會(huì)進(jìn)行后面的tup&&json請(qǐng)求的判斷。如果列表配置為空,那么也會(huì)判斷,這里支持前通配符。
          • tup_path: tup或tars請(qǐng)求的基礎(chǔ)path,默認(rèn)為 /tup ;
          • json_path: json 請(qǐng)求的基礎(chǔ)path,默認(rèn)為 /json ;
          • monitor_url: TarsGateway 的監(jiān)控地址,用來遠(yuǎn)程判斷服務(wù)是否存活。
          • 配置舉例:
              <main>
                  <base>
                      #tup_host 如果不配置,那么所有host開頭的,且沒有path或者path為 / , 也判斷為 tup 請(qǐng)求
                      tup_host=prx.tup.whup.com|prx2.tup.whup.com|*.prx.upchina.com
                      tup_path=/tup
                      json_path=/json
                      monitor_url=/monitor/monitor.html
                  </base>
              </main>
          

          2. TARS-tup && TARS-tars 協(xié)議代理

          TARS-tup協(xié)議代理,必須為post請(qǐng)求類型,路徑為/tup,body內(nèi)容為RequestPacket包tars序列化的內(nèi)容。TarsGateway收到包后,去反序列化body的內(nèi)容解析出RequestPacket包,然后根據(jù)其中的sServantName在配置中查找真是的tars服務(wù)的obj。如果配置auto_proxy=1,那么客戶端調(diào)用時(shí) sServantName 可以填真實(shí)的obj地址。這里建議:直接對(duì)C外網(wǎng)暴露的TarsGateway,建議配置auto_proxy=0,避免內(nèi)網(wǎng)的服務(wù)都直接對(duì)外暴露。另外,proxy的配置還可以支持 sServerName:sFuncName 的配置,會(huì)優(yōu)先根據(jù), 這種類型配置優(yōu)先級(jí)高于只配置sServerName 類型的配置。 proxy配置如下:

              <proxy>
                  hello = TestApp.HelloServer.HelloObj
                  hello:sayhello = TestApp.Hello2Server.HelloObj
              </proxy>
          

          經(jīng)過TarsGateway調(diào)用后端服務(wù),客戶端請(qǐng)求的http頭,可以通過配置采用tars的context進(jìn)行http頭的透?jìng)鳎J(rèn)情況下,REMOTE_IP (客戶端ip)都會(huì)透?jìng)鹘o后端。配置為 filterheaders,可以是多個(gè),比如:

              filterheaders = X-GUID|X-XUA
          

          調(diào)用后端tars服務(wù)時(shí),TarsGateway默認(rèn)采用tars自己的缺省輪訓(xùn)負(fù)載均衡策略(robin輪訓(xùn)),也可以通過配置自定義hash策略,hash_type為1時(shí),根據(jù)客戶端請(qǐng)求id進(jìn)行tarshash調(diào)用; hash_type為2時(shí),根據(jù)指定http頭(配種中的httpheader)進(jìn)行tarshash調(diào)用,比如http頭中的 X-GUID,注意這里選擇httpheader需要合理,避免過于集中某個(gè)值導(dǎo)致負(fù)載均衡過于不均勻的現(xiàn)象; hash_type為3時(shí),則根據(jù)客戶端的ip進(jìn)行tarshash調(diào)用。 如果obj后面沒有配置hash_type,那么采用tars默認(rèn)輪訓(xùn)調(diào)用。配置舉例如下:

              <proxy>
                  # servant = server_full_obj [| hash_type [| http header key] ]
                  # hash_type: 0, 輪訓(xùn); 1: requestid, 2: http頭, 3: client ip
                  # Hello=TestApp.HelloServer.HelloObj | 1
                  # Hello=TestApp.HelloServer.HelloObj | 2 | X-GUID
                  # Hello=TestApp.HelloServer.HelloObj | 3
                  hello = TestApp.HelloServer.HelloObj | 3
                  hello:sayhello = TestApp.Hello2Server.HelloObj
              </proxy>
              
          

          3. TARS-JSON 協(xié)議代理

          TARS-JSON協(xié)議代理,支持兩種類型的接口。

          • servantName和funcName在http url路徑中指定

          路徑為/json/servantName/funcName,其中/json是固定的,后面分別是servantName 和 funcName。

              請(qǐng)求:
              url: http://xx.xx.com/json/Test.GetSumServer.GetSumObj/getSumEx
              {"req":{"userKey":"upchina","userToken":"upchinatoken","x":1,"y":9900989}}
          
              響應(yīng):
              { "rsp": { "otherMsg": [ "1 + 9900989 = 9900990" ], "msg": "succ.", "sum": 9900990, "ret": 0 }, "": 0 }
          
          • 相關(guān)參數(shù)都在http body中指定:

          必須為post請(qǐng)求類型,路徑為/json,body內(nèi)容為json結(jié)構(gòu)。其中必須有reqid, obj, func, data 四個(gè)字段,分別表示請(qǐng)求id、服務(wù)servant、服務(wù)接口、接口參數(shù),對(duì)應(yīng)RequestPacket中的reqid:iRequestId, obj:sServantName, func:sFuncName。data內(nèi)容為接口中的參數(shù),key為參數(shù)名,value為參數(shù)內(nèi)容。除了以上必選四個(gè)字段之外,context為可選字段。回包內(nèi)容包括 reqid 和 data, data為接口出參內(nèi)容,其中 "" 的key對(duì)應(yīng)內(nèi)容為函數(shù)返回值。 這里除了這里包格式不一樣,其他后面的邏輯都和TARS-tup類型一樣。請(qǐng)求參數(shù)舉例如下:

              請(qǐng)求包:
              {
                  "reqid": 99999,
                  "obj": "getsum",
                  "func": "getSumEx",
                  "data": "{\"req\":{\"userKey\":\"upchina\",\"userToken\":\"upchinatoken\",\"x\":1,\"y\":9900989}}"
              }
              響應(yīng)包:
              { 
                  "data": "{ \"rsp\": { \"otherMsg\": [ \"1 + 9900989 = 9900990\" ], \"msg\": \"succ.\", \"sum\": 9900990, \"ret\": 0 }, \"\": 0 }", 
                  "reqid": 99999 
              }
          

          4. 普通HTTP協(xié)議代理

          普通HTTP協(xié)議代理,類似nginx的反向代理功能,主要功能包括根據(jù)domain和url進(jìn)行請(qǐng)求轉(zhuǎn)發(fā),后端負(fù)載均衡,容錯(cuò)容災(zāi),黑名單屏蔽,流量控制等功能。

          • 路由策略

          先匹配server_name,再匹配path,然后根據(jù) proxy_pass 路徑進(jìn)行轉(zhuǎn)發(fā),具體規(guī)則如下:

          server_name 匹配邏輯:
          {
          	1、查找全匹配
          	2、通配符在前匹配
          	3、通配符在后面匹配
          	4、正則匹配
          	5、如果server_name為空, 則默認(rèn)都匹配
          }
          
          path 匹配邏輯:
          {
          	1、= 全匹配:  /login
          	2、^~ uri以某個(gè)常規(guī)字符串開頭: ^~ /static/   (一旦匹配成功, 不再往后面匹配)
          	3、~ 正則匹配(區(qū)分大小寫):  ~ \.(gif|jpg|png|js|css)$  (正則表達(dá)式匹配多個(gè)的情況下, 按最長的匹配)
          	4、~* 正則匹配(不區(qū)分大小寫):~* \.png$
          	5、!~和!~*分別為區(qū)分大小寫不匹配及不區(qū)分大小寫不匹配 的正則:  !~ \.xhtml$,  !~* \.xhtml$
          	6、/xxx 從頭開始匹配路徑(匹配長度越長優(yōu)先級(jí)越高)
          	7、/ 任何請(qǐng)求都會(huì)匹配
          }
          
          proxy_pass:
          {
          	1、如果proxy_pass配置中沒有路徑(http://host/ 這個(gè)是有路徑的 /),這時(shí)候 location 匹配的完整路徑將直接透?jìng)鹘o url 
          	2、proxy_pass配置中包含路徑(哪怕只有一個(gè) / , 也算), 新路徑 = proxypassPath + (訪問路徑-location路徑)
          	3、當(dāng) location 中為正則時(shí), proxy_pass 不能帶路徑
          }
          
          • 負(fù)載均衡

          支持普通輪訓(xùn)和帶權(quán)重輪訓(xùn)策略,默認(rèn)權(quán)重(weight)為1,數(shù)據(jù)越大,權(quán)重越高。權(quán)重表示在一次輪訓(xùn)周期內(nèi)輪訓(xùn)的次數(shù)。

          • 容錯(cuò)容災(zāi)

          當(dāng)后端節(jié)點(diǎn)為多個(gè)節(jié)點(diǎn)時(shí)(大于等于2個(gè)節(jié)點(diǎn)),可以支持后端熔斷策略,這里是否進(jìn)行熔斷可以配置,默認(rèn)是打開的。

          失效屏蔽:如果出現(xiàn)連接出錯(cuò),那么就會(huì)直接臨時(shí)屏蔽該節(jié)點(diǎn),對(duì)應(yīng)inactive配置,其中的值為RequestCallback::FAILED_CODE類型。加入到失效的節(jié)點(diǎn),如果該站點(diǎn)配置了monitor_url,那么會(huì)定時(shí)輪訓(xùn)該url,如果出現(xiàn)http 200,那么恢復(fù)該節(jié)點(diǎn),輪訓(xùn)檢測(cè)間隔遞增,最大為2分鐘。如果沒有配置 monitor_url, 那么直接connect該節(jié)點(diǎn)的ip:port,能夠正常連接,那么恢復(fù)該節(jié)點(diǎn)。

          超時(shí)切換:當(dāng)超時(shí)次數(shù)在指定時(shí)間窗口達(dá)到一定閾值時(shí),或者超過一定比例時(shí),那么臨時(shí)屏蔽一段時(shí)間,一定時(shí)間后會(huì)嘗試超時(shí)恢復(fù)。

                  配置如下:
                  <http_retcode>
                      # 定義哪些返回碼做超時(shí)容錯(cuò)處理,哪些返回碼做出錯(cuò)容災(zāi)處理
                      inactive=2|6
                      timeout=1|3
                  </http_retcode>
          
                  RequestCallback::FAILED_CODE類型定義如下: 
                  enum FAILED_CODE
                  {
                      Failed_Net     = 0x01,      //網(wǎng)絡(luò)出錯(cuò)
                      Failed_Connect = 0x02,      //連接服務(wù)器出錯(cuò)
                      Failed_Timeout = 0x03,      //超時(shí)
                      Failed_Interrupt = 0x04,    //中斷接收數(shù)據(jù)
                      Failed_Close    = 0x05,     //服務(wù)器主動(dòng)關(guān)閉了鏈接
                      Failed_ConnectTimeout = 0x06, //鏈接超時(shí)
                  };
          

          IP黑名單和流控策略, 同時(shí)支持TarsGateway的三種協(xié)議,所以后面統(tǒng)一介紹。

          5. 流量控制

          可以支持訪問TarsGateway 訪問后端進(jìn)行流量控制,支持單機(jī)控制,也支持多機(jī)協(xié)同控制,也可以關(guān)閉流控。

          開關(guān)控制: 配置flow_control_onoff可以對(duì)流控進(jìn)行開關(guān)控制。另外如果服務(wù)servant沒有配置FlowControlObj,那么就不會(huì)開啟流控策略。

          流控策略: 一定時(shí)間內(nèi)最多訪問多少次, 通過時(shí)間滑動(dòng)窗口動(dòng)態(tài)控制,滑動(dòng)窗口大小為1s,超過次數(shù)則直接返回http 403。

          多機(jī)協(xié)同: 配置了tup_report_obj,那么會(huì)通過該obj進(jìn)行多機(jī)協(xié)同流量控制,否則進(jìn)行單機(jī)控制。注意,如果是單機(jī)的策略,那么流控配置的一定時(shí)間內(nèi)最多可以訪問多少次就是單機(jī)最多可以訪問該站點(diǎn)多少次;如果是多機(jī)協(xié)同,那么就是多機(jī)同時(shí)允許訪問該站點(diǎn)多少次。

          配置說明: 如果是TARS-tup或者TARS-JSON協(xié)議,那么流控的站點(diǎn)ID為服務(wù)Obj,如果是http協(xié)議,那么站點(diǎn)ID為配置中的stationId.

          6. 黑名單策略

          黑名單為IP黑名單,支持全局黑名單和站點(diǎn)黑名單兩個(gè)級(jí)別。

          黑名單格式: 客戶端IP地址,支持通配符。如 192.168.2.130, 192.168.10.*

          全局黑名單: 對(duì)所有訪問TarsGateway進(jìn)行控制,包括TARS-tup、TARS-JSON和普通HTTP協(xié)議。

          站點(diǎn)黑名單: 只針對(duì)指定站點(diǎn)控制,其他站點(diǎn)不首影響。

          站點(diǎn)白名單: 站點(diǎn)一旦配置了白名單,那么就只能是指定IP才能訪問,主要用于內(nèi)部系統(tǒng)控制指定ip訪問,或者開放給指定合作伙伴調(diào)用。

          7. 配置熱更新

          支持常用配置熱更新,包括:

          1. loadProxy: 通過該tars命令可以實(shí)現(xiàn)TARS-tup&TARS-JSON協(xié)議的servant代理配置更新;
          2. loadHttp: 通過該配置可以進(jìn)行普通HTTP協(xié)議的路由策略, 后端節(jié)點(diǎn)配置,監(jiān)控url配置等;
          3. loadComm: 通過該命令可以進(jìn)行一些公共的配置加載,主要包括黑白名單加載;
          4. 流控策略自動(dòng)動(dòng)態(tài)加載DB。
          瀏覽 19
          點(diǎn)贊
          評(píng)論
          收藏
          分享

          手機(jī)掃一掃分享

          編輯 分享
          舉報(bào)
          評(píng)論
          圖片
          表情
          推薦
          點(diǎn)贊
          評(píng)論
          收藏
          分享

          手機(jī)掃一掃分享

          編輯 分享
          舉報(bào)
          <kbd id="afajh"><form id="afajh"></form></kbd>
          <strong id="afajh"><dl id="afajh"></dl></strong>
            <del id="afajh"><form id="afajh"></form></del>
                1. <th id="afajh"><progress id="afajh"></progress></th>
                  <b id="afajh"><abbr id="afajh"></abbr></b>
                  <th id="afajh"><progress id="afajh"></progress></th>
                  亚洲无码视频在线观看高清 | 婷婷色五月丁香 | 全部免费黄色视频 | 青娱乐永久在线视频 | 亚洲综合免费观看高清 |