第三方接口設(shè)計方案注意事項

1、封裝統(tǒng)一的http請求工具類

集成apache httpclient開源框架响牛;
集成okhttp開源框架妓湘;

2查蓉、打印請求接口入?yún)ⅰ⒊鰠裉⒑臅r日志(可以在請求工具類統(tǒng)一打印)

在請求工具類統(tǒng)一打印豌研,例如:
long start = System.currentTimeMillis();
// todo 請求接口返回result結(jié)果
looinfo("耗時:{}ms,url:{},param:{},result:{}",System.currentTimeMillis()-start,result,reqUrl,param,result);

3、參數(shù)合法性校驗(減少對下游無效的調(diào)用)

  • 數(shù)據(jù)格式的校驗(例如非空唬党、合法性判斷)
  • 業(yè)務(wù)合法性的校驗

4、接口設(shè)置超時時間

http工具類提供配置的超時時間參數(shù)驶拱,供其他業(yè)務(wù)場景傳遞霜浴;

  • 不同的業(yè)務(wù)場景設(shè)置不同的超時時間;
  • 禁止不設(shè)置超時間蓝纲,設(shè)置默認(rèn)的超時時間;
  • 評估超時時間缸匪,要結(jié)合業(yè)務(wù),不能拍腦袋闯冷,比如可以根據(jù)接口監(jiān)控,看一下P95辩诞、P99的響應(yīng)時間纺涤,然后在這個基礎(chǔ)上放大一點撩炊;

5伯顶、接口是否需要重試以及重試次數(shù)

  • 事務(wù)類接口不要隨便重試,如果下游沒做好接口冪等容易超發(fā)掐暮,像活動的獎品發(fā)放愉择。但是一定要有業(yè)務(wù)告警衷戈,通過人工接入的方式殖妇,進行補發(fā)處理查詢類接口的重試谦趣;
  • 查詢類接口的重試,也要慎重考慮摘悴,如果下游接口支持的QPS有限舰绘,重試放量口四,容易把下游的接口打垮驳概,所以如果決定重試探膊,要調(diào)研下游接口的并發(fā)能力流济,酌情處理;

6、事務(wù)一致性保障

自身服務(wù):

  • 調(diào)用下游接口失敗斤彼,根據(jù)業(yè)務(wù)需要判斷是否回滾其他的業(yè)務(wù)或者記錄業(yè)務(wù)數(shù)據(jù)到本地事務(wù)消息表悦施,然后啟動一個job定時補償數(shù)據(jù)土陪;
  • 管理后臺提供一個事務(wù)消息表查詢的功能⊥芾簦可以在界面上手工點擊進行人工補償璧疗;

數(shù)據(jù)下游服務(wù):

  • 提供的接口定義一個唯一值的字段却音,接口做好冪等處理;
  • 提供一個根據(jù)唯一值的字段查詢業(yè)務(wù)數(shù)據(jù)的接口,便于上游對賬;

7、接口實現(xiàn)熔斷返回兜底值及降級

自動熔斷實現(xiàn)方案:

接入開源的Hystrx或sentne框架酬土,配置合理斷的值(例如1分鐘接口100個報錯叽唱,斷30s),實現(xiàn)超時或接口報錯自動熔斷钟鸵,同時跟業(yè)務(wù)商量給出一個默認(rèn)兜底值蒙袍。例如調(diào)用大數(shù)據(jù)客群接口岂昭,如果第三方提供的客群接口大量報錯或服務(wù)超時,為了保護我們自己的系統(tǒng)恰矩,框架自動熔斷同時返回默認(rèn)不命中的兜底值纪吮;

手動熔斷實現(xiàn)方案:

接入開源的動態(tài)配置中心apollo或disconf,配置熔斷開關(guān),當(dāng)收到大量業(yè)務(wù)告警,動態(tài)秒級關(guān)閉,恢復(fù)后打開開關(guān)谭贪;

