第三方接口设计方案注意事项

1、封装统一的http请求工具类

集成apache httpclient开源框架;
集成okhttp开源框架;

2、打印请求接口入参、出参、耗时日志(可以在请求工具类统一打印)

在请求工具类统一打印,例如:
long start = System.currentTimeMillis();
// todo 请求接口返回result结果
looinfo("耗时:{}ms,url:{},param:{},result:{}",System.currentTimeMillis()-start,result,reqUrl,param,result);

3、参数合法性校验(减少对下游无效的调用)

  • 数据格式的校验(例如非空、合法性判断)
  • 业务合法性的校验

4、接口设置超时时间

http工具类提供配置的超时时间参数,供其他业务场景传递;

  • 不同的业务场景设置不同的超时时间;
  • 禁止不设置超时间,设置默认的超时时间;
  • 评估超时时间,要结合业务,不能拍脑袋,比如可以根据接口监控,看一下P95、P99的响应时间,然后在这个基础上放大一点;

5、接口是否需要重试以及重试次数

  • 事务类接口不要随便重试,如果下游没做好接口幂等容易超发,像活动的奖品发放。但是一定要有业务告警,通过人工接入的方式,进行补发处理查询类接口的重试;
  • 查询类接口的重试,也要慎重考虑,如果下游接口支持的QPS有限,重试放量,容易把下游的接口打垮,所以如果决定重试,要调研下游接口的并发能力,酌情处理;

6、事务一致性保障

自身服务:

  • 调用下游接口失败,根据业务需要判断是否回滚其他的业务或者记录业务数据到本地事务消息表,然后启动一个job定时补偿数据;
  • 管理后台提供一个事务消息表查询的功能。可以在界面上手工点击进行人工补偿;

数据下游服务:

  • 提供的接口定义一个唯一值的字段,接口做好幂等处理;
  • 提供一个根据唯一值的字段查询业务数据的接口,便于上游对账;

7、接口实现熔断返回兜底值及降级

自动熔断实现方案:

接入开源的Hystrx或sentne框架,配置合理断的值(例如1分钟接口100个报错,断30s),实现超时或接口报错自动熔断,同时跟业务商量给出一个默认兜底值。例如调用大数据客群接口,如果第三方提供的客群接口大量报错或服务超时,为了保护我们自己的系统,框架自动熔断同时返回默认不命中的兜底值;

手动熔断实现方案:

接入开源的动态配置中心apollo或disconf,配置熔断开关,当收到大量业务告警,动态秒级关闭,恢复后打开开关;

无论是自动或手动,都需要配置业务告警。

8、多次调用改为单次批量调用

  • for循环根据id调用外部接口改为单次批量根据id调用,减少多次网络io带来的时间消耗;

  • 要考虑单次批量调用参数的大小,比如单次传1000个id参数,这个也不行,可能导致接口直接超时,所以要对参数进行分组切割批量调用,比如1000个参,1次100个,分10次调用;

9、接口返回的数据考虑是否缓存(防止对下游接口造成流量冲击)

查询客户命中的客群标签,同一人一天内理论上都是不变的,可以使用redis缓存,但是过期时间不适合太长,因为同一个人使用系统的时间也不长;

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,383评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,522评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,852评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,621评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,741评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,929评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,076评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,803评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,265评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,582评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,716评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,395评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,039评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,027评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,488评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,612评论 2 350

推荐阅读更多精彩内容