無論是自動或手動套媚,都需要配置業(yè)務(wù)告警浆熔。

8师郑、多次調(diào)用改為單次批量調(diào)用

  • for循環(huán)根據(jù)id調(diào)用外部接口改為單次批量根據(jù)id調(diào)用,減少多次網(wǎng)絡(luò)io帶來的時間消耗;

  • 要考慮單次批量調(diào)用參數(shù)的大小,比如單次傳1000個id參數(shù),這個也不行聘裁,可能導(dǎo)致接口直接超時衡便,所以要對參數(shù)進行分組切割批量調(diào)用姻政,比如1000個參善镰,1次100個品洛,分10次調(diào)用;

9、接口返回的數(shù)據(jù)考慮是否緩存(防止對下游接口造成流量沖擊)

查詢客戶命中的客群標(biāo)簽缓苛,同一人一天內(nèi)理論上都是不變的,可以使用redis緩存,但是過期時間不適合太長染乌,因為同一個人使用系統(tǒng)的時間也不長台颠;

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末局装,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子统舀,更是在濱河造成了極大的恐慌瓮钥,老刑警劉巖碉熄,帶你破解...
    沈念sama閱讀 219,427評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件琼梆,死亡現(xiàn)場離奇詭異羞海,居然都是意外死亡时鸵,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,551評論 3 395
  • 文/潘曉璐 我一進店門吴菠,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人刺覆,你說我怎么就攤上這事悍手」啄粒” “怎么了?”我有些...
    開封第一講書人閱讀 165,747評論 0 356
  • 文/不壞的土叔 我叫張陵忿偷,是天一觀的道長词渤。 經(jīng)常有香客問我牵舱,道長,這世上最難降的妖魔是什么缺虐? 我笑而不...
    開封第一講書人閱讀 58,939評論 1 295
  • 正文 為了忘掉前任芜壁,我火速辦了婚禮,結(jié)果婚禮上高氮,老公的妹妹穿的比我還像新娘慧妄。我一直安慰自己,他們只是感情好剪芍,可當(dāng)我...
    茶點故事閱讀 67,955評論 6 392
  • 文/花漫 我一把揭開白布塞淹。 她就那樣靜靜地躺著,像睡著了一般罪裹。 火紅的嫁衣襯著肌膚如雪饱普。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,737評論 1 305
  • 那天状共,我揣著相機與錄音套耕,去河邊找鬼。 笑死峡继,一個胖子當(dāng)著我的面吹牛冯袍,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 40,448評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼康愤,長吁一口氣:“原來是場噩夢啊……” “哼儡循!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起征冷,我...
    開封第一講書人閱讀 39,352評論 0 276
  • 序言:老撾萬榮一對情侶失蹤择膝,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后资盅,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體调榄,經(jīng)...
    沈念sama閱讀 45,834評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,992評論 3 338
  • 正文 我和宋清朗相戀三年呵扛,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片筐带。...
    茶點故事閱讀 40,133評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡今穿,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出伦籍,到底是詐尸還是另有隱情蓝晒,我是刑警寧澤,帶...
    沈念sama閱讀 35,815評論 5 346
  • 正文 年R本政府宣布帖鸦,位于F島的核電站芝薇,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏作儿。R本人自食惡果不足惜洛二,卻給世界環(huán)境...
    茶點故事閱讀 41,477評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望攻锰。 院中可真熱鬧晾嘶,春花似錦、人聲如沸娶吞。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,022評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽妒蛇。三九已至机断,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間绣夺,已是汗流浹背吏奸。 一陣腳步聲響...
    開封第一講書人閱讀 33,147評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留乐导,地道東北人苦丁。 一個月前我還...
    沈念sama閱讀 48,398評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像物臂,于是被迫代替她去往敵國和親旺拉。 傳聞我的和親對象是個殘疾皇子产上,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,077評論 2 355

推薦閱讀更多精彩內(nèi)容